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

Instance Method Summary collapse

Instance Attribute Details

#done_validating ⇒ Object (readonly)

Returns the value of attribute done_validating.



27
28
29
 
# File 'lib/mongrel/command.rb', line 27

def done_validating
  @done_validating
end

#original_args ⇒ Object (readonly)

Returns the value of attribute original_args.



27
28
29
 
# File 'lib/mongrel/command.rb', line 27

def original_args
  @original_args
end

#valid ⇒ Object (readonly)

Returns the value of attribute valid.



27
28
29
 
# File 'lib/mongrel/command.rb', line 27

def valid
  @valid
end

Instance Method Details

#configure ⇒ Object 



70
71
72
 
# File 'lib/mongrel/command.rb', line 70

def configure
  options []
end

#failure(message) ⇒ Object

Just a simple method to display failure until something better is developed.



137
138
139
 
# File 'lib/mongrel/command.rb', line 137

def failure(message)
  STDERR.puts "!!! #{message}"
end

#help ⇒ Object

Returns a help message. Defaults to OptionParser#help which should be good.



80
81
82
 
# File 'lib/mongrel/command.rb', line 80

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.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/mongrel/command.rb', line 44

def initialize(options={})
  argv = options[:argv] || []
  @opt = OptionParser.new
  @opt.banner = Mongrel::Command::BANNER
  @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 -v from exiting by default as well.
  @opt.on_tail("--version", "Show version") do
    @done_validating = true
    puts "Version #{Mongrel::Const::MONGREL_VERSION}"
  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.



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

def options(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.

Raises:

  • (NotImplementedError) 


86
87
88
 
# File 'lib/mongrel/command.rb', line 86

def run
  raise NotImplementedError
end

#valid?(exp, message) ⇒ Boolean

Validates the given expression is true and prints the message if not, exiting.

Returns:

  • (Boolean) 


92
93
94
95
96
97
98
 
# File 'lib/mongrel/command.rb', line 92

def valid?(exp, message)
  if not @done_validating and (not exp)
    failure message
    @valid = false
    @done_validating = true
  end
end

#valid_dir?(file, message) ⇒ Boolean

Validates that the given directory exists

Returns:

  • (Boolean) 


112
113
114
 
# File 'lib/mongrel/command.rb', line 112

def valid_dir?(file, message)
  valid?(file != nil && File.directory?(file), message)
end

#valid_exists?(file, message) ⇒ Boolean

Validates that a file exists and if not displays the message

Returns:

  • (Boolean) 


101
102
103
 
# File 'lib/mongrel/command.rb', line 101

def valid_exists?(file, message)
  valid?(file != nil && File.exist?(file), message)
end

#valid_file?(file, message) ⇒ Boolean

Validates that the file is a file and not a directory or something else.

Returns:

  • (Boolean) 


107
108
109
 
# File 'lib/mongrel/command.rb', line 107

def valid_file?(file, message)
  valid?(file != nil && File.file?(file), message)
end

#valid_group?(group) ⇒ Boolean

Returns:

  • (Boolean) 


126
127
128
129
130
131
132
133
134
 
# File 'lib/mongrel/command.rb', line 126

def valid_group?(group)
  valid?(@user, "You must also specify a user.")
  begin
    Etc.getgrnam(group)
  rescue
    failure "Group does not exist: #{group}"
    @valid = false
  end
end

#valid_user?(user) ⇒ Boolean

Returns:

  • (Boolean) 


116
117
118
119
120
121
122
123
124
 
# File 'lib/mongrel/command.rb', line 116

def valid_user?(user)
  valid?(@group, "You must also specify a group.")
  begin
    Etc.getpwnam(user)
  rescue
    failure "User does not exist: #{user}"
    @valid = false
  end
end

#validate ⇒ Object

Returns true/false depending on whether the command is configured properly.



75
76
77
 
# File 'lib/mongrel/command.rb', line 75

def validate
  return @valid
end