cri 2.6.0 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b5c4be8a90bd61c37d60ee1a789c51147f3d096
-  data.tar.gz: 19f03a77cb1414c4c5ae591d47a93027642160db
+  metadata.gz: 42a611aea2f4ef126558c77832d3f87e4c7769ee
+  data.tar.gz: 4629089940c31510094b05bafef780756d72f2db
 SHA512:
-  metadata.gz: 592d029e4b6294136592855225f57340d18f0e75511e01fed4ff1f14e2babb1f01bb8929671b96eefc2e373f4046d2aa283fe539dea65ef932a48919dea30ced
-  data.tar.gz: 0c402294f210d83b2ed2680b59e01303be52dd097a932c65169cee955684be620a5364db00ef1fd72abfce735d7b4a1dc7ff581b4c5f159b9380e7870fa24dec
+  metadata.gz: 5722bead0775cc5d35b658d60318c7b530590681f751dcfb51b9bf6cfd9c0d065387237d7906b8c4163a324d4e1df288f76bcac6fa4fb37775336b8c2908feff
+  data.tar.gz: 67a2d794fa2206fd4487068cb4ffe6e3876c8c9c1b49951b180d7bc62ae4bc375db1a063fbebab89a5aac6bc3e314bdb6e41ced98bbca7e6838424514aa2a17d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cri (2.6.0)
+    cri (2.6.1)
       colored (~> 1.2)
 
 GEM
@@ -16,10 +16,10 @@ GEM
       term-ansicolor
       thor
     docile (1.1.3)
-    mime-types (2.2)
-    minitest (5.3.2)
-    multi_json (1.9.2)
-    rake (10.2.2)
+    mime-types (2.3)
+    minitest (5.3.4)
+    multi_json (1.10.1)
+    rake (10.3.2)
     rest-client (1.6.7)
       mime-types (>= 1.16)
     simplecov (0.8.2)
@@ -30,7 +30,7 @@ GEM
     term-ansicolor (1.3.0)
       tins (~> 1.0)
     thor (0.19.1)
-    tins (1.0.1)
+    tins (1.3.0)
     yard (0.8.7.4)
 
 PLATFORMS

data/NEWS.md

@@ -1,16 +1,21 @@
 Cri News
 ========
 
+2.6.1
+-----
+
+* Disable ANSI color codes when not supported (#31, #32)
+
 2.6.0
 -----
 
-* Added support for multi-valued options [Toon Willems]
+* Added support for multi-valued options (#29) [Toon Willems]
 
 2.5.0
 -----
 
-* Made the default help command handle subcommands
-* Added `#raw` method to argument arrays, returning all arguments including `--`
+* Made the default help command handle subcommands (#27)
+* Added `#raw` method to argument arrays, returning all arguments including `--` (#22)
 
 2.4.1
 -----
@@ -21,14 +26,14 @@ Cri News
 2.4.0
 -----
 
-* Allowed either short or long option to be, eh, optional [Ken Coar]
-* Fixed wrap-and-indent behavior [Ken Coar]
+* Allowed either short or long option to be, eh, optional (#9, #10) [Ken Coar]
+* Fixed wrap-and-indent behavior (#12) [Ken Coar]
 * Moved version information into `cri/version`
 
 2.3.0
 -----
 
-* Added colors
+* Added colors (#1)
 * Added support for marking commands as hidden
 
 2.2.1

data/README.adoc

@@ -4,7 +4,7 @@ link:http://rubygems.org/gems/cri[image:http://img.shields.io/gem/v/cri.svg[]]
 link:https://travis-ci.org/ddfreyne/cri[image:http://img.shields.io/travis/ddfreyne/cri.svg[]]
 link:https://coveralls.io/r/ddfreyne/cri[image:http://img.shields.io/coveralls/ddfreyne/cri.svg[]]
 link:https://codeclimate.com/github/ddfreyne/cri[image:http://img.shields.io/codeclimate/github/ddfreyne/cri.svg[]]
-link:http://inch-pages.github.io/github/ddfreyne/cri/[image:http://inch-pages.github.io/github/ddfreyne/cri.png[]]
+link:http://inch-pages.github.io/github/ddfreyne/cri/[image:http://inch-pages.github.io/github/ddfreyne/cri.svg[]]
 
 Cri is a library for building easy-to-use commandline tools with support for
 nested commands.

data/lib/cri.rb

@@ -21,10 +21,12 @@ module Cri
   end
 
   autoload 'Command',           'cri/command'
+  autoload 'StringFormatter',   'cri/string_formatter'
   autoload 'CommandDSL',        'cri/command_dsl'
   autoload 'CommandRunner',     'cri/command_runner'
   autoload 'HelpRenderer',      'cri/help_renderer'
   autoload 'OptionParser',      'cri/option_parser'
+  autoload 'Platform',          'cri/platform'
 
 end
 

data/lib/cri/command.rb

@@ -302,6 +302,9 @@ module Cri
     #
     # @option params [Boolean] :verbose true if the help output should be
     #   verbose, false otherwise.
+    #
+    # @option params [IO] :io ($stdout) the IO the help text is intended for.
+    #   This influences the decision to enable/disable colored output.
     def help(params={})
       HelpRenderer.new(self, params).render
     end

data/lib/cri/commands/basic_help.rb

@@ -23,5 +23,5 @@ run do |opts, args, cmd|
   resolved_cmd = args.inject(cmd.supercommand) do |acc, name|
     acc.command_named(name)
   end
-  puts resolved_cmd.help(:verbose => is_verbose)
+  puts resolved_cmd.help(:verbose => is_verbose, :io => $stdout)
 end

data/lib/cri/core_ext/string.rb

@@ -4,81 +4,32 @@ require 'colored'
 
 module Cri::CoreExtensions
 
+  # @deprecated
   module String
 
-    # Extracts individual paragraphs (separated by two newlines).
-    #
-    # @return [Array<String>] A list of paragraphs in the string
+    # @see Cri::StringFormatter#to_paragraphs
     def to_paragraphs
-      lines = self.scan(/([^\n]+\n|[^\n]*$)/).map { |s| s[0].strip }
-
-      paragraphs = [ [] ]
-      lines.each do |line|
-        if line.empty?
-          paragraphs << []
-        else
-          paragraphs.last << line
-        end
-      end
-
-      paragraphs.reject { |p| p.empty? }.map { |p| p.join(' ') }
+      Cri::StringFormatter.new.to_paragraphs(self)
     end
 
-    # Word-wraps and indents the string.
-    #
-    # @param [Number] width The maximal width of each line. This also includes
-    #   indentation, i.e. the actual maximal width of the text is
-    #   `width`-`indentation`.
-    #
-    # @param [Number] indentation The number of spaces to indent each line.
-    #
-    # @return [String] The word-wrapped and indented string
+    # @see Cri::StringFormatter#to_paragraphs
     def wrap_and_indent(width, indentation)
-      indented_width = width - indentation
-      indent = ' ' * indentation
-      # Split into paragraphs
-      paragraphs = self.to_paragraphs
-
-      # Wrap and indent each paragraph
-      paragraphs.map do |paragraph|
-        # Initialize
-        lines = []
-        line = ''
-
-        # Split into words
-        paragraph.split(/\s/).each do |word|
-          # Begin new line if it's too long
-          if (line + ' ' + word).length >= indented_width
-            lines << line
-            line = ''
-          end
-
-          # Add word to line
-          line += (line == '' ? '' : ' ' ) + word
-        end
-        lines << line
-
-        # Join lines
-        lines.map { |l| indent + l }.join("\n")
-      end.join("\n\n")
+      Cri::StringFormatter.new.wrap_and_indent(self, width, indentation)
     end
 
-    # @return [String] The string, formatted to be used as a title in a section
-    #   in the help
+    # @see Cri::StringFormatter#format_as_title
     def formatted_as_title
-      self.upcase.red.bold
+      Cri::StringFormatter.new.format_as_title(self)
     end
 
-    # @return [String] The string, formatted to be used as the name of a command
-    #   in the help
+    # @see Cri::StringFormatter#format_as_command
     def formatted_as_command
-      self.green
+      Cri::StringFormatter.new.format_as_command(self)
     end
 
-    # @return [String] The string, formatted to be used as an option definition
-    #   of a command in the help
+    # @see Cri::StringFormatter#format_as_option
     def formatted_as_option
-      self.yellow
+      Cri::StringFormatter.new.format_as_option(self)
     end
 
   end

data/lib/cri/help_renderer.rb

@@ -15,6 +15,7 @@ module Cri
     def initialize(cmd, params={})
       @cmd        = cmd
       @is_verbose = params.fetch(:verbose, false)
+      @io         = params.fetch(:io, $stdout)
     end
 
     # @return [String] The help text for this command
@@ -32,13 +33,17 @@ module Cri
 
     private
 
+    def fmt
+      @_formatter ||= Cri::StringFormatter.new
+    end
+
     def append_summary(text)
       return if @cmd.summary.nil?
 
-      text << "name".formatted_as_title << "\n"
-      text << "    #{@cmd.name.formatted_as_command} - #{@cmd.summary}" << "\n"
+      text << fmt.format_as_title("name", @io) << "\n"
+      text << "    #{fmt.format_as_command(@cmd.name, @io)} - #{@cmd.summary}" << "\n"
       unless @cmd.aliases.empty?
-        text << "    aliases: " << @cmd.aliases.map { |a| a.formatted_as_command }.join(' ') << "\n"
+        text << "    aliases: " << @cmd.aliases.map { |a| fmt.format_as_command(a, @io) }.join(' ') << "\n"
       end
     end
 
@@ -47,36 +52,36 @@ module Cri
 
       path = [ @cmd.supercommand ]
       path.unshift(path[0].supercommand) until path[0].nil?
-      formatted_usage = @cmd.usage.gsub(/^([^\s]+)/) { |m| m.formatted_as_command }
-      full_usage = path[1..-1].map { |c| c.name.formatted_as_command + ' ' }.join + formatted_usage
+      formatted_usage = @cmd.usage.gsub(/^([^\s]+)/) { |m| fmt.format_as_command(m, @io) }
+      full_usage = path[1..-1].map { |c| fmt.format_as_command(c.name, @io) + ' ' }.join + formatted_usage
 
       text << "\n"
-      text << "usage".formatted_as_title << "\n"
-      text << full_usage.wrap_and_indent(78, 4) << "\n"
+      text << fmt.format_as_title("usage", @io) << "\n"
+      text << fmt.wrap_and_indent(full_usage, 78, 4) << "\n"
     end
 
     def append_description(text)
       return if @cmd.description.nil?
 
       text << "\n"
-      text << "description".formatted_as_title << "\n"
-      text << @cmd.description.wrap_and_indent(78, 4) + "\n"
+      text << fmt.format_as_title("description", @io) << "\n"
+      text << fmt.wrap_and_indent(@cmd.description, 78, 4) + "\n"
     end
 
     def append_subcommands(text)
       return if @cmd.subcommands.empty?
 
       text << "\n"
-      text << (@cmd.supercommand ? 'subcommands' : 'commands').formatted_as_title
+      text << fmt.format_as_title(@cmd.supercommand ? 'subcommands' : 'commands', @io)
       text << "\n"
 
       shown_subcommands = @cmd.subcommands.select { |c| !c.hidden? || @is_verbose }
-      length = shown_subcommands.map { |c| c.name.formatted_as_command.size }.max
+      length = shown_subcommands.map { |c| fmt.format_as_command(c.name, @io).size }.max
 
       # Command
       shown_subcommands.sort_by { |cmd| cmd.name }.each do |cmd|
         text << sprintf("    %-#{length+4}s %s\n",
-          cmd.name.formatted_as_command,
+          fmt.format_as_command(cmd.name, @io),
           cmd.summary)
       end
 
@@ -109,7 +114,7 @@ module Cri
       return if defs.empty?
 
       text << "\n"
-      text << "#{name}".formatted_as_title
+      text << fmt.format_as_title("#{name}", @io)
       text << "\n"
 
       ordered_defs = defs.sort_by { |x| x[:short] || x[:long] }
@@ -124,7 +129,7 @@ module Cri
           "    %-2s %-#{length+6}s",
           opt_def[:short] ? ('-' + opt_def[:short]) : '',
           opt_def[:long]  ? ('--' + opt_def[:long]) : '')
-      opt_text.formatted_as_option
+      fmt.format_as_option(opt_text, @io)
     end
 
   end

data/lib/cri/platform.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+module Cri
+
+  module Platform
+
+    # @return [Boolean] true if the current platform is Windows, false
+    # otherwise.
+    def self.windows?
+      !!(RUBY_PLATFORM =~ /windows|bccwin|cygwin|djgpp|mingw|mswin|wince/i)
+    end
+
+    # Checks whether colors can be enabled. For colors to be enabled, the given
+    # IO should be a TTY, and, when on Windows, ::Win32::Console::ANSI needs to
+    # be defined.
+    #
+    # @return [Boolean] True if colors should be enabled, false otherwise.
+    def self.color?(io)
+      if !io.tty?
+        false
+      elsif windows?
+        defined?(::Win32::Console::ANSI)
+      else
+        true
+      end
+    end
+
+  end
+
+end

data/lib/cri/string_formatter.rb

@@ -0,0 +1,108 @@
+# encoding: utf-8
+
+require 'colored'
+
+module Cri
+
+  class StringFormatter
+
+    # Extracts individual paragraphs (separated by two newlines).
+    #
+    # @param [String] s The string to format
+    #
+    # @return [Array<String>] A list of paragraphs in the string
+    def to_paragraphs(s)
+      lines = s.scan(/([^\n]+\n|[^\n]*$)/).map { |s| s[0].strip }
+
+      paragraphs = [ [] ]
+      lines.each do |line|
+        if line.empty?
+          paragraphs << []
+        else
+          paragraphs.last << line
+        end
+      end
+
+      paragraphs.reject { |p| p.empty? }.map { |p| p.join(' ') }
+    end
+
+    # Word-wraps and indents the string.
+    #
+    # @param [String] s The string to format
+    #
+    # @param [Number] width The maximal width of each line. This also includes
+    #   indentation, i.e. the actual maximal width of the text is
+    #   `width`-`indentation`.
+    #
+    # @param [Number] indentation The number of spaces to indent each line.
+    #
+    # @return [String] The word-wrapped and indented string
+    def wrap_and_indent(s, width, indentation)
+      indented_width = width - indentation
+      indent = ' ' * indentation
+      # Split into paragraphs
+      paragraphs = to_paragraphs(s)
+
+      # Wrap and indent each paragraph
+      paragraphs.map do |paragraph|
+        # Initialize
+        lines = []
+        line = ''
+
+        # Split into words
+        paragraph.split(/\s/).each do |word|
+          # Begin new line if it's too long
+          if (line + ' ' + word).length >= indented_width
+            lines << line
+            line = ''
+          end
+
+          # Add word to line
+          line += (line == '' ? '' : ' ' ) + word
+        end
+        lines << line
+
+        # Join lines
+        lines.map { |l| indent + l }.join("\n")
+      end.join("\n\n")
+    end
+
+    # @param [String] s The string to format
+    #
+    # @return [String] The string, formatted to be used as a title in a section
+    #   in the help
+    def format_as_title(s, io)
+      if Cri::Platform.color?(io)
+        s.upcase.red.bold
+      else
+        s.upcase
+      end
+    end
+
+    # @param [String] s The string to format
+    #
+    # @return [String] The string, formatted to be used as the name of a command
+    #   in the help
+    def format_as_command(s, io)
+      if Cri::Platform.color?(io)
+        s.green
+      else
+        s
+      end
+    end
+
+    # @param [String] s The string to format
+    #
+    # @return [String] The string, formatted to be used as an option definition
+    #   of a command in the help
+    def format_as_option(s, io)
+      if Cri::Platform.color?(io)
+        s.yellow
+      else
+        s
+      end
+    end
+
+  end
+
+end

data/lib/cri/version.rb

@@ -3,6 +3,6 @@
 module Cri
 
   # The current Cri version.
-  VERSION = '2.6.0'
+  VERSION = '2.6.1'
 
 end

data/test/test_command.rb

@@ -253,16 +253,30 @@ class Cri::CommandTestCase < Cri::TestCase
   end
 
   def test_help_nested
+    def $stdout.tty? ; true ; end
+
     help = nested_cmd.subcommands.find { |cmd| cmd.name == 'sub' }.help
 
     assert help.include?("USAGE\e[0m\e[0m\n    \e[32msuper\e[0m \e[32msub\e[0m [options]\n")
   end
 
+  def test_help_with_and_without_colors
+    def $stdout.tty? ; true ; end
+    help_on_tty = simple_cmd.help
+    def $stdout.tty? ; false ; end
+    help_not_on_tty = simple_cmd.help
+
+    assert_includes help_on_tty,     "\e[31mUSAGE\e[0m\e[0m\n    \e[32mmoo"
+    assert_includes help_not_on_tty, "USAGE\n    moo"
+  end
+
   def test_help_for_bare_cmd
     bare_cmd.help
   end
 
   def test_help_with_optional_options
+    def $stdout.tty? ; true ; end
+
     cmd = Cri::Command.define do
       name 'build'
       flag :s,  nil,   'short'

data/test/{test_core_ext.rb → test_string_formatter.rb}

@@ -2,6 +2,10 @@
 
 class Cri::CoreExtTestCase < Cri::TestCase
 
+  def formatter
+    Cri::StringFormatter.new
+  end
+
   def test_string_to_paragraphs
     original = "Lorem ipsum dolor sit amet,\nconsectetur adipisicing.\n\n" +
                "Sed do eiusmod\ntempor incididunt ut labore."
@@ -9,7 +13,7 @@ class Cri::CoreExtTestCase < Cri::TestCase
     expected = [ "Lorem ipsum dolor sit amet, consectetur adipisicing.",
                  "Sed do eiusmod tempor incididunt ut labore." ]
 
-    actual = original.to_paragraphs
+    actual = formatter.to_paragraphs(original)
     assert_equal expected, actual
   end
 
@@ -23,7 +27,7 @@ class Cri::CoreExtTestCase < Cri::TestCase
                "incididunt ut labore et dolore magna\n" +
                "aliqua."
 
-    actual = original.wrap_and_indent(40, 0)
+    actual = formatter.wrap_and_indent(original, 40, 0)
     assert_equal expected, actual
   end
 
@@ -38,7 +42,7 @@ class Cri::CoreExtTestCase < Cri::TestCase
                "    incididunt ut labore et dolore\n" +
                "    magna aliqua."
 
-    actual = original.wrap_and_indent(36, 4)
+    actual = formatter.wrap_and_indent(original, 36, 4)
     assert_equal expected, actual
   end
 
@@ -60,7 +64,7 @@ class Cri::CoreExtTestCase < Cri::TestCase
                "                              dolore magna\n" +
                "                              aliqua."
 
-    actual = original.wrap_and_indent(44, 30)
+    actual = formatter.wrap_and_indent(original, 44, 30)
     assert_equal expected, actual
   end
 
@@ -75,7 +79,7 @@ class Cri::CoreExtTestCase < Cri::TestCase
                "    incididunt ut labore et dolore\n" +
                "    magna aliqua."
 
-    actual = original.wrap_and_indent(36, 4)
+    actual = formatter.wrap_and_indent(original, 36, 4)
     assert_equal expected, actual
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cri
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.6.1
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-05 00:00:00.000000000 Z
+date: 2014-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -66,6 +66,8 @@ files:
 - lib/cri/core_ext/string.rb
 - lib/cri/help_renderer.rb
 - lib/cri/option_parser.rb
+- lib/cri/platform.rb
+- lib/cri/string_formatter.rb
 - lib/cri/version.rb
 - test/helper.rb
 - test/test_argument_array.rb
@@ -75,8 +77,8 @@ files:
 - test/test_command.rb
 - test/test_command_dsl.rb
 - test/test_command_runner.rb
-- test/test_core_ext.rb
 - test/test_option_parser.rb
+- test/test_string_formatter.rb
 homepage: http://stoneship.org/software/cri/
 licenses:
 - MIT
@@ -99,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: a library for building easy-to-use commandline tools