Class: Commands::Plugin

Inherits:
Object
  • Object
show all
Defined in:
lib/rails/commands/plugin.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initializePlugin

Returns a new instance of Plugin.


280
281
282
283
284
285
# File 'lib/rails/commands/plugin.rb', line 280

def initialize
  @environment = RailsEnvironment.default
  @rails_root = RailsEnvironment.default.root
  @script_name = File.basename($0)
  @sources = []
end

Instance Attribute Details

#environmentObject

Returns the value of attribute environment


279
280
281
# File 'lib/rails/commands/plugin.rb', line 279

def environment
  @environment
end

#script_nameObject (readonly)

Returns the value of attribute script_name


279
280
281
# File 'lib/rails/commands/plugin.rb', line 279

def script_name
  @script_name
end

#sourcesObject (readonly)

Returns the value of attribute sources


279
280
281
# File 'lib/rails/commands/plugin.rb', line 279

def sources
  @sources
end

Class Method Details

.parse!(args = ARGV) ⇒ Object


351
352
353
# File 'lib/rails/commands/plugin.rb', line 351

def self.parse!(args=ARGV)
  Plugin.new.parse!(args)
end

Instance Method Details

#optionsObject


292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
# File 'lib/rails/commands/plugin.rb', line 292

def options
  OptionParser.new do |o|
    o.set_summary_indent('  ')
    o.banner =    "Usage: plugin [OPTIONS] command"
    o.define_head "Rails plugin manager."

    o.separator ""
    o.separator "GENERAL OPTIONS"

    o.on("-r", "--root=DIR", String,
         "Set an explicit rails app directory.",
         "Default: #{@rails_root}") { |rails_root| @rails_root = rails_root; self.environment = RailsEnvironment.new(@rails_root) }
    o.on("-s", "--source=URL1,URL2", Array,
         "Use the specified plugin repositories instead of the defaults.") { |sources| @sources = sources}

    o.on("-v", "--verbose", "Turn on verbose output.") { |verbose| $verbose = verbose }
    o.on("-h", "--help", "Show this help message.") { puts o; exit }

    o.separator ""
    o.separator "COMMANDS"

    o.separator "  install    Install plugin(s) from known repositories or URLs."
    o.separator "  remove     Uninstall plugins."

    o.separator ""
    o.separator "EXAMPLES"
    o.separator "  Install a plugin:"
    o.separator "    #{@script_name} plugin install continuous_builder\n"
    o.separator "  Install a plugin from a subversion URL:"
    o.separator "    #{@script_name} plugin install http://dev.rubyonrails.com/svn/rails/plugins/continuous_builder\n"
    o.separator "  Install a plugin from a git URL:"
    o.separator "    #{@script_name} plugin install git://github.com/SomeGuy/my_awesome_plugin.git\n"
    o.separator "  Install a plugin and add a svn:externals entry to vendor/plugins"
    o.separator "    #{@script_name} plugin install -x continuous_builder\n"
  end
end

#parse!(args = ARGV) ⇒ Object


329
330
331
332
333
334
335
336
337
338
339
340
341
342
# File 'lib/rails/commands/plugin.rb', line 329

def parse!(args=ARGV)
  general, sub = split_args(args)
  options.parse!(general)

  command = general.shift
  if command =~ /^(install|remove)$/
    command = Commands.const_get(command.capitalize).new(self)
    command.parse!(sub)
  else
    puts "Unknown command: #{command}" unless command.blank?
    puts options
    exit 1
  end
end

#split_args(args) ⇒ Object


344
345
346
347
348
349
# File 'lib/rails/commands/plugin.rb', line 344

def split_args(args)
  left = []
  left << args.shift while args[0] and args[0] =~ /^-/
  left << args.shift if args[0]
  [left, args]
end