visionmedia-commander 3.2.6 → 3.2.7

data/History.rdoc

@@ -1,4 +1,9 @@
 
+=== 3.2.7 / 2009-04-08
+
+* Added #notify, #notify_ok, #notify_warning, #notify_info and #notify_error
+  These methods all utilize the MacOS growlnotify binary, very cool stuff check it out!
+
 === 3.2.6 / 2009-04-08
 
 * Added Commander::UI::AskForClass

data/Manifest

@@ -15,6 +15,10 @@ 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,6 +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
 * Use the 'commander' executable to initialize a commander driven program
 
 == Example
@@ -153,6 +154,21 @@ simplify common tasks using the following methods:
   # Ask editor, supplying initial text
   ask_editor 'previous data to update'
 
+  # Display a generic Growl notification r 
+  notify 'Something happened'
+
+  # Display an 'info' status notification
+  notify_info 'You have #{emails.length} new email(s)'
+
+  # Display an 'ok' status notification
+  notify_ok 'Gems updated'
+
+  # Display a 'warning' status notification 
+  notify_warning '1 gem failed installation'
+
+  # Display an 'error' status notification
+  notify_error "Gem #{name} failed"
+
 == Commander Goodies
 
 === Option Defaults
@@ -283,6 +299,11 @@ http://github.com/visionmedia/terminal-table
    |          |       |    |        | get it while its hot! |
    +----------+-------+----+--------+-----------------------+
 
+== Growl Notifications
+
+To utilize the #notify and #notify_STATUS methods you need to install
+http://github.com/visionmedia/growl which utilizes the 'growlnotify' executable.
+
 == Contrib
 
 Feel free to fork and request a pull, or submit a ticket

data/commander.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{commander}
-  s.version = "3.2.6"
+  s.version = "3.2.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["TJ Holowaychuk"]
@@ -11,8 +11,8 @@ Gem::Specification.new do |s|
   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/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.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.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/user_interaction.rb

@@ -79,6 +79,32 @@ 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.
     

data/lib/commander/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: visionmedia-commander
 version: !ruby/object:Gem::Version 
-  version: 3.2.6
+  version: 3.2.7
 platform: ruby
 authors: 
 - TJ Holowaychuk
@@ -44,6 +44,10 @@ 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
@@ -70,6 +74,10 @@ 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