visionmedia-commander 3.2.7 → 3.2.8

data/History.rdoc

@@ -1,4 +1,10 @@
 
+=== 3.2.8 / 2009-04-09
+
+* Added auto-loading support of visionmedia-growl convenience methods when the gem is available
+* Changed; growl related methods are now part of visionmedia-growl
+* Fixed doc typos
+
 === 3.2.7 / 2009-04-08
 
 * Added #notify, #notify_ok, #notify_warning, #notify_info and #notify_error

data/Manifest

@@ -15,10 +15,6 @@ lib/commander/help_formatters/terminal_compact/command_help.erb
 lib/commander/help_formatters/terminal_compact/help.erb
 lib/commander/help_formatters/terminal_compact.rb
 lib/commander/help_formatters.rb
-lib/commander/images/error.png
-lib/commander/images/info.png
-lib/commander/images/ok.png
-lib/commander/images/warning.png
 lib/commander/runner.rb
 lib/commander/user_interaction.rb
 lib/commander/version.rb

data/README.rdoc

@@ -21,7 +21,7 @@ features, and an elegant API.
 * Multi-word command name support such as 'drupal module install MOD', rather than 'drupal module_install MOD'
 * Sexy paging for long bodies of text
 * Sub-command aliasing (very powerful, as both switches and arguments can be used)
-* Support for MacOS Growl notifications
+* Growl notification support for MacOS
 * Use the 'commander' executable to initialize a commander driven program
 
 == Example
@@ -154,7 +154,7 @@ simplify common tasks using the following methods:
   # Ask editor, supplying initial text
   ask_editor 'previous data to update'
 
-  # Display a generic Growl notification r 
+  # Display a generic Growl notification
   notify 'Something happened'
 
   # Display an 'info' status notification

data/commander.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{commander}
-  s.version = "3.2.7"
+  s.version = "3.2.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["TJ Holowaychuk"]
-  s.date = %q{2009-04-08}
+  s.date = %q{2009-04-09}
   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 = ["bin/commander", "lib/commander/blank.rb", "lib/commander/command.rb", "lib/commander/core_ext/array.rb", "lib/commander/core_ext/object.rb", "lib/commander/core_ext/string.rb", "lib/commander/core_ext.rb", "lib/commander/help_formatters/base.rb", "lib/commander/help_formatters/terminal/command_help.erb", "lib/commander/help_formatters/terminal/help.erb", "lib/commander/help_formatters/terminal.rb", "lib/commander/help_formatters/terminal_compact/command_help.erb", "lib/commander/help_formatters/terminal_compact/help.erb", "lib/commander/help_formatters/terminal_compact.rb", "lib/commander/help_formatters.rb", "lib/commander/images/error.png", "lib/commander/images/info.png", "lib/commander/images/ok.png", "lib/commander/images/warning.png", "lib/commander/runner.rb", "lib/commander/user_interaction.rb", "lib/commander/version.rb", "lib/commander.rb", "README.rdoc", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
-  s.files = ["bin/commander", "commander.gemspec", "History.rdoc", "lib/commander/blank.rb", "lib/commander/command.rb", "lib/commander/core_ext/array.rb", "lib/commander/core_ext/object.rb", "lib/commander/core_ext/string.rb", "lib/commander/core_ext.rb", "lib/commander/help_formatters/base.rb", "lib/commander/help_formatters/terminal/command_help.erb", "lib/commander/help_formatters/terminal/help.erb", "lib/commander/help_formatters/terminal.rb", "lib/commander/help_formatters/terminal_compact/command_help.erb", "lib/commander/help_formatters/terminal_compact/help.erb", "lib/commander/help_formatters/terminal_compact.rb", "lib/commander/help_formatters.rb", "lib/commander/images/error.png", "lib/commander/images/info.png", "lib/commander/images/ok.png", "lib/commander/images/warning.png", "lib/commander/runner.rb", "lib/commander/user_interaction.rb", "lib/commander/version.rb", "lib/commander.rb", "Manifest", "Rakefile", "README.rdoc", "spec/command_spec.rb", "spec/core_ext/array_spec.rb", "spec/core_ext/object_spec.rb", "spec/core_ext/string_spec.rb", "spec/help_formatters/base_spec.rb", "spec/help_formatters/terminal_spec.rb", "spec/runner_spec.rb", "spec/spec_helper.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
+  s.extra_rdoc_files = ["bin/commander", "lib/commander/blank.rb", "lib/commander/command.rb", "lib/commander/core_ext/array.rb", "lib/commander/core_ext/object.rb", "lib/commander/core_ext/string.rb", "lib/commander/core_ext.rb", "lib/commander/help_formatters/base.rb", "lib/commander/help_formatters/terminal/command_help.erb", "lib/commander/help_formatters/terminal/help.erb", "lib/commander/help_formatters/terminal.rb", "lib/commander/help_formatters/terminal_compact/command_help.erb", "lib/commander/help_formatters/terminal_compact/help.erb", "lib/commander/help_formatters/terminal_compact.rb", "lib/commander/help_formatters.rb", "lib/commander/runner.rb", "lib/commander/user_interaction.rb", "lib/commander/version.rb", "lib/commander.rb", "README.rdoc", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
+  s.files = ["bin/commander", "commander.gemspec", "History.rdoc", "lib/commander/blank.rb", "lib/commander/command.rb", "lib/commander/core_ext/array.rb", "lib/commander/core_ext/object.rb", "lib/commander/core_ext/string.rb", "lib/commander/core_ext.rb", "lib/commander/help_formatters/base.rb", "lib/commander/help_formatters/terminal/command_help.erb", "lib/commander/help_formatters/terminal/help.erb", "lib/commander/help_formatters/terminal.rb", "lib/commander/help_formatters/terminal_compact/command_help.erb", "lib/commander/help_formatters/terminal_compact/help.erb", "lib/commander/help_formatters/terminal_compact.rb", "lib/commander/help_formatters.rb", "lib/commander/runner.rb", "lib/commander/user_interaction.rb", "lib/commander/version.rb", "lib/commander.rb", "Manifest", "Rakefile", "README.rdoc", "spec/command_spec.rb", "spec/core_ext/array_spec.rb", "spec/core_ext/object_spec.rb", "spec/core_ext/string_spec.rb", "spec/help_formatters/base_spec.rb", "spec/help_formatters/terminal_spec.rb", "spec/runner_spec.rb", "spec/spec_helper.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
   s.has_rdoc = true
   s.homepage = %q{http://visionmedia.github.com/commander}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Commander", "--main", "README.rdoc"]

data/lib/commander/core_ext/array.rb

@@ -3,7 +3,7 @@ class Array
   
   ##
   # Split +string+ into an array. Used in
-  # conjunection with Highline's ask, or ask_for_array
+  # conjunction with Highline's ask, or ask_for_array
   # methods, which must respond to #parse.
   #
   # === Highline example
@@ -26,4 +26,4 @@ class Array
     self.delete_if { |value| value.to_s =~ /^-/ } 
   end
   
-end
+end

data/lib/commander/runner.rb

@@ -118,7 +118,7 @@ module Commander
     
     ##
     # Creates and yields a command instance when a block is passed.
-    # Otherise attempts to return the command, raising InvalidCommandError when
+    # Otherwise attempts to return the command, raising InvalidCommandError when
     # it does not exist.
     #
     # === Examples:
@@ -150,7 +150,7 @@ module Commander
     end
     
     ##
-    # Alias command +name+ with +alias_name+. Optionallry +args+ may be passed
+    # Alias command +name+ with +alias_name+. Optionally +args+ may be passed
     # as if they were being passed straight to the original command via the command-line.
     
     def alias_command alias_name, name, *args
@@ -195,7 +195,7 @@ module Commander
     end
     
     ##
-    # Attemps to locate a command name from within the arguments.
+    # Attempts to locate a command name from within the arguments.
     # Supports multi-word commands, using the largest possible match.
     
     def command_name_from_args
@@ -272,7 +272,7 @@ module Commander
     
     ##
     # Removes global options from args. This prevents an invalid
-    # option error from ocurring when options are parsed
+    # option error from occurring when options are parsed
     # again for the sub-command.
     
     def remove_global_options
@@ -308,7 +308,7 @@ module Commander
     
     ##
     # Returns a proc allowing for sub-commands to inherit global options.
-    # This functionality works weither a block is present for the global
+    # This functionality works whether a block is present for the global
     # option or not, so simple switches such as --verbose can be used
     # without a block, and used throughout all sub-commands.
     
@@ -331,7 +331,7 @@ module Commander
     end
     
     ##
-    # Return switches and description seperated from the +args+ passed.
+    # Return switches and description separated from the +args+ passed.
 
     def self.seperate_switches_from_description *args
       switches = args.find_all { |arg| arg.to_s =~ /^-/ } 
@@ -361,4 +361,4 @@ module Commander
     end
     
   end
-end
+end

data/lib/commander/user_interaction.rb

@@ -1,16 +1,28 @@
 
+
 module Commander
   
   ##
   # = User Interaction
   #
-  # Commander's user interacton module mixes in common
+  # Commander's user interaction module mixes in common
   # methods which extend HighLine's functionality such 
-  # as a unified +password+ method rather than calling
-  # +ask+ directly.
+  # as a +password+ method rather than calling +ask+ directly.
   
   module UI
     
+    #--
+    # Auto include growl when available.
+    #++
+    
+    begin
+      require 'growl'
+    rescue LoadError
+      # Do nothing
+    else
+      include Growl
+    end
+    
     ##
     # Ask the user for a password. Specify a custom
     # +message+ other than 'Password: ' or override the 
@@ -79,32 +91,6 @@ module Commander
       end
     end
     
-    ##
-    # Send a Growl notification +message+. This method
-    # requires that visionmedia-growl is installed and in the
-    # loadpath stack.
-    #
-    # === Examples
-    #
-    #  notify 'You have a new email', :title => 'Email'
-    #  notify_ok 'Gems updated'
-    #  notify_warning "Gem #{name} failed to install"
-    #  notify_error 'Failed to update gems'
-    #
-    
-    def notify message, options = {}
-      require 'growl'
-      Growl({ :message => message.to_s, :title => program(:name) }.merge(options))
-    end
-    
-    %w( ok info warning error ).each do |type|
-      define_method :"notify_#{type}" do |message, *args|
-        options = args.first || {}
-        image = File.join File.expand_path(File.dirname(__FILE__)), 'images', "#{type}.png"
-        notify message, options.merge(:image => image)
-      end
-    end
-    
     ##
     # Implements ask_for_CLASS methods.
     
@@ -258,14 +244,14 @@ module Commander
       end
       
       ##
-      # Weither or not the operation is complete, and we have finished.
+      # Whether or not the operation is complete, and we have finished.
       
       def finished?
         @step == @total_steps + 1
       end
 
       ##
-      # Weither or not the operation has completed.
+      # Whether or not the operation has completed.
 
       def completed?
         @step == @total_steps
@@ -311,4 +297,4 @@ module Commander
       
     end
   end
-end
+end

data/lib/commander/version.rb

@@ -1,4 +1,4 @@
 
 module Commander
-  VERSION = '3.2.7'
+  VERSION = '3.2.8'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: visionmedia-commander
 version: !ruby/object:Gem::Version 
-  version: 3.2.7
+  version: 3.2.8
 platform: ruby
 authors: 
 - TJ Holowaychuk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-08 00:00:00 -07:00
+date: 2009-04-09 00:00:00 -07:00
 default_executable: commander
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,10 +44,6 @@ extra_rdoc_files:
 - lib/commander/help_formatters/terminal_compact/help.erb
 - lib/commander/help_formatters/terminal_compact.rb
 - lib/commander/help_formatters.rb
-- lib/commander/images/error.png
-- lib/commander/images/info.png
-- lib/commander/images/ok.png
-- lib/commander/images/warning.png
 - lib/commander/runner.rb
 - lib/commander/user_interaction.rb
 - lib/commander/version.rb
@@ -74,10 +70,6 @@ files:
 - lib/commander/help_formatters/terminal_compact/help.erb
 - lib/commander/help_formatters/terminal_compact.rb
 - lib/commander/help_formatters.rb
-- lib/commander/images/error.png
-- lib/commander/images/info.png
-- lib/commander/images/ok.png
-- lib/commander/images/warning.png
 - lib/commander/runner.rb
 - lib/commander/user_interaction.rb
 - lib/commander/version.rb