visionmedia-commander 3.2.3 → 3.2.4

data/History.rdoc

@@ -1,4 +1,8 @@
 
+=== 3.2.4 / 2009-04-02
+
+* Added #enable_paging [#9]
+
 === 3.2.3 / 2009-04-01
 
 * Added new pager using less [#9]

data/README.rdoc

@@ -12,15 +12,16 @@ features, and an elegant API.
 * Parses options using OptionParser
 * Auto-populates struct with options ( no more { |v| options[:recursive] = v } )
 * Auto-generates help documentation via pluggable help formatters
+* Optional default sub-command when none is present
+* Global / Sub-command level options
 * Packaged with two help formatters (Terminal, TerminalCompact)
 * Imports the highline gem for interacting with the terminal
 * Adds additional user interaction functionality
 * Highly customizable progress bar with intuative, simple usage
 * Multi-word command name support such as 'drupal module install MOD', rather than 'drupal module_install MOD'
-* Use the 'commander' executable to initialize a commander driven program
-* Optional default sub-command when none is present
-* Global / Sub-command level options
+* Sexy paging for long bodies of text
 * Sub-command aliasing (very powerful, as both switches and arguments can be used)
+* Use the 'commander' executable to initialize a commander driven program
 
 == Example
 
@@ -143,6 +144,9 @@ simplify common tasks using the following methods:
   # 'Log' action to stdout
   log "create", "path/to/file.rb"
 
+  # Enable paging of output after this point
+  enable_paging
+
 == Commander Goodies
 
 === Option Defaults

data/commander.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{commander}
-  s.version = "3.2.3"
+  s.version = "3.2.4"
 
   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-01}
+  s.date = %q{2009-04-02}
   s.default_executable = %q{commander}
   s.description = %q{The complete solution for Ruby command-line executables}
   s.email = %q{tj@vision-media.ca}

data/lib/commander/runner.rb

@@ -251,6 +251,7 @@ module Commander
         c.example 'Display global help', 'command help'
         c.example "Display help for 'foo'", 'command help foo'
         c.when_called do |args, options|
+          enable_paging
           if args.empty?
             say help_formatter.render 
           else

data/lib/commander/user_interaction.rb

@@ -35,6 +35,28 @@ module Commander
       say '%15s  %s' % [action, args.join(' ')]
     end
     
+    ##
+    # Enable paging of output after called.
+    
+    def enable_paging
+      return unless $stdout.tty?
+      read, write = IO.pipe
+
+      if Kernel.fork
+        $stdin.reopen read
+        read.close; write.close
+        Kernel.select [$stdin]
+        ENV['LESS'] = 'FSRX'
+        pager = ENV['PAGER'] || 'less'
+        exec pager rescue exec '/bin/sh', '-c', pager
+      else
+        $stdout.reopen write
+        $stderr.reopen write if $stderr.tty?
+        read.close; write.close
+        return
+      end
+    end
+    
     ##
     # = Progress Bar
     #

data/lib/commander/version.rb

@@ -1,4 +1,4 @@
 
 module Commander
-  VERSION = '3.2.3'
+  VERSION = '3.2.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: visionmedia-commander
 version: !ruby/object:Gem::Version 
-  version: 3.2.3
+  version: 3.2.4
 platform: ruby
 authors: 
 - TJ Holowaychuk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-01 00:00:00 -07:00
+date: 2009-04-02 00:00:00 -07:00
 default_executable: commander
 dependencies: 
 - !ruby/object:Gem::Dependency