cliutils 2.1.4 → 2.2.0

data/spec/validator/date_validator_spec.rb

@@ -0,0 +1,20 @@
+require_relative '../spec_helper'
+require 'cliutils/messaging'
+require 'cliutils/prefs/pref_validators/pref_validator'
+require 'cliutils/prefs/pref_validators/date_validator'
+
+describe CLIUtils::DateValidator do
+  it 'confirms that its input is a date' do
+    v = CLIUtils::DateValidator.new
+    v.validate('2014-02-01')
+    expect(v.is_valid).to be_true
+    expect(v.message).to eq('Response is not a date: 2014-02-01')
+  end
+
+  it 'confirms that its input is not a date' do
+    v = CLIUtils::DateValidator.new
+    v.validate('!@&^')
+    expect(v.is_valid).to_not be_true
+    expect(v.message).to eq('Response is not a date: !@&^')
+  end
+end

data/spec/validator/datetime_validator_spec.rb

@@ -0,0 +1,20 @@
+require_relative '../spec_helper'
+require 'cliutils/messaging'
+require 'cliutils/prefs/pref_validators/pref_validator'
+require 'cliutils/prefs/pref_validators/datetime_validator'
+
+describe CLIUtils::DatetimeValidator do
+  it 'confirms that its input is a datetime' do
+    v = CLIUtils::DatetimeValidator.new
+    v.validate('2014-02-01 12:34 PM')
+    expect(v.is_valid).to be_true
+    expect(v.message).to eq('Response is not a datetime: 2014-02-01 12:34 PM')
+  end
+
+  it 'confirms that its input is not a datetime' do
+    v = CLIUtils::DatetimeValidator.new
+    v.validate('!@&^')
+    expect(v.is_valid).to_not be_true
+    expect(v.message).to eq('Response is not a datetime: !@&^')
+  end
+end

data/spec/validator/filepath_exists_validator_spec.rb

@@ -0,0 +1,20 @@
+require_relative '../spec_helper'
+require 'cliutils/messaging'
+require 'cliutils/prefs/pref_validators/pref_validator'
+require 'cliutils/prefs/pref_validators/filepath_exists_validator'
+
+describe CLIUtils::FilepathExistsValidator do
+  it 'confirms that its input is an existing filepath' do
+    v = CLIUtils::FilepathExistsValidator.new
+    v.validate('/tmp')
+    expect(v.is_valid).to be_true
+    expect(v.message).to eq('Path does not exist locally: /tmp')
+  end
+
+  it 'confirms that its input is not an existing filepath' do
+    v = CLIUtils::FilepathExistsValidator.new
+    v.validate('!@&^')
+    expect(v.is_valid).to_not be_true
+    expect(v.message).to eq('Path does not exist locally: !@&^')
+  end
+end

data/spec/validator/non_nil_validator_spec.rb

@@ -0,0 +1,24 @@
+require_relative '../spec_helper'
+require 'cliutils/messaging'
+require 'cliutils/prefs/pref_validators/pref_validator'
+require 'cliutils/prefs/pref_validators/non_nil_validator'
+
+describe CLIUtils::NonNilValidator do
+  it 'confirms that its input is non-nil' do
+    v = CLIUtils::NonNilValidator.new
+    v.validate('bachya')
+    expect(v.is_valid).to be_true
+    expect(v.message).to eq('Nil text not allowed')
+  end
+
+  it 'confirms that its input is not non-nil' do
+    v = CLIUtils::NonNilValidator.new
+    v.validate('')
+    expect(v.is_valid).to_not be_true
+    expect(v.message).to eq('Nil text not allowed')
+
+    v.validate(nil)
+    expect(v.is_valid).to_not be_true
+    expect(v.message).to eq('Nil text not allowed')
+  end
+end

data/spec/validator/number_validator_spec.rb

@@ -0,0 +1,20 @@
+require_relative '../spec_helper'
+require 'cliutils/messaging'
+require 'cliutils/prefs/pref_validators/pref_validator'
+require 'cliutils/prefs/pref_validators/number_validator'
+
+describe CLIUtils::NumberValidator do
+  it 'confirms that its input is a number' do
+    v = CLIUtils::NumberValidator.new
+    v.validate('12345.678')
+    expect(v.is_valid).to be_true
+    expect(v.message).to eq('Response is not a number: 12345.678')
+  end
+
+  it 'confirms that its input is not a number' do
+    v = CLIUtils::NumberValidator.new
+    v.validate('bachya')
+    expect(v.is_valid).to_not be_true
+    expect(v.message).to eq('Response is not a number: bachya')
+  end
+end

data/spec/validator/pref_validator_spec.rb

@@ -0,0 +1,11 @@
+require_relative '../spec_helper'
+require 'cliutils/messaging'
+require 'cliutils/prefs/pref_validators/pref_validator'
+require File.join(File.dirname(__FILE__), '..', '..', 'support/test_validator_empty')
+
+describe CLIUtils::TestValidatorEmpty do
+  it 'raises an exception if `validate` is not implemented' do
+    m = '`validate` method not implemented on caller: CLIUtils::TestValidatorEmpty'
+    expect { CLIUtils::TestValidatorEmpty.new.validate('') }.to raise_error(RuntimeError, m)
+  end
+end

data/spec/validator/time_validator_spec.rb

@@ -0,0 +1,20 @@
+require_relative '../spec_helper'
+require 'cliutils/messaging'
+require 'cliutils/prefs/pref_validators/pref_validator'
+require 'cliutils/prefs/pref_validators/time_validator'
+
+describe CLIUtils::TimeValidator do
+  it 'confirms that its input is a time' do
+    v = CLIUtils::TimeValidator.new
+    v.validate('12:43 AM')
+    expect(v.is_valid).to be_true
+    expect(v.message).to eq('Response is not a time: 12:43 AM')
+  end
+
+  it 'confirms that its input is not a time' do
+    v = CLIUtils::TimeValidator.new
+    v.validate('!@&^')
+    expect(v.is_valid).to_not be_true
+    expect(v.message).to eq('Response is not a time: !@&^')
+  end
+end

data/spec/validator/url_validator_spec.rb

@@ -0,0 +1,20 @@
+require_relative '../spec_helper'
+require 'cliutils/messaging'
+require 'cliutils/prefs/pref_validators/pref_validator'
+require 'cliutils/prefs/pref_validators/url_validator'
+
+describe CLIUtils::UrlValidator do
+  it 'confirms that its input is a URL' do
+    v = CLIUtils::UrlValidator.new
+    v.validate('http://www.google.com')
+    expect(v.is_valid).to be_true
+    expect(v.message).to eq('Response is not a URL: http://www.google.com')
+  end
+
+  it 'confirms that its input is not a URL' do
+    v = CLIUtils::UrlValidator.new
+    v.validate('!@&^')
+    expect(v.is_valid).to_not be_true
+    expect(v.message).to eq('Response is not a URL: !@&^')
+  end
+end

data/{test/test_files → support}/configuration.yaml

@@ -5,4 +5,4 @@ my_app:
   version: 1.0.0
 user_data:
   username: bob
-  age: 45
+  age: 45

data/support/prefstest.yaml

@@ -0,0 +1,27 @@
+prompts:
+  - prompt_text: Batman or Superman?
+    default: Batman
+    config_key: superhero
+    config_section: personal_info
+  - prompt_text: Do you feel smart for preferring Batman?
+    default: Y
+    config_key: batman_answer
+    config_section: personal_info
+    prereqs:
+      - config_key: superhero
+        config_value: Batman
+  - prompt_text: Why do you prefer Superman?!
+    default: No clue
+    config_key: superman_answer
+    config_section: personal_info
+    prereqs:
+      - config_key: superhero
+        config_value: Superman
+  - prompt_text: Why don't you have a clue?
+    config_key: no_clue
+    config_section: personal_info
+    prereqs:
+      - config_key: superhero
+        config_value: Superman
+      - config_key: superman_answer
+        config_value: No clue

data/support/test_action_empty.rb

@@ -0,0 +1,7 @@
+module CLIUtils
+  # Pref Action to open a URL in the default
+  # browser.
+  class TestActionEmpty < PrefAction
+
+  end
+end

data/{test/test_files → support}/test_behavior.rb

@@ -5,7 +5,7 @@ module CLIUtils
     # @param [Object] text The "text" to evaluate
     # @return [String]
     def evaluate(text)
-      "test_behavior: #{ text }"
+      "test behavior: #{ text }"
     end
   end
-end
+end

data/support/test_behavior_empty.rb

@@ -0,0 +1,6 @@
+module CLIUtils
+  # A Behavior to prefix a Pref answer with a string
+  class TestBehaviorEmpty < PrefBehavior
+
+  end
+end

data/{test/test_files → support}/test_validator.rb

@@ -1,5 +1,3 @@
-require 'uri'
-
 module CLIUtils
   # A Validator to verify whether a Pref answer
   # is a valid URL.

data/support/test_validator_empty.rb

@@ -0,0 +1,7 @@
+module CLIUtils
+  # A Validator to verify whether a Pref answer
+  # is a valid URL.
+  class TestValidatorEmpty < PrefValidator
+
+  end
+end

data/test/pref_test.rb

@@ -7,7 +7,6 @@ require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/prefs/pref_actions
 require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/prefs/pref_behaviors/pref_behavior')
 require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/prefs/pref_validators/pref_validator')
 
-# Tests for the Prefs class
 class TestPref < Test::Unit::TestCase
   def setup
     @prefs_hash = {

data/test/prefs_test.rb

@@ -1,11 +1,11 @@
 require 'test_helper'
+require 'tempfile'
 require 'yaml'
 
 require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/ext/hash_extensions')
 require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/prefs')
 require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/prefs/pref')
 
-# Tests for the Prefs class
 class TestPrefs < Test::Unit::TestCase
   def setup
     @prefs_arr = [
@@ -56,6 +56,11 @@ class TestPrefs < Test::Unit::TestCase
     assert_equal(prefs[:prompts].map { |p| CLIUtils::Pref.new(p) }, p.prompts)
   end
 
+  def test_bad_file_creation
+    exception = assert_raise(RuntimeError) { p = CLIUtils::Prefs.new('asd') }
+    assert_equal('Invalid configuration file: asd', exception.message)
+  end
+
   def test_array_creation
     p = CLIUtils::Prefs.new(@prefs_arr)
     prefs = @prefs_hash.deep_symbolize_keys
@@ -68,6 +73,11 @@ class TestPrefs < Test::Unit::TestCase
     assert_equal(prefs[:prompts].map { |p| CLIUtils::Pref.new(p) }, p.prompts)
   end
 
+  def test_invalid_type_creation
+    exception = assert_raise(RuntimeError) { p = CLIUtils::Prefs.new(123) }
+    assert_equal('Invalid configuration data', exception.message)
+  end
+
   def test_register
     CLIUtils::Prefs.register_action(File.join(File.dirname(__FILE__), 'test_files/test_action.rb'))
     assert_equal(CLIUtils::Prefs.registered_actions.key?(:Test), true)
@@ -85,6 +95,19 @@ class TestPrefs < Test::Unit::TestCase
     assert_equal(CLIUtils::Prefs.registered_validators[:Test][:path], File.join(File.dirname(__FILE__), 'test_files/test_validator.rb'))
   end
 
+  def test_bad_registration
+    m = 'Registration failed because of unknown filepath: bachya.rb'
+
+    exception = assert_raise(RuntimeError) { CLIUtils::Prefs.register_action('bachya.rb') }
+    assert_equal(m, exception.message)
+
+    exception = assert_raise(RuntimeError) { CLIUtils::Prefs.register_behavior('bachya.rb') }
+    assert_equal(m, exception.message)
+
+    exception = assert_raise(RuntimeError) { CLIUtils::Prefs.register_validator('bachya.rb') }
+    assert_equal(m, exception.message)
+  end
+
   def test_deregister
     CLIUtils::Prefs.register_action(File.join(File.dirname(__FILE__), 'test_files/test_action.rb'))
     CLIUtils::Prefs.deregister_action(:Test)
@@ -98,4 +121,44 @@ class TestPrefs < Test::Unit::TestCase
     CLIUtils::Prefs.deregister_validator(:Test)
     assert_equal(CLIUtils::Prefs.registered_validators.key?(:Test), false)
   end
+
+  def test_ask
+    p = CLIUtils::Prefs.new(@prefs_filepath)
+    stdin = Tempfile.new("test_readline_stdin")
+    stdout = Tempfile.new("test_readline_stdout")
+    begin
+      stdin.write("\n")
+      stdin.close
+      stdout.close
+      line = replace_stdio(stdin.path, stdout.path) {
+        p.ask
+      }
+    ensure
+      stdin.close(true)
+      stdout.close(true)
+    end
+  end
+
+  private
+
+  def replace_stdio(stdin_path, stdout_path)
+    open(stdin_path, "r"){|stdin|
+      open(stdout_path, "w"){|stdout|
+        orig_stdin = STDIN.dup
+        orig_stdout = STDOUT.dup
+        STDIN.reopen(stdin)
+        STDOUT.reopen(stdout)
+        begin
+          Readline.input = STDIN
+          Readline.output = STDOUT
+          yield
+        ensure
+          STDIN.reopen(orig_stdin)
+          STDOUT.reopen(orig_stdout)
+          orig_stdin.close
+          orig_stdout.close
+        end
+      }
+    }
+  end
 end

data/test/test_helper.rb

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

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: cliutils
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 2.2.0
 platform: ruby
 authors:
 - Aaron Bach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-27 00:00:00.000000000 Z
+date: 2014-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -74,8 +88,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - HISTORY.md
 - LICENSE.txt
@@ -89,8 +103,8 @@ files:
 - lib/cliutils/ext/hash_extensions.rb
 - lib/cliutils/ext/logger_extensions.rb
 - lib/cliutils/ext/string_extensions.rb
-- lib/cliutils/logger_delegator.rb
 - lib/cliutils/messaging.rb
+- lib/cliutils/messenger.rb
 - lib/cliutils/prefs.rb
 - lib/cliutils/prefs/pref.rb
 - lib/cliutils/prefs/pref_actions/open_url_action.rb
@@ -130,37 +144,46 @@ files:
 - res/readme-images/prettyio-red-text.png
 - res/readme-images/prompting.png
 - res/readme-images/wrapping.png
-- test/action_tests/open_url_action_test.rb
-- test/behavior_tests/capitalize_behavior_test.rb
-- test/behavior_tests/expand_filepath_behavior_test.rb
-- test/behavior_tests/lowercase_behavior_test.rb
-- test/behavior_tests/prefix_behavior_test.rb
-- test/behavior_tests/suffix_behavior_test.rb
-- test/behavior_tests/titlecase_behavior_test.rb
-- test/behavior_tests/uppercase_behavior_test.rb
-- test/configuration_test.rb
-- test/configurator_test.rb
-- test/hash_extensions_test.rb
-- test/logger_extensions_test.rb
-- test/messaging_test.rb
+- spec/action/open_url_action_spec.rb
+- spec/action/pref_action_spec.rb
+- spec/behavior/capitalize_behavior_spec.rb
+- spec/behavior/expand_filepath_behavior_spec.rb
+- spec/behavior/lowercase_behavior_spec.rb
+- spec/behavior/pref_behavior_spec.rb
+- spec/behavior/prefix_behavior_spec.rb
+- spec/behavior/suffix_behavior_spec.rb
+- spec/behavior/titlecase_behavior_spec.rb
+- spec/behavior/uppercase_behavior_spec.rb
+- spec/configuration_spec.rb
+- spec/configurator_spec.rb
+- spec/ext/hash_extensions_spec.rb
+- spec/ext/logger_extensions_spec.rb
+- spec/ext/string_extensions_spec.rb
+- spec/messaging_spec.rb
+- spec/pref_spec.rb
+- spec/prefs_spec.rb
+- spec/spec_helper.rb
+- spec/validator/alphabetic_validator_spec.rb
+- spec/validator/alphanumeric_validator_spec.rb
+- spec/validator/date_validator_spec.rb
+- spec/validator/datetime_validator_spec.rb
+- spec/validator/filepath_exists_validator_spec.rb
+- spec/validator/non_nil_validator_spec.rb
+- spec/validator/number_validator_spec.rb
+- spec/validator/pref_validator_spec.rb
+- spec/validator/time_validator_spec.rb
+- spec/validator/url_validator_spec.rb
+- support/configuration.yaml
+- support/prefstest.yaml
+- support/test_action.rb
+- support/test_action_empty.rb
+- support/test_behavior.rb
+- support/test_behavior_empty.rb
+- support/test_validator.rb
+- support/test_validator_empty.rb
 - test/pref_test.rb
 - test/prefs_test.rb
-- test/string_extesions_test.rb
-- test/test_files/configuration.yaml
-- test/test_files/prefstest.yaml
-- test/test_files/test_action.rb
-- test/test_files/test_behavior.rb
-- test/test_files/test_validator.rb
 - test/test_helper.rb
-- test/validator_tests/alphabetic_validator_test.rb
-- test/validator_tests/alphanumeric_validator_test.rb
-- test/validator_tests/date_validator_test.rb
-- test/validator_tests/datetime_validator_test.rb
-- test/validator_tests/filepath_exists_validator_test.rb
-- test/validator_tests/non_nil_validator_test.rb
-- test/validator_tests/number_validator_test.rb
-- test/validator_tests/time_validator_test.rb
-- test/validator_tests/url_validator_test.rb
 homepage: https://github.com/bachya/cliutils
 licenses:
 - MIT
@@ -171,12 +194,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -186,35 +209,36 @@ signing_key:
 specification_version: 4
 summary: Sugary goodness for Ruby CLI apps.
 test_files:
-- test/action_tests/open_url_action_test.rb
-- test/behavior_tests/capitalize_behavior_test.rb
-- test/behavior_tests/expand_filepath_behavior_test.rb
-- test/behavior_tests/lowercase_behavior_test.rb
-- test/behavior_tests/prefix_behavior_test.rb
-- test/behavior_tests/suffix_behavior_test.rb
-- test/behavior_tests/titlecase_behavior_test.rb
-- test/behavior_tests/uppercase_behavior_test.rb
-- test/configuration_test.rb
-- test/configurator_test.rb
-- test/hash_extensions_test.rb
-- test/logger_extensions_test.rb
-- test/messaging_test.rb
+- spec/action/open_url_action_spec.rb
+- spec/action/pref_action_spec.rb
+- spec/behavior/capitalize_behavior_spec.rb
+- spec/behavior/expand_filepath_behavior_spec.rb
+- spec/behavior/lowercase_behavior_spec.rb
+- spec/behavior/pref_behavior_spec.rb
+- spec/behavior/prefix_behavior_spec.rb
+- spec/behavior/suffix_behavior_spec.rb
+- spec/behavior/titlecase_behavior_spec.rb
+- spec/behavior/uppercase_behavior_spec.rb
+- spec/configuration_spec.rb
+- spec/configurator_spec.rb
+- spec/ext/hash_extensions_spec.rb
+- spec/ext/logger_extensions_spec.rb
+- spec/ext/string_extensions_spec.rb
+- spec/messaging_spec.rb
+- spec/pref_spec.rb
+- spec/prefs_spec.rb
+- spec/spec_helper.rb
+- spec/validator/alphabetic_validator_spec.rb
+- spec/validator/alphanumeric_validator_spec.rb
+- spec/validator/date_validator_spec.rb
+- spec/validator/datetime_validator_spec.rb
+- spec/validator/filepath_exists_validator_spec.rb
+- spec/validator/non_nil_validator_spec.rb
+- spec/validator/number_validator_spec.rb
+- spec/validator/pref_validator_spec.rb
+- spec/validator/time_validator_spec.rb
+- spec/validator/url_validator_spec.rb
 - test/pref_test.rb
 - test/prefs_test.rb
-- test/string_extesions_test.rb
-- test/test_files/configuration.yaml
-- test/test_files/prefstest.yaml
-- test/test_files/test_action.rb
-- test/test_files/test_behavior.rb
-- test/test_files/test_validator.rb
 - test/test_helper.rb
-- test/validator_tests/alphabetic_validator_test.rb
-- test/validator_tests/alphanumeric_validator_test.rb
-- test/validator_tests/date_validator_test.rb
-- test/validator_tests/datetime_validator_test.rb
-- test/validator_tests/filepath_exists_validator_test.rb
-- test/validator_tests/non_nil_validator_test.rb
-- test/validator_tests/number_validator_test.rb
-- test/validator_tests/time_validator_test.rb
-- test/validator_tests/url_validator_test.rb
 has_rdoc: