claide 0.5.0 → 0.6.0

data/lib/claide/help.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 module CLAide
-
   require 'claide/informative_error'
 
   # The exception class that is raised to indicate a help banner should be
@@ -20,20 +19,6 @@ module CLAide
     #
     attr_reader :error_message
 
-    # @return [Bool] Whether the error message should use ANSI codes to
-    #         prettify output.
-    #
-    attr_reader  :ansi_output
-    alias_method :ansi_output?, :ansi_output
-
-    def colorize
-      warn "[!] The use of `CLAide::Help#colorize` has been " \
-           "deprecated. Use `CLAide::Help#ansi_output` instead. " \
-           "(Called from: #{caller.first})"
-      ansi_output
-    end
-    alias_method :colorize?, :colorize
-
     # @param [String] banner @see banner
     # @param [String] error_message @see error_message
     #
@@ -41,10 +26,9 @@ module CLAide
     #        terminate the program with, will be set to `1`, otherwise a {Help}
     #        exception is treated as not being a real error and exits with `0`.
     #
-    def initialize(banner, error_message = nil, ansi_output = false)
+    def initialize(banner, error_message = nil)
       @banner = banner
       @error_message = error_message
-      @ansi_output = ansi_output
       @exit_status = @error_message.nil? ? 0 : 1
     end
 
@@ -61,7 +45,7 @@ module CLAide
     # @return [String]
     #
     def prettify_error_message(message)
-      ansi_output? ? message.red : message
+      message.ansi.red
     end
 
     # @return [String] The optional error message, combined with the help

data/lib/claide/helper.rb

@@ -0,0 +1,113 @@
+# encoding: utf-8
+
+module CLAide
+  module Helper
+    # @return [Fixnum] The width of the current terminal, unless being piped.
+    #
+    def self.terminal_width
+      unless @terminal_width
+        if STDOUT.tty? && system('which tput > /dev/null 2>&1')
+          @terminal_width = `tput cols`.to_i
+        else
+          @terminal_width = 0
+        end
+      end
+      @terminal_width
+    end
+
+    # @return [String] Formats a markdown string by stripping heredoc
+    #         indentation and wrapping by word to the terminal width taking
+    #         into account a maximum one, and indenting the string. Code lines
+    #         (i.e. indented by four spaces) are not word wrapped.
+    #
+    # @param  [String] string
+    #         The string to format.
+    #
+    # @param  [Fixnum] indent
+    #         The number of spaces to insert before the string.
+    #
+    # @param  [Fixnum] max_width
+    #         The maximum width to use to format the string if the terminal is
+    #         too wide.
+    #
+    def self.format_markdown(string, indent = 0, max_width = 80)
+      paragraphs = Helper.strip_heredoc(string).split("\n\n")
+      paragraphs = paragraphs.map do |paragraph|
+        unless paragraph.start_with?(' ' * 4)
+          full_line = paragraph.gsub("\n", ' ')
+          paragraph = wrap_with_indent(full_line, indent, max_width)
+        end
+        paragraph.insert(0, ' ' * indent).rstrip
+      end
+      paragraphs.join("\n\n")
+    end
+
+    # @return [String] Wraps a string to the terminal width taking into
+    #         account the given indentation.
+    #
+    # @param  [String] string
+    #         The string to indent.
+    #
+    # @param  [Fixnum] indent
+    #         The number of spaces to insert before the string.
+    #
+    # @param  [Fixnum] max_width
+    #         The maximum width to use to format the string if the terminal is
+    #         too wide.
+    #
+    def self.wrap_with_indent(string, indent = 0, max_width = 80)
+      if terminal_width == 0
+        width = max_width
+      else
+        width = [terminal_width, max_width].min
+      end
+
+      available_width = width - indent
+      space = ' ' * indent
+      word_wrap(string, available_width).split("\n").join("\n#{space}")
+    end
+
+    # @return [String] Lifted straight from ActionView. Thanks guys!
+    #
+    def self.word_wrap(line, line_width)
+      line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip
+    end
+
+    # @return [String] Lifted straight from ActiveSupport. Thanks guys!
+    #
+    def self.strip_heredoc(string)
+      if min = string.scan(/^[ \t]*(?=\S)/).min
+        string.gsub(/^[ \t]{#{min.size}}/, '')
+      else
+        string
+      end
+    end
+
+    # Returns the Levenshtein distance between the given strings.
+    # From: http://rosettacode.org/wiki/Levenshtein_distance#Ruby
+    #
+    # @param  [String] a
+    #         The first string to compare.
+    #
+    # @param  [String] b
+    #         The second string to compare.
+    #
+    # @return [Fixnum] The distance between the strings.
+    #
+    # rubocop:disable all
+    def self.levenshtein_distance(a, b)
+      a, b = a.downcase, b.downcase
+      costs = Array(0..b.length)
+      (1..a.length).each do |i|
+        costs[0], nw = i, i - 1
+        (1..b.length).each do |j|
+          costs[j], nw = [
+            costs[j] + 1, costs[j - 1] + 1, a[i - 1] == b[j - 1] ? nw : nw + 1
+          ].min, costs[j]
+        end
+      end
+      costs[b.length]
+    end
+    # rubocop:enable all
+  end
+end

data/lib/claide/informative_error.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 module CLAide
-
   # Including this module into an exception class will ensure that when raised,
   # while running {Command.run}, only the message of the exception will be
   # shown to the user. Unless disabled with the `--verbose` flag.
@@ -10,7 +9,6 @@ module CLAide
   # is set to `true`.
   #
   module InformativeError
-
     # @return [Numeric] The exist status code that should be used to terminate
     #         the program with. Defaults to `1`.
     #

data/lib/claide/mixins.rb

@@ -0,0 +1,25 @@
+unless String.method_defined? :strip_margin
+  class String
+    # @return [String] The method strips the characters preceding a special
+    # margin character. Useful for HEREDOCs and other multi-line strings.
+    #
+    # @example
+    #
+    #   code = <<-END.strip_margin('|')
+    #     |def test
+    #     |  some_method
+    #     |  other_method
+    #     |end
+    #   END
+    #
+    #   #=> "def\n  some_method\n  \nother_method\nend"
+    #
+    # @note Extracted from the powerpack gem available under the MIT license
+    #       and copyright (c) 2013 Bozhidar Batsov.
+    #
+    def strip_margin(margin_characters)
+      margin = Regexp.quote(margin_characters)
+      gsub(/^\s+#{margin}/, '')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: claide
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Eloy Duran
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-26 00:00:00.000000000 Z
+date: 2014-05-19 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -22,11 +22,25 @@ files:
 - LICENSE
 - README.markdown
 - lib/claide.rb
+- lib/claide/ansi.rb
+- lib/claide/ansi/cursor.rb
+- lib/claide/ansi/graphics.rb
+- lib/claide/ansi/string_escaper.rb
 - lib/claide/argv.rb
+- lib/claide/argv/parser.rb
 - lib/claide/command.rb
 - lib/claide/command/banner.rb
+- lib/claide/command/banner/prettifier.rb
+- lib/claide/command/options.rb
+- lib/claide/command/parser.rb
+- lib/claide/command/plugins_helper.rb
+- lib/claide/command/shell_completion_helper.rb
+- lib/claide/command/shell_completion_helper/zsh_completion_generator.rb
+- lib/claide/command/validation_helper.rb
 - lib/claide/help.rb
+- lib/claide/helper.rb
 - lib/claide/informative_error.rb
+- lib/claide/mixins.rb
 homepage: https://github.com/CocoaPods/CLAide
 licenses:
 - MIT