cliutils 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68db9f1432d7c3406a8e3e0d8da2b36ebb3f9ca2
-  data.tar.gz: 6f94550ad158c2fe248ce3a96d55c79b10205858
+  metadata.gz: 7a871fd064a86dc102c5f840bd900f51f60aedfd
+  data.tar.gz: b73ad1c281bdc4f03b4079ac2992e2b7f4fbe832
 SHA512:
-  metadata.gz: 0f4cdd934a27ce5806633a2d6a4949e7f6d60a6f1bf60563952cc602035cee1609443a445844b1923b882163795dfab6ce306503ea8ada5d7b11654b048697b9
-  data.tar.gz: f00af86450a6e7d39bb695c926ddb7005b23f28ebe90ff3983f619b0eaed384bc699b449a85675bab7cc4e561ec4ce88824ace3b90ce37a80e81f40b1f49a1ae
+  metadata.gz: 406caacfd63537aa09a66865b5e390e311877c7234ea8db01ff027b9b520cc52ae2e59b7966f205911b75bc44173585ffa7da89800b3847c1e44426ef096da54
+  data.tar.gz: e1c0a4abc34dc40a1f62f3c0759c17db0bd29ce78f541d9d33c0d15f7d464453975db85bea2d9e2ee46cd7e4119309aaaa6b045da5976f5b38dcb6fc29cd5464

data/HISTORY.md

@@ -1,3 +1,9 @@
+# 2.1.2 (2014-04-26)
+
+* Added some error checking to Configuration
+* More unit tests
+* A few small bugfixes
+
 # 2.1.1 (2014-04-26)
 
 * Fixed a bug in which older Ruby versions wouldn't load Pref assets correctly

data/Rakefile

@@ -17,7 +17,7 @@ require 'rake/testtask'
 desc 'Run unit tests'
 Rake::TestTask.new do |t|
   t.libs << "test"
-  t.test_files = FileList['test/*_test.rb']
+  t.test_files = FileList['test/*_test.rb', 'test/**/*_test.rb']
 end
 
 desc "Release CLIUtils version #{version}"

data/lib/cliutils/configuration.rb

@@ -1,5 +1,4 @@
 require 'logger'
-require 'yaml'
 
 module CLIUtils
   # Configuration Module
@@ -15,6 +14,8 @@ module CLIUtils
       'FATAL' => Logger::FATAL
     }
 
+    @@configuration = nil
+
     # Hook that triggers when this module is included.
     # @param [Object] k The includer object
     # @return [void]
@@ -26,7 +27,12 @@ module CLIUtils
     # a Configurator.
     # @return [Configurator]
     def configuration
-      @@configuration ||= Configurator.new('~/.default-cliutils')
+      if !@@configuration.nil?
+        @@configuration
+      else
+        fail 'Attempted to access `configuration` before ' \
+        'executing `load_configuration`'
+      end
     end
 
     # Singleton method to return (or initialize, if needed)

data/lib/cliutils/constants.rb

@@ -8,5 +8,5 @@ module CLIUtils
   SUMMARY = 'Sugary goodness for Ruby CLI apps.'
 
   # The current version of the gem
-  VERSION = '2.1.1'
+  VERSION = '2.1.2'
 end

data/test/action_tests/open_url_action_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib/cliutils/prefs/pref_actions/open_url_action')
+
+# Tests for the Configurator class
+class TestOpenUrlAction < Test::Unit::TestCase
+  def test_run
+    a = CLIUtils::OpenUrlAction.new
+    a.parameters = { url: 'http://www.google.com' }
+    assert_output() { a.run }
+  end
+end

data/test/behavior_tests/capitalize_behavior_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib/cliutils/prefs/pref_behaviors/capitalize_behavior')
+
+# Tests for the Configurator class
+class TestCapitalizeBehavior < Test::Unit::TestCase
+  def test_evaluation
+    v = CLIUtils::CapitalizeBehavior.new
+    assert_equal(v.evaluate('bachya'), 'Bachya')
+  end
+end

data/test/behavior_tests/expand_filepath_behavior_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib/cliutils/prefs/pref_behaviors/expand_filepath_behavior')
+
+# Tests for the Configurator class
+class TestExpandFilepathBehavior < Test::Unit::TestCase
+  def test_evaluation
+    v = CLIUtils::ExpandFilepathBehavior.new
+    assert_equal(v.evaluate('~/test'), "#{ ENV['HOME'] }/test")
+  end
+end

data/test/behavior_tests/lowercase_behavior_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib/cliutils/prefs/pref_behaviors/lowercase_behavior')
+
+# Tests for the Configurator class
+class TestLowercaseBehavior < Test::Unit::TestCase
+  def test_evaluation
+    v = CLIUtils::LowercaseBehavior.new
+    assert_equal(v.evaluate('BaChYa'), 'bachya')
+  end
+end

data/test/behavior_tests/prefix_behavior_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib/cliutils/prefs/pref_behaviors/prefix_behavior')
+
+# Tests for the Configurator class
+class TestPrefixBehavior < Test::Unit::TestCase
+  def test_evaluation
+    v = CLIUtils::PrefixBehavior.new
+    v.parameters = { prefix: 'test: ' }
+    assert_equal(v.evaluate('bachya'), 'test: bachya')
+  end
+end

data/test/behavior_tests/suffix_behavior_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib/cliutils/prefs/pref_behaviors/suffix_behavior')
+
+# Tests for the Configurator class
+class TestSuffixBehavior < Test::Unit::TestCase
+  def test_evaluation
+    v = CLIUtils::SuffixBehavior.new
+    v.parameters = { suffix: ' - signing off!' }
+    assert_equal(v.evaluate('bachya'), 'bachya - signing off!')
+  end
+end

data/test/behavior_tests/titlecase_behavior_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib/cliutils/prefs/pref_behaviors/titlecase_behavior')
+
+# Tests for the Configurator class
+class TestTitlecaseBehavior < Test::Unit::TestCase
+  def test_evaluation
+    v = CLIUtils::TitlecaseBehavior.new
+    assert_equal(v.evaluate('my sentence is here'), 'My Sentence Is Here')
+  end
+end

data/test/behavior_tests/uppercase_behavior_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib/cliutils/prefs/pref_behaviors/uppercase_behavior')
+
+# Tests for the Configurator class
+class TestUppercaseBehavior < Test::Unit::TestCase
+  def test_evaluation
+    v = CLIUtils::UppercaseBehavior.new
+    assert_equal(v.evaluate('bachya'), 'BACHYA')
+  end
+end

data/test/configuration_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/configurator')
+require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/configuration')
+
+# Tests for the Configurator class
+class TestConfiguration < Test::Unit::TestCase
+  include CLIUtils::Configuration
+
+  def setup
+    @config_path = '/tmp/test.config'
+    @expected_config_data = {
+      my_app: {
+        config_location: '/Users/bob/.my-app-config',
+        log_level: 'WARN',
+        version: '1.0.0'
+      },
+      user_data: {
+        username: 'bob',
+        age: 45
+      }
+    }
+  end
+
+  def teardown
+    FileUtils.rm(@config_path) if File.file?(@config_path)
+  end
+
+  def test_before_loading
+    assert_raise RuntimeError do
+      configuration
+    end
+  end
+
+  def test_empty_configuration
+    load_configuration(@config_path)
+    assert_equal(configuration.class, CLIUtils::Configurator)
+    assert_equal(configuration.config_path, @config_path)
+    assert_equal(configuration.data, {})
+  end
+
+  def test_existing_configuration
+    FileUtils.cp(File.join(File.dirname(__FILE__), '..', 'test/test_files/configuration.yaml'), @config_path)
+    load_configuration(@config_path)
+    assert_equal(configuration.class, CLIUtils::Configurator)
+    assert_equal(configuration.config_path, @config_path)
+    assert_equal(configuration.data, @expected_config_data)
+  end
+end

data/test/test_files/configuration.yaml

@@ -0,0 +1,8 @@
+---
+my_app:
+  config_location: "/Users/bob/.my-app-config"
+  log_level: WARN
+  version: 1.0.0
+user_data:
+  username: bob
+  age: 45

data/test/validator_tests/alphabetic_validator_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib/cliutils/prefs/pref_validators/alphabetic_validator')
+
+# Tests for the Configurator class
+class TestAlphabeticValidator < Test::Unit::TestCase
+  def test_valid
+    v = CLIUtils::AlphabeticValidator.new
+    v.validate('bachya')
+
+    assert_equal(v.is_valid, 0)
+    assert_equal(v.message, 'Response is not alphabetic: bachya')
+  end
+
+  def test_invalid
+    v = CLIUtils::AlphabeticValidator.new
+    v.validate('12345')
+
+    assert_not_equal(v.is_valid, 0)
+    assert_equal(v.message, 'Response is not alphabetic: 12345')
+  end
+end

data/test/validator_tests/alphanumeric_validator_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib/cliutils/prefs/pref_validators/alphanumeric_validator')
+
+# Tests for the Configurator class
+class TestAlphanumericValidator < Test::Unit::TestCase
+  def test_valid
+    v = CLIUtils::AlphanumericValidator.new
+    v.validate('bachya91238 ')
+
+    assert_equal(v.is_valid, 0)
+    assert_equal(v.message, 'Response is not alphanumeric: bachya91238 ')
+  end
+
+  def test_invalid
+    v = CLIUtils::AlphanumericValidator.new
+    v.validate('!@&^')
+
+    assert_not_equal(v.is_valid, 0)
+    assert_equal(v.message, 'Response is not alphanumeric: !@&^')
+  end
+end

data/test/validator_tests/date_validator_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib/cliutils/prefs/pref_validators/date_validator')
+
+# Tests for the Configurator class
+class TestDateValidator < Test::Unit::TestCase
+  def test_valid
+    v = CLIUtils::DateValidator.new
+    v.validate('2014-02-01')
+
+    assert_equal(v.is_valid, true)
+    assert_equal(v.message, 'Response is not a date: 2014-02-01')
+  end
+
+  def test_invalid
+    v = CLIUtils::DateValidator.new
+    v.validate('!@&^')
+
+    assert_equal(v.is_valid, false)
+    assert_equal(v.message, 'Response is not a date: !@&^')
+  end
+end

data/test/validator_tests/datetime_validator_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib/cliutils/prefs/pref_validators/datetime_validator')
+
+# Tests for the Configurator class
+class TestDatetimeValidator < Test::Unit::TestCase
+  def test_valid
+    v = CLIUtils::DatetimeValidator.new
+    v.validate('2014-02-01 12:34 PM')
+
+    assert_equal(v.is_valid, true)
+    assert_equal(v.message, 'Response is not a datetime: 2014-02-01 12:34 PM')
+  end
+
+  def test_invalid
+    v = CLIUtils::DatetimeValidator.new
+    v.validate('!@&^')
+
+    assert_equal(v.is_valid, false)
+    assert_equal(v.message, 'Response is not a datetime: !@&^')
+  end
+end

data/test/validator_tests/filepath_exists_validator_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib/cliutils/prefs/pref_validators/filepath_exists_validator')
+
+# Tests for the Configurator class
+class TestFilepathExistsValidator < Test::Unit::TestCase
+  def test_valid
+    v = CLIUtils::FilepathExistsValidator.new
+    v.validate('/tmp')
+
+    assert_equal(v.is_valid, true)
+    assert_equal(v.message, 'Path does not exist locally: /tmp')
+  end
+
+  def test_invalid
+    v = CLIUtils::FilepathExistsValidator.new
+    v.validate('asdasd')
+
+    assert_equal(v.is_valid, false)
+    assert_equal(v.message, 'Path does not exist locally: asdasd')
+  end
+end

data/test/validator_tests/non_nil_validator_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib/cliutils/prefs/pref_validators/non_nil_validator')
+
+# Tests for the Configurator class
+class TestNonNilValidator < Test::Unit::TestCase
+  def test_valid
+    v = CLIUtils::NonNilValidator.new
+    v.validate('asdasdasd')
+
+    assert_equal(v.is_valid, true)
+    assert_equal(v.message, 'Nil text not allowed')
+  end
+
+  def test_invalid_1
+    v = CLIUtils::NonNilValidator.new
+    v.validate('')
+
+    assert_equal(v.is_valid, false)
+    assert_equal(v.message, 'Nil text not allowed')
+  end
+
+  def test_invalid_2
+    v = CLIUtils::NonNilValidator.new
+    v.validate(nil)
+
+    assert_equal(v.is_valid, false)
+    assert_equal(v.message, 'Nil text not allowed')
+  end
+end

data/test/validator_tests/number_validator_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib/cliutils/prefs/pref_validators/number_validator')
+
+# Tests for the Configurator class
+class TestNumberValidator < Test::Unit::TestCase
+  def test_valid
+    v = CLIUtils::NumberValidator.new
+    v.validate('1234.112')
+
+    assert_equal(v.is_valid, 0)
+    assert_equal(v.message, 'Response is not a number: 1234.112')
+  end
+
+  def test_invalid
+    v = CLIUtils::NumberValidator.new
+    v.validate('abcdefg')
+
+    assert_not_equal(v.is_valid, 0)
+    assert_equal(v.message, 'Response is not a number: abcdefg')
+  end
+end

data/test/validator_tests/time_validator_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib/cliutils/prefs/pref_validators/time_validator')
+
+# Tests for the Configurator class
+class TestTimeValidator < Test::Unit::TestCase
+  def test_valid
+    v = CLIUtils::TimeValidator.new
+    v.validate('12:43 AM')
+
+    assert_equal(v.is_valid, true)
+    assert_equal(v.message, 'Response is not a time: 12:43 AM')
+  end
+
+  def test_invalid
+    v = CLIUtils::TimeValidator.new
+    v.validate('bzzzp')
+
+    assert_equal(v.is_valid, false)
+    assert_equal(v.message, 'Response is not a time: bzzzp')
+  end
+end

data/test/validator_tests/url_validator_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib/cliutils/prefs/pref_validators/url_validator')
+
+# Tests for the Configurator class
+class TestUrlValidator < Test::Unit::TestCase
+  def test_valid
+    v = CLIUtils::UrlValidator.new
+    v.validate('http://www.google.com')
+
+    assert_equal(v.is_valid, 0)
+    assert_equal(v.message, 'Response is not a url: http://www.google.com')
+  end
+
+  def test_invalid
+    v = CLIUtils::UrlValidator.new
+    v.validate('basdahd0283123')
+
+    assert_not_equal(v.is_valid, 0)
+    assert_equal(v.message, 'Response is not a url: basdahd0283123')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cliutils
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors:
 - Aaron Bach
@@ -130,18 +130,37 @@ 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/messenging_test.rb
+- test/messaging_test.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
@@ -167,16 +186,35 @@ 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/messenging_test.rb
+- test/messaging_test.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: