choosy 0.4.0 → 0.4.1

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## 0.4.0 (March 28, 2011)
 
+Fixes:
+
+  - Minor cleanup of the formatting.
+
+## 0.4.0 (March 28, 2011)
+
 Features:
 
   - Added a 'section' operation to allow for subsection grouping in commands, for greater clarity.

data/lib/VERSION.yml

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

data/lib/choosy/printing/base_printer.rb

@@ -1,6 +1,12 @@
 require 'choosy/errors'
 require 'choosy/printing/terminal'
 
+class String
+  def unformatted
+    gsub(/\e\[\d+m/, '').gsub(/\\f[IPB]/, '')
+  end
+end
+
 module Choosy::Printing
   class BasePrinter
     include Terminal
@@ -98,9 +104,9 @@ module Choosy::Printing
 
     def regular_option(option, value="")
       if option.short_flag
-        value << option_begin
+        value << highlight_begin
         value << option.short_flag
-        value << option_end
+        value << highlight_end
         if option.long_flag
           value << ', '
         end
@@ -109,7 +115,7 @@ module Choosy::Printing
       end
 
       if option.long_flag
-        value << option_begin
+        value << highlight_begin
         if option.negated?
           value << '--['
           value << option.negation
@@ -118,7 +124,7 @@ module Choosy::Printing
         else
           value << option.long_flag
         end
-        value << option_end
+        value << highlight_end
       end
 
       if option.metaname
@@ -138,6 +144,7 @@ module Choosy::Printing
 
     # doesn't indent the first line
     def usage_wrapped(command, indent='', columns=80)
+      columns = (columns > 70) ? 70 : columns
       lines = []
       line = command_name(command)
       starting_width = width = line.length + indent.length
@@ -190,11 +197,11 @@ module Choosy::Printing
       end
     end
 
-    def option_begin
+    def highlight_begin
       ''
     end
 
-    def option_end
+    def highlight_end
       ''
     end
 
@@ -208,8 +215,9 @@ module Choosy::Printing
         case item
         when Choosy::Option
           opt = regular_option(item)
-          if opt.length > optionlen
-            optionlen = opt.length
+          len = opt.unformatted.length
+          if len > optionlen
+            optionlen = len
           end
           prefixes << opt
         when Choosy::Command
@@ -224,6 +232,7 @@ module Choosy::Printing
       end
 
       option_indent = ' ' * (optionlen + indent.length + offset.length)
+      puts optionlen
       cmd_indent = ' ' * (cmdlen + indent.length + offset.length)
       [cmd_indent, option_indent, prefixes]
     end

data/lib/choosy/printing/help_printer.rb

@@ -74,11 +74,11 @@ module Choosy::Printing
     end
 
     protected
-    def option_begin
-      @option_begin ||= color.multiple(nil, option_styles)
+    def highlight_begin
+      @highlight_begin ||= color.multiple(nil, option_styles)
     end
 
-    def option_end
+    def highlight_end
       color.reset
     end
 
@@ -88,10 +88,10 @@ module Choosy::Printing
     end
 
     def write_prefix(prefix, after_indent)
-      len = after_indent.length - prefix.length - indent.length
+      len = after_indent.length - prefix.unformatted.length - indent.length
       @buffer << indent
       @buffer << prefix
-      @buffer << ' ' * len
+      @buffer << " " * len
     end
 
     def write_lines(str, prefix, indent_first)

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,9 +56,8 @@ module Choosy::Printing
 
     def format_synopsis(command)
       @manpage.section_heading(@synopsis)
-      cols = (columns > 70) ? 70 : columns
       @manpage.nofill do |man|
-        usage_wrapped(command, '', cols).each do |line|
+        usage_wrapped(command, '', columns).each do |line|
           man.text line
         end
       end
@@ -69,7 +68,7 @@ module Choosy::Printing
     end
 
     def format_command(command, formatted_command, indent)
-      @manpage.term_paragraph(formatted_command, command.summary || "", indent.length)
+      @manpage.term_paragraph(@manpage.format.italics(formatted_command), command.summary || "", indent.length)
     end
 
     def format_element(item)
@@ -85,11 +84,11 @@ module Choosy::Printing
     end
 
     protected
-    def option_begin
+    def highlight_begin
       @manpage.format.italics
     end
 
-    def option_end
+    def highlight_end
       @manpage.format.reset
     end
   end

data/spec/choosy/printing/help_printer_spec.rb

@@ -15,7 +15,7 @@ module Choosy::Printing
 
         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."
+        integer_ :count, "The count of something that should also really span multiple lines, if possible."
         boolean_ :debug, "Debug output"
         version "1.2"
         help
@@ -45,8 +45,8 @@ module Choosy::Printing
         @h.columns = 60
         @h.format_prologue(@c)
 
-        @h.buffer.should eql("Usage: foo [-e|--evaluate] [-c|--count=COUNT] [--debug]
-           [--version] [-h|--help] FOOS\n\n")
+        @h.buffer.should eql("Usage: foo [-e|--evaluate] [--count=COUNT] [--debug] [--version]
+           [-h|--help] FOOS\n\n")
       end
 
       it "should know how to format a super command" do
@@ -91,6 +91,14 @@ module Choosy::Printing
 ')
     end
 
+    it "should print out an option correctly that only has a single line" do
+      @h.columns = 70
+      @h.format_option(@c.listing[5], "      \e[1m--count\e[0m COUNT", ' ' * 23)
+      @h.buffer.should eql("        \e[1m--count\e[0m COUNT  The count of something that should also really
+                       span multiple lines, if possible.
+")
+    end
+
     it "should print out any commands that are present" do
       @h.columns = 70
       @h.format_command(@c, 'foo', '         ')

data/spec/choosy/printing/manpage_printer_spec.rb

@@ -64,7 +64,7 @@ option line here.')
       end
       @man.format_command(@cmd, 'cmd', '    ')
       output.should eql('.TP 4
-cmd
+\fIcmd\fP
 this is a summary')
     end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Gabe McArthur