choosy 0.2.5 → 0.3.0

data/spec/choosy/printing/manpage_printer_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helpers'
+require 'choosy/command'
+require 'choosy/printing/manpage_printer'
+
+module Choosy::Printing
+  describe ManpagePrinter do
+    before :each do
+      @man = ManpagePrinter.new
+      @cmd = Choosy::Command.new(:manpage)
+    end
+
+    def output
+      @man.manpage.buffer.join("\n")
+    end
+
+    describe "for the name segment" do
+      it "should not print anything if no summary is present" do
+        @man.format_name(@cmd)
+        output.should eql('')
+      end
+
+      it "should print out the summary" do
+        @cmd.alter do 
+          summary 'summary goes here'
+        end
+        @man.format_name(@cmd)
+        output.should eql('.SH "NAME"
+manpage \\- summary goes here')
+      end
+    end
+
+    describe "for the synopsis" do
+      it "should add the synopsis correctly" do
+        @cmd.alter do
+          boolean :bold, "bold"
+          integer :long_option_goes_here, "long"
+          integer :shorter_option, "short"
+          arguments do
+            metaname '[ARGS+++]'
+          end
+        end
+        @man.columns = 60
+        @man.format_synopsis(@cmd)
+        output.should eql('.SH "SYNOPSIS"
+.nf
+manpage [\\-b|\\-\\-bold]
+        [\\-l|\\-\\-long\\-option\\-goes\\-here=LONG_OPTION_GOES_HERE]
+        [\\-s|\\-\\-shorter\\-option=SHORTER_OPTION] [ARGS+++]
+.fi')
+      end
+    end
+
+    it "should format an option" do
+      o = @cmd.builder.integer :opt, 'option line here.'
+      @man.format_option(o, @man.regular_option(o), '        ')
+      output.should eql('.TP 8
+\\fI\\-o\\fP, \\fI\\-\\-opt\\fP OPT
+option line here&.')
+    end
+
+    it "should format a command" do
+      @cmd.alter do
+        summary 'this is a summary'
+      end
+      @man.format_command(@cmd, 'cmd', '    ')
+      output.should eql('.TP 4
+cmd
+this is a summary')
+    end
+
+    it "should format a heading correctly" do
+      @cmd.alter do
+        header 'here'
+      end
+      @man.format_element(@cmd.listing[0])
+      output.should eql('.SH "HERE"')
+    end
+
+    it "should format a regular paragraph" do
+      @cmd.alter do
+        para 'paragraph'
+      end
+      @man.format_element(@cmd.listing[0])
+      output.should eql(".P\nparagraph")
+    end
+
+    it "should format an empty paragraph" do
+      @cmd.alter do
+        para
+      end
+      @man.format_element(@cmd.listing[0])
+      output.should eql('.P')
+    end
+  end
+end

data/spec/choosy/printing/manpage_spec.rb

@@ -0,0 +1,206 @@
+require 'choosy/printing/manpage'
+require 'spec_helpers'
+
+module Choosy::Printing
+  describe ManpageFormatter do
+    before :each do 
+      @format = ManpageFormatter.new
+    end
+
+    it "should format bold" do
+      @format.bold("this").should eql('\\fBthis\\fP')
+    end
+
+    it "should format simple bold" do
+      @format.bold.should eql('\\fB')
+    end
+
+    it "should format italics" do
+      @format.italics('this').should eql('\\fIthis\\fP')
+    end
+
+    it "should format simple italics" do
+      @format.italics.should eql('\\fI')
+    end
+
+    it "should format roman" do
+      @format.roman('this').should eql('\\fRthis\\fP')
+    end
+
+    it "should format simple roman" do
+      @format.roman.should eql('\\fR')
+    end
+  end
+
+  describe Manpage do
+    before :each do
+      @man = Manpage.new
+    end
+
+    it "should format the frame outlines correctly" do
+      @man.name = 'named'
+      @man.date = 'today'
+      @man.version = 'version'
+      @man.manual = 'manual'
+
+      @man.frame_outline.should eql('.TH "named" "1" "today" "version" "manual"')
+    end
+
+    it "should format a section heading correctly" do
+      @man.section_heading("Header:").should eql(%Q{.SH "HEADER"})
+    end
+
+    it "should format a sub-section heading correctly" do
+      @man.subsection_heading('Sub-Section:').should eql(%Q{.SS "SUB\\-SECTION"})
+    end
+
+    it "should add a paragraph break" do
+      @man.paragraph.should eql(".P")
+    end
+    
+    it "should attach the line after the paragraph" do
+      @man.paragraph("some text").should eql(".P\nsome text")
+    end
+
+    it "should handle indented paragraphs" do
+      @man.indented_paragraph("this is a", "goes here").should eql(%Q{.IP "this is a"\ngoes here})
+    end
+
+    it "should handle hanging paragraphs" do
+      @man.hanging_paragraph("this is a paragraph").should eql(%Q{.HP\nthis is a paragraph})
+    end
+
+    it "should handle an indented region" do
+      @man.indented_region.should eql('.RE')
+    end
+
+    describe :bold do
+      it "should allow for bolded text" do
+        @man.bold("line").should eql('.B "line"')
+      end
+
+      it "should allow for bold alternating with italics" do
+        @man.bold("line", :italics).should eql('.BI "line"')
+      end
+
+      it "should allow for bold alternating with roman" do
+        @man.bold("line", :roman).should eql('.BR "line"')
+      end
+
+      it "should fail on unrecognized type" do
+        attempting {
+          @man.bold("line", :blah)
+        }.should raise_error(Choosy::ConfigurationError, /bold/)
+      end
+    end
+
+    describe :italics do
+      it "should allow for italicized text" do
+        @man.italics("line").should eql('.I "line"')
+      end
+
+      it "should allow for alternating bold" do
+        @man.italics("line", :bold).should eql('.IB "line"')
+      end
+
+      it "should allow for alternating roman" do
+        @man.italics("line", :roman).should eql('.IR "line"')
+      end
+
+      it "should fail on unrecognized type" do
+        attempting {
+          @man.italics("line", :blah)
+        }.should raise_error(Choosy::ConfigurationError, /italics/)
+      end
+    end
+
+    describe :roman do
+      it "should allow for alternating bold text" do
+        @man.roman("line", :bold).should eql('.RB "line"')
+      end
+
+      it 'should allow for alternating italics text' do
+        @man.roman("line", :italics).should eql('.RI "line"')
+      end
+
+      it "should fail when the type isn't given" do
+        attempting {
+          @man.roman("line", nil)
+        }.should raise_error(Choosy::ConfigurationError, /roman/)
+      end
+    end
+
+    describe :small do
+      it "should allow for small text" do
+        @man.small("this").should eql('.SM "this"')
+      end
+
+      it "should allow for small bold text" do
+        @man.small("this", :bold).should eql('.SB "this"')
+      end
+
+      it "should fail when not bold" do
+        attempting {
+          @man.small("this", :blah)
+        }.should raise_error(Choosy::ConfigurationError, /small/)
+      end
+    end
+
+    it "should allow for comments" do
+      @man.comment("here").should eql('./" here')
+    end
+
+    it "should allow for line breaks" do
+      @man.line_break.should eql('.br')
+    end
+
+    it "should allow for nofill" do
+      @man.nofill.should eql('.nf')
+    end
+
+    it "should allow for blocks of no-fill" do
+      @man.nofill do |man|
+        man.text 'here'
+      end
+      @man.buffer.join("\n").should eql(".nf\nhere\n.fi")
+    end
+
+    it "should allow for fill" do
+      @man.fill.should eql('.fi')
+    end
+
+    describe :term_paragraph do
+      it "should allow for a default width within the term" do
+        @man.term_paragraph("this", "that").should eql(%Q{.TP 5\nthis\nthat})
+      end
+
+      it "should allow you to set the first column width" do
+        @man.term_paragraph("this", "that", 10).should eql(%Q{.TP 10\nthis\nthat})
+      end
+    end
+
+    describe :to_s do
+      it "should write out everything to a string" do
+        @man.name = "blah"
+        @man.date = 'today'
+
+        @man.section_heading('description')
+        @man.paragraph('this is a line of text')
+
+        @man.to_s.should eql(<<EOF
+.TH "blah" "1" "today" " " " "
+.ie \\n(.g .ds Aq \\(aq
+.el       .ds Aq '
+.\\" disable hyphenation
+.nh
+.\\" disable justification (adjust text to left margin only)
+.ad l
+.SH "DESCRIPTION"
+.P
+this is a line of text
+EOF
+        )
+      end
+    end
+  end
+end

data/spec/choosy/super_command_spec.rb

@@ -76,5 +76,12 @@ module Choosy
         count.should eql(5)
       end
     end#execute!
+
+    describe :finalize! do
+      it "should set the metaname if not already set" do
+        @c.finalize!
+        @c.metaname.should eql('COMMAND')
+      end
+    end#finalize!
   end
 end

data/spec/choosy/super_parser_spec.rb

@@ -73,6 +73,15 @@ module Choosy
           @p.parse!()
         }.should raise_error(Choosy::HelpCalled, Choosy::DSL::SuperCommandBuilder::SUPER)
       end
+
+      it "should push the default command on the stack to parse" do
+        @p.command :bar
+        @p.super.alter do 
+          default :bar
+        end
+
+        @p.parse!().subresults.should have(1).item
+      end
     end
 
     describe "with subcommands" do

data/spec/choosy/verifier_spec.rb

@@ -12,7 +12,7 @@ module Choosy
     end
 
     def v
-      @c.builder.finalize!
+      @c.finalize!
       Verifier.new
     end
 
@@ -233,6 +233,16 @@ module Choosy
         }.should raise_error(RuntimeError, 'Called!')
       end
 
+      it "should convert the arguments to the requested type" do
+        b.arguments do
+          cast :integer
+        end
+        @res.args.push("1", "2", "3")
+
+        v.verify_arguments!(@res)
+        @res.args.should eql([1, 2, 3])
+      end
+
       it "should validate that the argument count isn't too few" do
         b.arguments do
           count 2
@@ -273,6 +283,26 @@ module Choosy
           v.verify_arguments!(@res)
         }.should raise_error(Choosy::ValidationError, /no arguments allowed/)
       end
+
+      it "should fail when the the arguments aren't in the list" do
+        b.arguments do
+          only :tomcat, :apache
+        end
+        @res.args << "this"
+        attempting {
+          v.verify_arguments!(@res)
+        }.should raise_error(Choosy::ValidationError, /unrecognized value/)
+      end
+
+      it "should allow multiple of the same command" do
+        b.arguments do
+          only :tomcat, :apache
+        end
+        @res.args.push(:apache, :tomcat, :apache)
+        attempting {
+          v.verify_arguments!(@res)
+        }.should_not raise_error
+      end
     end
   end
 end

data/spec/choosy/version.yml

@@ -0,0 +1,5 @@
+version:
+  major: 5
+  minor: 4
+  tiny: 3
+date: 'today'

data/spec/choosy/version_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helpers'
+require 'tempfile'
+require 'choosy/version'
+
+module Choosy
+  describe Version do
+    before :each do
+      version_file = File.join(File.dirname(__FILE__), 'version.yml')
+      @version = Version.new(version_file)
+    end
+
+    describe "should be able to read" do
+      it "the major version" do
+        @version.major.should eql(5)
+      end
+
+      it "the minor version" do
+        @version.minor.should eql(4)
+      end
+
+      it "the tiny verison" do
+        @version.tiny.should eql(3)
+      end
+      
+      it "the date" do
+        @version.date.should eql('today')
+      end
+    end
+
+    describe "while altering the config file" do
+      before :each do
+        @tmp = Tempfile.new('version.yml')
+        @version.version_file = @tmp.path
+      end
+
+      after :each do
+        @tmp.delete
+      end
+
+      it "should bump the major rev" do
+        @version.version!(:major)
+        @version.reload!
+        @version.major.should eql(6)
+      end
+
+      it "should bump the minor rev" do
+        @version.version!(:minor)
+        @version.reload!
+        @version.major.should eql(5)
+      end
+
+      it "should bump the tiny rev" do
+        @version.version!(:tiny)
+        @version.reload!
+        @version.tiny.should eql(4)
+      end
+
+      it "should reset the tiny version when minor is bumped" do
+        @version.version!(:minor)
+        @version.reload!
+        @version.tiny.should eql(0)
+      end
+
+      it "should reset the minor version when major is bumped" do
+        @version.version!(:major)
+        @version.reload!
+        @version.minor.should eql(0)
+      end
+
+      it "should reset the tiny version when major is bumped" do
+        @version.version!(:major)
+        @version.reload!
+        @version.tiny.should eql(0)
+      end
+
+      it "should reset the date" do
+        now = Time.now
+        @version.version!(:major)
+        @version.reload!
+        day, month, year = @version.date.split(/\//).map{|i|i.to_i}
+        now.day.should be(day)
+        now.month.should eql(month)
+        now.year.should eql(year)
+      end
+    end
+  end
+end

data/spec/integration/command-C_spec.rb

@@ -0,0 +1,23 @@
+require 'choosy'
+require 'spec_helpers'
+
+describe "Command C" do
+  before :each do
+    @cmd = Choosy::Command.new :foo do
+      arguments do
+        only :tomcat, :apache
+      end
+    end
+  end
+
+  it "should only allow for given arguments" do
+    attempting {
+      @cmd.parse!(['tomcat', 'no-arg'], true)
+    }.should raise_error(Choosy::ValidationError, /unrecognized value/)
+  end
+
+  it "should allow a number of arguments" do
+    result = @cmd.parse!(['tomcat', 'apache', 'tomcat'])
+    result.args.should eql([:tomcat, :apache, :tomcat])
+  end
+end

data/spec/integration/supercommand-C_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helpers'
+require 'choosy'
+
+describe "SuperCommand C" do
+  class SuperCommandC
+    def super_command
+      Choosy::SuperCommand.new :super do
+
+        command subA
+        command subB
+
+        boolean :option, "Option" do
+          desc option_name
+        end
+      end
+    end
+
+    def subA
+      Choosy::Command.new :subA do
+        string :sub_option, "Sub option" do
+          desc option_name
+        end
+      end
+    end
+
+    def subB
+      Choosy::Command.new :subB do
+      end
+    end
+
+    def option_name
+      "an option name"
+    end
+  end
+
+  it "should set the option name correctly" do
+    sup = SuperCommandC.new.super_command
+    sup.option_builders[:option].entity.description.should eql("an option name")
+  end
+
+  it "should set the sub-option name correctly" do
+    sup = SuperCommandC.new.super_command
+    sup.command_builders[:subA].entity.option_builders[:sub_option].entity.description.should eql("an option name")
+  end
+end