choosy 0.4.4 → 0.4.5

data/README.markdown

@@ -436,7 +436,7 @@ For those who want the nice, manpage experience, there's also the <code>:manpage
       version FOO_VERSION # If you don't supply a version above, this will be used
     end
 
-Because the library is super-awesome, the manpage will even be in color when piped to <code>less -R<code> (the default)! If you don't like the format of my manpage, feel free to implement your own using the <code>choosy/printing/manpage</code> class, a useful utility class for formatting manpage output correctly.
+Because the library is super-awesome, the manpage will even be in color when piped to <code>less -R</code> (the default)! If you don't like the format of my manpage, feel free to implement your own using the <code>choosy/printing/manpage</code> class, a useful utility class for formatting manpage output correctly.
 
 If you already have some templates that you'd like to use, there is also the <code>:erb</code> template that can be customized by writing a template of your choice:
 
@@ -448,7 +448,7 @@ If you already have some templates that you'd like to use, there is also the <co
 
 The ERB printer also accepts the <code>:color</code> option. The color is exposed via a <code>color</code> property in the template; the command is exposed by the <code>command</code> property.
 
-Finally, because I don't want to tell you how to print your help, I also give you the option of supplying your own printer. Just create a class with a <code>print!(command)</code> method on that class, and it will be passed in the command that it should print the help for. I have supplied some code you may find useful in <code>choosy/printing/terminal</code> that will help with things like finding commands and determining the column width of the terminal.
+Finally, because I don't want to tell you how to print your help, I also give you the option of supplying your own printer. Just create a class with a <code>print!(command)</code> method on that class, and it will be passed in the command that it should print the help for. I have supplied some code you may find useful in <code>choosy/terminal</code> that will help with things like finding commands and determining the column width of the terminal.
 
     class CustomPrinter
       def print!(command)

data/lib/VERSION.yml

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

data/lib/choosy/printing/base_printer.rb

@@ -1,15 +1,9 @@
 require 'choosy/errors'
-require 'choosy/printing/terminal'
-
-class String
-  def unformatted
-    gsub(/\e\[\d+m/, '').gsub(/\\f[IPB]/, '')
-  end
-end
+require 'choosy/terminal'
 
 module Choosy::Printing
   class BasePrinter
-    include Terminal
+    include Choosy::Terminal
 
     attr_accessor :indent, :offset, :formatting_options, :heading_styles, :option_styles
 
@@ -215,7 +209,7 @@ module Choosy::Printing
         case item
         when Choosy::Option
           opt = regular_option(item)
-          len = opt.unformatted.length
+          len = unformatted(opt).length
           if len > optionlen
             optionlen = len
           end

data/lib/choosy/printing/help_printer.rb

@@ -1,5 +1,4 @@
 require 'choosy/errors'
-require 'choosy/printing/terminal'
 require 'choosy/printing/base_printer'
 
 module Choosy::Printing
@@ -88,7 +87,7 @@ module Choosy::Printing
     end
 
     def write_prefix(prefix, after_indent)
-      len = after_indent.length - prefix.unformatted.length - indent.length
+      len = after_indent.length - unformatted(prefix).length - indent.length
       @buffer << indent
       @buffer << prefix
       @buffer << " " * len

data/lib/choosy/printing/manpage.rb

@@ -206,7 +206,7 @@ EOF
     end
 
     def prefixed(tag, quot, line=nil)
-      puts tag if quot.nil?
+      return if quot.nil?
       tag << SQUOTE << quot << EQUOTE
       if line.nil?
         append(tag)

data/lib/choosy/terminal.rb

@@ -0,0 +1,132 @@
+require 'choosy/errors'
+require 'choosy/printing/color'
+
+module Choosy
+  module Terminal
+    DEFAULT_LINE_COUNT = 25
+    DEFAULT_COLUMN_COUNT = 80
+
+    attr_writer :lines, :columns
+
+    def lines
+      @lines ||= find_terminal_size('LINES', 'lines', 0) || DEFAULT_LINE_COUNT
+    end
+
+    def columns
+      @columns ||= find_terminal_size('COLUMNS', 'cols', 1) || DEFAULT_COLUMN_COUNT
+    end
+
+    def color
+      @color ||= Choosy::Printing::Color.new
+    end
+
+    def pager?
+      !pager.empty?
+    end
+
+    def pager
+      @pager ||= nil
+      return @pager if @pager
+
+      @pager ||= ENV['PAGER'] || 
+                  ENV['MANPAGER'] ||
+                  if command_exists?('less')
+                    'less -R'
+                  elsif command_exists?('more')
+                    'more'
+                  else
+                    ''
+                  end
+      if @pager !~ /less -R/
+        color.disable! 
+      end
+      @pager
+    end
+
+    def page(contents, pipe_command=nil)
+      if pager?
+        if pipe_command
+          pipe_out("#{pipe_command} | #{pager}", contents)
+        else
+          pipe_out(pager, contents)
+        end
+      else
+        pipe_out(pipe_command, contents)
+      end
+    end
+
+    def pipe_out(command, contents = nil, &block)
+      puts contents if command.nil? && contents
+
+      IO.popen(command, 'w') do |f|
+        f.puts contents if contents
+        if block_given?
+          yield f
+        end
+      end
+    end
+    
+    def pipe_in(command = nil, &block)
+      raise ArgumentError.new("Requires a block") unless block_given?
+
+      if command
+        IO.popen(command, 'r') do |f|
+          f.each_line do |line|
+            yield line
+          end
+        end
+        $?
+      elsif stdin?
+        STDIN.each_line do |line|
+          yield line
+        end
+        0
+      else
+        1
+      end
+    end
+
+    # directly from hirb
+    def command_exists?(command)
+      ENV['PATH'].split(File::PATH_SEPARATOR).any? {|d| File.exists? File.join(d, command) }
+    end
+
+    def stdin?
+      begin
+        require 'fcntl'
+        STDIN.fcntl(Fcntl::F_GETFL, 0) == 0 && !stdin.tty?
+      rescue
+        $stdin.stat.size != 0
+      end
+    end
+
+    def unformatted(line='')
+      line = line.gsub(/\e\[\d+m/, '')
+      line.gsub!(/\\f[IPB]/, '')
+      line
+    end
+
+    def die(message)
+      raise Choosy::ConfigurationError.new(message)
+    end
+
+    private
+    # https://github.com/cldwalker/hirb
+    # modified from hirb
+    def find_terminal_size(env_name, tput_name, stty_index)
+      begin 
+        if ENV[env_name] =~ /^\d$/
+          ENV[env_name].to_i
+        elsif (RUBY_PLATFORM =~ /java/ || (!STDIN.tty? && ENV['TERM'])) && command_exists?('tput')
+          `tput #{tput_name}`.to_i
+        elsif STDIN.tty? && command_exists?('stty')
+          `stty size`.scan(/\d+/).map { |s| s.to_i }[stty_index]
+        else
+          nil
+        end
+      rescue
+        nil
+      end
+    end
+  end
+end

data/spec/choosy/{printing/terminal_spec.rb → terminal_spec.rb}

@@ -1,7 +1,7 @@
 require 'spec_helpers'
-require 'choosy/printing/terminal'
+require 'choosy/terminal'
 
-module Choosy::Printing
+module Choosy
   class TerminalTest
     include Terminal
   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 4
-  - 4
-  version: 0.4.4
+  - 5
+  version: 0.4.5
 platform: ruby
 authors: 
 - Gabe McArthur
@@ -98,6 +98,7 @@ files:
 - lib/choosy/version.rb
 - lib/choosy/option.rb
 - lib/choosy/command.rb
+- lib/choosy/terminal.rb
 - lib/choosy/super_command.rb
 - lib/choosy/dsl/argument_builder.rb
 - lib/choosy/dsl/super_command_builder.rb
@@ -111,7 +112,6 @@ files:
 - lib/choosy/printing/base_printer.rb
 - lib/choosy/printing/formatting_element.rb
 - lib/choosy/printing/manpage.rb
-- lib/choosy/printing/terminal.rb
 - lib/choosy/printing/color.rb
 - lib/choosy/printing/erb_printer.rb
 - lib/choosy/printing/help_printer.rb
@@ -128,6 +128,7 @@ files:
 - spec/choosy/argument_spec.rb
 - spec/choosy/base_command_spec.rb
 - spec/choosy/version.yml
+- spec/choosy/terminal_spec.rb
 - spec/choosy/command_spec.rb
 - spec/choosy/dsl/super_command_builder_spec.rb
 - spec/choosy/dsl/option_builder_spec.rb
@@ -139,7 +140,6 @@ files:
 - spec/choosy/super_parser_spec.rb
 - spec/choosy/verifier_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/color_spec.rb

data/lib/choosy/printing/terminal.rb

@@ -1,84 +0,0 @@
-require 'choosy/errors'
-require 'choosy/printing/color'
-
-module Choosy::Printing
-  module Terminal
-    DEFAULT_LINE_COUNT = 25
-    DEFAULT_COLUMN_COUNT = 80
-
-    attr_writer :lines, :columns
-
-    def lines
-      @lines ||= find_terminal_size('LINES', 'lines', 0) || DEFAULT_LINE_COUNT
-    end
-
-    def columns
-      @columns ||= find_terminal_size('COLUMNS', 'cols', 1) || DEFAULT_COLUMN_COUNT
-    end
-
-    def color
-      @color ||= Color.new
-    end
-
-    def pager?
-      !pager.empty?
-    end
-
-    def pager
-      @pager ||= ENV['PAGER'] || ENV['MANPAGER']
-      return @pager if @pager
-
-      @pager = if command_exists?('less')
-                 'less -R'
-               elsif command_exists?('more')
-                 'more'
-               else
-                 ''
-               end
-    end
-
-    def page(contents, pipe_command=nil)
-      if pager?
-        if pipe_command
-          pipe(contents, "#{pipe_command} | #{pager}")
-        else
-          pipe(contents, pager)
-        end
-      else
-        pipe(contents, pipe_command)
-      end
-    end
-
-    def pipe(contents, command)
-      puts contents if command.nil?
-
-      IO.popen(command, 'w') do |f|
-        f.puts contents
-      end
-    end
-
-    # directly from hirb
-    def command_exists?(command)
-      ENV['PATH'].split(File::PATH_SEPARATOR).any? {|d| File.exists? File.join(d, command) }
-    end
-
-    private
-    # https://github.com/cldwalker/hirb
-    # modified from hirb
-    def find_terminal_size(env_name, tput_name, stty_index)
-      begin 
-        if ENV[env_name] =~ /^\d$/
-          ENV[env_name].to_i
-        elsif (RUBY_PLATFORM =~ /java/ || (!STDIN.tty? && ENV['TERM'])) && command_exists?('tput')
-          `tput #{tput_name}`.to_i
-        elsif STDIN.tty? && command_exists?('stty')
-          `stty size`.scan(/\d+/).map { |s| s.to_i }[stty_index]
-        else
-          nil
-        end
-      rescue
-        nil
-      end
-    end
-  end
-end