tty 0.0.11 → 0.1.0

data/lib/tty/coercer/range.rb

@@ -1,17 +1,18 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Coercer
-
     # A class responsible for range type coercion
     class Range
-
       # Coerce value to Range type with possible ranges
       #
       # @param [Object] value
       #
       # @example
-      #   coerce('0-9') # => (0..9)
+      #   coerce('0,9')  # => (0..9)
+      #
+      # @example
+      #   coerce('0-9')  # => (0..9)
       #
       # @api public
       def self.coerce(value)
@@ -23,11 +24,9 @@ module TTY
         when /\A(\w)(\.{2}\.?|-|,)(\w)\Z/
           ::Range.new($1.to_s, $3.to_s, $2 == '...')
         else
-          raise InvalidArgument, "#{value} could not be coerced into Range type"
+          fail InvalidArgument, "#{value} could not be coerced into Range type"
         end
       end
-
     end # Range
-
   end # Coercer
 end # TTY

data/lib/tty/logger.rb

@@ -1,7 +1,6 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
-
   # A class providing logging system
   class Logger
     include TTY::Equatable
@@ -33,8 +32,10 @@ module TTY
     # @option options [String] :output
     #
     # @api public
-    def initialize(options={})
-      @namespace = options.fetch(:namespace) { raise ArgumentError, "Logger must have namespace", caller }
+    def initialize(options = {})
+      @namespace = options.fetch(:namespace) do
+        fail ArgumentError, 'Logger must have namespace', caller
+      end
       @output = options.fetch(:output) { $stderr }
       @level  = options.fetch(:level) { ALL }
       @timestamp_format = options.fetch(:timestamp_format) { '%Y-%m-%d %T' }
@@ -45,27 +46,40 @@ module TTY
       @level = level
     end
 
+    # Create a timestamp
+    #
+    # @return [Time]
+    #
     # @api public
     def timestamp
       Time.now.strftime(timestamp_format)
     end
 
     def validate_level(level)
-      unless valid_level?(level)
-        raise ArgumentError, "Log level must be 0..#{MAX_LEVELS}", caller
-      end
+      return if valid_level?(level)
+      fail ArgumentError, "Log level must be 0..#{MAX_LEVELS}", caller
     end
 
+    # Verify valid level
+    #
+    # @param [Number] level
+    #   the level of this logger
+    #
+    # @return [Boolean]
+    #
+    # @api public
     def self.valid_level?(level)
-      !level.nil? && level.kind_of?(Numeric) && level >= ALL && level <= OFF
+      !level.nil? && level.is_a?(Numeric) && level >= ALL && level <= OFF
     end
 
     # Print formatted log to output
     #
+    # @param [String] message
+    #   the message to print to output
+    #
     # @api public
     def log(message)
       output.print timestamp + ' - ' + message
     end
-
   end # Logger
 end # TTY

data/lib/tty/plugins.rb

@@ -1,10 +1,8 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
-
   # A class responsible for managing plugins installation
   class Plugins
-
     PLUGIN_PREFIX = 'tty'
 
     attr_accessor :plugins
@@ -33,7 +31,7 @@ module TTY
     # @param [TTY::Plugin] plugin
     #
     # @api public
-    def register(name, plugin=false)
+    def register(name, plugin = false)
       if plugin && !loaded?(name)
         plugins << plugin
       end
@@ -56,7 +54,7 @@ module TTY
     #
     # @api public
     def names
-      plugins.inject(Hash.new) do |hash, plugin|
+      plugins.reduce({}) do |hash, plugin|
         hash[plugin.name] = plugin
         hash
       end
@@ -70,6 +68,5 @@ module TTY
     def loaded?(name)
       plugins.any? { |plugin| plugin.gem_name == name }
     end
-
   end # PluginManager
 end # TTY

data/lib/tty/plugins/plugin.rb

@@ -1,10 +1,8 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
-
   # A class responsible for plugin loading
   class Plugin
-
     attr_reader :name
 
     attr_reader :gem
@@ -35,7 +33,7 @@ module TTY
     #
     # @api public
     def enabled?
-      !!enabled
+      enabled
     end
 
     # Load the plugin (require the gem)
@@ -45,12 +43,11 @@ module TTY
       begin
         require gem_name unless enabled?
       rescue LoadError => error
-        TTY.shell.error("Unable to load plugin #{gem_name}.")
+        TTY.shell.error("Unable to load plugin #{gem_name} due to #{error}.")
       rescue => error
         TTY.shell.error("require '#{gem_name}' failed with #{error}")
       end
-      self.enabled = true
+      @enabled = true
     end
-
   end # Plugin
 end # TTY

data/lib/tty/shell.rb

@@ -1,23 +1,23 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
-
   # A class responsible for shell prompt interactions.
   class Shell
-
     # @api private
     attr_reader :input
 
     # @api private
     attr_reader :output
 
+    # Shell prompt prefix
+    #
     # @api private
     attr_reader :prefix
 
     # Initialize a Shell
     #
     # @api public
-    def initialize(input=stdin, output=stdout, options={})
+    def initialize(input = stdin, output = stdout, options = {})
       @input  = input
       @output = output
       @prefix = options.fetch(:prefix) { '' }
@@ -48,7 +48,7 @@ module TTY
       question.prompt(statement)
     end
 
-    # A shortcut method to ask the user positive question and return 
+    # A shortcut method to ask the user positive question and return
     # true for 'yes' reply.
     #
     # @return [Boolean]
@@ -79,7 +79,7 @@ module TTY
     # @return [String]
     #
     # @api public
-    def say(message="", options={})
+    def say(message = '', options = {})
       message = message.to_str
       return unless message.length > 0
 
@@ -100,14 +100,14 @@ module TTY
     # @api public
     def confirm(*args)
       options = Utils.extract_options!(args)
-      args.each { |message| say message, options.merge(:color => :green) }
+      args.each { |message| say message, options.merge(color: :green) }
     end
 
     # Print statement(s) out in yellow color.
     #
     # @example
     #   shell.warn "This action can have dire consequences"
-    #   shell.warn "Carefull young apprentice", "This is potentially dangerous."
+    #   shell.warn "Carefull young apprentice", "This is potentially dangerous"
     #
     # @param [Array] messages
     #
@@ -116,7 +116,7 @@ module TTY
     # @api public
     def warn(*args)
       options = Utils.extract_options!(args)
-      args.each { |message| say message, options.merge(:color => :yellow) }
+      args.each { |message| say message, options.merge(color: :yellow) }
     end
 
     # Print statement(s) out in red color.
@@ -132,7 +132,7 @@ module TTY
     # @api public
     def error(*args)
       options = Utils.extract_options!(args)
-      args.each { |message| say message, options.merge(:color => :red) }
+      args.each { |message| say message, options.merge(color: :red) }
     end
 
     # Takes the string provided by the user and compare it with other possible
@@ -157,7 +157,7 @@ module TTY
     # @return [String]
     #
     # @api public
-    def suggest(message, possibilities, options={})
+    def suggest(message, possibilities, options = {})
       suggestion = Suggestion.new(options)
       say(suggestion.suggest(message, possibilities))
     end
@@ -187,17 +187,25 @@ module TTY
       stdout.tty?
     end
 
+    # Return standard in
+    #
+    # @api private
     def stdin
       $stdin
     end
 
+    # Return standard out
+    #
+    # @api private
     def stdout
       $stdout
     end
 
+    # Return standard error
+    #
+    # @api private
     def stderr
       $stderr
     end
-
   end # Shell
 end # TTY

data/lib/tty/shell/question.rb

@@ -1,18 +1,17 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 require 'date'
 
 module TTY
   # A class responsible for shell prompt interactions.
   class Shell
-
-    # A class representing a question.
+    # A class representing a command line question
     class Question
       include TTY::Shell::ResponseDelegation
 
-      PREFIX          = " + "
-      MULTIPLE_PREFIX = "   * "
-      ERROR_PREFIX    = "  ERROR:"
+      PREFIX          = ' + '
+      MULTIPLE_PREFIX = '   * '
+      ERROR_PREFIX    = '  ERROR:'
 
       # Store statement.
       #
@@ -41,16 +40,6 @@ module TTY
 
       attr_reader :error
 
-      # Returns echo mode
-      #
-      # @api public
-      attr_reader :echo
-
-      # Returns character mask
-      #
-      # @api public
-      attr_reader :mask
-
       # Returns character mode
       #
       # @api public
@@ -63,16 +52,18 @@ module TTY
       # Initialize a Question
       #
       # @api public
-      def initialize(shell, options={})
-        @shell        = shell || Shell.new
-        @required     = options.fetch(:required) { false }
-        @echo         = options.fetch(:echo) { true }
-        @mask         = options.fetch(:mask) { false  }
-        @character    = options.fetch(:character) { false }
-        @in           = options.fetch(:in) { false }
-        @modifier     = Modifier.new options.fetch(:modifier) { [] }
-        @valid_values = options.fetch(:valid) { [] }
-        @validation   = Validation.new options.fetch(:validation) { nil }
+      def initialize(shell, options = {})
+        @shell         = shell || Shell.new
+        @required      = options.fetch(:required) { false }
+        @echo          = options.fetch(:echo) { true }
+        @mask          = options.fetch(:mask) { false  }
+        @character     = options.fetch(:character) { false }
+        @in            = options.fetch(:in) { false }
+        @modifier      = Modifier.new options.fetch(:modifier) { [] }
+        @valid_values  = options.fetch(:valid) { [] }
+        @validation    = Validation.new options.fetch(:validation) { nil }
+        @default_value = nil
+        @error         = false
       end
 
       # Set a new prompt
@@ -81,6 +72,7 @@ module TTY
       #
       # @return [self]
       #
+      # @api public
       def prompt(message)
         self.statement = message
         shell.say shell.prefix + statement
@@ -91,7 +83,7 @@ module TTY
       #
       # @api public
       def default(value)
-        return self if value == ""
+        return self if value == ''
         @default_value = value
         self
       end
@@ -136,7 +128,7 @@ module TTY
       # @return [Question]
       #
       # @api public
-      def validate(value=nil, &block)
+      def validate(value = nil, &block)
         @validation = Validation.new(value || block)
         self
       end
@@ -176,7 +168,7 @@ module TTY
       # Setup behaviour when error(s) occur
       #
       # @api public
-      def on_error(action=nil)
+      def on_error(action = nil)
         @error = action
         self
       end
@@ -192,8 +184,8 @@ module TTY
       # that the entered characters are not echoed back to the screen.
       #
       # @api public
-      def echo(value=(not_set=true))
-        return @echo if not_set
+      def echo(value = nil)
+        return @echo if value.nil?
         @echo = value
         self
       end
@@ -212,9 +204,9 @@ module TTY
       # @return [self]
       #
       # @api public
-      def mask(character=(not_set=true))
-        return @mask if not_set
-        @mask = character
+      def mask(char = nil)
+        return @mask if char.nil?
+        @mask = char
         self
       end
 
@@ -234,8 +226,8 @@ module TTY
       # @return [self]
       #
       # @api public
-      def character(value=(not_set=true))
-        return @character if not_set
+      def char(value = nil)
+        return @character if value.nil?
         @character = value
         self
       end
@@ -254,8 +246,8 @@ module TTY
       # @param [String] value
       #
       # @api public
-      def in(value=(not_set=true))
-        return @in if not_set
+      def in(value = nil)
+        return @in if value.nil?
         @in = TTY::Coercer::Range.coerce value
         self
       end
@@ -278,13 +270,13 @@ module TTY
       # @api private
       def evaluate_response(value)
         return default_value if !value && default?
+        check_required(value)
+        return if value.nil?
 
-        check_required value
-        return         if value.nil?
-        check_valid    value unless valid_values.empty?
-        within?        value
-        validation.valid_value? value
-        modifier.apply_to value
+        check_valid(value) unless valid_values.empty?
+        within?(value)
+        validation.valid_value?(value)
+        modifier.apply_to(value)
       end
 
       private
@@ -294,7 +286,7 @@ module TTY
       # @api private
       def check_required(value)
         if required? && !default? && value.nil?
-          raise ArgumentRequired, 'No value provided for required'
+          fail ArgumentRequired, 'No value provided for required'
         end
       end
 
@@ -304,7 +296,8 @@ module TTY
       def check_valid(value)
         if Array(value).all? { |val| valid_values.include? val }
           return value
-        else raise InvalidArgument, "Valid values are: #{valid_values.join(', ')}"
+        else
+          fail InvalidArgument, "Valid values are: #{valid_values.join(', ')}"
         end
       end
 
@@ -314,11 +307,11 @@ module TTY
       def within?(value)
         if in? && value
           if @in.include?(value)
-          else raise InvalidArgument, "Value #{value} is not included in the range #{@in}"
+          else
+            fail InvalidArgument, "Value #{value} is not included in the range #{@in}"
           end
         end
       end
-
     end # Question
   end # Shell
 end # TTY