choosy 0.2.5 → 0.3.0

data/spec/choosy/dsl/base_builder_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helpers'
+require 'choosy/dsl/base_builder'
+
+module Choosy::DSL
+  class FakeBuilder
+    include BaseBuilder
+
+    attr_reader :entity
+    def initialize(mock)
+      @entity = mock
+    end
+  end
+
+  describe BaseBuilder do
+    describe "external access calls" do
+      module ExternalCaller
+        attr_reader :called
+        def call!
+          @called = true
+        end
+        def called?
+          @called ||= false
+        end
+      end
+
+      include ExternalCaller
+
+      it "should allow for external calls" do
+        called?.should be(false)
+        
+        mock = mock()
+        mock.should_receive(:finalize!)
+        builder = FakeBuilder.new(mock)
+
+        builder.evaluate! do
+          call!
+        end
+
+        called?.should be(true)
+      end
+    end
+  end
+end

data/spec/choosy/dsl/base_command_builder_spec.rb

@@ -211,13 +211,13 @@ module Choosy::DSL
 
           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
+            @builder.entity.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)
+            @builder.entity.listing.should have(1).item
+            @builder.entity.listing[0].name.should eql(:o)
           end
         end
       end
@@ -359,13 +359,11 @@ module Choosy::DSL
         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)
+      it "should set the type of the version to boolean" do
+        v = @builder.version "1.0"
+        v.cast_to.should eql(:boolean)
       end
-    end#finalize!
+    end#version
   end
 end

data/spec/choosy/dsl/commmand_builder_spec.rb

@@ -63,7 +63,7 @@ module Choosy::DSL
     end#help
 
     describe :arguments do
-      it "should fail if there is no block given" do
+      it "should not fail if there is no block given" do
         attempting {
           @builder.arguments
         }.should_not raise_error
@@ -86,6 +86,14 @@ module Choosy::DSL
           @command.arguments.validation_step.call([2, 2, 3], nil)
         }.should raise_error(RuntimeError, "called")
       end
+
+      it "should finalize the arguments" do
+        @builder.arguments do
+          metaname 'args'
+        end
+
+        @builder.entity.arguments.cast_to.should eql(:string)
+      end
     end#arguments
   end
 end

data/spec/choosy/dsl/option_builder_spec.rb

@@ -5,7 +5,7 @@ module Choosy::DSL
   describe OptionBuilder do
     before :each do
       @builder = OptionBuilder.new(:stub)
-      @option = @builder.option
+      @option = @builder.entity
     end
     
     describe :name do
@@ -180,13 +180,6 @@ module Choosy::DSL
       end
     end#depends_on
 
-    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
-
     describe :negate do
       it "should set the default negation to 'no'" do
         @builder.negate
@@ -199,13 +192,6 @@ module Choosy::DSL
         @option.negated?.should be_true
         @option.negation.should eql('non')
       end
-
-      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#negate
 
     describe :from_hash do
@@ -242,55 +228,5 @@ 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

data/spec/choosy/dsl/super_command_builder_spec.rb

@@ -38,6 +38,17 @@ module Choosy::DSL
         @builder.command cmd
         @command.listing[0].should be(cmd)
       end
+
+      it "should set the parent command on new commands" do
+        cmd = @builder.command :foo
+        cmd.parent.should be(@command)
+      end
+
+      it "should set the parent command on existing commands" do
+        cmd = Choosy::Command.new :foo
+        @builder.command cmd
+        cmd.parent.should be(@command)
+      end
     end
     
     describe :parsimonious do
@@ -58,17 +69,17 @@ module Choosy::DSL
       end
     end
 
-    describe "standard options" do
-      it "should also be able to set flags" do
-        o = @builder.boolean :count, "The count"
-        @command.option_builders[:count].option.name.should eql(:count)
+    describe :default do
+      it "should set the default command" do
+        @builder.default :foo
+        @command.default_command.should eql(:foo)
       end
     end
 
-    describe :finalize! do
-      it "should set the metaname if not already set" do
-        @builder.finalize!
-        @command.metaname.should eql('COMMAND')
+    describe "standard options" do
+      it "should also be able to set flags" do
+        o = @builder.boolean :count, "The count"
+        @command.option_builders[:count].entity.name.should eql(:count)
       end
     end
 

data/spec/choosy/option_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helpers'
+require 'choosy/option'
+
+module Choosy
+  describe Option do
+    before :each do
+      @option = Option.new(:option)
+    end
+
+    describe :negated do
+      it "should format the long name correctly" do
+        @option.long_flag = "--long"
+        @option.negation = 'no'
+        @option.negated.should eql("--no-long")
+      end
+    end
+
+    describe :finalize! do
+      it "should set the arity if not already set" do
+        @option.short_flag = '-s'
+        @option.finalize!
+        @option.arity.should eql(0..0)
+      end
+
+      it "should set the cast to :string on regular arguments" do
+        @option.single!
+        @option.finalize!
+        @option.cast_to.should eql(:string)
+      end
+
+      it "should set the cast to :boolean on single flags" do
+        @option.finalize!
+        @option.cast_to.should eql(:boolean)
+      end
+
+      it "should fail when both boolean and restricted" do
+        @option.short_flag = '-s'
+        @option.allowable_values = [:a, :b]
+        attempting{
+          @option.finalize!
+        }.should raise_error(Choosy::ConfigurationError, /boolean and restricted/)
+      end
+
+      it "should fail when the argument is negated and not boolean" do
+        @option.long_flag = '--long'
+        @option.negation = 'un'
+        @option.single!
+        attempting {
+          @option.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
+        @option.short_flag = '-s'
+        @option.negation = 'un'
+        attempting {
+          @option.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
+        @option.short_flag = '-s'
+        @option.finalize!
+        @option.default_value.should be(false)
+      end
+    end#finalize!
+  end
+end

data/spec/choosy/printing/base_printer_spec.rb

@@ -0,0 +1,155 @@
+require 'spec_helpers'
+require 'choosy/printing/base_printer'
+require 'choosy/command'
+require 'choosy/super_command'
+
+module Choosy::Printing
+  describe BasePrinter do
+    before :each do
+      @s = Choosy::SuperCommand.new(:super)
+      @sb = @s.builder
+      @c = Choosy::Command.new(:cmd, @s)
+      @cb = @c.builder 
+      @p = BasePrinter.new({})
+    end
+
+    describe "for the usage line" do
+      it "should format a full boolean option" do
+        o = @cb.boolean :bold, "bold"
+        @p.usage_option(o).should eql("[-b|--bold]")
+      end
+
+      it "should format a partial boolean option" do
+        o = @cb.boolean_ :bold, "bold"
+        @p.usage_option(o).should eql('[--bold]')
+      end
+
+      it "should format a short boolean option" do
+        o = @cb.option :bold do
+          short '-b'
+        end
+        @p.usage_option(o).should eql('[-b]')
+      end
+
+      it "should format a negation of a boolean option" do
+        o = @cb.boolean :bold, "Bold!!" do
+          negate 'un'
+        end
+        @p.usage_option(o).should eql('[-b|--bold|--un-bold]')
+      end
+
+      it "should format a full single option" do
+        o = @cb.single :color, "color"
+        @p.usage_option(o).should eql('[-c|--color=COLOR]')
+      end
+
+      it "should format a parial boolean option" do
+        o = @cb.single_ :color, "color"
+        @p.usage_option(o).should eql('[--color=COLOR]')
+      end
+      
+      it "shoudl format a full multiple option" do 
+        o = @cb.multiple :colors, "c"
+        @p.usage_option(o).should eql('[-c|--colors COLORS+]')
+      end
+
+      it "should format a partial multiple option" do
+        o = @cb.multiple_ :colors, "c"
+        @p.usage_option(o).should eql('[--colors COLORS+]')
+      end
+    end
+
+    describe "for the option line" do
+      it "should format a full boolean option" do
+        o = @cb.boolean :bold, "b"
+        @p.regular_option(o).should eql('-b, --bold')
+      end
+
+      it "should format a partial boolean option" do
+        o = @cb.boolean_ :bold, "b"
+        @p.regular_option(o).should eql('    --bold')
+      end
+
+      it "should format a short boolean option" do
+        o = @cb.option :bold do |b|
+          b.short '-b'
+        end
+
+        @p.regular_option(o).should eql('-b')
+      end
+
+      it "should format a negation of an option" do
+        o = @cb.boolean :bold, "Bold" do
+          negate 'un'
+        end
+
+        @p.regular_option(o).should eql('-b, --[un-]bold')
+      end
+
+      it "should format a full single option" do
+        o = @cb.single :color, "color"
+        @p.regular_option(o).should eql('-c, --color COLOR')
+      end
+
+      it "should format a partial single option" do
+        o = @cb.single_ :color, "color"
+        @p.regular_option(o).should eql('    --color COLOR')
+      end
+
+      it "should format a full multiple option" do
+        o = @cb.multiple :colors, "colors"
+        @p.regular_option(o).should eql('-c, --colors COLORS+')
+      end
+
+      it "should format a partial multiple option" do
+        o = @cb.multiple_ :colors, "colors"
+        @p.regular_option(o).should eql('    --colors COLORS+')
+      end
+    end
+
+    describe "formatting the command name" do
+      it "should format the name with the supercommand" do
+        @p.command_name(@c).should eql('super cmd')
+      end
+
+      it "should format the command" do
+        @p.command_name(Choosy::Command.new(:name)).should eql('name')
+      end
+
+      it "should format the super command" do
+        @p.command_name(@s).should eql('super')
+      end
+    end
+
+    describe "formatting the full usage" do
+      describe "for commands" do
+        it "should add the default metaname" do
+          @p.usage_wrapped(@c).should eql(['super cmd'])
+        end
+
+        it "should add an option if given" do
+          @cb.boolean :bold, "Bold?"
+          @p.usage_wrapped(@c).should eql(['super cmd [-b|--bold]'])
+        end
+
+        it "should add several options and wrap each line" do
+          @cb.integer :bold, "bold"
+          @cb.integer :long_method, "long"
+          @cb.integer :here_it_goes, "here"
+          @p.usage_wrapped(@c, ' ', 40).should eql(
+['super cmd [-b|--bold=BOLD]',
+ '           [-l|--long-method=LONG_METHOD]',
+ '           [-h|--here-it-goes=HERE_IT_GOES]'])
+        end
+
+        it "should add the metaname" do
+          @cb.arguments do
+            metaname 'CMDS'
+          end
+          @p.usage_wrapped(@c).should eql(['super cmd CMDS'])
+        end
+      end
+    end
+  end
+end
+

data/spec/choosy/printing/color_spec.rb

@@ -84,5 +84,9 @@ module Choosy::Printing
     it "should be able to format multiple items" do
       @c.multiple("this", [:red, :blink]).should eql("\e[5m\e[31mthis\e[0m")
     end
+
+    it "should keep multiple colors without a reset if the string is nil" do
+      @c.multiple(nil, [:red, :blink]).should eql("\e[5m\e[31m")
+    end
   end
 end

data/spec/choosy/printing/help_printer_spec.rb

@@ -39,51 +39,51 @@ module Choosy::Printing
       @h = @s.printer
     end
 
-    describe :print_usage do
+    describe :format_prologue do
       it "should know how to format a regular command" do
         @h.color.disable!
         @h.columns = 60
-        @h.print_usage(@c)
+        @h.format_prologue(@c)
 
         @h.buffer.should eql("Usage: foo [-e|--evaluate] [-c|--count=COUNT] [--debug]
-           [--version] [-h|--help] FOOS\n")
+           [--version] [-h|--help] FOOS\n\n")
       end
 
       it "should know how to format a super command" do
         @h.color.disable!
         @h.columns = 60
-        @h.print_usage(@s)
+        @h.format_prologue(@s)
 
-        @h.buffer.should eql("Usage: super [-b|--bold] CMDS\n")
+        @h.buffer.should eql("Usage: super [-b|--bold] CMDS\n\n")
       end
     end
 
     it "should write a header, properly colored" do
-      @h.print_header("option")
+      @h.format_header("option")
       @h.buffer.should eql("\e[34m\e[1moption\e[0m")
     end
 
     it "should print out a formatted header" do
-      @h.print_element(@c.listing[0])
-      @h.buffer.should eql("\n\e[34m\e[1mDESCRIPTION\e[0m\n")
+      @h.format_element(@c.listing[0])
+      @h.buffer.should eql("\n\e[34m\e[1mDESCRIPTION\e[0m\n\n")
     end
 
     it "should print out a formatting element correctly" do
-      @h.print_element(@c.listing[1])
-      @h.buffer.should eql("\n  This is a description of this command that should span\n")
+      @h.format_element(@c.listing[1])
+      @h.buffer.should eql("  This is a description of this command that should span\n\n")
     end
 
     it "should wrap lines in a paragraph correctly" do
       @h.columns = 70
-      @h.print_element(@c.listing[2])
-      @h.buffer.should eql("\n  Multiple lines and carry itself beyond the average line length when
+      @h.format_element(@c.listing[2])
+      @h.buffer.should eql("  Multiple lines and carry itself beyond the average line length when
   actually called out from the unit tests itself so that we can
-  correctly guage the line wrapping.\n")
+  correctly guage the line wrapping.\n\n")
     end
 
     it "should print out an option on multiple lines" do
       @h.columns = 70
-      @h.print_option(@c.listing[4], '-e, --evaluate', ' ' * 20)
+      @h.format_option(@c.listing[4], '-e, --evaluate', ' ' * 20)
       @h.buffer.should eql('  -e, --evaluate    The evaluation of some boolean something or other
                     that really should span at least 3 lines of
                     continuous text for testing the output of the
@@ -93,104 +93,10 @@ module Choosy::Printing
 
     it "should print out any commands that are present" do
       @h.columns = 70
-      @h.print_command(@c, 'foo', '         ')
+      @h.format_command(@c, 'foo', '         ')
       @h.buffer.should eql("  foo    This is a fairly long summary that should wrap around the
          whole screen at least once, so that I can test whether it's
          properly formatted\n")
     end
-
-    describe "for the usage line" do
-      it "should format a full boolean option" do
-        o = @b.boolean :bold, "bold"
-        @h.usage_option(o).should eql("[-b|--bold]")
-      end
-
-      it "should format a partial boolean option" do
-        o = @b.boolean_ :bold, "bold"
-        @h.usage_option(o).should eql('[--bold]')
-      end
-
-      it "should format a short boolean option" do
-        o = @b.option :bold do
-          short '-b'
-        end
-        @h.usage_option(o).should eql('[-b]')
-      end
-
-      it "should format a negation of a boolean option" do
-        o = @b.boolean :bold, "Bold!!" do
-          negate 'un'
-        end
-        @h.usage_option(o).should eql('[-b|--bold|--un-bold]')
-      end
-
-      it "should format a full single option" do
-        o = @b.single :color, "color"
-        @h.usage_option(o).should eql('[-c|--color=COLOR]')
-      end
-
-      it "should format a parial boolean option" do
-        o = @b.single_ :color, "color"
-        @h.usage_option(o).should eql('[--color=COLOR]')
-      end
-      
-      it "shoudl format a full multiple option" do 
-        o = @b.multiple :colors, "c"
-        @h.usage_option(o).should eql('[-c|--colors COLORS+]')
-      end
-
-      it "should format a partial multiple option" do
-        o = @b.multiple_ :colors, "c"
-        @h.usage_option(o).should eql('[--colors COLORS+]')
-      end
-    end
-
-    describe "for the option line" do
-      it "should format a full boolean option" do
-        o = @b.boolean :bold, "b"
-        @h.regular_option(o).should eql('-b, --bold')
-      end
-
-      it "should format a partial boolean option" do
-        o = @b.boolean_ :bold, "b"
-        @h.regular_option(o).should eql('    --bold')
-      end
-
-      it "should format a short boolean option" do
-        o = @b.option :bold do |b|
-          b.short '-b'
-        end
-
-        @h.regular_option(o).should eql('-b')
-      end
-
-      it "should format a negation of an option" do
-        o = @b.boolean :bold, "Bold" do
-          negate 'un'
-        end
-
-        @h.regular_option(o).should eql('-b, --[un-]bold')
-      end
-
-      it "should format a full single option" do
-        o = @b.single :color, "color"
-        @h.regular_option(o).should eql('-c, --color COLOR')
-      end
-
-      it "should format a partial single option" do
-        o = @b.single_ :color, "color"
-        @h.regular_option(o).should eql('    --color COLOR')
-      end
-
-      it "should format a full multiple option" do
-        o = @b.multiple :colors, "colors"
-        @h.regular_option(o).should eql('-c, --colors COLORS+')
-      end
-
-      it "should format a partial multiple option" do
-        o = @b.multiple_ :colors, "colors"
-        @h.regular_option(o).should eql('    --colors COLORS+')
-      end
-    end
   end
 end