commander 3.3.0 → 4.0.0

data/History.rdoc

@@ -1,4 +1,16 @@
 
+=== 4.0.0 / 2009-10-10
+
+* Changed; Aliased #when_called as #action [#9]
+* Changed; Sort commands and aliases alphabetically.
+* Changed; Sort aliases alphabetically
+* Changed; Sort commands alphabetically.
+* Changed; require user to require 'commander/import' for dsl
+* Fixed broken regexp; Changed :int_message, only traps INT when available
+* Fixed Ruby 1.9 warning caused by removing object_id from Object
+* Removed #eval const hack
+* Moving to Gemcutter (GRRRR Github)
+
 === 3.3.0 / 2009-05-12
 
 * Added #choose

data/Manifest

@@ -29,8 +29,8 @@ spec/core_ext/object_spec.rb
 spec/help_formatters/base_spec.rb
 spec/help_formatters/terminal_spec.rb
 spec/runner_spec.rb
+spec/spec.opts
 spec/spec_helper.rb
 spec/ui_spec.rb
 tasks/docs.rake
 tasks/gemspec.rake
-tasks/spec.rake

data/README.rdoc

@@ -27,13 +27,13 @@ features, and an elegant API.
 
 == Installation
 
-Due to issues with Github and supporting previous releases, until 4.0 you must:
-  sudo gem install visionmedia-commander --version 3.2.9
+Install [Gemcutter](http://gemcutter.org) and execute:
+  $ sudo gem install commander
 
 == Example
 
 For more option examples view the Commander::Command#option method. Also
-an important feature to note is that when_called may be a class to instantiate,
+an important feature to note is that action may be a class to instantiate,
 as well as an object, specifying a method to call, so view the RDoc for more information.
 
    require 'rubygems'
@@ -47,7 +47,7 @@ as well as an object, specifying a method to call, so view the RDoc for more inf
    command :foo do |c|
      c.syntax = 'foobar foo'
      c.description = 'Displays foo'
-     c.when_called do |args, options|
+     c.action do |args, options|
        say 'foo'
      end
    end
@@ -57,7 +57,7 @@ as well as an object, specifying a method to call, so view the RDoc for more inf
      c.description = 'Display bar with optional prefix and suffix'
      c.option '--prefix STRING', String, 'Adds a prefix to bar'
      c.option '--suffix STRING', String, 'Adds a suffix to bar'
-     c.when_called do |args, options|
+     c.action do |args, options|
        options.default :prefix => '(', :suffix => ')'
        say "#{options.prefix}bar#{options.suffix}"
      end
@@ -186,13 +186,13 @@ simplify common tasks using the following methods:
 
 === Option Defaults
 
-The options struct passed to #when_called provides a #default method, allowing you
+The options struct passed to #action provides a #default method, allowing you
 to set defaults in a clean manor to options which have not been set.
 
   command :foo do |c|
     c.option '--interval SECONDS', Integer, 'Interval in seconds'
     c.option '--timeout SECONDS', Integer, 'Timeout in seconds'
-    c.when_called do |args, options|
+    c.action do |args, options|
       options.default \
         :interval => 2,
         :timeout  => 60
@@ -204,7 +204,7 @@ to set defaults in a clean manor to options which have not been set.
 Aliases can be created using the #alias_command method like below:
 
   command :'install gem' do |c|
-    c.when_called { puts 'foo' }
+    c.action { puts 'foo' }
   end
   alias_command :'gem install', :'install gem'
 
@@ -214,7 +214,7 @@ as if it was invoked via the command line:
   command :'install gem' do |c|
     c.syntax = 'install gem <name> [options]'
     c.option '--dest DIR', String, 'Destination directory'
-    c.when_called { |args, options| puts "installing #{args.first} to #{options.dest}" }
+    c.action { |args, options| puts "installing #{args.first} to #{options.dest}" }
   end
   alias_command :update, :'install gem', 'rubygems', '--dest', 'some_path'
 
@@ -270,7 +270,7 @@ means that instead of the following:
 
   global_option('--verbose') { $verbose = true }
   ...
-  c.when_called do |args, options|
+  c.action do |args, options|
     say 'foo' if $verbose
   ...
 
@@ -278,20 +278,20 @@ You may:
 
   global_option '--verbose'
   ...
-  c.when_called do |args, options|
+  c.action do |args, options|
     say 'foo' if options.verbose
   ...
 
 === Formatters
 
 Two core formatters are currently available, the default Terminal formatter as well
-as TerminalCompact. To utilize a different formatter simply use :help_formatter like below:
+as TerminalCompact. To utilize a different formatter simply use :formatter like below:
 
-  program :help_formatter, Commander::HelpFormatter::TerminalCompact
+  program :formatter, Commander::HelpFormatter::TerminalCompact
 
 Or utilize the help formatter aliases:
 
-  program :help_formatter, :compact
+  program :formatter, :compact
 
 This abstraction could be utilized to generate HTML documentation for your executable.
 
@@ -322,10 +322,18 @@ To utilize the #notify and #notify_STATUS methods you need to install
 http://github.com/visionmedia/growl which utilizes the 'growlnotify' executable.
 Note that growl is auto-imported by Commander when available, no need to require.
 
+== Running Specifications
+
+  $ autospec
+  
+OR 
+
+  $ spec --color spec
+
 == Contrib
 
 Feel free to fork and request a pull, or submit a ticket
-http://visionmedia.lighthouseapp.com/projects/27643-commander
+http://github.com/visionmedia/commander/issues
 
 == Known Issues
  

data/bin/commander

@@ -13,7 +13,7 @@ command :init do |c|
 	c.description = 'Initialize an empty <file> with a commander template, 
     allowing very quick creation of commander executables.'
 	c.example 'Create a new file with a commander template.', 'commander init bin/my_executable'
-	c.when_called do |args, options|
+	c.action do |args, options|
 	  file = args.shift || abort('file argument required.')
 		name = ask 'Machine name of program: '
 		description = ask 'Describe your program: '
@@ -39,7 +39,7 @@ command :init do |c|
               c.description = ''
               c.example 'description', 'command example'
               c.option '--some-switch', 'Some switch that does something'
-              c.when_called do |args, options|
+              c.action do |args, options|
                 # Do something or c.when_called #{name.capitalize}::Commands::#{command.capitalize}
               end
             end

data/commander.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{commander}
-  s.version = "3.3.0"
+  s.version = "4.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["TJ Holowaychuk"]
-  s.date = %q{2009-10-08}
+  s.date = %q{2009-10-10}
   s.default_executable = %q{commander}
   s.description = %q{The complete solution for Ruby command-line executables}
   s.email = %q{tj@vision-media.ca}
   s.executables = ["commander"]
-  s.extra_rdoc_files = ["README.rdoc", "bin/commander", "lib/commander.rb", "lib/commander/blank.rb", "lib/commander/command.rb", "lib/commander/core_ext.rb", "lib/commander/core_ext/array.rb", "lib/commander/core_ext/object.rb", "lib/commander/delegates.rb", "lib/commander/help_formatters.rb", "lib/commander/help_formatters/base.rb", "lib/commander/help_formatters/terminal.rb", "lib/commander/help_formatters/terminal/command_help.erb", "lib/commander/help_formatters/terminal/help.erb", "lib/commander/help_formatters/terminal_compact.rb", "lib/commander/help_formatters/terminal_compact/command_help.erb", "lib/commander/help_formatters/terminal_compact/help.erb", "lib/commander/import.rb", "lib/commander/runner.rb", "lib/commander/user_interaction.rb", "lib/commander/version.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
-  s.files = ["History.rdoc", "Manifest", "README.rdoc", "Rakefile", "bin/commander", "commander.gemspec", "lib/commander.rb", "lib/commander/blank.rb", "lib/commander/command.rb", "lib/commander/core_ext.rb", "lib/commander/core_ext/array.rb", "lib/commander/core_ext/object.rb", "lib/commander/delegates.rb", "lib/commander/help_formatters.rb", "lib/commander/help_formatters/base.rb", "lib/commander/help_formatters/terminal.rb", "lib/commander/help_formatters/terminal/command_help.erb", "lib/commander/help_formatters/terminal/help.erb", "lib/commander/help_formatters/terminal_compact.rb", "lib/commander/help_formatters/terminal_compact/command_help.erb", "lib/commander/help_formatters/terminal_compact/help.erb", "lib/commander/import.rb", "lib/commander/runner.rb", "lib/commander/user_interaction.rb", "lib/commander/version.rb", "spec/command_spec.rb", "spec/core_ext/array_spec.rb", "spec/core_ext/object_spec.rb", "spec/help_formatters/base_spec.rb", "spec/help_formatters/terminal_spec.rb", "spec/runner_spec.rb", "spec/spec_helper.rb", "spec/ui_spec.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
+  s.extra_rdoc_files = ["README.rdoc", "bin/commander", "lib/commander.rb", "lib/commander/blank.rb", "lib/commander/command.rb", "lib/commander/core_ext.rb", "lib/commander/core_ext/array.rb", "lib/commander/core_ext/object.rb", "lib/commander/delegates.rb", "lib/commander/help_formatters.rb", "lib/commander/help_formatters/base.rb", "lib/commander/help_formatters/terminal.rb", "lib/commander/help_formatters/terminal/command_help.erb", "lib/commander/help_formatters/terminal/help.erb", "lib/commander/help_formatters/terminal_compact.rb", "lib/commander/help_formatters/terminal_compact/command_help.erb", "lib/commander/help_formatters/terminal_compact/help.erb", "lib/commander/import.rb", "lib/commander/runner.rb", "lib/commander/user_interaction.rb", "lib/commander/version.rb", "tasks/docs.rake", "tasks/gemspec.rake"]
+  s.files = ["History.rdoc", "Manifest", "README.rdoc", "Rakefile", "bin/commander", "commander.gemspec", "lib/commander.rb", "lib/commander/blank.rb", "lib/commander/command.rb", "lib/commander/core_ext.rb", "lib/commander/core_ext/array.rb", "lib/commander/core_ext/object.rb", "lib/commander/delegates.rb", "lib/commander/help_formatters.rb", "lib/commander/help_formatters/base.rb", "lib/commander/help_formatters/terminal.rb", "lib/commander/help_formatters/terminal/command_help.erb", "lib/commander/help_formatters/terminal/help.erb", "lib/commander/help_formatters/terminal_compact.rb", "lib/commander/help_formatters/terminal_compact/command_help.erb", "lib/commander/help_formatters/terminal_compact/help.erb", "lib/commander/import.rb", "lib/commander/runner.rb", "lib/commander/user_interaction.rb", "lib/commander/version.rb", "spec/command_spec.rb", "spec/core_ext/array_spec.rb", "spec/core_ext/object_spec.rb", "spec/help_formatters/base_spec.rb", "spec/help_formatters/terminal_spec.rb", "spec/runner_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "spec/ui_spec.rb", "tasks/docs.rake", "tasks/gemspec.rake"]
   s.homepage = %q{http://visionmedia.github.com/commander}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Commander", "--main", "README.rdoc"]
   s.require_paths = ["lib"]

data/lib/commander/command.rb

@@ -142,6 +142,7 @@ module Commander
       raise ArgumentError, 'must pass an object, class, or block.' if args.empty? and !block
       @when_called = block ? [block] : args
     end
+    alias :action :when_called
     
     ##
     # Run the command with _args_.

data/lib/commander/version.rb

@@ -1,4 +1,4 @@
 
 module Commander
-  VERSION = '3.3.0'
+  VERSION = '4.0.0'
 end

data/spec/command_spec.rb

@@ -1,4 +1,6 @@
 
+require File.dirname(__FILE__) + '/spec_helper'
+
 describe Commander::Command do
   
   before :each do
@@ -54,6 +56,13 @@ describe Commander::Command do
         @command.when_called object
         @command.run 'foo'        
       end
+      
+      it "should allow #action as an alias to #when_called" do
+        object = mock 'Object'
+        object.should_receive(:call).once
+        @command.action object
+        @command.run 'foo'
+      end
             
       it "calling an arbitrary method when an object is called" do
         object = mock 'Object'

data/spec/core_ext/array_spec.rb

@@ -1,4 +1,6 @@
 
+require File.dirname(__FILE__) + '/../spec_helper'
+
 describe Array do
   
   describe "#parse" do

data/spec/core_ext/object_spec.rb

@@ -1,4 +1,6 @@
 
+require File.dirname(__FILE__) + '/../spec_helper'
+
 describe Object do
   
   describe "#get_binding" do

data/spec/help_formatters/base_spec.rb

@@ -1,4 +1,6 @@
 
+require File.dirname(__FILE__) + '/../spec_helper'
+
 describe Commander::HelpFormatter do
   
   before :each do

data/spec/help_formatters/terminal_spec.rb

@@ -1,4 +1,6 @@
 
+require File.dirname(__FILE__) + '/../spec_helper'
+
 describe Commander::HelpFormatter::Terminal do
   
   before :each do

data/spec/runner_spec.rb

@@ -1,4 +1,6 @@
 
+require File.dirname(__FILE__) + '/spec_helper'
+
 describe Commander do
   
 	before :each do

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 
+$:.unshift File.dirname(__FILE__) + '/../lib'
 require 'rubygems'
 require 'commander/import'
 require 'stringio'
@@ -47,7 +48,7 @@ end
 
 def run *args
   new_command_runner *args do
-    program :help_formatter, Commander::HelpFormatter::Base
+    program :formatter, Commander::HelpFormatter::Base
   end.run!    
   @output.string
 end

data/spec/ui_spec.rb

@@ -1,4 +1,6 @@
 
+require File.dirname(__FILE__) + '/spec_helper'
+
 describe Commander::UI do
   
   describe ".replace_tokens" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: commander
 version: !ruby/object:Gem::Version 
-  version: 3.3.0
+  version: 4.0.0
 platform: ruby
 authors: 
 - TJ Holowaychuk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-08 00:00:00 -07:00
+date: 2009-10-10 00:00:00 -07:00
 default_executable: commander
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,7 +52,6 @@ extra_rdoc_files:
 - lib/commander/version.rb
 - tasks/docs.rake
 - tasks/gemspec.rake
-- tasks/spec.rake
 files: 
 - History.rdoc
 - Manifest
@@ -85,11 +84,11 @@ files:
 - spec/help_formatters/base_spec.rb
 - spec/help_formatters/terminal_spec.rb
 - spec/runner_spec.rb
+- spec/spec.opts
 - spec/spec_helper.rb
 - spec/ui_spec.rb
 - tasks/docs.rake
 - tasks/gemspec.rake
-- tasks/spec.rake
 has_rdoc: true
 homepage: http://visionmedia.github.com/commander
 licenses: []

data/tasks/spec.rake

@@ -1,25 +0,0 @@
-
-require 'spec/rake/spectask'
-  
-desc "Run all specifications"
-Spec::Rake::SpecTask.new(:spec) do |t|
-  t.libs << "lib"
-  t.spec_opts = ["--color", "--require", "spec/spec_helper.rb"]
-end
-  
-namespace :spec do
-
-  desc "Run all specifications verbosely"
-  Spec::Rake::SpecTask.new(:verbose) do |t|
-    t.libs << "lib"
-    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
-  end
-  
-  desc "Run specific specification verbosely (specify SPEC)"
-  Spec::Rake::SpecTask.new(:select) do |t|
-    t.libs << "lib"
-    t.spec_files = [ENV["SPEC"]]
-    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
-  end
-  
-end