claide 0.7.0 → 0.8.0

data/lib/claide/command/banner.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 
-require 'claide/command/banner/prettifier'
-
 module CLAide
   class Command
     # Creates the formatted banner to present as help of the provided command
@@ -57,7 +55,9 @@ module CLAide
       #
       def formatted_usage_description
         message = command.description || command.summary || ''
-        message = Helper.format_markdown(message, TEXT_INDENT, MAX_WIDTH)
+        message = TextWrapper.wrap_formatted_text(message,
+                                                  TEXT_INDENT,
+                                                  MAX_WIDTH)
         message = prettify_message(command, message)
         "#{signature}\n\n#{message}"
       end
@@ -128,7 +128,9 @@ module CLAide
         result << name
         result << ' ' * DESCRIPTION_SPACES
         result << ' ' * (max_name_width - name_width)
-        result << Helper.wrap_with_indent(description, desc_start, MAX_WIDTH)
+        result << TextWrapper.wrap_with_indent(description,
+                                               desc_start,
+                                               MAX_WIDTH)
       end
 
       # @!group Overrides
@@ -137,33 +139,50 @@ module CLAide
       # @return [String] A decorated title.
       #
       def prettify_title(title)
-        Prettifier.prettify_title(title)
-      end
-
-      # @return [String] A decorated textual representation of the command.
-      #
-      def prettify_signature(command, subcommand, argument)
-        Prettifier.prettify_signature(command, subcommand, argument)
-      end
-
-      # @return [String] A decorated command description.
-      #
-      def prettify_message(command, message)
-        Prettifier.prettify_message(command, message)
+        title.ansi.underline
       end
 
       # @return [String] A decorated textual representation of the subcommand
       #         name.
       #
       def prettify_subcommand(name)
-        Prettifier.prettify_subcommand(name)
+        name.chomp.ansi.green
       end
 
       # @return [String] A decorated textual representation of the option name.
       #
       #
       def prettify_option_name(name)
-        Prettifier.prettify_option_name(name)
+        name.chomp.ansi.blue
+      end
+
+      # @return [String] A decorated textual representation of the command.
+      #
+      def prettify_signature(command, subcommand, argument)
+        components = [
+          [command, :green],
+          [subcommand, :green],
+          [argument, :magenta],
+        ]
+        components.reduce('') do |memo, (string, ansi_key)|
+          next memo if !string || string.empty?
+          memo << ' ' << string.ansi.apply(ansi_key)
+        end.lstrip
+      end
+
+      # @return [String] A decorated command description.
+      #
+      def prettify_message(command, message)
+        message = message.dup
+        command.arguments.each do |arg|
+          arg.names.each do |name|
+            message.gsub!("`#{name.gsub(/\.{3}$/, '')}`", '\0'.ansi.magenta)
+          end
+        end
+        command.options.each do |(name, _description)|
+          message.gsub!("`#{name}`", '\0'.ansi.blue)
+        end
+        message
       end
 
       # @!group Private helpers
@@ -189,6 +208,95 @@ module CLAide
         end.max
         widths.flatten.compact.max || 1
       end
+
+      module TextWrapper
+        # @return [String] Wraps a formatted string (e.g. markdown) 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 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.wrap_formatted_text(string, indent = 0, max_width = 80)
+          paragraphs = strip_heredoc(string).split("\n\n")
+          paragraphs = paragraphs.map do |paragraph|
+            if paragraph.start_with?(' ' * 4)
+              paragraph.gsub!(/\n/, "\n#{' ' * indent}")
+            else
+              paragraph = wrap_with_indent(paragraph, 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
+
+          full_line = string.gsub("\n", ' ')
+          available_width = width - indent
+          space = ' ' * indent
+          word_wrap(full_line, 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
+
+        # @!group Private helpers
+        #---------------------------------------------------------------------#
+
+        # @return [Fixnum] The width of the current terminal unless being piped.
+        #
+        def self.terminal_width
+          unless @terminal_width
+            if !ENV['CLAIDE_DISABLE_AUTO_WRAP'] &&
+                STDOUT.tty? && system('which tput > /dev/null 2>&1')
+              @terminal_width = `tput cols`.to_i
+            else
+              @terminal_width = 0
+            end
+          end
+          @terminal_width
+        end
+      end
     end
   end
 end

data/lib/claide/command/{plugins_helper.rb → plugin_manager.rb}

@@ -12,12 +12,12 @@ module CLAide
     # `lib/#{plugin_prefix}_plugin` relative path.
     # - Be stored in a folder named after the plugin.
     #
-    class PluginsHelper
-      class << self
-        # @return [Array<Pathname>] The list of the root directories of the
-        #         loaded plugins.
-        #
-        attr_reader :plugin_paths
+    class PluginManager
+      # @return [Array<Pathname>] The list of the root directories of the
+      #         loaded plugins.
+      #
+      def self.plugin_paths
+        @plugin_paths ||= {}
       end
 
       # @return [Array<String>] Loads plugins via RubyGems looking for files
@@ -25,36 +25,36 @@ module CLAide
       #         the gems loaded successfully. Plugins are required safely.
       #
       def self.load_plugins(plugin_prefix)
-        return if plugin_paths
-        paths = PluginsHelper.plugin_load_paths(plugin_prefix)
-        plugin_paths = []
-        paths.each do |path|
-          if PluginsHelper.safe_require(path.to_s)
-            plugin_paths << Pathname(path + './../../').cleanpath
+        return if plugin_paths[plugin_prefix]
+
+        loaded_paths = []
+        plugin_load_paths(plugin_prefix).each do |path|
+          if safe_require(path.to_s)
+            loaded_paths << Pathname(path + './../../').cleanpath
           end
         end
 
-        @plugin_paths = plugin_paths
+        plugin_paths[plugin_prefix] = loaded_paths
       end
 
       # @return [Array<Specification>] The RubyGems specifications for the
       #         loaded plugins.
       #
       def self.specifications
-        PluginsHelper.plugin_paths.map do |path|
+        plugin_paths.values.flatten.map do |path|
           specification(path)
         end.compact
       end
 
-      # @return [Array<Specification>] The RubyGems specifications for the
-      #         plugin with the given root path.
+      # @return [Specification] The RubyGems specification for the plugin at the
+      #         given path.
       #
       # @param  [#to_s] path
       #         The root path of the plugin.
       #
       def self.specification(path)
-        glob = Dir.glob("#{path}/*.gemspec")
-        spec = Gem::Specification.load(glob.first) if glob.count == 1
+        matches = Dir.glob("#{path}/*.gemspec")
+        spec = Gem::Specification.load(matches.first) if matches.count == 1
         unless spec
           warn '[!] Unable to load a specification for the plugin ' \
             "`#{path}`".ansi.yellow
@@ -69,7 +69,7 @@ module CLAide
       #         The exception to analyze.
       #
       def self.plugins_involved_in_exception(exception)
-        paths = plugin_paths.select do |plugin_path|
+        paths = plugin_paths.values.flatten.select do |plugin_path|
           exception.backtrace.any? { |line| line.include?(plugin_path.to_s) }
         end
         paths.map { |path| path.to_s.split('/').last }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: claide
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Eloy Duran
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-11 00:00:00.000000000 Z
+date: 2014-12-25 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -24,21 +24,13 @@ files:
 - lib/claide/ansi/string_escaper.rb
 - lib/claide/ansi.rb
 - lib/claide/argument.rb
-- lib/claide/argv/parser.rb
 - lib/claide/argv.rb
-- lib/claide/command/banner/prettifier.rb
+- lib/claide/command/argument_suggester.rb
 - lib/claide/command/banner.rb
-- lib/claide/command/options.rb
-- lib/claide/command/parser.rb
-- lib/claide/command/plugins_helper.rb
-- lib/claide/command/shell_completion_helper/zsh_completion_generator.rb
-- lib/claide/command/shell_completion_helper.rb
-- lib/claide/command/validation_helper.rb
+- lib/claide/command/plugin_manager.rb
 - lib/claide/command.rb
 - lib/claide/help.rb
-- lib/claide/helper.rb
 - lib/claide/informative_error.rb
-- lib/claide/mixins.rb
 - lib/claide.rb
 - README.markdown
 - LICENSE
@@ -67,4 +59,3 @@ signing_key:
 specification_version: 3
 summary: A small command-line interface framework.
 test_files: []
-has_rdoc: 

data/lib/claide/argv/parser.rb

@@ -1,83 +0,0 @@
-module CLAide
-  class ARGV
-    module Parser
-      # @return [Array<Array<Symbol, String, Array>>] A list of tuples for each
-      #         parameter, where the first entry is the `type` and the second
-      #         entry the actual parsed parameter.
-      #
-      # @example
-      #
-      #   list = parse(['tea', '--no-milk', '--sweetner=honey'])
-      #   list # => [[:arg, "tea"],
-      #              [:flag, ["milk", false]],
-      #              [:option, ["sweetner", "honey"]]]
-      #
-      def self.parse(argv)
-        entries = []
-        copy = argv.map(&:to_s)
-        while argument = copy.shift
-          type = argument_type(argument)
-          parameter = argument_parameter(type, argument)
-          entries << [type, parameter]
-        end
-        entries
-      end
-
-      # @return [Symbol] Returns the type of an argument. The types can be
-      #         either: `:arg`, `:flag`, `:option`.
-      #
-      # @param  [String] argument
-      #         The argument to check.
-      #
-      def self.argument_type(argument)
-        if argument.start_with?('--')
-          if argument.include?('=')
-            :option
-          else
-            :flag
-          end
-        else
-          :arg
-        end
-      end
-
-      # @return [String, Array<String, String>] Returns argument itself for
-      #         normal arguments (like commands) and a tuple with they key and
-      #         the value for options and flags.
-      #
-      # @param  [Symbol] type
-      #         The type of the argument.
-      #
-      # @param  [String] argument
-      #         The argument to check.
-      #
-      def self.argument_parameter(type, argument)
-        case type
-        when :arg
-          return argument
-        when :flag
-          return flag_paramenter(argument)
-        when :option
-          return argument[2..-1].split('=', 2)
-        end
-      end
-
-      # @return [String, Array<String, String>] Returns the parameter
-      #         describing a flag arguments.
-      #
-      # @param  [String] argument
-      #         The flag argument to check.
-      #
-      def self.flag_paramenter(argument)
-        if argument.start_with?('--no-')
-          key = argument[5..-1]
-          value = false
-        else
-          key = argument[2..-1]
-          value = true
-        end
-        [key, value]
-      end
-    end
-  end
-end

data/lib/claide/command/banner/prettifier.rb

@@ -1,61 +0,0 @@
-# encoding: utf-8
-
-module CLAide
-  class Command
-    class Banner
-      # Implements the default logic to prettify the Banner.
-      #
-      module Prettifier
-        # @return [String] A decorated title.
-        #
-        def self.prettify_title(title)
-          title.ansi.underline
-        end
-
-        # @return [String] A decorated textual representation of the command.
-        #
-        def self.prettify_signature(command, subcommand, argument)
-          components = [
-            [command, :green],
-            [subcommand, :green],
-            [argument, :magenta],
-          ]
-          components.reduce('') do |memo, (string, ansi_key)|
-            next memo if !string || string.empty?
-            memo << ' ' << string.ansi.apply(ansi_key)
-          end.lstrip
-        end
-
-        # @return [String] A decorated command description.
-        #
-        def self.prettify_message(command, message)
-          message = message.dup
-          command.arguments.each do |arg|
-            arg.names.each do |name|
-              message.gsub!("`#{name.gsub(/\.{3}$/, '')}`", '\0'.ansi.magenta)
-            end
-          end
-          command.options.each do |(name, _description)|
-            message.gsub!("`#{name}`", '\0'.ansi.blue)
-          end
-          message
-        end
-
-        # @return [String] A decorated textual representation of the subcommand
-        #         name.
-        #
-        def self.prettify_subcommand(name)
-          name.chomp.ansi.green
-        end
-
-        # @return [String] A decorated textual representation of the option
-        #         name.
-        #
-        #
-        def self.prettify_option_name(name)
-          name.chomp.ansi.blue
-        end
-      end
-    end
-  end
-end