oyster 0.9.1 → 0.9.2

data/History.txt

@@ -1,6 +1,17 @@
-=== 1.0.0 / 2008-07-09
+=== 0.9.2 / 2009-06-19
 
-* 1 major enhancement
+* Use Curses to set the width of help output.
+* Fix some formatting and layout bugs in help text.
 
-  * Birthday!
+
+=== 0.9.1 / 2009-01-30
+
+* Ruby 1.9 compatibility fixes.
+
+
+=== 0.9.0 / 2008-07-17
+
+* Initial release. Includes option parsing for flags, strings, ints,
+  floats, globs, files, shortcuts and subcommands. Automatically
+  renders man-page-style help to stdout with the -h flag.
 

data/Manifest.txt

@@ -5,13 +5,13 @@ Rakefile
 lib/oyster.rb
 lib/oyster/specification.rb
 lib/oyster/option.rb
+lib/oyster/options/array.rb
+lib/oyster/options/file.rb
 lib/oyster/options/flag.rb
-lib/oyster/options/string.rb
-lib/oyster/options/integer.rb
 lib/oyster/options/float.rb
-lib/oyster/options/file.rb
-lib/oyster/options/array.rb
 lib/oyster/options/glob.rb
+lib/oyster/options/integer.rb
 lib/oyster/options/shortcut.rb
+lib/oyster/options/string.rb
 lib/oyster/options/subcommand.rb
 test/test_oyster.rb

data/README.txt

@@ -1,18 +1,22 @@
 = Oyster
 
-http://github.com/jcoglan/oyster
-
-=== Description
+* http://github.com/jcoglan/oyster
 
 Oyster is a command-line input parser that doesn't hate you. It provides a simple
 API that you use to write a spec for the user interface to your program, and it
 handles mapping the input to a hash for you. It supports both long and short option
 names, subcommands, and various types of input data.
 
+
+=== Installation
+
+  sudo gem install oyster
+
+
 === Features
 
 * Parses command line options into a hash for easy access
-* Supports long (--example) and short (-e) names, including compound (-zxvf) short options
+* Supports long (<tt>--example</tt>) and short (<tt>-e</tt>) names, including compound (<tt>-zxvf</tt>) short options
 * Supports subcommand recognition
 * Can parse options as booleans, strings, arrays, files, globs
 * Automatically handles single-letter shortcuts for option names
@@ -20,12 +24,13 @@ names, subcommands, and various types of input data.
 * Is easily extensible to support custom input types
 * Automatically outputs man-page-style help for your program
 
+
 === Usage
 
 You begin your command-line script by writing a spec for its options, layed out
 like a Unix manual page. This spec will be used to parse input and to generate
-help text using the --help flag. This example demonstrates a wide range of the
-spec API. You can use as much or as little of it as you like, none of the fields
+help text using the <tt>--help</tt> flag. This example demonstrates a wide range of
+the spec API. You can use as much or as little of it as you like, none of the fields
 are required.
 
   require 'rubygems'
@@ -45,19 +50,21 @@ are required.
     EOS
     
     flag    :verbose,   :default => false,
-    :desc => 'Print verbose output'
+            :desc => 'Print verbose output'
     
     flag    :recurse,   :default => true,
-    :desc => 'Enter directories recursively'
+            :desc => 'Enter directories recursively'
+    
+    shortcut :all, '--verbose --recurse'
     
     string  :type,      :default => 'f',
-    :desc => 'Which type of files to move'
+            :desc => 'Which type of files to move'
     
     integer :status,    :default => 200,
-    :desc => 'Tell the program the status code to return'
+            :desc => 'Tell the program the status code to return'
     
     float   :quality,   :default => 0.5,
-    :desc => 'Level of compression loss incurred when copying'
+            :desc => 'Level of compression loss incurred when copying'
     
     glob    :files,     :desc => <<-EOS
     Pattern for selecting which files to move. For example, to select all the
@@ -87,8 +94,8 @@ are required.
   end
 
 Having defined your spec, you can use it to parse user input. Input is specified
-as an array of string tokens, and defaults to ARGV. If the program is invoked using
---help, Oyster will throw a <tt>Oyster::HelpRendered</tt> exception that you can
+as an array of string tokens, and defaults to +ARGV+. If the program is invoked using
+<tt>--help</tt>, Oyster will throw a <tt>Oyster::HelpRendered</tt> exception that you can
 use to halt your program if necessary. An example taking input from the command
 line:
 
@@ -105,6 +112,10 @@ as specified by the user. For example:
   Input:    --no-recurse
   Oupput:   opts[:recurse] == false
   
+  Input:    --all
+  Output    options[:verbose] == true
+            options[:recurse] == true
+  
   Input:    --dest /path/to/mydir
   Output:   opts[:dest] == '/path/to/mydir'
   
@@ -136,6 +147,7 @@ glob before handing it to the Ruby interpreter.
             -- Oyster will call Dir.glob('**/*.rb')
                opts[:files] == ['foo.rb', 'bar.rb', 'dir/baz.rb', ...]
 
+
 === Unclaimed input
 
 Any input tokens not absorbed by one of the option flags will be written to an
@@ -146,6 +158,7 @@ array in <tt>opts[:unclaimed]</tt>:
             opts[:dest] == '/path/to/dir'
             opts[:unclaimed] == ['some_arg']
 
+
 === Subcommands
 
 You can easily create subcommands by nesting specs inside the main one:
@@ -179,14 +192,6 @@ Subcommand options are stored as a hash inside the main options hash:
 Beware that you cannot give a subcommand the same name as an option flag,
 otherwise you'll get a name collision in the output.
 
-=== Requirements
-
-* Rubygems
-* Oyster gem
-
-=== Installation
-
-  sudo gem install oyster
 
 === License
 

data/Rakefile

@@ -4,7 +4,7 @@ require 'rubygems'
 require 'hoe'
 require './lib/oyster.rb'
 
-Hoe.new('oyster', Oyster::VERSION) do |p|
+Hoe.spec('oyster') do |p|
   p.developer('James Coglan', 'jcoglan@googlemail.com')
 end
 

data/lib/oyster.rb

@@ -1,11 +1,14 @@
 module Oyster
-  VERSION = '0.9.1'
+  VERSION = '0.9.2'
   
   LONG_NAME   = /^--([a-z\[][a-z0-9\]\-]+)$/i
   SHORT_NAME  = /^-([a-z0-9]+)$/i
   
   HELP_INDENT = 7
-  HELP_WIDTH  = 72
+  HELP_WIDTH  = 80
+  
+  STOP_FLAG   = '--'
+  NEGATOR     = /^no-/
   
   WINDOWS = RUBY_PLATFORM.split('-').any? { |part| part =~ /mswin\d*/i }
   
@@ -19,7 +22,7 @@ module Oyster
   end
   
   def self.is_name?(string)
-    !string.nil? and !!(string =~ LONG_NAME || string =~ SHORT_NAME || string == '--')
+    !string.nil? and !!(string =~ LONG_NAME || string =~ SHORT_NAME || string == STOP_FLAG)
   end
 end
 

data/lib/oyster/specification.rb

@@ -49,7 +49,7 @@ module Oyster
       output = {:unclaimed => []}
       
       while token = input.shift
-        if token == '--'
+        if token == STOP_FLAG
           output[:unclaimed] = output[:unclaimed] + input
           break
         end
@@ -61,8 +61,8 @@ module Oyster
         
         input = short.scan(/./).map { |s| "-#{s}" } + input and next if short and short.size > 1
         
-        negative = !!(long && long =~ /^no-/)
-        long.sub!(/^no-/, '') if negative
+        negative = !!(long && long =~ NEGATOR)
+        long.sub!(NEGATOR, '') if negative
         
         option ||= self[long] || self[short]
         output[:unclaimed] << token and next unless option
@@ -95,34 +95,53 @@ module Oyster
       initial
     end
     
-    def help
-      display(@data[:name],         1, 'NAME')
-      display(@data[:synopsis],     1, 'SYNOPSIS', false, true)
-      display(@data[:description],  1, 'DESCRIPTION')
-      puts "\n#{ bold }OPTIONS#{ normal }"
+    def help(stream = $stdout)
+      render(stream, @data[:name],         1, 'NAME')
+      render(stream, @data[:synopsis],     1, 'SYNOPSIS', false, true)
+      render(stream, @data[:description],  1, 'DESCRIPTION')
+      
+      i = 0
+      stream.puts "\n#{ bold }OPTIONS#{ normal }"
       each do |option|
-        display(option.help_names.join(', '), 1, nil, false, true)
-        display(option.description, 2)
-        puts "\n"
+        render(stream, option.help_names.join(', '), 1, nil, false, true)
+        render(stream, option.description, 2)
+        i += 1
+        stream.puts "\n" if i < @options.size
       end
-      display(@data[:notes],        1, 'NOTES')
-      display(@data[:author],       1, 'AUTHOR')
-      display(@data[:copyright],    1, 'COPYRIGHT')
+      
+      render(stream, @data[:notes],        1, 'NOTES')
+      render(stream, @data[:author],       1, 'AUTHOR')
+      render(stream, @data[:copyright],    1, 'COPYRIGHT')
+      stream.puts "\n"
       self
     end
     
-    def display(text, level = 1, title = nil, join = true, man = false)
+    # Plagiarised from Trollop, Copyright (c) 2008 William Morgan
+    def display_width
+      @width ||= begin
+                   require 'curses'
+                   Curses.init_screen
+                   x = Curses.cols
+                   Curses.close_screen
+                   x
+                 rescue
+                   HELP_WIDTH
+                 end
+      @width - HELP_INDENT
+    end
+    
+    def render(stream, text, level = 1, title = nil, join = true, man = false)
       return unless text
-      puts "\n" + format("#{ bold }#{ title }#{ normal }", level - 1) if title
+      stream.puts "\n" + format("#{ normal }#{ bold }#{ title }#{ normal }", level - 1) if title
       text = man_format(text) if man
-      puts format(text, level, join)
+      stream.puts format(text, level, join)
     end
     
     def format(text, level = 1, join = true)
       lines   = text.split(/\n/)
       outdent = lines.inject(1000) { |n,s| [s.scan(/^\s*/).first.size, n].min }
       indent  = level * HELP_INDENT
-      width   = HELP_WIDTH - indent
+      width   = display_width - indent
       
       lines.map { |line|
         line.sub(/\s*$/, '').sub(%r{^\s{#{outdent}}}, '')

data/test/test_oyster.rb

@@ -35,6 +35,13 @@ class OysterTest < Test::Unit::TestCase
       Which binary to use. You can change the executable used to format the output
       of this command, setting it to your scripting language of choice. This is just
       a lot of text to make sure help formatting works.
+      
+        class WeCan
+          attr_writer :write_code
+          
+          def in_option_descriptions
+          end
+        end
       EOS
       
       integer :status,    :default => 200,
@@ -188,7 +195,7 @@ class OysterTest < Test::Unit::TestCase
   
   def test_file
     opts = @spec.parse %w(--path Rakefile)
-    assert opts[:path] =~ /Oyster::VERSION/
+    assert opts[:path] =~ /Hoe/
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: oyster
 version: !ruby/object:Gem::Version 
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors: 
 - James Coglan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-30 00:00:00 +00:00
+date: 2009-06-19 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,9 +20,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.2
+        version: 2.0.0
     version: 
-description: Oyster is a command-line input parser that doesn't hate you. It provides a simple API that you use to write a spec for the user interface to your program, and it handles mapping the input to a hash for you. It supports both long and short option names, subcommands, and various types of input data.
+description: ""
 email: 
 - jcoglan@googlemail.com
 executables: []
@@ -41,18 +41,20 @@ files:
 - lib/oyster.rb
 - lib/oyster/specification.rb
 - lib/oyster/option.rb
+- lib/oyster/options/array.rb
+- lib/oyster/options/file.rb
 - lib/oyster/options/flag.rb
-- lib/oyster/options/string.rb
-- lib/oyster/options/integer.rb
 - lib/oyster/options/float.rb
-- lib/oyster/options/file.rb
-- lib/oyster/options/array.rb
 - lib/oyster/options/glob.rb
+- lib/oyster/options/integer.rb
 - lib/oyster/options/shortcut.rb
+- lib/oyster/options/string.rb
 - lib/oyster/options/subcommand.rb
 - test/test_oyster.rb
 has_rdoc: true
 homepage: http://github.com/jcoglan/oyster
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -74,9 +76,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: oyster
-rubygems_version: 1.3.1
+rubygems_version: 1.3.3
 signing_key: 
-specification_version: 2
-summary: Oyster is a command-line input parser that doesn't hate you
+specification_version: 3
+summary: ""
 test_files: 
 - test/test_oyster.rb