choosy 0.2.5 → 0.3.0

data/lib/choosy/printing/base_printer.rb

@@ -0,0 +1,231 @@
+require 'choosy/errors'
+require 'choosy/printing/terminal'
+
+module Choosy::Printing
+  class BasePrinter
+    include Terminal
+
+    attr_accessor :indent, :offset, :formatting_options, :header_styles, :option_styles
+
+    def initialize(options)
+      @formatting_options = options
+
+      @header_styles = options[:header_styles] || [:bold, :blue]
+      @option_styles = options[:option_styles] || [:bold]
+      @indent = options[:indent] || '  '
+      @offset = options[:offset] || '    '
+
+      if options[:color] == false
+        self.color.disable!
+      end
+      if options[:max_width] && self.columns > options[:max_width]
+        self.columns = options[:max_width]
+      end
+    end
+
+    def print!(command)
+      page format!(command)
+    end
+
+    def format!(command)
+      format_prologue(command)
+
+      cmd_indent, option_indent, prefixes = retrieve_formatting_info(command)
+      command.listing.each_with_index do |item, i|
+        case item
+        when Choosy::Option
+          format_option(item, prefixes[i], option_indent)
+        when Choosy::Command
+          format_command(item, prefixes[i], cmd_indent)
+        when Choosy::Printing::FormattingElement
+          format_element(item)
+        end
+      end
+
+      format_epilogue(command)
+    end
+
+    def line_count
+      # Override
+    end
+
+    def format_prologue(command)
+      # Override
+    end
+
+    def format_option(option, formatted_prefix, indent)
+      # Override
+    end
+
+    def format_command(command, formatted_prefix, indent)
+      # Override
+    end
+
+    def format_element(item)
+      # Override
+    end
+
+    def format_epilogue(command)
+      # Override
+    end
+
+    def usage_option(option, value="")
+      value << "["
+      if option.short_flag
+        value << option.short_flag
+        if option.long_flag
+          value << "|"
+        end
+      end
+      if option.long_flag
+        value << option.long_flag
+      end
+      if option.negated?
+        value << '|'
+        value << option.negated
+      end
+      if option.metaname
+        if option.arity.max > 1
+          value << ' '
+          value << option.metaname
+        else
+          value << '='
+          value << option.metaname
+        end
+      end
+      value << ']'
+    end
+
+    def regular_option(option, value="")
+      if option.short_flag
+        value << option_begin
+        value << option.short_flag
+        value << option_end
+        if option.long_flag
+          value << ', '
+        end
+      else
+        value << '    '
+      end
+
+      if option.long_flag
+        value << option_begin
+        if option.negated?
+          value << '--['
+          value << option.negation
+          value << '-]'
+          value << option.long_flag.gsub(/^--/, '')
+        else
+          value << option.long_flag
+        end
+        value << option_end
+      end
+
+      if option.metaname
+        value << ' '
+        value << option.metaname
+      end
+      value
+    end
+
+    def command_name(command)
+      if command.is_a?(Choosy::Command) && command.subcommand?
+        "#{command.parent.name} #{command.name}"
+      else
+        "#{command.name}"
+      end
+    end
+
+    # doesn't indent the first line
+    def usage_wrapped(command, indent='', columns=80)
+      lines = []
+      line = command_name(command)
+      starting_width = width = line.length + indent.length
+      lines << line
+
+      wrap = lambda do |part|
+        if width + part.length > columns
+          line = ' ' * starting_width
+          lines << line
+          line << ' ' << part
+          width = starting_width + part.length
+        else
+          line << ' ' << part
+          width += part.length
+        end
+      end
+
+      command.listing.each do |option|
+        if option.is_a?(Choosy::Option)
+          formatted = usage_option(option)
+          wrap.call(formatted)
+        end
+      end
+
+      case command
+      when Choosy::Command
+        if command.arguments
+          wrap.call(command.arguments.metaname)
+        end
+      when Choosy::SuperCommand
+        wrap.call(command.metaname)
+      end
+
+      lines
+    end
+
+    protected
+    def fix_termcap
+      if pager.include?('less')
+        headers = color.multiple(nil, @header_styles)
+        options = color.multiple(nil, @option_styles)
+
+        ENV['LESS_TERMCAP_mb'] ||= "\e[31m"       # Begin blinking
+        ENV['LESS_TERMCAP_md'] ||= headers        # Begin bold
+        ENV['LESS_TERMCAP_me'] ||= "\e[0m"        # End mode
+        ENV['LESS_TERMCAP_se'] ||= "\e[0m"        # End STDOUT-mode
+        ENV['LESS_TERMCAP_so'] ||= headers        # Begin STDOUT-mode
+        ENV['LESS_TERMCAP_ue'] ||= "\e[0m"        # End Underline
+        ENV['LESS_TERMCAP_us'] ||= options        # Begin Underline
+      end
+    end
+
+    def option_begin
+      ''
+    end
+
+    def option_end
+      ''
+    end
+
+    private
+    def retrieve_formatting_info(command)
+      cmdlen = 0
+      optionlen = 0
+      prefixes = []
+
+      command.listing.each do |item|
+        case item
+        when Choosy::Option
+          opt = regular_option(item)
+          if opt.length > optionlen
+            optionlen = opt.length
+          end
+          prefixes << opt
+        when Choosy::Command
+          name = item.name.to_s
+          if name.length > cmdlen
+            cmdlen = name.length
+          end
+          prefixes << name
+        else
+          prefixes << nil
+        end
+      end
+
+      option_indent = ' ' * (optionlen + indent.length + offset.length)
+      cmd_indent = ' ' * (cmdlen + indent.length + offset.length)
+      [cmd_indent, option_indent, prefixes]
+    end
+  end
+end

data/lib/choosy/printing/color.rb

@@ -48,8 +48,8 @@ module Choosy::Printing
       @disabled = true
     end
 
-    def color?(color)
-      COLORS.has_key?(color.to_sym)
+    def color?(col)
+      COLORS.has_key?(col.to_sym)
     end
 
     def effect?(effect)
@@ -59,11 +59,12 @@ module Choosy::Printing
     def multiple(str, styles)
       return str if styles.nil? || styles.empty? || disabled?
 
+      originally_nil = str.nil?
       styles.each do |style|
         if color?(style)
-          str = bedazzle(COLORS[style] + FOREGROUND, str)
+          str = bedazzle(COLORS[style] + FOREGROUND, str, originally_nil)
         elsif effect?(style)
-          str = bedazzle(EFFECTS[style], str)
+          str = bedazzle(EFFECTS[style], str, originally_nil)
         end
       end
       str
@@ -105,12 +106,14 @@ module Choosy::Printing
       end
     end
 
-    def bedazzle(number, str)
+    def bedazzle(number, str, keep_open=nil)
       prefix = "\e[#{number}m"
       if str.nil?
         prefix
       elsif str =~ /\e\[0m$/
         "#{prefix}#{str}"
+      elsif keep_open
+        "#{prefix}#{str}"
       else
         "#{prefix}#{str}\e[0m"
       end

data/lib/choosy/printing/erb_printer.rb

@@ -10,7 +10,7 @@ module Choosy::Printing
       super(options)
       if options[:template].nil?
         raise Choosy::ConfigurationError.new("no template file given to ERBPrinter")
-      elsif !File.exist?(options[:template])
+      elsif !File.file?(options[:template])
         raise Choosy::ConfigurationError.new("the template file doesn't exist: #{options[:template]}")
       end
       @template = options[:template]

data/lib/choosy/printing/help_printer.rb

@@ -1,199 +1,90 @@
 require 'choosy/errors'
 require 'choosy/printing/terminal'
+require 'choosy/printing/base_printer'
 
 module Choosy::Printing
-  class HelpPrinter
-    include Terminal
-
-    attr_reader :header_styles, :indent, :offset, :buffer, :usage
+  class HelpPrinter < BasePrinter
+    attr_reader :buffer, :usage, :line_count
 
     def initialize(options)
-      @indent = options[:indent] || '  '
-      @offset = options[:offset] || '  '
-      @header_styles = options[:header_styles] || [:bold, :blue]
+      super(options)
+
       @buffer = options[:buffer] || ""
       @usage = options[:usage] || 'Usage:'
 
-      if options[:color] == false
-        color.disable!
-      end
-      if options[:max_width]
-        self.columns = options[:max_width]
-      end
+      @line_count = 0
     end
 
     def print!(command)
-      print_usage(command)
-
-      cmd_indent, option_indent, prefixes = retrieve_formatting_info(command)
-
-      command.listing.each_with_index do |item, i|
-        case item
-        when Choosy::Option
-          print_option(item, prefixes[i], option_indent)
-        when Choosy::Command
-          print_command(item, prefixes[i], cmd_indent)
-        when Choosy::Printing::FormattingElement
-          print_element(item)
-        end
+      format!(command)
+      if @line_count > lines
+        page(@buffer)
+      else
+        puts @buffer
       end
-
-      @buffer
     end
 
-    def print_usage(command)
-      print_header(@usage)
+    def format_prologue(command)
+      format_header(@usage)
       @buffer << ' '
-      @buffer << command.name.to_s
-      return if command.options.empty?
-
-      width = starting_width = 8 + command.name.to_s.length # So far
-      command.listing.each do |option|
-        if option.is_a?(Choosy::Option)
-          formatted = usage_option(option)
-          width += formatted.length
-          if width > columns
-            @buffer << "\n"
-            @buffer << ' ' * starting_width
-            @buffer << formatted
-            width = starting_width + formatted.length
-          else
-            @buffer << ' '
-            @buffer << formatted
-            width += 1
-          end
-        end
-      end
-
-      case command
-      when Choosy::Command
-        if command.arguments
-          @buffer << ' '
-          @buffer << command.arguments.metaname
-        end
-      when Choosy::SuperCommand
-        @buffer << ' '
-        @buffer << command.metaname
+      indent = ' ' * (@usage.length + 1)
+      usage_wrapped(command, indent, columns).each do |line|
+        @buffer << line
+        nl
       end
-
-      @buffer << "\n"
+      nl
     end
 
-    def print_header(str, styles=nil)
-      return if str.nil?
-      if styles && !styles.empty?
-        @buffer << color.multiple(str, styles)
-      else
-        @buffer << color.multiple(str, header_styles)
-      end
+    def format_epilogue(command)
+      nl
+      @buffer
     end
 
-    def print_element(element)
-      if element.header?
-        @buffer << "\n"
-        print_header(element.value, element.styles)
-        @buffer << "\n"
+    def format_element(element)
+      if element.value.nil?
+        nl
+      elsif element.header?
+        nl if @buffer[-2,1] != "\n"
+        format_header(element.value, element.styles)
+        nl
+        nl
       else
-        @buffer << "\n"
         write_lines(element.value, indent, true)
+        nl
       end
     end
 
-    def print_option(option, formatted_prefix, opt_indent)
+    def format_option(option, formatted_prefix, opt_indent)
       write_prefix(formatted_prefix, opt_indent)
       write_lines(option.description, opt_indent, false)
     end
 
-    def print_command(command, formatted_prefix, cmd_indent)
+    def format_command(command, formatted_prefix, cmd_indent)
       write_prefix(formatted_prefix, cmd_indent)
       write_lines(command.summary, cmd_indent, false)
     end
 
-    def usage_option(option, value=nil)
-      value ||= ""
-      value << "["
-      if option.short_flag
-        value << option.short_flag
-        if option.long_flag
-          value << "|"
-        end
-      end
-      if option.long_flag
-        value << option.long_flag
-      end
-      if option.negated?
-        value << '|'
-        value << option.negated
-      end
-      if option.metaname
-        if option.arity.max > 1
-          value << ' '
-          value << option.metaname
-        else
-          value << '='
-          value << option.metaname
-        end
-      end
-      value << ']'
-    end
-
-    def regular_option(option, value=nil)
-      value ||= ""
-      if option.short_flag
-        value << option.short_flag
-        if option.long_flag
-          value << ', '
-        end
+    def format_header(str, styles=nil)
+      return if str.nil?
+      if styles && !styles.empty?
+        @buffer << color.multiple(str, styles)
       else
-        value << '    '
-      end
-
-      if option.long_flag
-        if option.negated?
-          value << '--['
-          value << option.negation
-          value << '-]'
-          value << option.long_flag.gsub(/^--/, '')
-        else
-          value << option.long_flag
-        end
-      end
-
-      if option.metaname
-        value << ' '
-        value << option.metaname
+        @buffer << color.multiple(str, header_styles)
       end
-      value
     end
 
     protected
-    def retrieve_formatting_info(command)
-      cmdlen = 0
-      optionlen = 0
-      prefixes = []
+    def option_begin
+      @option_begin ||= color.multiple(nil, option_styles)
+    end
 
-      command.listing.each do |item|
-        case item
-        when Choosy::Option
-          opt = regular_option(item)
-          if opt.length > optionlen
-            optionlen = opt.length
-          end
-          prefixes << opt
-        when Choosy::Command
-          name = item.name.to_s
-          if name.length > cmdlen
-            cmdlen = name.length
-          end
-          prefixes << name
-        else
-          prefixes << nil
-        end
-      end
+    def option_end
+      color.reset
+    end
 
-      option_indent = ' ' * (optionlen + indent.length + offset.length)
-      cmd_indent = ' ' * (cmdlen + indent.length + offset.length)
-      [cmd_indent, option_indent, prefixes]
+    def nl
+      @line_count += 1
+      @buffer << "\n"
     end
 
     def write_prefix(prefix, after_indent)
@@ -204,14 +95,9 @@ module Choosy::Printing
     end
 
     def write_lines(str, prefix, indent_first)
-      if str.nil?
-        @buffer << "\n"
-        return
-      end
-
       str.split("\n").each do |line|
         if line.length == 0
-          @buffer << "\n"
+          nl
         else
           index = 0
 
@@ -248,7 +134,7 @@ module Choosy::Printing
       char.downto(char - MAX_BACKTRACK) do |i| # Only go back a fixed line segment
         if line[i, 1] == ' '
           @buffer << line[index, i - index]
-          @buffer << "\n"
+          nl
           return i + 1
         end
       end
@@ -259,7 +145,7 @@ module Choosy::Printing
 
     def write_rest(line, index)
       @buffer << line[index, line.length]
-      @buffer << "\n"
+      nl
       line.length
     end
   end