choosy 0.1.0

data/lib/choosy.rb

@@ -0,0 +1,16 @@
+# $:.unshift File.dirname(__FILE__)
+
+require 'choosy/command'
+require 'choosy/super_command'
+require 'choosy/converter'
+require 'choosy/errors'
+require 'choosy/option'
+require 'choosy/version'
+require 'choosy/parser'
+require 'choosy/verifier'
+require 'choosy/dsl/command_builder'
+require 'choosy/dsl/super_command_builder'
+require 'choosy/dsl/option_builder'
+require 'choosy/printing/color'
+require 'choosy/printing/erb_printer'
+require 'choosy/printing/help_printer'

data/spec/choosy/base_command_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helpers'
+require 'choosy/command'
+
+module Choosy
+  describe BaseCommand do
+    it "should finalize the builder" do
+      cmd = Command.new :cmd
+      cmd.printer.should be_a(Choosy::Printing::HelpPrinter)
+    end 
+  end
+end

data/spec/choosy/command_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helpers'
+require 'choosy/command'
+require 'choosy/printing/help_printer'
+
+module Choosy
+  describe Command do
+    before :each do
+      @c = Command.new :foo
+    end
+
+    describe :parse! do
+      it "should print out the version number" do
+        @c.alter do |c|
+          c.version "blah"
+        end
+
+        o = capture :stdout do
+          attempting {
+            @c.parse!(['--version'])
+          }.should raise_error(SystemExit)
+        end
+
+        o.should eql("blah\n")
+      end
+
+      it "should print out the help info" do
+        @c.alter do |c|
+          c.summary "Summary"
+          c.desc "this is a description"
+          c.help
+        end
+
+        o = capture :stdout do
+          attempting {
+            @c.parse!(['--help'])
+          }.should raise_error(SystemExit)
+        end
+
+        o.should match(/-h, --help/)
+      end
+    end
+
+    describe :execute! do
+      it "should fail when no executor is given" do
+        attempting {
+         @c.execute!(['a', 'b'])
+        }.should raise_error(Choosy::ConfigurationError, /No executor/)
+      end
+    end
+  end
+end

data/spec/choosy/converter_spec.rb

@@ -0,0 +1,145 @@
+require 'spec_helpers'
+require 'choosy/version'
+require 'choosy/converter'
+
+module Choosy
+  describe Converter do
+
+    describe :for do
+      describe "symbols" do
+        it "knows about strings" do
+          Converter.for(:string).should eql(:string)
+        end
+        
+        it "knows about files" do
+          Converter.for(:file).should eql(:file)
+        end
+
+        it "knows about ints" do
+          Converter.for(:int).should eql(:integer)
+        end
+
+        it "knows about integers" do
+          Converter.for(:integer).should eql(:integer)
+        end
+
+        it "knows about floats" do
+          Converter.for(:float).should eql(:float)
+        end
+
+        it "knows about Dates" do
+          Converter.for(:date).should eql(:date)
+        end
+
+        it "knows about Time" do
+          Converter.for(:time).should eql(:time)
+        end
+
+        it "knows about DateTime" do
+          Converter.for(:datetime).should eql(:datetime)
+        end
+      end
+
+      describe "unknown types" do
+        it "returns nil" do
+          Converter.for(Hash).should be(nil)
+        end
+      end
+
+      describe "unknown symbols" do
+        it "returns nil" do
+          Converter.for(:tada).should be(nil)
+        end
+      end
+
+      describe "booleans" do
+        it "returns :boolean on :boolean" do
+          Converter.for(:boolean).should eql(:boolean)
+        end
+
+        it "returns :boolean on :bool" do
+          Converter.for(:bool).should eql(:boolean)
+        end
+      end
+    end#for
+
+    describe "converting" do
+      describe :integer do
+        it "should return an integer value" do
+          Converter.convert(:integer, "42").should eql(42)
+        end
+      end
+
+      describe :float do
+        it "should return an float value" do
+          Converter.convert(:float, "3.2").should eql(3.2)
+        end
+      end
+
+      describe :symbol do
+        it "should return a symbol" do
+          Converter.convert(:symbol, "this").should eql(:this)
+        end
+      end
+
+      describe :file do
+        it "should return a file" do
+          Converter.convert(:file, __FILE__).path.should eql(__FILE__)
+        end
+
+        it "should succeed if the file is present" do
+          Converter.convert(:file, __FILE__).path.should eql(__FILE__)
+        end
+
+        it "should fail if the file is not present" do
+          attempting {
+            Converter.convert(:file, __FILE__ + "nothere")
+          }.should raise_error(Choosy::ValidationError, /Unable to locate file:/)
+        end
+      end
+
+      describe :yaml do
+        it "should raise an error if the file doesn't exist" do
+          attempting {
+            Converter.convert(:yaml, __FILE__ + "non")
+          }.should raise_error(Choosy::ValidationError, /Unable to locate/)
+        end
+
+        it "should be able to parse a good yaml file" do
+          y = Converter.convert(:yaml, File.join(File.dirname(__FILE__), '..', '..', 'lib', 'VERSION'))
+          y.should eql(Choosy::Version.to_s.chomp)
+        end
+      end
+
+      describe :date do
+        it "should return a Date" do
+          date = Converter.convert(:date, "July 17, 2010")
+          date.month.should eql(7)
+          date.day.should eql(17)
+          date.year.should eql(2010)
+        end
+      end
+
+      describe :time do
+        it "should return a Time" do
+          time = Converter.convert(:time, "12:30:15")
+          time.hour.should eql(12)
+          time.min.should eql(30)
+          time.sec.should eql(15)
+        end
+      end
+
+      describe :datetime do
+        it "should return a DateTime" do
+          datetime = Converter.convert(:datetime, "July 17, 2010 12:30:15")
+          datetime.month.should eql(7)
+          datetime.day.should eql(17)
+          datetime.year.should eql(2010)
+          datetime.hour.should eql(12)
+          datetime.min.should eql(30)
+          datetime.sec.should eql(15)
+        end
+      end
+    end#converting
+  end
+end

data/spec/choosy/dsl/base_command_builder_spec.rb

@@ -0,0 +1,328 @@
+require 'spec_helpers'
+require 'choosy/dsl/base_command_builder'
+require 'choosy/command'
+
+module Choosy::DSL
+  describe BaseCommandBuilder do
+    before :each do
+      @command = Choosy::Command.new(:cmd)
+      @builder = @command.builder
+    end
+
+    describe :printer do
+      it "should raise an error on a non-standard printer" do
+        attempting {
+          @builder.printer :non_standard
+        }.should raise_error(Choosy::ConfigurationError, /Unknown printing/)
+      end
+      
+      it "should know how to set the default printer" do
+        @builder.printer :standard
+        @command.printer.should be_a(Choosy::Printing::HelpPrinter)
+      end
+
+      it "should know how to turn off color" do
+        @builder.printer :standard, :color => false
+        @command.printer.color.disabled?.should be(true)
+      end
+      
+      class TestPrinter
+        def print!(cmd)
+        end
+      end 
+
+      it "should understand how to set custom printers" do
+        attempting {
+          @builder.printer TestPrinter.new
+        }.should_not raise_error
+      end
+
+      it "should fail when the printer doesn't implement 'print!'" do
+        attempting {
+          @builder.printer "this"
+        }.should raise_error(Choosy::ConfigurationError, /Unknown printing/)
+      end
+
+      describe "for :erb printing" do
+        it "should be able to handle a given template" do
+          @builder.printer :erb, :template => __FILE__
+          @command.printer.should be_a(Choosy::Printing::ERBPrinter)
+        end
+
+        it "should fail when the tempate file doesn't exist" do
+          attempting {
+            @builder.printer :erb, :template => "non"
+          }.should raise_error(Choosy::ConfigurationError, /template file doesn't exist/)
+        end
+
+        it "should fail when no template option is specified" do
+          attempting {
+            @builder.printer :erb
+          }.should raise_error(Choosy::ConfigurationError, /no template/)
+        end
+      end
+    end#printer
+
+    describe :summary do
+      it "should set the summary for this command" do
+        @builder.summary "This is a summary"
+        @command.summary.should eql("This is a summary")
+      end
+    end#summary
+
+    describe :desc do
+      it "should set the summary for this command" do
+        @builder.desc "This is a description"
+        @command.description.should match(/This is/)
+      end
+    end#desc
+
+    describe :separator do
+      it "should add a separator to the list of options for printing" do
+        @builder.separator 'Required arguments'
+        @command.listing[0].should eql('Required arguments')
+      end
+
+      it "should add an empty string to the listing when called with no arguments" do
+        @builder.separator
+        @command.listing[0].should eql('')
+      end
+    end#separator
+
+    describe :option do
+      describe "when using just a name" do
+        it "should set the name of the option" do
+          o = @builder.option :opto do |o|
+            o.short '-o'
+          end
+          o.name.should eql(:opto)
+        end
+
+        it "should handle a CommandBuilder block" do
+          @builder.option :opto do |o|
+            o.short '-s'
+            o.should be_a(OptionBuilder)
+          end
+        end
+
+        it "should fail when no block is given" do
+          attempting {
+            @builder.option "blah"
+          }.should raise_error(Choosy::ConfigurationError, /No configuration block/)
+        end
+
+        it "should fail when the symbol is nil" do
+          attempting {
+            @builder.option nil do |o|
+              o.short = '-o'
+            end
+          }.should raise_error(Choosy::ConfigurationError, /The option name was nil/)
+        end
+      end
+
+      describe "when using a hash" do
+        describe "for dependencies" do
+          it "should set the dependencies of that option" do
+            o = @builder.option :o => [:s] do |o|
+              o.short '-o'
+            end
+            o.dependent_options.should have(1).items
+            o.dependent_options[0].should eql(:s)
+          end
+        end
+        
+        describe "for options" do
+          it "should set the name of the option" do 
+            o = @builder.option :o => {:short => '-o'}
+            o.name.should eql(:o)
+          end
+
+          it "should set the properties via the hash" do
+            o = @builder.option :o => {:short => '-o'}
+            o.short_flag.should eql('-o')
+          end
+
+          it "should still accept the block" do
+            o = @builder.option :o => {:short => '-o'} do |s|
+              s.desc "short"
+            end
+            o.description.should eql('short')
+          end
+        end
+
+        describe "whose arguments are invalid" do
+          it "should fail when more than one key is present" do
+            attempting {
+              @builder.option({:o => nil, :p => nil})
+            }.should raise_error(Choosy::ConfigurationError, /Malformed option hash/)
+          end
+
+          it "should fail when more than the hash is empty" do
+            attempting {
+              @builder.option({})
+            }.should raise_error(Choosy::ConfigurationError, /Malformed option hash/)
+          end
+
+          it "should fail when the option value is not an Array or a Hash" do
+            attempting {
+              @builder.option({:o => :noop})
+            }.should raise_error(Choosy::ConfigurationError, "Unable to process option hash")
+          end
+        end
+
+        describe "after the option block has been processed" do
+          it "should call the 'finalize!' method on the builder" do
+            o = @builder.option :o do |o|
+              o.short '-o'
+            end
+            o.cast_to.should eql(:boolean)
+          end
+
+          it "should add the builder with the given name to the command option_builders hash" do
+            @builder.option :o => {:short => '-l'}
+            @builder.command.option_builders.should have(1).item
+          end
+
+          it "adds the option to the listing" do
+            @builder.option :o => {:short => '-l'}
+            @builder.command.listing.should have(1).item
+            @builder.command.listing[0].name.should eql(:o)
+          end
+        end
+      end
+    end#option
+
+    describe :boolean do
+      it "should be able to set short flag" do
+        o = @builder.boolean :Debug, "Show the debug output"
+        o.short_flag.should eql('-D')
+      end
+
+      it "should be able to set the long flag" do
+        o = @builder.boolean :Debug, "show debug"
+        o.long_flag.should eql('--debug')
+      end
+
+      it "should be able to fix the naming convention for long names" do
+        o = @builder.boolean :no_COLOR, "No color output"
+        o.long_flag.should eql('--no-color')
+      end
+
+      it "should set the description" do
+        o = @builder.boolean :no_color, "No color output"
+        o.description.should eql("No color output")
+      end
+
+      it "should handle optional configuration" do
+        o = @builder.boolean :debug, "Debug", {:short => '-D'}
+        o.short_flag.should eql('-D')
+      end
+
+      it "should be able to capture block level data" do
+        o = @builder.boolean :debug, "Show debug output" do |d|
+          d.short '-D'
+        end
+        o.short_flag.should eql("-D")
+      end
+
+      it "should suppress the short flag for boolean_" do
+        o = @builder.boolean_ :debug, "Show debug output"
+        o.short_flag.should be(nil)
+      end
+    end#boolean
+
+    describe :single do
+      it "should be able to set the short flag" do
+        o = @builder.single :count, "Show the count"
+        o.short_flag.should eql('-c')
+      end
+
+      it "should be able to set the parameter name" do
+        o = @builder.single :count, "Show the count"
+        o.flag_parameter.should eql('COUNT')
+      end
+    end#single
+
+    describe :multiple do
+      it "should be able to set the short flag" do
+        o = @builder.multiple :file_names, "The file names"
+        o.short_flag.should eql('-f')
+      end
+
+      it "should be able to set the parameter name" do
+        o = @builder.multiple :file_names, "The file names"
+        o.flag_parameter.should eql('FILE_NAMES+')
+      end
+
+      it "should be able to yield a block" do
+        o = @builder.multiple :file_names, "The file names" do |f|
+          f.long '--files'
+        end
+        o.long_flag.should eql('--files')
+      end
+    end#multiple
+
+    describe "dynamically generated method for" do
+      Choosy::Converter::CONVERSIONS.keys.each do |method|
+        it "#{method}" do
+          o = @builder.send(method, method, "Desc of #{method}")
+          o.cast_to.should eql(Choosy::Converter.for(method))
+          if o.cast_to == :boolean
+            o.flag_parameter.should be(nil)
+          else
+            o.flag_parameter.should eql(method.to_s.upcase)
+          end
+        end
+
+        it "#{method}_" do
+          underscore = "#{method}_".to_sym
+          o = @builder.send(underscore, method, "Desc of #{method}_")
+          o.short_flag.should be(nil)
+        end
+        
+        next if method == :boolean || method == :bool
+
+        it "#{method}s" do
+          plural = "#{method}s".to_sym
+          o = @builder.send(plural, plural, "Desc of #{plural}")
+          o.cast_to.should eql(Choosy::Converter.for(method))
+          o.flag_parameter.should eql("#{plural.to_s.upcase}+")
+        end
+
+        it "#{method}s_" do
+          underscore = "#{method}s_".to_sym
+          o = @builder.send(underscore, method, "Desc of #{method}s_")
+          o.short_flag.should be(nil)
+        end
+      end
+    end
+
+    describe :version do
+      it "should allow you to set the message" do
+        v = @builder.version 'blah'
+        attempting {
+          v.validation_step.call
+        }.should raise_error(Choosy::VersionCalled, 'blah')
+      end
+
+      it "should allow you to use a block to alter the help message" do
+        v = @builder.version 'blah' do |v|
+          v.desc "Version"
+        end
+        v.description.should eql("Version")
+      end
+
+      it "should set the message automatically" do
+        v = @builder.version "blah"
+        v.description.should eql("The version number")
+      end
+    end#version
+
+    describe :finalize! do
+      it "should set the printer if not already set" do
+        @builder.finalize!
+        @command.printer.should be_a(Choosy::Printing::HelpPrinter)
+      end
+    end#finalize!
+  end
+end

data/spec/choosy/dsl/commmand_builder_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helpers'
+require 'choosy/dsl/command_builder'
+require 'choosy/command'
+require 'choosy/converter'
+require 'choosy/errors'
+
+module Choosy::DSL
+  class FakeExecutor
+    attr_reader :options, :args
+    def execute!(options, args)
+      @options = options
+      @args = args
+    end
+  end
+
+  describe CommandBuilder do
+    before :each do
+      @command = Choosy::Command.new(:cmd)
+      @builder = @command.builder
+    end
+
+    describe :executor do
+      it "should set the executor in the command" do
+        @builder.executor FakeExecutor.new
+        @command.executor.should be_a(FakeExecutor)
+      end
+
+      it "should handle proc arguments" do
+        @builder.executor {|opts, args| puts "hi"}
+        @command.executor.should_not be(nil)
+      end
+
+      it "should raise an error if the executor is nil" do
+        attempting {
+          @builder.executor nil
+        }.should raise_error(Choosy::ConfigurationError, /executor was nil/)
+      end
+
+      it "should raise an error if the executor class doesn't have an 'execute!' method" do
+        attempting {
+          @builder.executor Array.new
+        }.should raise_error(Choosy::ConfigurationError, /'execute!'/)
+      end
+    end#executor
+
+    describe :help do
+      it "should allow for a no arg" do
+        h = @builder.help
+        h.description.should eql("Show this help message")
+      end
+
+      it "should allow you to set the message" do
+        h = @builder.help 'Help message'
+        h.description.should eql('Help message')
+      end
+
+      it "should throw a HelpCalled upon validation" do
+        h = @builder.help
+        attempting {
+          h.validation_step.call
+        }.should raise_error(Choosy::HelpCalled)
+      end
+    end#help
+
+    describe :arguments do
+      it "should fail if there is no block given" do
+        attempting {
+          @builder.arguments
+        }.should raise_error(Choosy::ConfigurationError, /arguments/)
+      end
+
+      it "should pass in the arguments to validate" do
+        @builder.arguments do |args|
+          args.should have(3).items
+        end
+        @command.argument_validation.call([1, 2, 3])
+      end
+    end#arguments
+  end
+end