claide 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc7d7f59268bec92fc656c3999c983c819b16b74
-  data.tar.gz: c1b9b2bce23334941e832dee7aa7f19a7ebb85c0
+  metadata.gz: c401c5a5be0c7e2652c31c9cc82a46dca6a8b4b2
+  data.tar.gz: 76dc8118415015daf186720e9c188f86bd37c512
 SHA512:
-  metadata.gz: 171f3513817794fea26279c20f65a9d8cf71ab03edce821e428b86e363ebb75f69de418097c8a67a3415cd755b26f867e7c0b626944cc9c7a590e07a69b944ce
-  data.tar.gz: 1949a384b568d4fa1722696827dc66059b3641dc932bdff88ec57721ca48434c15ad7920efbbd632eb8df74f09b1d7373a72b95fce5570aff52f20c0910def64
+  metadata.gz: 0b38f9c3ef3e9a08dc2b6f52002aa928e48216f3b1fe3997d1613499c1f1716566e6f865a498c4f2e3854aaf4db9e2308a5b02549d884fd115ec5477da7a1077
+  data.tar.gz: 636d2249e8aacb1a0cfe05f88131c7aa46b4fb9904c45075ad51647c5f801442ac7ed312b0b58eefc8997089dd233f130ea125956d32c4af088197d420d65ae5

data/lib/claide.rb

@@ -8,7 +8,7 @@ module CLAide
   #
   #   CLAide’s version, following [semver](http://semver.org).
   #
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'
 
   require 'claide/ansi'
   require 'claide/argv'

data/lib/claide/ansi/graphics.rb

@@ -39,7 +39,7 @@ module CLAide
       # @return [String] The escape sequence for a foreground color using the
       #         xterm-256 format.
       #
-      # @param  [Fixnum] key
+      # @param  [Fixnum] color
       #         The value of the color.
       #
       def self.foreground_color_256(color)
@@ -50,7 +50,7 @@ module CLAide
       # @return [String] The escape sequence for a background color using the
       #         xterm-256 format.
       #
-      # @param  [Fixnum] key
+      # @param  [Fixnum] color
       #         The value of the color.
       #
       def self.background_color_256(color)

data/lib/claide/ansi/string_escaper.rb

@@ -6,7 +6,7 @@ module CLAide
     # `ANSI.disabled` setting.
     #
     class StringEscaper < String
-      # @param  [String] The string to wrap.
+      # @param  [String] string The string to wrap.
       #
       def initialize(string)
         super

data/lib/claide/command.rb

@@ -89,27 +89,28 @@ module CLAide
       #
       attr_accessor :plugin_prefix
 
-      # @return [Array<Tuple>] A list of arguments the command handles. This
-      #         is shown in the usage section of the command’s help banner.
-      #         Each tuple in the array represents an argument using
-      #         [name, type] where:
+      # @return [Array<Array<String,Symbol>>]
+      #         A list of arguments the command handles. This is shown
+      #         in the usage section of the command’s help banner.
+      #         Each Array<String,Symbol> tuple in the array represents an
+      #         argument using the form [name, type] where:
       #          - name is a String containing the argument
       #          - type is either :optional or :required
       #
-      # @TODO   Remove deprecation
+      # @todo   Remove deprecation
       #
-      # rubocop:disable all
       attr_accessor :arguments
       def arguments
         @arguments ||= []
       end
 
-      # @param [Array<Tuple>] arguments
+      # @param [Array<Array<String,Symbol>>] arguments
       #        An array containing arguments, each described by a tuple of
       #        the form [name, type], where:
       #          - name is a String containing the argument
       #          - type is either :optional or :required
       #
+      # rubocop:disable MethodLength
       def arguments=(arguments)
         if arguments.is_a?(Array)
           @arguments = arguments
@@ -125,7 +126,7 @@ module CLAide
           end
         end
       end
-      # rubocop:enable all
+      # rubocop:enable MethodLength
 
       # @return [Boolean] The default value for {Command#ansi_output}. This
       #         defaults to `true` if `STDOUT` is connected to a TTY and
@@ -274,8 +275,8 @@ module CLAide
       PluginsHelper.load_plugins(plugin_prefix)
       command = parse(argv)
 
+      ANSI.disabled = !command.ansi_output?
       unless Options.handle_root_option(command, argv)
-        ANSI.disabled = !ansi_output?
         command.validate!
         command.run
       end
@@ -351,9 +352,6 @@ module CLAide
     #
     # Returns the banner for the command.
     #
-    # @param  [Boolean] ansi
-    #         Whether the banner should use ANSI codes to prettify output.
-    #
     # @param  [Class] banner_class
     #         The class to use to format help banners.
     #

data/lib/claide/command/banner.rb

@@ -27,7 +27,7 @@ module CLAide
           ['Options',  formatted_options_description]
         ]
         banner = sections.map do |(title, body)|
-          ["#{prettify_title(title)}:", body] unless body.empty?
+          [prettify_title("#{title}:"), body] unless body.empty?
         end.compact.join("\n\n")
         banner
       end

data/lib/claide/command/shell_completion_helper/zsh_completion_generator.rb

@@ -32,7 +32,7 @@ module CLAide
         # @param  [Class] command
         #         The command to generate the fragment for.
         #
-        # @param  [Fixnum] nesting_level
+        # @param  [Fixnum] nest_level
         #         The nesting level to detect the index of the words array.
         #
         # @return [String] the case statement fragment.
@@ -82,7 +82,7 @@ module CLAide
         # @param  [Class] command
         #         The command to generate the fragment for.
         #
-        # @param  [Fixnum] nesting_level
+        # @param  [Fixnum] nest_level
         #         The nesting level to detect the index of the words array.
         #
         # @return [String] the case statement fragment.

data/lib/claide/command/validation_helper.rb

@@ -63,7 +63,7 @@ module CLAide
       # @param  [String] suggestion
       #         The suggestion to prettify.
       #
-      # @param  [Type]
+      # @param  [Type] type
       #         The type of the suggestion: either `:command` or `:option`.
       #
       # @return [String] A handsome suggestion.

data/lib/claide/help.rb

@@ -33,7 +33,7 @@ module CLAide
     end
 
     # @return [String] The optional error message, colored in red if
-    #         {Command.colorize_output} is set to `true`.
+    #         {Command.ansi_output} is set to `true`.
     #
     def formatted_error_message
       if error_message

data/lib/claide/informative_error.rb

@@ -5,7 +5,7 @@ module CLAide
   # while running {Command.run}, only the message of the exception will be
   # shown to the user. Unless disabled with the `--verbose` flag.
   #
-  # In addition, the message will be colored red, if {Command.colorize_output}
+  # In addition, the message will be colored red, if {Command.ansi_output}
   # is set to `true`.
   #
   module InformativeError

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: claide
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Eloy Duran
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-19 00:00:00.000000000 Z
+date: 2014-05-20 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: