choosy 0.1.0

data/spec/choosy/verifier_spec.rb

@@ -0,0 +1,180 @@
+require 'spec_helpers'
+require 'choosy/verifier'
+require 'choosy/errors'
+require 'choosy/parser'
+require 'choosy/command'
+
+module Choosy
+
+  module VerifierHelper
+    def reset!
+      @c = Command.new(:verifier)
+    end
+
+    def v
+      @c.builder.finalize!
+      Verifier.new
+    end
+
+    def b
+      @c.builder
+    end
+  end
+
+  describe Verifier do
+    include VerifierHelper
+
+    before :each do
+      reset!
+      @res = ParseResult.new(@c)
+    end
+
+    describe :verify_options! do
+      it "should not try to validate arguments if not set" do
+        b.boolean :debug, "Debug"
+        @res.args << "a"
+        attempting {
+          v.verify_options!(@res)
+        }.should_not raise_error
+      end
+    end
+
+    describe :verify_arguments! do
+      it "should validate arguments if asked" do
+        b.arguments do |args|
+          raise RuntimeError.new('Called!')
+        end
+
+        attempting {
+          v.verify_arguments!(@res)
+        }.should raise_error(RuntimeError, 'Called!')
+      end
+    end
+
+    describe :populate! do
+      it "should fill in default boolean values to false if unset" do
+        o = b.boolean :debug, "Debug"
+        v.populate!(o, @res)
+        @res.options.should eql({:debug => false})
+      end
+
+      it "should fill in the default boolean to true if set to true" do
+        o = b.boolean :verbose, "Verbose", :default => true
+        v.populate!(o, @res)
+        @res.options.should eql({:verbose => true})
+      end
+
+      it "should set the default of multi-arg options to []" do
+        o = b.strings :words, "Words"
+        v.populate!(o, @res)
+        @res.options.should eql({:words => []})
+      end
+
+      it "should set the default value for other options to nil if empty" do
+        o = b.string :line, "Line"
+        v.populate!(o, @res)
+        @res.options.should eql({:line => nil})
+      end
+
+      it "should set the default value for other options if set" do
+        o = b.string :line, "Line", :default => "line!"
+        v.populate!(o, @res)
+        @res.options.should eql({:line => "line!"})
+      end
+
+      it "should not populate the default help option" do
+        o = b.help
+        v.populate!(o, @res)
+        @res.options.should be_empty
+      end
+
+      it "should not populate the default version option" do
+        o = b.version "blah"
+        v.populate!(o, @res)
+        @res.options.should be_empty
+      end
+    end#populate_defaults!
+
+    describe :validate! do
+      it "should call the validate proc associated with each option" do
+        o = b.string :line, "Line" do |l|
+          l.validate do |arg|
+            l.fail "Validated!"
+          end
+        end
+        @res[:line] = "line"
+
+        attempting {
+          v.validate!(o, @res)
+        }.should raise_error(Choosy::ValidationError, /Validated!/)
+      end
+
+      it "should not call the proc on empty arguments" do
+        o = b.strings :line, "Line" do |l|
+          l.validate do |arg|
+            l.fail "Validated!"
+          end
+        end
+        @res[:line] = []
+
+        v.validate!(o, @res)
+        @res[:line].should eql([])
+      end
+
+      it "should not call the proc when the arguments are null" do
+        o = b.string :line, "Line" do |l|
+          l.validate do |arg|
+            l.fail "Validated!"
+          end
+        end
+        @res[:line] = nil
+
+        v.validate!(o, @res)
+        @res[:line].should be(nil)
+      end
+    end#validate!
+
+    describe :required? do
+      it "should fail when an option is required but not provided" do
+        o = b.string :str, "String" do |s|
+          s.required
+        end
+        attempting {
+          v.required?(o, @res)
+        }.should raise_error(Choosy::ValidationError, /Required/)
+      end
+
+      it "should succeed when nothing is required" do
+        o = b.string :str, "String"
+        attempting {
+          v.required?(o, @res)
+        }.should_not raise_error
+      end
+    end
+
+    describe :convert! do
+      it "should convert files" do
+        o = b.file :afile, "A File"
+        @res[:afile] = __FILE__
+        v.convert!(o, @res)
+        @res[:afile].path.should eql(__FILE__)
+      end
+
+      class CustomConverter
+        def convert(value)
+          value.to_i
+        end
+      end
+
+      it "should convert a custom type" do
+        o = b.single :an_int, "An int" do |i|
+          i.cast CustomConverter.new
+        end
+        @res[:an_int] = "1"
+
+        v.convert!(o, @res)
+        @res[:an_int].should eql(1)
+      end
+    end#convert!
+  end
+end

data/spec/integration/command-A_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helpers'
+require 'choosy'
+
+describe "Command A" do
+  
+  before :each do
+    @cmd = Choosy::Command.new :A do |a|
+      a.integer :count, "The count"
+      a.boolean :bold, "Bold the output"
+      a.version "blah"
+      a.help
+    end
+  end
+
+  it "should print a help message" do
+    o = capture :stdout do
+      @cmd.parse! ['--help']
+    end
+
+    o.should match /USAGE:/
+  end
+
+  it "should handle multiple arguments" do
+    result = @cmd.parse! ['--bold', '-c', '5']
+    result.options.should eql({:bold => true, :count => 5})
+    result.args.should be_empty
+    result.unparsed.should be_empty
+  end
+  
+  it "should print out the version number" do
+    o = capture :stdout do
+      @cmd.parse! ['--count', '5', '--version']
+    end
+
+    o.should eql("blah\n")
+  end
+end

data/spec/integration/supercommand-A_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helpers'
+require 'choosy'
+
+describe "SuperCommand A" do
+  before :each do
+    @cmd = Choosy::SuperCommand.new :superfoo do |foo|
+      foo.desc "This is a supercommand of a definite size"
+      foo.separator 'Commands:'
+      
+      foo.command :bar do |bar|
+        bar.summary "This command is a bar"
+        bar.desc "This is a description of this subcommand"
+        bar.string :favorite_pet, "Your favorite pet."
+        bar.boolean :Fuzzy, "Is your pet fuzzy?"
+      end
+
+      foo.command :baz do |baz|
+        baz.summary "This is a baz command"
+        baz.desc "This is a description of baz"
+        baz.boolean :accountant, "Your accountant who helps you cheat on your taxes"
+        baz.integer :amount, "How much money do you save?"
+      end
+
+      foo.help
+
+      foo.separator 'Options:'
+      foo.version "1.ohyeah"
+    end
+  end
+=begin
+  it "should fail when a command is not set" do
+    o = capture :stderr do
+      @cmd.parse! ['blah']
+    end
+
+    o.should match(/^superfoo: 'blah' is not a standard command/)
+  end
+
+  it "should fail when parsing a non-existent option" do
+    o = capture :stderr do
+      @cmd.parse! ['--non-option']
+    end
+
+    o.should match(/^superfoo: '--non-option' is not a standard/)
+  end
+
+  it "should print the version with the given global flag" do
+    o = capture :stdout do
+      @cmd.parse! ['--version']
+    end
+
+    o.should eql("1.ohyeah\n")
+  end
+
+  it "should correctly parse the bar command" do
+    results = @cmd.parse! ['bar', '--favorite-pet', 'Blue']
+    results.should have(1).item
+    result[0].options.should eql({:favorite_pet => 'Blue', :Fuzzy => false})
+  end
+=end
+end

data/spec/spec_helpers.rb

@@ -0,0 +1,30 @@
+
+def attempting(&block)
+  lambda &block
+end
+
+def attempting_to(&block)
+  lambda &block
+end
+
+# Ammended from: https://github.com/cldwalker/hirb/blob/master/lib/hirb/util.rb
+def capture(kind=nil, &block)
+  original_stdout = $stdout
+  original_stderr = $stderr
+  $stdout = fake_out = StringIO.new
+  $stderr = fake_err = StringIO.new
+  begin
+    yield
+  rescue SystemExit => e
+    # Skip
+  ensure
+    $stdout = original_stdout
+    $stderr = original_stderr
+  end
+  res = {:stdout => fake_out.string, :stderr => fake_err.string}
+  if kind
+    res[kind]
+  else
+    res
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: choosy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Gabe McArthur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-03-01 00:00:00.000000000 -08:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &69898880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *69898880
+- !ruby/object:Gem::Dependency
+  name: autotest
+  requirement: &69898640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *69898640
+- !ruby/object:Gem::Dependency
+  name: autotest-notification
+  requirement: &69898400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *69898400
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &69936700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: *69936700
+description: This is a DSL for creating more complicated command line tools.
+email:
+- madeonamac@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.markdown
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.markdown
+- Rakefile
+- lib/VERSION
+- lib/choosy.rb
+- lib/choosy/base_command.rb
+- lib/choosy/command.rb
+- lib/choosy/converter.rb
+- lib/choosy/dsl/base_command_builder.rb
+- lib/choosy/dsl/command_builder.rb
+- lib/choosy/dsl/option_builder.rb
+- lib/choosy/dsl/super_command_builder.rb
+- lib/choosy/errors.rb
+- lib/choosy/option.rb
+- lib/choosy/parse_result.rb
+- lib/choosy/parser.rb
+- lib/choosy/printing/color.rb
+- lib/choosy/printing/erb_printer.rb
+- lib/choosy/printing/help_printer.rb
+- lib/choosy/super_command.rb
+- lib/choosy/super_parser.rb
+- lib/choosy/verifier.rb
+- lib/choosy/version.rb
+- spec/choosy/base_command_spec.rb
+- spec/choosy/command_spec.rb
+- spec/choosy/converter_spec.rb
+- spec/choosy/dsl/base_command_builder_spec.rb
+- spec/choosy/dsl/commmand_builder_spec.rb
+- spec/choosy/dsl/option_builder_spec.rb
+- spec/choosy/dsl/super_command_builder_spec.rb
+- spec/choosy/parser_spec.rb
+- spec/choosy/printing/color_spec.rb
+- spec/choosy/printing/help_printer_spec.rb
+- spec/choosy/super_command_spec.rb
+- spec/choosy/super_parser_spec.rb
+- spec/choosy/verifier_spec.rb
+- spec/integration/command-A_spec.rb
+- spec/integration/supercommand-A_spec.rb
+- spec/spec_helpers.rb
+has_rdoc: true
+homepage: http://github.com/gabemc/choosy
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Yet another option parsing library.
+test_files:
+- spec/choosy/base_command_spec.rb
+- spec/choosy/command_spec.rb
+- spec/choosy/converter_spec.rb
+- spec/choosy/dsl/base_command_builder_spec.rb
+- spec/choosy/dsl/commmand_builder_spec.rb
+- spec/choosy/dsl/option_builder_spec.rb
+- spec/choosy/dsl/super_command_builder_spec.rb
+- spec/choosy/parser_spec.rb
+- spec/choosy/printing/color_spec.rb
+- spec/choosy/printing/help_printer_spec.rb
+- spec/choosy/super_command_spec.rb
+- spec/choosy/super_parser_spec.rb
+- spec/choosy/verifier_spec.rb
+- spec/integration/command-A_spec.rb
+- spec/integration/supercommand-A_spec.rb
+- spec/spec_helpers.rb