visionmedia-commander 2.4.6 → 2.5.6

data/History.rdoc

@@ -1,4 +1,10 @@
 
+=== 2.5.5 / 2009-03-06
+
+* Replaced Commander::VERSION::STRING with Commander::VERSION (for release gem)
+* Refactored progress bar
+* Fixed String#tokenize
+
 === 2.4.5 / 2009-03-03
 
 * Fixed bug which was not allowing switch arguments which are strings

data/Manifest

@@ -22,13 +22,14 @@ Manifest
 Rakefile
 README.rdoc
 spec/commander_spec.rb
-spec/core_ext_spec.rb
+spec/core_ext/string_spec.rb
 spec/help_formatter_spec.rb
 spec/spec_helper.rb
 tasks/docs.rake
 tasks/gemspec.rake
 tasks/spec.rake
 test/fileutils.rb
+test/names.rb
 test/progress.rb
 test/ui.rb
 Todo.rdoc

data/Rakefile

@@ -1,7 +1,7 @@
 
 %w( rubygems rake echoe ./lib/commander.rb ).each { |lib| require lib }
 
-Echoe.new("commander", Commander::VERSION::STRING) do |p|
+Echoe.new("commander", Commander::VERSION) do |p|
   p.author = "TJ Holowaychuk"
   p.email = "tj@vision-media.ca"
   p.summary = "The complete solution for Ruby command-line executables"

data/Todo.rdoc

@@ -1,4 +1,11 @@
 
+* Fix stupid #program error output 
+* mixins like c.use Commander::TraceOption ? ...
+* add configuration management like release gem
+* test bool switches --[no-]-foo ... document
+* Add option defaults when null / revisit OpenStruct population
+* Refactor specs / improve testing
+* Add option copying / merging capabilities
 * Fix issue with having command name in the args list, #args_without_command
 * Add optional command to be executed when none is specified
 * Add aliasing of commands / args / options

data/bin/commander

@@ -4,7 +4,7 @@ require 'rubygems'
 require 'commander'
 
 program :name, 'commander'
-program :version, Commander::VERSION::STRING
+program :version, Commander::VERSION
 program :description, 'Commander utility program.'
 
 command :init do |c|
@@ -27,7 +27,7 @@ require 'commander'
 require '#{name}'
 
 program :name, '#{name}'
-program :version, #{name.camelcase}::VERSION::STRING
+program :version, #{name.camelcase}::VERSION
 program :description, '#{description}'
  
 CODE

data/commander.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{commander}
-  s.version = "2.4.6"
+  s.version = "2.5.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["TJ Holowaychuk"]
-  s.date = %q{2009-03-03}
+  s.date = %q{2009-03-06}
   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/command.rb", "lib/commander/core_ext/array.rb", "lib/commander/core_ext/kernel.rb", "lib/commander/core_ext/object.rb", "lib/commander/core_ext/string.rb", "lib/commander/core_ext.rb", "lib/commander/fileutils.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.rb", "lib/commander/import.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/command.rb", "lib/commander/core_ext/array.rb", "lib/commander/core_ext/kernel.rb", "lib/commander/core_ext/object.rb", "lib/commander/core_ext/string.rb", "lib/commander/core_ext.rb", "lib/commander/fileutils.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.rb", "lib/commander/import.rb", "lib/commander/runner.rb", "lib/commander/user_interaction.rb", "lib/commander/version.rb", "lib/commander.rb", "Manifest", "Rakefile", "README.rdoc", "spec/commander_spec.rb", "spec/core_ext_spec.rb", "spec/help_formatter_spec.rb", "spec/spec_helper.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake", "test/fileutils.rb", "test/progress.rb", "test/ui.rb", "Todo.rdoc"]
+  s.files = ["bin/commander", "commander.gemspec", "History.rdoc", "lib/commander/command.rb", "lib/commander/core_ext/array.rb", "lib/commander/core_ext/kernel.rb", "lib/commander/core_ext/object.rb", "lib/commander/core_ext/string.rb", "lib/commander/core_ext.rb", "lib/commander/fileutils.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.rb", "lib/commander/import.rb", "lib/commander/runner.rb", "lib/commander/user_interaction.rb", "lib/commander/version.rb", "lib/commander.rb", "Manifest", "Rakefile", "README.rdoc", "spec/commander_spec.rb", "spec/core_ext/string_spec.rb", "spec/help_formatter_spec.rb", "spec/spec_helper.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake", "test/fileutils.rb", "test/names.rb", "test/progress.rb", "test/ui.rb", "Todo.rdoc"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/visionmedia/commander}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Commander", "--main", "README.rdoc"]

data/lib/commander/command.rb

@@ -52,10 +52,10 @@ module Commander
     # contains the results of this option. This handles common formats such as:
     #
     #    -h, --help          options.help           # => bool
-    #    --[with]-feature    options.feature        # => bool
+    #    --[no-]feature      options.feature        # => bool
     #    --large-switch      options.large_switch   # => bool
     #    --file FILE         options.file           # => file passed
-    #    --list words        options.list           # => array
+    #    --list WORDS        options.list           # => array
     #    --date [DATE]       options.date           # => date or nil when optional argument not set
     #
     # === Examples:
@@ -64,8 +64,8 @@ module Commander
     #      c.option '--recursive', 'Do something recursively'
     #      c.option '--file FILE', 'Specify a file'
     #      c.option('--info', 'Display info') { puts "handle with block" }
-    #      c.option '--[no]-feature', 'With or without feature'
-    #      c.option '--list files', Array, 'List the files specified'
+    #      c.option '--[no-]feature', 'With or without feature'
+    #      c.option '--list FILES', Array, 'List the files specified'
     #
     #      c.when_called do |args, options|
     #        do_something_recursively if options.recursive
@@ -195,7 +195,7 @@ module Commander
     end
     
     def inspect #:nodoc:
-      "#<Command:#{@name}>"
+      "#<Commander::Command:#{@name}>"
     end
     
     private 

data/lib/commander/core_ext/string.rb

@@ -4,14 +4,15 @@ class String
   ##
   # Replace +hash+ keys with associated values. Mutative.
   
-  def tokenize! hash
-    hash.inject(self) { |s, (k, v)| s.gsub! /:#{k}/, v }
+  def tokenize! hash = {}
+    hash.each { |k, v| gsub! /:#{k}/, v.to_s }
+    self
   end
     
   ##
   # Replace +hash+ keys with associated values.
   
-  def tokenize hash
+  def tokenize hash = {}
     self.dup.tokenize! hash
   end
   

data/lib/commander/runner.rb

@@ -178,7 +178,7 @@ module Commander
     def create_default_commands
       command :help do |c|
         c.syntax = "command help <sub_command>"
-        c.summary = "Display help documentation"
+        c.summary = "Display help documentation for <sub_command>"
         c.description = "Display help documentation for the global or sub commands"
         c.example "Display global help", "command help"
         c.example "Display help for 'foo'", "command help foo"

data/lib/commander/user_interaction.rb

@@ -47,13 +47,14 @@ module Commander
     #
     # Terminal progress bar utility. In its most basic form
     # requires that the developer specifies when the bar should
-    # be incremented:
+    # be incremented. Note that a hash of tokens may be passed to
+    # #increment, (or returned when using Kernel#progress).
     #
-    #    uris = %w[ 
+    #    uris = %w( 
     #      http://vision-media.ca
     #      http://yahoo.com
     #      http://google.com
-    #      ]
+    #      )
     #
     #    bar = Commander::UI::ProgressBar.new uris.length, options
     #    threads = []
@@ -61,25 +62,19 @@ module Commander
     #      threads << Thread.new do
     #        begin
     #          res = open uri
-    #          bar.inc :uri => uri
+    #          bar.increment :uri => uri
     #        rescue Exception => e
-    #          bar.inc :uri => "#{uri} failed"
+    #          bar.increment :uri => "#{uri} failed"
     #        end
     #      end
     #    end
     #    threads.each { |t| t.join }
     #
-    # The Kernel method #progress is also available, below are
-    # single and multi-threaded examples:
+    # The Kernel method #progress is also available:
     #
     #    progress uris, :width => 10 do |uri|
     #      res = open uri
     #    end
-    #    
-    #    threads = uris.collect { |uri| Thread.new { res = open uri } } 
-    #    progress threads, :progress_char => '-' do |thread|
-    #      thread.join
-    #    end
     #
 
     class ProgressBar
@@ -91,8 +86,8 @@ module Commander
       #    
       #    :title              Title, defaults to "Progress"
       #    :width              Width of :progress_bar
-      #    :progress_char      Progress character, defaults to "="
-      #    :incomplete_char    Incomplete bar character, defaults to '.'
+      #    :progress_str       Progress string, defaults to "="
+      #    :incomplete_str     Incomplete bar string, defaults to '.'
       #    :format             Defaults to ":title |:progress_bar| :percent_complete% complete "
       #    :tokens             Additional tokens replaced within the format string
       #    :complete_message   Defaults to "Process complete"
@@ -102,88 +97,129 @@ module Commander
       #    :title 
       #    :percent_complete
       #    :progress_bar
-      #    :current
-      #    :remaining
-      #    :total
-      #    :output
+      #    :step
+      #    :steps_remaining
+      #    :total_steps
       #    :time_elapsed
       #    :time_remaining
       #
 
       def initialize total, options = {}
-        @total, @options, @current, @start = total, options, 0, Time.now
-        @options = {
-          :title => "Progress",
-          :width => 25,
-          :progress_char => "=",
-          :incomplete_char => ".",
-          :complete_message => "Process complete",
-          :format => ":title |:progress_bar| :percent_complete% complete ",
-          :output => $stderr, 
-          :tokens => {},
-        }.merge! options
-        show
+        @total_steps, @step, @start_time = total, 0, Time.now
+        @title = options.fetch :title, 'Progress'
+        @width = options.fetch :width, 25
+        @progress_str = options.fetch :progress_str, '='
+        @incomplete_str = options.fetch :incomplete_str, '.'
+        @complete_message = options.fetch :complete_message, 'Process complete'
+        @format = options.fetch :format, ':title |:progress_bar| :percent_complete% complete '
+        @tokens = options.fetch :tokens, {}
+      end
+      
+      ##
+      # Completion percentage.
+      
+      def percent_complete
+        @step * 100 / @total_steps
+      end
+      
+      ##
+      # Time that has elapsed since the operation started.
+      
+      def time_elapsed
+        Time.now - @start_time
+      end
+      
+      ##
+      # Estimated time remaining.
+      
+      def time_remaining
+        (time_elapsed / @step) * steps_remaining
+      end
+      
+      ##
+      # Number of steps left.
+      
+      def steps_remaining
+        @total_steps - @step
+      end
+      
+      ##
+      # Formatted progress bar.
+      
+      def progress_bar
+        (@progress_str * (@width * percent_complete / 100)).ljust @width, @incomplete_str
+      end
+      
+      ##
+      # Generates tokens for this step.
+      
+      def generate_tokens
+        {
+          :title => @title,
+          :percent_complete => percent_complete,
+          :progress_bar => progress_bar, 
+          :step => @step,
+          :steps_remaining => steps_remaining,
+          :total_steps => @total_steps, 
+          :time_elapsed => "%0.2fs" % time_elapsed,
+          :time_remaining => "%0.2fs" % time_remaining,
+        }.
+        merge! @tokens
       end
 
       ##
       # Output the progress bar.
 
       def show
-        unless @current >= (@total + 1)
+        # TODO: shift steps stack instead
+        unless finished?
           erase_line
-          percent = (@current * 100) / @total
-          elapsed = Time.now - @start
-          remaining = @total - @current
-          tokens = {
-            :title => @options[:title],
-            :percent_complete => percent,
-            :progress_bar => (@options[:progress_char] * (@options[:width] * percent / 100)).ljust(@options[:width], @options[:incomplete_char]), 
-            :current => @current,
-            :remaining => remaining,
-            :total => @total, 
-            :time_elapsed => "%0.2fs" % [elapsed],
-            :time_remaining => "%0.2fs" % [(elapsed / @current) * remaining],
-          }.merge! @options[:tokens]
           if completed?
-            @options[:output].print @options[:complete_message].tokenize(tokens) << "\n" if @options[:complete_message].is_a? String
+            puts @complete_message.tokenize(generate_tokens) if @complete_message.is_a? String
           else
-            @options[:output].print @options[:format].tokenize(tokens)
+            print @format.tokenize(generate_tokens)
+            $stdout.flush
           end
         end
       end
+      
+      ##
+      # Weither or not the operation is complete, and we have finished.
+      
+      def finished?
+        @step == @total_steps + 1
+      end
 
       ##
       # Weither or not the operation has completed.
 
       def completed?
-        @current == @total
+        @step == @total_steps
       end
-      alias :finished? :completed?
 
       ##
       # Increment progress. Optionally pass _tokens_ which
       # can be displayed in the output format.
 
       def increment tokens = {}
-        @current += 1
-        @options[:tokens].merge! tokens if tokens.is_a? Hash
+        @step += 1
+        @tokens.merge! tokens if tokens.is_a? Hash
         show
       end
-      alias :inc :increment
 
       ##
       # Erase previous terminal line.
 
       def erase_line
-        @options[:output].print "\r\e[K"
+        print "\r\e[K"
       end
 
       ##
-      # Output progress while iterating _enum_.
+      # Output progress while iterating _arr_.
       #
       # === Example:
       #
-      #    uris = %[ http://vision-media.ca http://google.com ]
+      #    uris = %w( http://vision-media.ca http://google.com )
       #    ProgressBar.progress uris, :format => "Remaining: :time_remaining" do |uri|
       #      res = open uri
       #    end
@@ -192,9 +228,9 @@ module Commander
       #
       # * Kernel#progress
 
-      def self.progress enum, options = {}, &block
-        bar = ProgressBar.new enum.length, options
-        enum.each { |v| bar.inc yield(v) } 
+      def self.progress arr, options = {}, &block
+        bar = ProgressBar.new arr.length, options
+        arr.each { |v| bar.increment yield(v) }
       end
       
     end

data/lib/commander/version.rb

@@ -1,7 +1,4 @@
 
 module Commander
-  module VERSION #:nodoc:
-    MAJOR, MINOR, TINY = 2, 4, 6
-    STRING = [MAJOR, MINOR, TINY].join '.'
-  end
+  VERSION = '2.5.6'
 end

data/spec/core_ext/string_spec.rb

@@ -0,0 +1,25 @@
+
+describe String do
+  
+  describe "#tokenize" do
+    it "should replace tokens within a string, with hash values" do
+      s = 'Welcome :name, enjoy your :object'.tokenize  :name => 'TJ', :object => 'cookie'
+      s.should == 'Welcome TJ, enjoy your cookie'
+    end
+    
+    it "should not mutate the string" do
+      s = 'Hey :msg'
+      s.tokenize :msg => 'there'
+      s.should_not == 'Hey there'
+    end
+  end
+  
+  describe "#tokenize!" do
+    it "should mutate the string while replacing tokens" do
+      s = 'Hey :msg'
+      s.tokenize! :msg => 'there'
+      s.should == 'Hey there'
+    end
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: visionmedia-commander
 version: !ruby/object:Gem::Version 
-  version: 2.4.6
+  version: 2.5.6
 platform: ruby
 authors: 
 - TJ Holowaychuk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-03 00:00:00 -08:00
+date: 2009-03-06 00:00:00 -08:00
 default_executable: commander
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -76,13 +76,14 @@ files:
 - Rakefile
 - README.rdoc
 - spec/commander_spec.rb
-- spec/core_ext_spec.rb
+- spec/core_ext/string_spec.rb
 - spec/help_formatter_spec.rb
 - spec/spec_helper.rb
 - tasks/docs.rake
 - tasks/gemspec.rake
 - tasks/spec.rake
 - test/fileutils.rb
+- test/names.rb
 - test/progress.rb
 - test/ui.rb
 - Todo.rdoc

data/spec/core_ext_spec.rb

@@ -1,9 +0,0 @@
-
-describe Commander do
-  describe String do
-    it "should tokenize strings" do
-      s = 'Welcome :name, enjoy your :object'.tokenize!({ :name => 'TJ', :object => 'cookie' })
-      s.should == 'Welcome TJ, enjoy your cookie'
-    end
-  end
-end