Class: SchemaToScaffold::Help

Inherits:
Object
  • Object
show all
Defined in:
lib/schema_to_scaffold/help.rb

Constant Summary collapse

GENERIC_HELP =

Usage help text to print in all platforms

<<-END_OF_HELP

Usage: scaffold [options]
Generate a rails scaffold script for a given schema.rb
 -h             Displays help.
 -p <path>      It specifies a path to a folder or to a file.
 -c             Will copy the script to your clipboard. Requires xclip be installed on Linux.
 -f             Generates a factory_bot:model rather than a full scaffold.
 -m             Add migration (use if your schema comes from a different database)

END_OF_HELP
WINDOWS_HELP =

Windows specific usage help text

<<-WINDOWS_SAMPLE
Examples:
scaffold
scaffold -p C:\\Users\\JohnDoe
scaffold -c -p C:\\Users\\JohnDoe\\Documents\\schema.rb
WINDOWS_SAMPLE
LINUX_HELP =

Linux specific usage help text

<<-LINUX_SAMPLE
Examples:
scaffold
scaffold -c -p ~/work/rails/my_app
scaffold -c -p ~/work/rails/my_app/db/schema.rb
LINUX_SAMPLE

Class Method Summary collapse

Class Method Details

.message ⇒ Object 



32
33
34
35
36
37
38
39
40
 
# File 'lib/schema_to_scaffold/help.rb', line 32

def self.message
  return GENERIC_HELP +
  case platform
  when /darwin/i then LINUX_HELP
  when /linux/i  then LINUX_HELP
  when /mingw/i  then WINDOWS_HELP
  when /win/i    then WINDOWS_HELP
  end
end

.platform ⇒ Object 



42
43
44
 
# File 'lib/schema_to_scaffold/help.rb', line 42

def self.platform
  RUBY_PLATFORM
end