choosy 0.3.5 → 0.4.0

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 0.4.0 (March 28, 2011)
+
+Features:
+
+  - Added a 'section' operation to allow for subsection grouping in commands, for greater clarity.
+
+Fixes:
+
+  - 'parsimonious' operation failed to handle global options.
+  - Renamed 'header' to 'heading'.
+  - Fixed 'default' operation for SuperCommands.
+  - Made sure the usage width in manpages is reasonable.
+  - 'help' subcommand now exposed via the 'command' operation, so that the '--help' option can be attached to options.
+  - '&.' bug in the manpage output.
+  - Added a 'gem cleanup' to the rake integration.
+
 ## 0.3.5 (March 26, 2011)
 
 Features:

data/lib/VERSION.yml

@@ -1,6 +1,6 @@
 --- 
-date: 26/03/2011
+date: 28/03/2011
 version: 
-  tiny: 5
+  tiny: 0
   major: 0
-  minor: 3
+  minor: 4

data/lib/choosy/dsl/base_command_builder.rb

@@ -37,10 +37,13 @@ module Choosy::DSL
 
     # Formatting
 
-    def header(msg, *styles)
+    def heading(msg, *styles, &block)
       @entity.listing << Choosy::Printing::FormattingElement.new(:header, msg, styles)
+      evaluate!(&block) if block_given?
     end
 
+    alias :section :heading
+
     def para(msg=nil, *styles)
       @entity.listing << Choosy::Printing::FormattingElement.new(:para, msg, styles)
     end
@@ -120,7 +123,22 @@ module Choosy::DSL
     def enum_(sym, allowed, desc, config=nil, &block)
       simple_option(sym, desc, false, :one, :symbol, allowed, config, &block)
     end
+
     # Additional helpers
+    
+    def help(msg=nil, &block)
+      h = OptionBuilder.new(OptionBuilder::HELP)
+      h.short '-h'
+      h.long '--help'
+      msg ||= "Show this help message"
+      h.desc msg
+
+      h.validate do
+        raise Choosy::HelpCalled.new(@name)
+      end 
+
+      evaluate_option_builder!(h, &block)
+    end
 
     def version(msg, &block)
       v = OptionBuilder.new(OptionBuilder::VERSION)

data/lib/choosy/dsl/command_builder.rb

@@ -21,20 +21,6 @@ module Choosy::DSL
       end
     end
 
-    def help(msg=nil, &block)
-      h = OptionBuilder.new(OptionBuilder::HELP)
-      h.short '-h'
-      h.long '--help'
-      msg ||= "Show this help message"
-      h.desc msg
-
-      h.validate do
-        raise Choosy::HelpCalled.new(@name)
-      end 
-
-      evaluate_option_builder!(h, &block)
-    end
-
     def arguments(&block)
       builder = ArgumentBuilder.new
       # Set multiple by default

data/lib/choosy/dsl/super_command_builder.rb

@@ -8,7 +8,9 @@ module Choosy::DSL
     SUPER = :__SUPER_COMMAND__
 
     def command(cmd, &block)
-      subcommand = if cmd.is_a?(Choosy::Command)
+      subcommand = if cmd == :help
+                     help_command
+                   elsif cmd.is_a?(Choosy::Command)
                      cmd.parent = entity
                      cmd
                    else
@@ -30,10 +32,17 @@ module Choosy::DSL
       @entity.default_command = cmd
     end
 
-    def help(msg=nil, &block)
-      msg ||= "Show the info for a command, or this message"
-      help_command = Choosy::Command.new HELP do |help|
-        help.summary msg
+    protected
+    def evaluate_command_builder!(builder, &block)
+      builder.evaluate!(&block)
+      @entity.listing << builder.entity
+      @entity.command_builders[builder.entity.name] = builder
+      builder.entity
+    end
+
+    def help_command
+      Choosy::Command.new HELP, @entity do |help|
+        help.summary "Show the info for a command, or this message"
 
         help.arguments do
           count 0..1
@@ -52,15 +61,6 @@ module Choosy::DSL
           end
         end
       end
-      evaluate_command_builder!(help_command.builder, &block)
-    end
-
-    protected
-    def evaluate_command_builder!(builder, &block)
-      builder.evaluate!(&block)
-      @entity.listing << builder.entity
-      @entity.command_builders[builder.entity.name] = builder
-      builder.entity
     end
   end
 end

data/lib/choosy/printing/base_printer.rb

@@ -5,12 +5,12 @@ module Choosy::Printing
   class BasePrinter
     include Terminal
 
-    attr_accessor :indent, :offset, :formatting_options, :header_styles, :option_styles
+    attr_accessor :indent, :offset, :formatting_options, :heading_styles, :option_styles
 
     def initialize(options)
       @formatting_options = options
 
-      @header_styles = options[:header_styles] || [:bold, :blue]
+      @heading_styles = options[:heading_styles] || [:bold, :blue]
       @option_styles = options[:option_styles] || [:bold]
       @indent = options[:indent] || '  '
       @offset = options[:offset] || '    '
@@ -177,7 +177,7 @@ module Choosy::Printing
     protected
     def fix_termcap
       if pager.include?('less')
-        headers = color.multiple(nil, @header_styles)
+        headers = color.multiple(nil, @heading_styles)
         options = color.multiple(nil, @option_styles)
 
         ENV['LESS_TERMCAP_mb'] ||= "\e[31m"       # Begin blinking

data/lib/choosy/printing/help_printer.rb

@@ -69,7 +69,7 @@ module Choosy::Printing
       if styles && !styles.empty?
         @buffer << color.multiple(str, styles)
       else
-        @buffer << color.multiple(str, header_styles)
+        @buffer << color.multiple(str, heading_styles)
       end
     end
 

data/lib/choosy/printing/manpage.rb

@@ -222,7 +222,7 @@ EOF
 
     def escape(line)
       nline = line.gsub(/-/, "\\-")
-      nline.gsub!(/(\.+)/, '&\1')
+      #nline.gsub!(/(\.+)/, '&\1')
       nline
     end
 

data/lib/choosy/printing/manpage_printer.rb

@@ -24,7 +24,7 @@ module Choosy::Printing
     def print!(command)
       if command_exists?('groff') && pager?
         fix_termcap
-        page format!(command), 'groff -t -e -W all -Tutf8 -mandoc'
+        page format!(command)#, 'groff -t -e -W all -Tutf8 -mandoc'
       else
         # Fall back to a help printer if there is no pager
         help = HelpPrinter.new(formatting_options)
@@ -56,8 +56,9 @@ module Choosy::Printing
 
     def format_synopsis(command)
       @manpage.section_heading(@synopsis)
+      cols = (columns > 70) ? 70 : columns
       @manpage.nofill do |man|
-        usage_wrapped(command, '', columns).each do |line|
+        usage_wrapped(command, '', cols).each do |line|
           man.text line
         end
       end

data/lib/choosy/rake.rb

@@ -82,8 +82,9 @@ namespace :git do
   end
 
   task :tag => [:diff, 'version:load'] do
-    sh "Tagging version #{$version}"
-    SH.attempt "git tag -a -m 'Tagging release #{$version}' v#{$version}" do |code, contents|
+    puts "Tagging version #{$version}"
+    SH.attempt "git tag -a -m \"Tagging release #{$version}\" v#{$version}" do |code, contents|
+      puts contents
       SH.attempt "git tag -d v#{$version}", :error => "git tag: unable to delete tag"
       raise "Unable to commit tag."
     end
@@ -122,6 +123,16 @@ namespace :gem do
     SH.files("#{$version}.gem") do |gem|
       puts "  Installing gem: #{gem}"
       SH.attempt "gem install --no-ri --no-rdoc #{gem}"
+      SH.attempt "gem cleanup #{gem}"
+    end
+  end
+
+  desc "Installs the current gem using sudo."
+  task :sudo => :build do
+    SH.files("#{$version}.gem") do |gem|
+      puts "  Installing gem: #{gem}"
+      SH.attempt "sudo gem install --no-ri --no-rdoc #{gem}"
+      SH.attempt "sudo gem cleanup #{gem}"
     end
   end
 

data/lib/choosy/super_parser.rb

@@ -55,16 +55,16 @@ module Choosy
       count = args.count
 
       result = SuperParseResult.new(@super_command)
-      parser = Parser.new(@super_command, true, @terminals)
+      parser = Parser.new(@super_command, true, [])
       parser.parse!(args, result)
       verifier.verify_special!(result)
 
       # if we found a global action, we should have hit it by now...
       if result.unparsed.length == 0
-        if @super_command.command_builders[Choosy::DSL::SuperCommandBuilder::HELP]
-          raise Choosy::HelpCalled.new(Choosy::DSL::SuperCommandBuilder::SUPER)
-        elsif count == 0 && @super_command.has_default?
+        if count == 0 && @super_command.has_default?
           result.unparsed << @super_command.default_command.to_s
+        elsif @super_command.command_builders[Choosy::DSL::SuperCommandBuilder::HELP]
+          raise Choosy::HelpCalled.new(Choosy::DSL::SuperCommandBuilder::SUPER)
         else
           raise Choosy::SuperParseError.new("requires a command")
         end

data/spec/choosy/dsl/base_command_builder_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helpers'
 require 'choosy/dsl/base_command_builder'
 require 'choosy/command'
+require 'choosy/super_command'
 
 module Choosy::DSL
   describe BaseCommandBuilder do
@@ -37,14 +38,14 @@ module Choosy::DSL
       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])
+        @builder.printer :standard, :heading_styles => [:bold, :green]
+        @command.printer.heading_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
+        @builder.printer :standard, :max_width => 25, :heading_styles => [:bold, :red], :color => false
         @command.printer.color.should be_disabled
-        @command.printer.header_styles.should eql([:bold, :red])
+        @command.printer.heading_styles.should eql([:bold, :red])
         @command.printer.columns.should eql(25)
       end
       
@@ -93,17 +94,29 @@ module Choosy::DSL
       end
     end#summary
 
-    describe :header do
+    describe :heading do
       it "should set a header for this command" do
-        @builder.header 'HEADER'
+        @builder.heading 'HEADER'
         @command.listing[0].value.should eql('HEADER')
       end
 
       it "should set the attributes of the header effectively" do
-        @builder.header 'HEADER', :bold, :blue
+        @builder.heading 'HEADER', :bold, :blue
         @command.listing[0].styles.should eql([:bold, :blue])
       end
-    end#header
+
+      it "should accept an inner block" do
+        @builder.heading 'Header' do
+          para 'this'
+        end
+        @command.listing[1].value.should eql('this')
+      end
+
+      it "should allow for the 'section' alias" do
+        @builder.section 'here'
+        @command.listing[0].value.should eql('here')
+      end 
+    end#heading
 
     describe :para do
       it "should add a paragraph to the list of options for printing" do
@@ -127,6 +140,33 @@ module Choosy::DSL
       end
     end#para
 
+    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
+
+      it "should allow for help on super commands" do
+        s = Choosy::SuperCommand.new :super
+        h = s.builder.help
+        attempting {
+          h.validation_step.call
+        }.should raise_error(Choosy::HelpCalled)
+      end
+    end#help
+
     describe :option do
       describe "when using just a name" do
         it "should set the name of the option" do

data/spec/choosy/dsl/commmand_builder_spec.rb

@@ -43,25 +43,6 @@ module Choosy::DSL
       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 not fail if there is no block given" do
         attempting {

data/spec/choosy/dsl/super_command_builder_spec.rb

@@ -85,30 +85,32 @@ module Choosy::DSL
 
     describe :help do
       it "should create a help command when asked" do
-        h = @builder.help
+        h = @builder.command :help
         @command.listing[0].should be(h)
       end
 
       it "should set the default summary of the help command" do
-        h = @builder.help
+        h = @builder.command :help
         h.summary.should match(/Show the info/)
       end
 
       it "should st the summary of the command when given" do
-        h = @builder.help "Show this help message"
+        h = @builder.command :help do
+          summary "Show this help message"
+        end
         h.summary.should match(/Show this/)
       end
 
       describe "when validated" do
         it "should return the super command name when called without arguments" do
-          h = @builder.help
+          h = @builder.command :help
           attempting {
             h.arguments.validation_step.call([])
           }.should raise_error(Choosy::HelpCalled, nil)
         end
 
         it "should return the name of the first argument when called, as a symbol" do
-          h = @builder.help
+          h = @builder.command :help
           attempting {
             h.arguments.validation_step.call(['foo'])
           }.should raise_error(Choosy::HelpCalled, :foo)

data/spec/choosy/printing/help_printer_spec.rb

@@ -9,11 +9,11 @@ module Choosy::Printing
       @c = Choosy::Command.new :foo do
         summary "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"
 
-        header 'DESCRIPTION'
+        heading 'DESCRIPTION'
         para 'This is a description of this command that should span'
         para '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.'
 
-        header 'OPTIONS'
+        heading 'OPTIONS'
         boolean :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 option command."
         integer :count, "The count of something that should also really span multiple lines, if possible."
         boolean_ :debug, "Debug output"
@@ -29,7 +29,7 @@ module Choosy::Printing
       @b = @c.builder
 
       @s = Choosy::SuperCommand.new :super do
-        printer :standard, :color => true, :header_styles => [:bold, :blue]
+        printer :standard, :color => true, :heading_styles => [:bold, :blue]
         command @c
         metaname 'CMDS'
 

data/spec/choosy/printing/manpage_printer_spec.rb

@@ -55,7 +55,7 @@ manpage [\\-b|\\-\\-bold]
       @man.format_option(o, @man.regular_option(o), '        ')
       output.should eql('.TP 8
 \\fI\\-o\\fP, \\fI\\-\\-opt\\fP OPT
-option line here&.')
+option line here.')
     end
 
     it "should format a command" do
@@ -70,7 +70,7 @@ this is a summary')
 
     it "should format a heading correctly" do
       @cmd.alter do
-        header 'here'
+        heading 'here'
       end
       @man.format_element(@cmd.listing[0])
       output.should eql('.SH "HERE"')

data/spec/choosy/super_command_spec.rb

@@ -22,7 +22,7 @@ module Choosy
 
       it "should print out the supercommand help message" do
         @c.alter do
-          help
+          command :help
         end
 
         o = capture :stdout do
@@ -34,7 +34,7 @@ module Choosy
 
       it "should print out a subcommand help message" do
         @c.alter do
-          help
+          command :help
           command :bar do
             boolean :count, "The count"
           end

data/spec/choosy/super_parser_spec.rb

@@ -68,7 +68,7 @@ module Choosy
       end
 
       it "should raise a HelpCalled error when a help command is defined" do
-        @p.super.builder.help
+        @p.super.builder.command :help
         attempting {
           @p.parse!()
         }.should raise_error(Choosy::HelpCalled, Choosy::DSL::SuperCommandBuilder::SUPER)
@@ -119,6 +119,15 @@ module Choosy
         it "should parse separate commands" do
           @p.command(:bar).command(:baz).parse!('bar', 'baz').subresults.should have(2).items
         end
+
+        it "should be able to read global options" do
+          @p.super.alter do
+            version 'this'
+          end
+          attempting {
+            @p.command(:bar).parse!('bar', '--version')
+          }.should raise_error(Choosy::VersionCalled)
+        end
       end
     end
   end

data/spec/integration/supercommand-A_spec.rb

@@ -7,7 +7,7 @@ describe "SuperCommand A" do
   before :each do
     @cmd = Choosy::SuperCommand.new :superfoo do
       para "This is a supercommand of a definite size"
-      header 'Commands:'
+      heading 'Commands:'
       
       command :bar do
         summary notes[:this]
@@ -23,9 +23,9 @@ describe "SuperCommand A" do
         integer :amount, "How much money do you save?"
       end
 
-      help
+      command :help
 
-      header 'Options:'
+      heading 'Options:'
       integer :count, "The Count" do
         #required
       end

data/spec/integration/supercommand-B_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helpers'
 describe "SuperCommand B" do
   before :each do
     @s = Choosy::SuperCommand.new :super do
-      header 'Commands:'
+      heading 'Commands:'
       command :bar do
         arguments do
           count 0..1

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: choosy
 version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: 
+  prerelease: false
   segments: 
   - 0
-  - 3
-  - 5
-  version: 0.3.5
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Gabe McArthur
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-26 00:00:00 -07:00
+date: 2011-03-28 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 9
         segments: 
         - 2
         - 5
@@ -41,7 +39,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -55,7 +52,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -69,7 +65,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 43
         segments: 
         - 4
         - 5
@@ -88,71 +83,71 @@ extra_rdoc_files: []
 
 files: 
 - TODO.md
-- LICENSE
-- Rakefile
 - Gemfile
 - README.markdown
-- CHANGELOG.md
 - Gemfile.lock
-- lib/choosy/super_parser.rb
-- lib/choosy/option.rb
-- lib/choosy/version.rb
+- CHANGELOG.md
+- LICENSE
+- Rakefile
+- lib/choosy.rb
+- lib/VERSION.yml
+- lib/choosy/errors.rb
 - lib/choosy/printing.rb
-- lib/choosy/command.rb
+- lib/choosy/rake.rb
 - lib/choosy/converter.rb
 - lib/choosy/parse_result.rb
-- lib/choosy/parser.rb
+- lib/choosy/verifier.rb
 - lib/choosy/argument.rb
+- lib/choosy/version.rb
+- lib/choosy/option.rb
+- lib/choosy/command.rb
 - lib/choosy/super_command.rb
-- lib/choosy/dsl/base_command_builder.rb
+- lib/choosy/dsl/argument_builder.rb
 - lib/choosy/dsl/super_command_builder.rb
-- lib/choosy/dsl/command_builder.rb
 - lib/choosy/dsl/base_builder.rb
+- lib/choosy/dsl/command_builder.rb
 - lib/choosy/dsl/option_builder.rb
-- lib/choosy/dsl/argument_builder.rb
+- lib/choosy/dsl/base_command_builder.rb
+- lib/choosy/parser.rb
 - lib/choosy/base_command.rb
-- lib/choosy/errors.rb
-- lib/choosy/printing/terminal.rb
-- lib/choosy/printing/manpage.rb
 - lib/choosy/printing/manpage_printer.rb
-- lib/choosy/printing/help_printer.rb
+- lib/choosy/printing/base_printer.rb
 - lib/choosy/printing/formatting_element.rb
-- lib/choosy/printing/erb_printer.rb
+- lib/choosy/printing/manpage.rb
+- lib/choosy/printing/terminal.rb
 - lib/choosy/printing/color.rb
-- lib/choosy/printing/base_printer.rb
-- lib/choosy/rake.rb
-- lib/choosy/verifier.rb
-- lib/choosy.rb
-- lib/VERSION.yml
+- lib/choosy/printing/erb_printer.rb
+- lib/choosy/printing/help_printer.rb
+- lib/choosy/super_parser.rb
+- spec/integration/command-A_spec.rb
+- spec/integration/supercommand-C_spec.rb
+- spec/integration/command-B_spec.rb
+- spec/integration/supercommand-B_spec.rb
+- spec/integration/supercommand-A_spec.rb
+- spec/integration/command-C_spec.rb
+- spec/choosy/converter_spec.rb
+- spec/choosy/option_spec.rb
 - spec/choosy/version_spec.rb
-- spec/choosy/super_parser_spec.rb
-- spec/choosy/super_command_spec.rb
+- spec/choosy/argument_spec.rb
+- spec/choosy/base_command_spec.rb
 - spec/choosy/version.yml
 - spec/choosy/command_spec.rb
-- spec/choosy/converter_spec.rb
-- spec/choosy/dsl/argument_builder_spec.rb
-- spec/choosy/dsl/commmand_builder_spec.rb
 - spec/choosy/dsl/super_command_builder_spec.rb
 - spec/choosy/dsl/option_builder_spec.rb
 - spec/choosy/dsl/base_builder_spec.rb
+- spec/choosy/dsl/argument_builder_spec.rb
+- spec/choosy/dsl/commmand_builder_spec.rb
 - spec/choosy/dsl/base_command_builder_spec.rb
-- spec/choosy/option_spec.rb
+- spec/choosy/super_command_spec.rb
+- spec/choosy/super_parser_spec.rb
 - spec/choosy/verifier_spec.rb
-- spec/choosy/printing/manpage_spec.rb
-- spec/choosy/printing/base_printer_spec.rb
+- spec/choosy/printing/help_printer_spec.rb
 - spec/choosy/printing/terminal_spec.rb
+- spec/choosy/printing/base_printer_spec.rb
 - spec/choosy/printing/manpage_printer_spec.rb
-- spec/choosy/printing/help_printer_spec.rb
 - spec/choosy/printing/color_spec.rb
-- spec/choosy/argument_spec.rb
-- spec/choosy/base_command_spec.rb
+- spec/choosy/printing/manpage_spec.rb
 - spec/choosy/parser_spec.rb
-- spec/integration/supercommand-A_spec.rb
-- spec/integration/command-A_spec.rb
-- spec/integration/supercommand-C_spec.rb
-- spec/integration/command-B_spec.rb
-- spec/integration/command-C_spec.rb
-- spec/integration/supercommand-B_spec.rb
 - spec/spec_helpers.rb
 has_rdoc: true
 homepage: http://github.com/gabemc/choosy
@@ -168,7 +163,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -177,7 +171,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 23
       segments: 
       - 1
       - 3
@@ -186,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Yet another option parsing library.