Module: Mongrel::Command::Base
- Defined in:
- lib/mongrel/command.rb
Overview
A Command pattern implementation used to create the set of command available to the user from Mongrel. The script uses objects which implement this interface to do the user’s bidding.
Instance Attribute Summary collapse
-
#done_validating ⇒ Object
readonly
Returns the value of attribute done_validating.
-
#original_args ⇒ Object
readonly
Returns the value of attribute original_args.
-
#valid ⇒ Object
readonly
Returns the value of attribute valid.
Instance Method Summary collapse
-
#failure(message) ⇒ Object
Just a simple method to display failure until something better is developed.
-
#help ⇒ Object
Returns a help message.
-
#initialize(options = {}) ⇒ Object
Called by the subclass to setup the command and parse the argv arguments.
-
#options(opts) ⇒ Object
Called by the implemented command to set the options for that command.
-
#run ⇒ Object
Runs the command doing it’s job.
-
#valid?(exp, message) ⇒ Boolean
Validates the given expression is true and prints the message if not, exiting.
-
#valid_dir?(file, message) ⇒ Boolean
Validates that the given directory exists.
-
#valid_exists?(file, message) ⇒ Boolean
Validates that a file exists and if not displays the message.
-
#valid_file?(file, message) ⇒ Boolean
Validates that the file is a file and not a directory or something else.
-
#validate ⇒ Object
Returns true/false depending on whether the command is configured properly.
Instance Attribute Details
#done_validating ⇒ Object (readonly)
Returns the value of attribute done_validating.
18 19 20 |
# File 'lib/mongrel/command.rb', line 18 def done_validating @done_validating end |
#original_args ⇒ Object (readonly)
Returns the value of attribute original_args.
18 19 20 |
# File 'lib/mongrel/command.rb', line 18 def original_args @original_args end |
#valid ⇒ Object (readonly)
Returns the value of attribute valid.
18 19 20 |
# File 'lib/mongrel/command.rb', line 18 def valid @valid end |
Instance Method Details
#failure(message) ⇒ Object
Just a simple method to display failure until something better is developed.
105 106 107 |
# File 'lib/mongrel/command.rb', line 105 def failure() STDERR.puts "!!! #{}" end |
#help ⇒ Object
Returns a help message. Defaults to OptionParser#help which should be good.
68 69 70 |
# File 'lib/mongrel/command.rb', line 68 def help @opt.help end |
#initialize(options = {}) ⇒ Object
Called by the subclass to setup the command and parse the argv arguments. The call is destructive on argv since it uses the OptionParser#parse! function.
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
# File 'lib/mongrel/command.rb', line 35 def initialize(={}) argv = [:argv] || [] @opt = OptionParser.new @valid = true # this is retarded, but it has to be done this way because -h and -v exit @done_validating = false @original_args = argv.dup configure # I need to add my own -h definition to prevent the -h by default from exiting. @opt.on_tail("-h", "--help", "Show this message") do @done_validating = true puts @opt end # I need to add my own -v definition to prevent the -h from exiting by default as well. @opt.on_tail("--version", "Show version") do @done_validating = true if VERSION puts "Version #{VERSION}" end end @opt.parse! argv end |
#options(opts) ⇒ Object
Called by the implemented command to set the options for that command. Every option has a short and long version, a description, a variable to set, and a default value. No exceptions.
23 24 25 26 27 28 29 30 31 |
# File 'lib/mongrel/command.rb', line 23 def (opts) # process the given options array opts.each do |short, long, help, variable, default| self.instance_variable_set(variable, default) @opt.on(short, long, help) do |arg| self.instance_variable_set(variable, arg) end end end |
#run ⇒ Object
Runs the command doing it’s job. You should implement this otherwise it will throw a NotImplementedError as a reminder.
74 75 76 |
# File 'lib/mongrel/command.rb', line 74 def run raise NotImplementedError end |
#valid?(exp, message) ⇒ Boolean
Validates the given expression is true and prints the message if not, exiting.
80 81 82 83 84 85 86 |
# File 'lib/mongrel/command.rb', line 80 def valid?(exp, ) if not @done_validating and (not exp) failure @valid = false @done_validating = true end end |
#valid_dir?(file, message) ⇒ Boolean
Validates that the given directory exists
100 101 102 |
# File 'lib/mongrel/command.rb', line 100 def valid_dir?(file, ) valid?(file != nil && File.directory?(file), ) end |
#valid_exists?(file, message) ⇒ Boolean
Validates that a file exists and if not displays the message
89 90 91 |
# File 'lib/mongrel/command.rb', line 89 def valid_exists?(file, ) valid?(file != nil && File.exist?(file), ) end |
#valid_file?(file, message) ⇒ Boolean
Validates that the file is a file and not a directory or something else.
95 96 97 |
# File 'lib/mongrel/command.rb', line 95 def valid_file?(file, ) valid?(file != nil && File.file?(file), ) end |
#validate ⇒ Object
Returns true/false depending on whether the command is configured properly.
63 64 65 |
# File 'lib/mongrel/command.rb', line 63 def validate return @valid end |