commander 4.1.3 → 4.1.4

data/.gitignore

@@ -3,4 +3,5 @@
 Gemfile.lock
 pkg/*
 .rvmrc
-coverage/*
+.ruby-version
+coverage/*

data/History.rdoc

@@ -1,3 +1,9 @@
+=== 4.1.4 / 2013-07-21
+
+* Improve help formatting for multiline program and command descriptions
+* Add ability to set speaking rate (@kethomassen)
+* Clean up examples in docs (@parkr)
+
 === 4.1.3 / 2012-12-15
 
 * Remove use of eval in Array.parse

data/README.rdoc

@@ -72,7 +72,7 @@ as well as an object, specifying a method to call, so view the RDoc for more inf
    $ foobar bar
    # => (bar)
 
-   $ foobar bar --suffix '{' --prefix '}'
+   $ foobar bar --suffix '}' --prefix '{'
    # => {bar}
 
 == HighLine
@@ -159,6 +159,7 @@ following methods to simplify common tasks:
   speak 'What is your favorite food? '
   food = ask 'favorite food?: '
   speak "Wow, I like #{food} too. We have so much in common." 
+  speak "I like #{food} as well!", "Victoria", 190
 
   # Execute arbitrary applescript
   applescript 'foo'
@@ -192,16 +193,12 @@ growl is auto-imported by Commander when available, no need to require.
   # Display an 'ok' status notification
   notify_ok 'Gems updated'
 
-  # Display a 'warning' status notification 
+  # Display a 'warning' status notification
   notify_warning '1 gem failed installation'
 
   # Display an 'error' status notification
   notify_error "Gem #{name} failed"
 
-growlnotify can also be installed via homebrew[http://mxcl.github.com/homebrew/]:
-
-  $ brew install growlnotify
-
 == Commander Goodies
 
 === Option Defaults

data/Rakefile

@@ -4,7 +4,7 @@ require "bundler/gem_tasks"
 desc "Run specs"
 RSpec::Core::RakeTask.new do |t|
   t.verbose = false
-  t.rspec_opts = '--color'
+  t.rspec_opts = '--color --order random'
 end
 
 task :default => :spec

data/lib/commander/help_formatters.rb

@@ -4,5 +4,10 @@ module Commander
     autoload :Base, 'commander/help_formatters/base'
     autoload :Terminal, 'commander/help_formatters/terminal'
     autoload :TerminalCompact, 'commander/help_formatters/terminal_compact'
+
+    module_function
+    def indent amount, text
+      text.gsub("\n", "\n" + (' ' * amount))
+    end
   end
-end
+end

data/lib/commander/help_formatters/terminal/command_help.erb

@@ -12,7 +12,7 @@
 
   <%= $terminal.color "DESCRIPTION", :bold %>:
 
-    <%= @description || @summary || 'No description.' -%>
+    <%= Commander::HelpFormatter.indent 4, (@description || @summary || 'No description.') -%>
 
 <% unless @examples.empty? -%>
 

data/lib/commander/help_formatters/terminal/help.erb

@@ -4,7 +4,7 @@
 
   <%= $terminal.color "DESCRIPTION", :bold %>:
 
-    <%= program :description %>
+    <%= Commander::HelpFormatter.indent 4, program(:description) %>
 
   <%= $terminal.color "COMMANDS", :bold %>:
 <% for name, command in @commands.sort -%>

data/lib/commander/user_interaction.rb

@@ -119,22 +119,25 @@ module Commander
     end
 
     ##
-    # Speak _message_ using _voice_ which defaults
-    # to 'Alex', which is one of the better voices.
+    # Speak _message_ using _voice_ at a speaking rate of _rate_
+    # 
+    # Voice defaults to 'Alex', which is one of the better voices.
+    # Speaking rate defaults to 175 words per minute
     #
     # === Examples
     #    
     #   speak 'What is your favorite food? '
     #   food = ask 'favorite food?: '
-    #   speak "wow, I like #{food} too. We have so much alike." 
+    #   speak "Wow, I like #{food} too. We have so much in common." 
+    #   speak "I like #{food} as well!", "Victoria", 190
     #
     # === Notes
     #
     # * MacOS only
     #
     
-    def speak message, voice = :Alex
-      Thread.new { applescript "say #{message.inspect} using #{voice.to_s.inspect}" }
+    def speak message, voice = :Alex, rate = 175
+      Thread.new { applescript "say #{message.inspect} using #{voice.to_s.inspect} speaking rate #{rate}" }
     end
     
     ##

data/lib/commander/version.rb

@@ -1,3 +1,3 @@
 module Commander
-  VERSION = '4.1.3'
+  VERSION = '4.1.4'
 end

data/spec/runner_spec.rb

@@ -353,18 +353,24 @@ describe Commander do
   
   describe "#valid_command_names_from" do
     it "should return array of valid command names" do
-      command('foo bar') {}
-      command('foo bar foo') {}
-      command_runner.valid_command_names_from('foo', 'bar', 'foo').sort.should eq(['foo bar', 'foo bar foo'])
+      new_command_runner do
+        command('foo bar') {}
+        command('foo bar foo') {}
+        command_runner.valid_command_names_from('foo', 'bar', 'foo').sort.should eq(['foo bar', 'foo bar foo'])
+      end
     end
     
     it "should return empty array when no possible command names exist" do
-      command_runner.valid_command_names_from('fake', 'command', 'name').should eq([])
+      new_command_runner do
+        command_runner.valid_command_names_from('fake', 'command', 'name').should eq([])
+      end
     end
 
     it "should match exact commands only" do
-      command('foo') {}
-      command_runner.valid_command_names_from('foobar').should eq([])
+      new_command_runner do
+        command('foo') {}
+        command_runner.valid_command_names_from('foobar').should eq([])
+      end
     end
   end
   

data/spec/spec_helper.rb

@@ -1,13 +1,29 @@
 require 'rubygems'
+require 'stringio'
 require 'simplecov'
 SimpleCov.start
 
-# prevent paging (through less) from actually occurring in test environment
-ENV['PAGER'] = 'cat'
-
+# Unshift so that local files load instead of something in gems
 $:.unshift File.dirname(__FILE__) + '/../lib'
-require 'commander/import'
-require 'stringio'
+
+# This basically replicates the behavior of `require 'commander/import'`
+# but without adding an `at_exit` hook, which interferes with exit code
+require 'commander'
+require 'commander/delegates'
+
+include Commander::UI
+include Commander::UI::AskForClass
+include Commander::Delegates
+
+# prevent paging from actually occurring in test environment
+
+module Commander
+  module UI
+    def enable_paging
+      return
+    end
+  end
+end
 
 # Mock terminal IO streams so we can spec against them
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commander
 version: !ruby/object:Gem::Version
-  version: 4.1.3
+  version: 4.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-16 00:00:00.000000000 Z
+date: 2013-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline