choosy 0.1.0 → 0.2.0

data/spec/choosy/dsl/base_command_builder_spec.rb

@@ -21,9 +21,31 @@ module Choosy::DSL
         @command.printer.should be_a(Choosy::Printing::HelpPrinter)
       end
 
+      it "should turn on color by default" do
+        @builder.printer :standard
+        @command.printer.color.should_not be_disabled
+      end
+
       it "should know how to turn off color" do
         @builder.printer :standard, :color => false
-        @command.printer.color.disabled?.should be(true)
+        @command.printer.color.should be_disabled
+      end
+
+      it "should know how to set the maximum width" do
+        @builder.printer :standard, :max_width => 70
+        @command.printer.columns.should eql(70)
+      end
+
+      it "should know how to set the header attributes" do
+        @builder.printer :standard, :header_styles => [:bold, :green]
+        @command.printer.header_styles.should eql([:bold, :green])
+      end
+
+      it "should be able to set multiple properties of the printer" do
+        @builder.printer :standard, :max_width => 25, :header_styles => [:bold, :red], :color => false
+        @command.printer.color.should be_disabled
+        @command.printer.header_styles.should eql([:bold, :red])
+        @command.printer.columns.should eql(25)
       end
       
       class TestPrinter
@@ -47,6 +69,7 @@ module Choosy::DSL
         it "should be able to handle a given template" do
           @builder.printer :erb, :template => __FILE__
           @command.printer.should be_a(Choosy::Printing::ERBPrinter)
+          @command.printer.template.should eql(__FILE__)
         end
 
         it "should fail when the tempate file doesn't exist" do
@@ -70,41 +93,49 @@ module Choosy::DSL
       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/)
+    describe :header do
+      it "should set a header for this command" do
+        @builder.header 'HEADER'
+        @command.listing[0].value.should eql('HEADER')
+      end
+
+      it "should set the attributes of the header effectively" do
+        @builder.header 'HEADER', :bold, :blue
+        @command.listing[0].styles.should eql([:bold, :blue])
       end
-    end#desc
+    end#header
 
-    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')
+    describe :para do
+      it "should add a paragraph to the list of options for printing" do
+        @builder.para 'Required arguments'
+        @command.listing[0].value.should eql('Required arguments')
+      end
+
+      it "should leave the paragraph without attributes" do
+        @builder.para 'No attributes'
+        @command.listing[0].styles.should eql([])
       end
 
       it "should add an empty string to the listing when called with no arguments" do
-        @builder.separator
-        @command.listing[0].should eql('')
+        @builder.para
+        @command.listing[0].value.should be(nil)
+      end
+
+      it "should add attributes to the paragraph" do
+        @builder.para 'Here', :bold, :red
+        @command.listing[0].styles.should eql([:bold, :red])
       end
-    end#separator
+    end#para
 
     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'
+          o = @builder.option :opto do
+            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"
@@ -113,8 +144,8 @@ module Choosy::DSL
 
         it "should fail when the symbol is nil" do
           attempting {
-            @builder.option nil do |o|
-              o.short = '-o'
+            @builder.option nil do
+              short = '-o'
             end
           }.should raise_error(Choosy::ConfigurationError, /The option name was nil/)
         end
@@ -123,10 +154,10 @@ module Choosy::DSL
       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'
+            o = @builder.option :o => [:s] do
+              short '-o'
             end
-            o.dependent_options.should have(1).items
+            o.dependent_options.should have(1).item
             o.dependent_options[0].should eql(:s)
           end
         end
@@ -143,8 +174,8 @@ module Choosy::DSL
           end
 
           it "should still accept the block" do
-            o = @builder.option :o => {:short => '-o'} do |s|
-              s.desc "short"
+            o = @builder.option :o => {:short => '-o'} do
+              desc "short"
             end
             o.description.should eql('short')
           end
@@ -172,8 +203,8 @@ module Choosy::DSL
 
         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'
+            o = @builder.option :o do
+              short '-o'
             end
             o.cast_to.should eql(:boolean)
           end
@@ -219,8 +250,8 @@ module Choosy::DSL
       end
 
       it "should be able to capture block level data" do
-        o = @builder.boolean :debug, "Show debug output" do |d|
-          d.short '-D'
+        o = @builder.boolean :debug, "Show debug output" do
+          short '-D'
         end
         o.short_flag.should eql("-D")
       end
@@ -229,17 +260,29 @@ module Choosy::DSL
         o = @builder.boolean_ :debug, "Show debug output"
         o.short_flag.should be(nil)
       end
+
+      it "should set the default value if not set" do
+        o = @builder.boolean :debug, "Show debug"
+        o.default_value.should be(false)
+      end
     end#boolean
 
+    describe :enum do
+      it "should set the allowable values" do
+        o = @builder.enum :this, [:a, :b, :c], "this"
+        o.allowable_values.should eql([:a, :b, :c])
+      end
+    end
+
     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
+      it "should be able to set the metaname name" do
         o = @builder.single :count, "Show the count"
-        o.flag_parameter.should eql('COUNT')
+        o.metaname.should eql('COUNT')
       end
     end#single
 
@@ -249,14 +292,14 @@ module Choosy::DSL
         o.short_flag.should eql('-f')
       end
 
-      it "should be able to set the parameter name" do
+      it "should be able to set the metaname name" do
         o = @builder.multiple :file_names, "The file names"
-        o.flag_parameter.should eql('FILE_NAMES+')
+        o.metaname.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'
+        o = @builder.multiple :file_names, "The file names" do
+          long '--files'
         end
         o.long_flag.should eql('--files')
       end
@@ -268,9 +311,9 @@ module Choosy::DSL
           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)
+            o.metaname.should be(nil)
           else
-            o.flag_parameter.should eql(method.to_s.upcase)
+            o.metaname.should eql(method.to_s.upcase)
           end
         end
 
@@ -286,7 +329,7 @@ module Choosy::DSL
           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}+")
+          o.metaname.should eql("#{plural.to_s.upcase}+")
         end
 
         it "#{method}s_" do
@@ -306,8 +349,8 @@ module Choosy::DSL
       end
 
       it "should allow you to use a block to alter the help message" do
-        v = @builder.version 'blah' do |v|
-          v.desc "Version"
+        v = @builder.version 'blah' do
+          desc "Version"
         end
         v.description.should eql("Version")
       end

data/spec/choosy/dsl/commmand_builder_spec.rb

@@ -66,14 +66,25 @@ module Choosy::DSL
       it "should fail if there is no block given" do
         attempting {
           @builder.arguments
-        }.should raise_error(Choosy::ConfigurationError, /arguments/)
+        }.should_not raise_error
+      end
+
+      it "should pass in the block correctly" do
+        @builder.arguments do
+          metaname 'ARGS'
+        end
+        @command.arguments.metaname.should eql('ARGS')
       end
 
       it "should pass in the arguments to validate" do
-        @builder.arguments do |args|
-          args.should have(3).items
+        @builder.arguments do
+          validate do |args, options|
+            raise RuntimeError, "called"
+          end
         end
-        @command.argument_validation.call([1, 2, 3])
+        attempting {
+          @command.arguments.validation_step.call([2, 2, 3], nil)
+        }.should raise_error(RuntimeError, "called")
       end
     end#arguments
   end

data/spec/choosy/dsl/option_builder_spec.rb

@@ -21,18 +21,18 @@ module Choosy::DSL
       end
 
       describe "and the arity" do
-        it "should not be set without a parameter" do
+        it "should not be set without a metaname" do
           @builder.short '-s'
           @option.short_flag.should eql('-s')
           @option.arity.should be(nil)
         end
 
-        it "should be set on STD+ parameter" do
+        it "should be set on STD+ metaname" do
           @builder.short '-s', 'STD+'
           @option.arity.should eql(1..1000)
         end
 
-        it "should set single arity on STD parameter" do
+        it "should set single arity on STD metaname" do
           @builder.short '-s', 'STD'
           @option.arity.should eql(1..1)
         end
@@ -44,15 +44,15 @@ module Choosy::DSL
         end
       end
 
-      describe "and the flag parameter" do
-        it "on STD parameters" do
+      describe "and the flag metaname" do
+        it "on STD metanames" do
           @builder.short '-s', 'STD'
-          @option.flag_parameter.should eql('STD')
+          @option.metaname.should eql('STD')
         end
 
-        it "on STD+ parameters" do
+        it "on STD+ metanames" do
           @builder.short '-s', 'STD+'
-          @option.flag_parameter.should eql('STD+')
+          @option.metaname.should eql('STD+')
         end
       end
     end#short
@@ -80,15 +80,15 @@ module Choosy::DSL
         end
       end#arity
 
-      describe "and the flag parameter" do
-        it "on STD parameters" do
+      describe "and the flag metaname" do
+        it "on STD metanames" do
           @builder.long '-s', 'STD'
-          @option.flag_parameter.should eql('STD')
+          @option.metaname.should eql('STD')
         end
 
-        it "on STD+ parameters" do
+        it "on STD+ metanames" do
           @builder.long '-s', 'STD+'
-          @option.flag_parameter.should eql('STD+')
+          @option.metaname.should eql('STD+')
         end
       end
     end#long
@@ -106,7 +106,7 @@ module Choosy::DSL
 
       it "should leave the param nil when just the short flag is given" do
         @builder.flags '-s'
-        @option.flag_parameter.should be(nil)
+        @option.metaname.should be(nil)
       end
 
       it "should be able to set the short when the long flag is given" do
@@ -119,14 +119,14 @@ module Choosy::DSL
         @option.long_flag.should eql('--short')
       end
 
-      it "should leave the parameter empty when not given" do
+      it "should leave the metaname empty when not given" do
         @builder.flags '-s', '--short'
-        @option.flag_parameter.should be(nil)
+        @option.metaname.should be(nil)
       end
 
-      it "should set the parameter if given" do
+      it "should set the metaname if given" do
         @builder.flags '-s', '--short', 'SHORT'
-        @option.flag_parameter.should eql('SHORT')
+        @option.metaname.should eql('SHORT')
       end
     end#flags
 
@@ -144,209 +144,69 @@ module Choosy::DSL
       end
     end#default
 
-    describe :required do
-      it "should set the option" do
-        @builder.required
-        @option.required?.should be(true)
-      end
-
-      it "should set the option on non-nil/non-true" do
-        @builder.required 1
-        @option.required?.should be(false)
-      end
-
-      it "should set the option on false" do
-        @builder.required false
-        @option.required?.should be(false)
-      end
-    end#required
-
-    describe :param do
-      it "should be able to set the name of the parameter" do
-        @builder.param 'PARAM'
-        @option.flag_parameter.should eql('PARAM')
-      end
-
-      it "should set the arity on STD+ to 1+" do
-        @builder.param 'STD+'
-        @option.arity.should eql(1..1000)
-      end
-
-      it "should set the arity on STD to 1" do
-        @builder.param 'STD'
-        @option.arity.should eql(1..1)
-      end
-    end#param
-
-    describe :count do
-      describe "when welformed" do
-        it "should set :at_least the right arity" do
-          @builder.count :at_least => 32
-          @option.arity.should eql(32..1000)
-        end
-
-        it "should set :at_most the right arity" do
-          @builder.count :at_most => 31
-          @option.arity.should eql(1..31)
-        end
-
-        it "should set :once to the right arity" do
-          @builder.count :once
-          @option.arity.should eql(1..1)
-        end
-
-        it "should set :zero to the right arity" do
-          @builder.count :zero
-          @option.arity.should eql(0..0)
-        end
-
-        it "should set :none to the right arity" do
-          @builder.count :none
-          @option.arity.should eql(0..0)
-        end
-
-        it "should set a number exactly" do
-          @builder.count 3
-          @option.arity.should eql(3..3)
-        end
-      end
-
-      describe "when malformed" do
-        it "should fail when the :exactly isn't a number" do
-          attempting {
-            @builder.count :exactly => 'p'
-          }.should raise_error(Choosy::ConfigurationError, /number/)
-        end
-
-        it "should fail when the :at_most isn't a number" do
-          attempting {
-            @builder.count :at_most => 'p'
-          }.should raise_error(Choosy::ConfigurationError, /number/)
-        end
-
-        it "should fail when the :at_least isn't a number" do
-          attempting {
-            @builder.count :at_least => 'p'
-          }.should raise_error(Choosy::ConfigurationError, /number/)
-        end
-
-        it "should fail when the :count isn't a number" do
-          attempting {
-            @builder.count 'p'
-          }.should raise_error(Choosy::ConfigurationError, /number/)
-        end
-
-        it "should fail when the :at_least is greater than :at_most" do
-          attempting {
-            @builder.count :at_least => 3, :at_most => 2
-          }.should raise_error(Choosy::ConfigurationError, /lower bound/)
-        end
-      end
-    end#count
-
-    describe :cast do
-      it "should allow symbol casts" do
-        @builder.cast :int
-        @option.cast_to.should eql(:integer)
-      end
-  
-      class CustomConverter
-        def convert(value)
-        end
-      end
-
-      it "should allow for custom conversions" do
-        conv = CustomConverter.new
-        @builder.cast conv
-        @option.cast_to.should be(conv)
-      end
-
-      it "should fail if it doesn't know about a Type" do
-        attempting {
-          @builder.cast Choosy::Error
-        }.should raise_error(Choosy::ConfigurationError, /Unknown conversion/)
-      end
-
-      it "should fail if it doesn't know about a symbol" do
-        attempting {
-          @builder.cast :unknown_type
-        }.should raise_error(Choosy::ConfigurationError, /Unknown conversion/)
-      end
-    end#cast
-
-    describe :fail do
+    describe :die do
       it "should format the error message with both flags" do
         @builder.short '-k'
         @builder.long '--keep', 'KEEP'
         attempting {
-          @builder.fail "Didn't keep anything"
+          @builder.die "Didn't keep anything"
         }.should raise_error(Choosy::ValidationError, /-k\/--keep KEEP: Didn't keep anything/)
       end
 
       it "should set the format of the error with the short flag" do
         @builder.short '-k'
         attempting {
-          @builder.fail "Didn't keep anything"
+          @builder.die "Didn't keep anything"
         }.should raise_error(Choosy::ValidationError, /-k: Didn't keep anything/)
       end
 
       it "should set the format of the long flag alone" do
         @builder.long '--keep'
         attempting {
-          @builder.fail "Didn't keep anything"
+          @builder.die "Didn't keep anything"
         }.should raise_error(Choosy::ValidationError, /--keep: Didn't keep anything/)
       end
-    end#fail
+    end#die
 
-    describe :validate do
-      it "should save the context of the validation in a Proc to call later" do
-        @builder.validate do
-          puts "Hi!"
-        end
-        @option.validation_step.should be_a(Proc)
-      end
-      
-      it "should have access to the larger context when called" do
-        value = nil
-        @builder.validate do
-          value = 'here'
-        end
-        @option.validation_step.call
-        value.should eql('here')
+    describe :depends_on do
+      it "should be able to process multiple arguments" do
+        @builder.depends_on :a, :b
+        @option.dependent_options.should eql([:a, :b])
       end
-    end#validate
 
-    describe :finalize! do
-      it "should set the arity if not already set" do
-        @builder.short '-s'
-        @builder.finalize!
-        @option.arity.should eql(0..0)
+      it "should be able to process Array arguments" do
+        @builder.depends_on [:a, :b]
+        @option.dependent_options.should eql([:a, :b])
       end
+    end#depends_on
 
-      it "should set the cast to :string on regular arguments" do
-        @builder.short '-s', 'SHORT'
-        @builder.finalize!
-        @option.cast_to.should eql(:string)
+    describe :only do
+      it "should set the allowable_values for an option" do
+        @builder.only :this, :that, :other
+        @option.allowable_values.should eql([:this, :that, :other])
       end
+    end#only
 
-      it "should set the cast to :boolean on single flags" do
-        @builder.short '-s'
-        @builder.finalize!
-        @option.cast_to.should eql(:boolean)
+    describe :negate do
+      it "should set the default negation to 'no'" do
+        @builder.negate
+        @option.negated?.should be_true
+        @option.negation.should eql('no')
       end
-    end#finalize!
 
-    describe :dependencies do
-      it "should be able to process multiple arguments" do
-        @builder.dependencies :a, :b
-        @option.dependent_options.should eql([:a, :b])
+      it "should set the the negation to a specific value" do
+        @builder.negate 'non'
+        @option.negated?.should be_true
+        @option.negation.should eql('non')
       end
 
-      it "should be able to process Array arguments" do
-        @builder.dependencies [:a, :b]
-        @option.dependent_options.should eql([:a, :b])
+      it "should set the flag string for the negated value" do
+        @builder.flags '-s', '--short'
+        @builder.negate
+        @builder.finalize!
+        @option.negated.should eql("--no-short")
       end
-    end#dependencies
+    end#negate
 
     describe :from_hash do
       it "should fail on unrecognized methods" do
@@ -382,5 +242,55 @@ module Choosy::DSL
         }.should raise_error(Choosy::ConfigurationError, /Only hash arguments allowed/)
       end
     end#from_hash
+
+    describe :finalize! do
+      it "should set the arity if not already set" do
+        @builder.short '-s'
+        @builder.finalize!
+        @option.arity.should eql(0..0)
+      end
+
+      it "should set the cast to :string on regular arguments" do
+        @builder.short '-s', 'SHORT'
+        @builder.finalize!
+        @option.cast_to.should eql(:string)
+      end
+
+      it "should set the cast to :boolean on single flags" do
+        @builder.short '-s'
+        @builder.finalize!
+        @option.cast_to.should eql(:boolean)
+      end
+
+      it "should fail when both boolean and restricted" do
+        @builder.short '-s'
+        @builder.only :a, :b
+        attempting{
+          @builder.finalize!
+        }.should raise_error(Choosy::ConfigurationError, /boolean and restricted/)
+      end
+
+      it "should fail when the argument is negated and not boolean" do
+        @builder.short '-s', 'SHORT'
+        @builder.negate
+        attempting {
+          @builder.finalize!
+        }.should raise_error(Choosy::ConfigurationError, /negate a non-boolean option/)
+      end
+
+      it "should fail when there is no long boolean option name to negate" do
+        @builder.short '-s'
+        @builder.negate
+        attempting {
+          @builder.finalize!
+        }.should raise_error(Choosy::ConfigurationError, /long flag is required for negation/)
+      end
+
+      it "should set the default value for booleans if not already set" do
+        @builder.short '-s'
+        @builder.finalize!
+        @option.default_value.should be(false)
+      end
+    end#finalize!
   end
 end