cliutils 1.4.2 → 2.0.0

data/lib/cliutils/prefs/pref_validators/pref_validator.rb

@@ -0,0 +1,31 @@
+module CLIUtils
+  # The generic base class for a Pref
+  # Validator.
+  class PrefValidator
+    include Messaging
+
+    # Holds whether the validator returned
+    # successful or not.
+    # @return [Boolean]
+    attr_accessor :is_valid
+
+    # Holds the message to display to the
+    # user when the Validator fails.
+    # @return [String]
+    attr_accessor :message
+
+    # Holds a reference to the Pref that is
+    # applying this Validator.
+    # @return [Pref]
+    attr_accessor :pref
+
+    # Validate the Validator!
+    # @parameter [String] text
+    # @raise [StandardError] if the subclass
+    #   doesn't implement this method.
+    # @return [void]
+    def validate(text = nil)
+      fail "`validate` method not implemented on caller: #{ self.class }"
+    end
+  end
+end

data/lib/cliutils/prefs/pref_validators/time_validator.rb

@@ -0,0 +1,13 @@
+module CLIUtils
+  # A Validator to verify whether a Pref answer
+  # is a valid time.
+  class TimeValidator < PrefValidator
+    # Runs the Validator against the answer.
+    # @param [Object] text The "text" to evaluate
+    # @return [String]
+    def validate(text)
+      @is_valid = !(Time.parse(text) rescue nil).nil?
+      @message = "Response is not a time: #{ text }"
+    end
+  end
+end

data/lib/cliutils/prefs/pref_validators/url_validator.rb

@@ -0,0 +1,15 @@
+require 'uri'
+
+module CLIUtils
+  # A Validator to verify whether a Pref answer
+  # is a valid URL.
+  class UrlValidator < PrefValidator
+    # Runs the Validator against the answer.
+    # @param [Object] text The "text" to evaluate
+    # @return [String]
+    def validate(text)
+      @is_valid = text.to_s =~ URI::DEFAULT_PARSER.regexp[:ABS_URI]
+      @message = "Response is not a url: #{ text }"
+    end
+  end
+end

data/lib/cliutils/pretty_io.rb

@@ -48,118 +48,6 @@ module CLIUtils
       end
     end
 
-    # Empty method so that Messaging doesn't freak
-    # out when passed a debug message.
-    # @return [void]
-    def debug(m); end
-
-    # Outputs a formatted-red error message.
-    # @param [String] m The message to output
-    # @return [void]
-    def error(m)
-      puts _word_wrap(m, '# ').red
-    end
-
-    # Outputs a formatted-blue informational message.
-    # @param [String] m The message to output
-    # @return [void]
-    def info(m)
-      puts _word_wrap(m, '# ').blue
-    end
-
-    # Wraps a block in an opening and closing info message.
-    # @param [String] m1 The opening message to output
-    # @param [String] m2 The closing message to output
-    # @param [<True, False>] multiline Whether the message should be multiline
-    # @yield
-    # @return [void]
-    def info_block(m1, m2 = 'Done.', multiline = false)
-      if block_given?
-        if multiline
-          info(m1)
-        else
-          print _word_wrap(m1, '# ').blue
-        end
-
-        yield
-
-        if multiline
-          info(m2)
-        else
-          puts _word_wrap(m2, '# ').blue
-        end
-      else
-        fail 'Did not specify a valid block'
-      end
-    end
-
-    # Empty method so that Messaging doesn't freak
-    # out when passed a log message.
-    # @return [void]
-    def log(m); end
-
-    # Outputs a prompt, collects the user's response, and
-    # returns it.
-    # @param [String] prompt The prompt to output
-    # @param [String] default The default option
-    # @param [String] start_dir The directory to start from for autocompletion
-    # @return [String]
-    def prompt(prompt, default = nil, start_dir = '')
-      Readline.completion_append_character = nil
-      Readline.completion_proc = lambda do |prefix|
-        files = Dir["#{start_dir}#{prefix}*"]
-        files.map { |f| File.expand_path(f) }
-             .map { |f| File.directory?(f) ? "#{ f }/" : f }
-      end
-      p = "# #{ prompt }#{ default.nil? ? ':' : " [default: #{ default }]:" } "
-      choice = Readline.readline(p.cyan)
-      if choice.empty?
-        default
-      else
-        choice
-      end
-    end
-
-    # Outputs a formatted-purple section message.
-    # @param [String] m The message to output
-    # @return [void]
-    def section(m)
-      puts _word_wrap(m, '---> ').purple
-    end
-
-    # Wraps a block in an opening and closing section message.
-    # @param [String] m The opening message to output
-    # @param [<True, False>] multiline Whether the message should be multiline
-    # @yield
-    # @return [void]
-    def section_block(m, multiline = true)
-      if block_given?
-        if multiline
-          section(m)
-        else
-          print _word_wrap(m, '---> ').purple
-        end
-
-        yield
-      else
-        fail 'Did not specify a valid block'
-      end
-    end
-
-    # Outputs a formatted-green success message.
-    # @param [String] m The message to output
-    # @return [void]
-    def success(m)
-      puts _word_wrap(m, '# ').green
-    end
-
-    # Outputs a formatted-yellow warning message.
-    # @param [String] m The message to output
-    # @return [void]
-    def warn(m)
-      puts _word_wrap(m, '# ').yellow
-    end
-
     private
 
     # Outputs a wrapped string (where each line is limited

data/lib/cliutils.rb

@@ -11,6 +11,7 @@ require 'cliutils/messaging'
 require 'cliutils/prefs'
 require 'cliutils/prefs/pref'
 require 'cliutils/prefs/pref_actions/pref_action'
+require 'cliutils/prefs/pref_behaviors/pref_behavior'
 require 'cliutils/prefs/pref_validators/pref_validator'
 
 # The CLIUtils module, which wraps everything

data/test/configurator_test.rb

@@ -1,5 +1,5 @@
 require 'fileutils'
-require 'test/unit'
+require 'test_helper'
 
 require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/configurator')
 

data/test/hash_extensions_test.rb

@@ -1,4 +1,4 @@
-require 'test/unit'
+require 'test_helper'
 
 require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/ext/hash_extensions')
 

data/test/logger_extensions_test.rb

@@ -1,4 +1,4 @@
-require 'test/unit'
+require 'test_helper'
 
 require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/ext/logger_extensions')
 

data/test/messenging_test.rb

@@ -1,5 +1,5 @@
 require 'logger'
-require 'test/unit'
+require 'test_helper'
 
 require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/ext/string_extensions')
 require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/pretty_io')

data/test/prefs_test.rb

@@ -1,4 +1,4 @@
-require 'test/unit'
+require 'test_helper'
 require 'yaml'
 
 require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/ext/hash_extensions')

data/test/string_extesions_test.rb

@@ -1,4 +1,4 @@
-require 'test/unit'
+require 'test_helper'
 
 require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/ext/string_extensions')
 

data/test/test_files/prefstest.yaml

@@ -2,13 +2,33 @@ prompts:
   - prompt_text: What is the top story on espn.com?
     config_key: top_story
     config_section: app_data
-    # pre:
-    #   message: 'I will now open espn.com in your default browser.'
-    #   action: open_url
-    #   action_parameters:
-    #     - url: http://www.espn.com
-    # post:
-    #   message: 'Thanks for inputting!'
+    pre:
+      message: 'I will now open espn.com in your default browser.'
+      action:
+        name: open_url
+        parameters:
+          url: http://www.espn.com
+    post:
+      message: 'Thanks for inputting!'
     validators:
-      - non_nil
-      - alphabetic
+      # - alphabetic
+      # - alphanumeric
+      # - date
+      # - datetime
+      # - filepath_exists
+      # - non_nil
+      # - number
+      # - time
+      # - url
+    behaviors:
+      # - name: capitalize
+      # - name: expand_filepath
+      # - name: lowercase
+      # - name: prefix
+      #   parameters:
+      #     prefix: 'back'
+      # - name: suffix
+      #   parameters:
+      #     suffix: 'test'
+      # - name: titlecase
+      # - name: uppercase

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'test/unit'
+
+class Test::Unit::TestCase
+  require 'coveralls'
+  Coveralls.wear!
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cliutils
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Aaron Bach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-15 00:00:00.000000000 Z
+date: 2014-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,8 +95,24 @@ files:
 - lib/cliutils/prefs/pref.rb
 - lib/cliutils/prefs/pref_actions/open_url_action.rb
 - lib/cliutils/prefs/pref_actions/pref_action.rb
-- lib/cliutils/prefs/pref_behavior.rb
-- lib/cliutils/prefs/pref_validation.rb
+- lib/cliutils/prefs/pref_behaviors/capitalize_behavior.rb
+- lib/cliutils/prefs/pref_behaviors/expand_filepath_behavior.rb
+- lib/cliutils/prefs/pref_behaviors/lowercase_behavior.rb
+- lib/cliutils/prefs/pref_behaviors/pref_behavior.rb
+- lib/cliutils/prefs/pref_behaviors/prefix_behavior.rb
+- lib/cliutils/prefs/pref_behaviors/suffix_behavior.rb
+- lib/cliutils/prefs/pref_behaviors/titlecase_behavior.rb
+- lib/cliutils/prefs/pref_behaviors/uppercase_behavior.rb
+- lib/cliutils/prefs/pref_validators/alphabetic_validator.rb
+- lib/cliutils/prefs/pref_validators/alphanumeric_validator.rb
+- lib/cliutils/prefs/pref_validators/date_validator.rb
+- lib/cliutils/prefs/pref_validators/datetime_validator.rb
+- lib/cliutils/prefs/pref_validators/filepath_exists_validator.rb
+- lib/cliutils/prefs/pref_validators/non_nil_validator.rb
+- lib/cliutils/prefs/pref_validators/number_validator.rb
+- lib/cliutils/prefs/pref_validators/pref_validator.rb
+- lib/cliutils/prefs/pref_validators/time_validator.rb
+- lib/cliutils/prefs/pref_validators/url_validator.rb
 - lib/cliutils/pretty_io.rb
 - res/readme-images/actions-1.png
 - res/readme-images/actions-2.png
@@ -121,6 +137,7 @@ files:
 - test/prefs_test.rb
 - test/string_extesions_test.rb
 - test/test_files/prefstest.yaml
+- test/test_helper.rb
 homepage: http://www.bachyaproductions.com/cliutils-ruby-library-cli-apps/
 licenses:
 - MIT
@@ -153,4 +170,5 @@ test_files:
 - test/prefs_test.rb
 - test/string_extesions_test.rb
 - test/test_files/prefstest.yaml
+- test/test_helper.rb
 has_rdoc: 

data/lib/cliutils/prefs/pref_behavior.rb

@@ -1,58 +0,0 @@
-module CLIUtils
-  # PrefBehavior Module
-  # Behaviors that should be applied to a Pref's
-  # final value
-  module PrefBehavior
-    # Capitalizes the first word of the passed text.
-    # @param [String] args[0] The text to evaluate
-    # @return [String]
-    def self.capitalize(*args)
-      args[0].capitalize
-    end
-
-    # Expands the passed text (assumes it
-    # is a filepath).
-    # @param [String] args[0] The text to evaluate
-    # @return [String]
-    def self.expand_filepath(*args)
-      File.expand_path(args[0])
-    end
-
-    # Lowercases all characters in the passed text.
-    # @param [String] args[0] The text to evaluate
-    # @return [String]
-    def self.lowercase(*args)
-      args[0].downcase
-    end
-
-    # Adds a prefix to the passed text.
-    # @param [String] args[0] The text to evaluate
-    # @param [String] args[1] The prefix to add
-    # @return [String]
-    def self.prefix(*args)
-      args[1] + args[0]
-    end
-
-    # Adds a suffix to the passed text.
-    # @param [String] args[0] The text to evaluate
-    # @param [String] args[1] The suffix to add
-    # @return [String]
-    def self.suffix(*args)
-      args[0] + args[1]
-    end
-
-    # Capitalizes each word in the passed text.
-    # @param [String] args[0] The text to evaluate
-    # @return [String]
-    def self.titlecase(*args)
-      args[0].split.map(&:capitalize).join(' ')
-    end
-
-    # Uppercases all characters in the passed text.
-    # @param [String] args[0] The text to evaluate
-    # @return [String]
-    def self.uppercase(*args)
-      args[0].upcase
-    end
-  end
-end

data/lib/cliutils/prefs/pref_validation.rb

@@ -1,96 +0,0 @@
-require 'uri'
-
-module CLIUtils
-  # PrefValidation Module
-  # Validation rules that can be applied to a Pref.
-  module PrefValidation
-    # Struct to contain a validation result
-    # and a result message.
-    Validator = Struct.new(:code, :message)
-
-    # Validates that a value is only letters
-    # and spaces.
-    # @param [String] text The text to inspect
-    # @return [Boolean]
-    def self.alphabetic(text)
-      m = "Response is not alphabetic: #{ text }"
-      c = text.to_s =~ /\A[A-Za-z\s]+\z/
-      Validator.new(c, m)
-    end
-
-    # Validates that a value is only letters, numbers
-    # and spaces.
-    # @param [String] text The text to inspect
-    # @return [Boolean]
-    def self.alphanumeric(text)
-      m = "Response is not alphanumeric: #{ text }"
-      c = text.to_s =~ /\A[A-Za-z0-9\s]+\z/
-      Validator.new(c, m)
-    end
-
-    # Validates that a value is a date.
-    # @param [String] text The text to inspect
-    # @return [Boolean]
-    def self.date(text)
-      m = "Response is not a date: #{ text }"
-      c = !(Date.parse(text) rescue nil).nil?
-      Validator.new(c, m)
-    end
-
-    # Validates that a value is a datetime.
-    # @param [String] text The text to inspect
-    # @return [Boolean]
-    def self.datetime(text)
-      m = "Response is not a datetime: #{ text }"
-      c = !(DateTime.parse(text) rescue nil).nil?
-      Validator.new(c, m)
-    end
-
-    # Validates that a value is passed and is not
-    # empty.
-    # @param [String] text The text to inspect
-    # @return [Boolean]
-    def self.non_nil(text)
-      m = 'Nil text not allowed'
-      c = !text.nil? && !text.empty?
-      Validator.new(c, m)
-    end
-
-    # Validates that a value is some sort of number.
-    # @param [String] text The text to inspect
-    # @return [Boolean]
-    def self.number(text)
-      m = "Response is not a number: #{ text }"
-      c = text.to_s =~ /\A[-+]?\d*\.?\d+\z/
-      Validator.new(c, m)
-    end
-
-    # Validates that a filepath exists on the
-    # local filesystem.
-    # @param [String] text The text to inspect
-    # @return [Boolean]
-    def self.filepath_exists(text)
-      m = "Path does not exist locally: #{ text }"
-      c = Pathname.new(text).exist?
-      Validator.new(c, m)
-    end
-
-    # Validates that a value is a time.
-    # @param [String] text The text to inspect
-    # @return [Boolean]
-    def self.time(text)
-      m = "Response is not a time: #{ text }"
-      c = !(Time.parse(text) rescue nil).nil?
-      Validator.new(c, m)
-    end
-
-    # Validates that passed value is a URL.
-    # @param [String] text The text to inspect
-    # @return [Boolean]
-    def self.url(text)
-      m = "Response is not a url: #{ text }"
-      c = text.to_s =~ URI::DEFAULT_PARSER.regexp[:ABS_URI]
-      Validator.new(c, m)
-    end
-  end
-end