cooloptions 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.1.0 / 2006-11-30
+
+* Initial Release
+

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/cooloptions.rb
+test/test_cooloptions.rb

data/README.txt

@@ -0,0 +1,40 @@
+= CoolOptions
+    by Nathaniel Talbott <nathaniel@terralien.com>
+    http://cooloptions.rubyforge.org/
+
+== DESCRIPTION:
+  
+CoolOptions is a simple wrapper around optparse that provides less options and more convenience.
+
+== SYNOPSYS:
+
+  options = CoolOptions.parse!("[options] PROJECTNAME") do |o|
+    o.on :svk,              "[no-]svk",              "Use svk.",                              true
+    o.on :project_path,     "project-path PATH",     "Root of project workspaces.",           File.expand_path("~/svk")
+    o.on :repository,       "repository URL",        "Remote subversion repository."          
+    o.on :repository_path,  "repository-path PATH",  "Remote repository path.",               "/",       "l"
+    o.on :mirror_path,      "mirror-path SVKPATH",   "SVK mirror path.",                      "//"
+    o.on :local_path,       "local-path SVKPATH",    "SVK local path.",                       "//local", "t"
+    o.on :create_structure, "[no-]create-structure", "Create trunk/tags/branches structure.", true
+    o.on :finish,           "[no-]finish"          , "Prep and commit the new project.",      true
+    
+    o.after do |r|
+      r.project_path = File.expand_path(r.project_path)
+      raise "Invalid path." unless File.exist?(r.project_path)
+      r.project_name = ARGV.shift
+    end
+  end
+
+== REQUIREMENTS:
+
+optparse (included in Ruby stdlib)
+
+== INSTALL:
+
+  sudo gem install cooloptions
+
+== LICENSE:
+
+The RUBY License
+
+Copyright (c) 2006 Nathaniel Talbott and Terralien, Inc. All Rights Reserved.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'hoe'
+require './lib/cooloptions.rb'
+
+Hoe.new('cooloptions', CoolOptions::VERSION) do |p|
+  p.rubyforge_name = 'cooloptions'
+  p.summary = p.description = 'CoolOptions is a simple wrapper around optparse that provides less options and more convenience.'
+  p.url = 'https://rubyforge.org/projects/cooloptions/'
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.author = "Nathaniel Talbott"
+  p.email = "nathaniel@terralien.com"
+  p.extra_deps = []
+end

data/lib/cooloptions.rb

@@ -0,0 +1,90 @@
+# Copyright (c) 2006 Nathaniel Talbott and Terralien, Inc. All Rights Reserved.
+# Licensed under the RUBY license.
+
+require 'optparse'
+require 'ostruct'
+
+class CoolOptions
+  VERSION = '0.1.0'
+
+  class Error < StandardError #:nodoc:
+  end
+
+  def self.parse!(*args)
+    o = new
+    yield o
+    o.parse!(*args)
+  rescue Error => e
+    out.puts e.message
+    o.help true
+  end
+  
+  def self.out #:nodoc:
+    @out || STDOUT
+  end
+  
+  def out #:nodoc:
+    self.class.out
+  end
+  
+  def self.out=(out) #:nodoc:
+    @out = out
+  end
+  
+  def initialize
+    @options = []
+    @after = nil
+  end
+  
+  def on(key, long, message, default=nil, short=nil)
+    unless short
+      short = if /^\[/ =~ long
+        long.split(/\]/).last
+      else
+        long
+      end[0,1]
+    end
+    @options << [key, short, long, message, default]
+  end
+  
+  def parse!(banner="[options]", argv=ARGV)
+    result = {}
+    required = []
+    OptionParser.new do |o|
+      @o = o
+      o.banner = "Usage: #{File.basename($0)} #{banner}"
+
+      @options.each do |(key, short, long, message, default)|
+        args = ["-#{short}", "--#{long}", message]
+        if default.nil?
+          required << key
+        else
+          result[key] = default
+          args << "Default is: #{default}"
+        end
+        o.on(*args){|e| result[key] = e}
+      end
+      
+      o.on('-h', '--help', "This help info."){help}
+    end.parse!(argv)
+    required.reject!{|e| result.key?(e)}
+    error "Missing required options: #{required.join(', ')}" unless required.empty?
+    result = OpenStruct.new(result)
+    @after.call(result) if @after
+    result
+  end
+  
+  def error(message)
+    raise Error, message, caller
+  end
+  
+  def after(&after)
+    @after = after
+  end
+  
+  def help(error=false)
+    out.puts @o
+    exit(error ? 1 : 0)
+  end
+end
+

data/test/test_cooloptions.rb

@@ -0,0 +1,95 @@
+# --
+# Copyright (c) 2006 Nathaniel Talbott and Terralien, Inc. All Rights Reserved.
+# Licensed under the RUBY license.
+
+require 'test/unit'
+require 'cooloptions'
+require 'stringio'
+
+class TestCoolOptions < Test::Unit::TestCase
+  def setup
+    @out = CoolOptions.out = StringIO.new
+  end
+
+  def parse!(argv, &block)
+    CoolOptions.parse!('', argv, &block)
+  rescue Exception
+    raise if $!.class >= StandardError
+    raise "Exception raised: #{$!.inspect}#{"\nOutput:\n" + @out.string if $!.class == SystemExit}"
+  end
+
+  def test_should_handle_booleans
+    r = parse!(%w(-a --no-b --c)) do |o|
+      o.on :a, '[no-]a', 'a', false
+      o.on :b, '[no-]b', 'b', true
+      o.on :c, '[no-]c', 'c', false
+      o.on :d, '[no-]d', 'd', true
+    end
+    
+    assert r.a
+    assert !r.b
+    assert r.c
+    assert r.d
+  end
+  
+  def test_should_handle_strings
+    r = parse!(%w(-a b --c=d)) do |o|
+      o.on :a, 'a ARG', 'a'
+      o.on :c, 'c ARG', 'c'
+    end
+    
+    assert_equal 'b', r.a
+    assert_equal 'd', r.c
+  end
+  
+  def test_should_ignore_non_options
+    r = CoolOptions.parse!('', argv=%w(ab -c de)) do |o|
+      o.on :c, '[no-]c', 'c'
+    end
+    
+    assert r.c
+    assert_equal %w(ab de), argv
+  end
+  
+  def test_should_call_after
+    called = false
+    r = parse!(%w(-a)) do |o|
+      o.on :a, '[no-]a', 'a'
+      o.after{|r| assert r.a; called=true}
+    end
+    assert called
+  end
+  
+  def test_should_not_catch_random_errors
+    assert_raise(RuntimeError) do
+      parse!([]) do |o|
+        o.after{raise RuntimeError}
+      end
+    end
+  end
+  
+  def test_should_output_help
+    begin
+      r = CoolOptions.parse!('details', %w(--help)) do |o|
+        o.on :a, '[no-]a', 'aa'
+      end
+    rescue SystemExit
+      rescued = true
+    end
+
+    assert rescued
+    assert_equal <<EOH, @out.string
+Usage: #{File.basename($0)} details
+    -a, --[no-]a                     aa
+    -h, --help                       This help info.
+EOH
+  end
+  
+  def test_should_require_options_with_no_default
+    assert_raise(SystemExit) do
+      CoolOptions.parse!([]) do |o|
+        o.on :a, 'a A', 'a'
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: cooloptions
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2006-12-07 00:00:00 -05:00
+summary: CoolOptions is a simple wrapper around optparse that provides less options and more convenience.
+require_paths: 
+- lib
+email: nathaniel@terralien.com
+homepage: https://rubyforge.org/projects/cooloptions/
+rubyforge_project: cooloptions
+description: CoolOptions is a simple wrapper around optparse that provides less options and more convenience.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- Nathaniel Talbott
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/cooloptions.rb
+- test/test_cooloptions.rb
+test_files: 
+- test/test_cooloptions.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+