cliutils 2.1.4 → 2.2.0

data/lib/cliutils/prefs/pref_actions/open_url_action.rb

@@ -9,7 +9,7 @@ module CLIUtils
     def run
       url = @parameters[:url]
       Launchy.open(url) do |exception|
-        puts "Failed to open #{ url }: #{ exception }"
+        fail "Failed to open URL: #{ exception }" if exception
       end
     end
   end

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

@@ -1,3 +1,5 @@
+require 'pathname'
+
 module CLIUtils
   # A Validator to verify whether a Pref answer
   # is a local filepath that exists.

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

@@ -9,7 +9,7 @@ module CLIUtils
     # @return [String]
     def validate(text)
       @is_valid = text.to_s =~ URI::DEFAULT_PARSER.regexp[:ABS_URI]
-      @message = "Response is not a url: #{ text }"
+      @message = "Response is not a URL: #{ text }"
     end
   end
 end

data/lib/cliutils/prefs.rb

@@ -54,7 +54,7 @@ module CLIUtils
           data = YAML.load_file(data).deep_symbolize_keys
           @prompts = _generate_prefs(data)
         else
-          fail "Invalid configuration file: #{ data }"
+            fail "Invalid configuration file: #{ data }"
         end
       when Hash
         @config_path = nil

data/lib/cliutils/pretty_io.rb

@@ -1,13 +1,3 @@
-begin
-  unless (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM).nil?
-    require 'Win32/Console/ANSI'
-  end
-rescue LoadError
-  raise 'You must run `gem install win32console` to use CLIMessage on Windows'
-end
-
-require 'readline'
-
 module CLIUtils
   # CLIMessenger Module
   # Outputs color-coordinated messages to a CLI

data/lib/cliutils.rb

@@ -6,7 +6,7 @@ require 'cliutils/constants'
 require 'cliutils/pretty_io'
 require 'cliutils/configurator'
 require 'cliutils/configuration'
-require 'cliutils/logger_delegator'
+require 'cliutils/messenger'
 require 'cliutils/messaging'
 require 'cliutils/prefs'
 require 'cliutils/prefs/pref'

data/spec/action/open_url_action_spec.rb

@@ -0,0 +1,20 @@
+require_relative '../spec_helper'
+require 'cliutils/messaging'
+require 'cliutils/prefs/pref_actions/pref_action'
+require 'cliutils/prefs/pref_actions/open_url_action'
+
+describe CLIUtils::OpenUrlAction do
+  it 'opens a website with the specified parameter' do
+    a = CLIUtils::OpenUrlAction.new
+    a.parameters = { url: 'http://www.google.com' }
+    expect(Launchy).to receive(:open).with('http://www.google.com')
+    a.run
+  end
+
+  it 'throws an exception with a bad URL' do
+    a = CLIUtils::OpenUrlAction.new
+    a.parameters = { url: 'bachya' }
+    m = "Failed to open URL: No application found to handle 'bachya'"
+    expect { a.run }.to raise_error(RuntimeError, m)
+  end
+end

data/spec/action/pref_action_spec.rb

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

data/spec/behavior/capitalize_behavior_spec.rb

@@ -0,0 +1,11 @@
+require_relative '../spec_helper'
+require 'cliutils/messaging'
+require 'cliutils/prefs/pref_behaviors/pref_behavior'
+require 'cliutils/prefs/pref_behaviors/capitalize_behavior'
+
+describe CLIUtils::CapitalizeBehavior do
+  it 'capitalizes its input' do
+    b = CLIUtils::CapitalizeBehavior.new
+    expect(b.evaluate('bachya')).to eq('Bachya')
+  end
+end

data/spec/behavior/expand_filepath_behavior_spec.rb

@@ -0,0 +1,11 @@
+require_relative '../spec_helper'
+require 'cliutils/messaging'
+require 'cliutils/prefs/pref_behaviors/pref_behavior'
+require 'cliutils/prefs/pref_behaviors/expand_filepath_behavior'
+
+describe CLIUtils::ExpandFilepathBehavior do
+  it 'runs File.expand_path on its input' do
+    b = CLIUtils::ExpandFilepathBehavior.new
+    expect(b.evaluate('~/test')).to eq("#{ ENV['HOME'] }/test")
+  end
+end

data/spec/behavior/lowercase_behavior_spec.rb

@@ -0,0 +1,11 @@
+require_relative '../spec_helper'
+require 'cliutils/messaging'
+require 'cliutils/prefs/pref_behaviors/pref_behavior'
+require 'cliutils/prefs/pref_behaviors/lowercase_behavior'
+
+describe CLIUtils::LowercaseBehavior do
+  it 'lowercases its input' do
+    b = CLIUtils::LowercaseBehavior.new
+    expect(b.evaluate('BaChYa')).to eq('bachya')
+  end
+end

data/spec/behavior/pref_behavior_spec.rb

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

data/spec/behavior/prefix_behavior_spec.rb

@@ -0,0 +1,12 @@
+require_relative '../spec_helper'
+require 'cliutils/messaging'
+require 'cliutils/prefs/pref_behaviors/pref_behavior'
+require 'cliutils/prefs/pref_behaviors/prefix_behavior'
+
+describe CLIUtils::PrefixBehavior do
+  it 'prefixes its input' do
+    b = CLIUtils::PrefixBehavior.new
+    b.parameters = { prefix: 'Starting up: ' }
+    expect(b.evaluate('bachya')).to eq('Starting up: bachya')
+  end
+end

data/spec/behavior/suffix_behavior_spec.rb

@@ -0,0 +1,12 @@
+require_relative '../spec_helper'
+require 'cliutils/messaging'
+require 'cliutils/prefs/pref_behaviors/pref_behavior'
+require 'cliutils/prefs/pref_behaviors/suffix_behavior'
+
+describe CLIUtils::SuffixBehavior do
+  it 'prefixes its input' do
+    b = CLIUtils::SuffixBehavior.new
+    b.parameters = { suffix: ' - signing off!' }
+    expect(b.evaluate('bachya')).to eq('bachya - signing off!')
+  end
+end

data/spec/behavior/titlecase_behavior_spec.rb

@@ -0,0 +1,10 @@
+require 'cliutils/messaging'
+require 'cliutils/prefs/pref_behaviors/pref_behavior'
+require 'cliutils/prefs/pref_behaviors/titlecase_behavior'
+
+describe CLIUtils::TitlecaseBehavior do
+  it 'titlecases its input' do
+    b = CLIUtils::TitlecaseBehavior.new
+    expect(b.evaluate('my sentence is here')).to eq('My Sentence Is Here')
+  end
+end

data/spec/behavior/uppercase_behavior_spec.rb

@@ -0,0 +1,11 @@
+require_relative '../spec_helper'
+require 'cliutils/messaging'
+require 'cliutils/prefs/pref_behaviors/pref_behavior'
+require 'cliutils/prefs/pref_behaviors/uppercase_behavior'
+
+describe CLIUtils::UppercaseBehavior do
+  it 'uppercases its input' do
+    b = CLIUtils::UppercaseBehavior.new
+    expect(b.evaluate('bachya')).to eq('BACHYA')
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,37 @@
+require_relative 'spec_helper'
+require 'cliutils/messaging'
+require 'cliutils/configuration'
+require 'cliutils/configurator'
+
+describe CLIUtils::Configuration do
+  include CLIUtils::Configuration
+
+  it 'raises an exception if not loaded properly' do
+    m = 'Attempted to access `configuration` before executing `load_configuration`'
+    expect { configuration }.to raise_error(RuntimeError, m)
+  end
+
+  let(:config_path_new) { File.expand_path('support/configuration2.yaml') }
+  it 'initializies configuration from scratch' do
+    load_configuration(config_path_new)
+    expect(configuration.class).to eq(CLIUtils::Configurator)
+    expect(configuration.config_path).to eq(config_path_new)
+    expect(configuration.data).to eq({})
+  end
+
+  let(:config_path_existing) { File.expand_path('support/configuration.yaml') }
+  let(:existing_data) { { my_app: {
+                            config_location: '/Users/bob/.my-app-config',
+                            log_level: 'WARN',
+                            version: '1.0.0' },
+                          user_data: {
+                            username: 'bob',
+                            age: 45 } } }
+
+  it 'works with existing configuration data' do
+    load_configuration(config_path_existing)
+    expect(configuration.class).to eq(CLIUtils::Configurator)
+    expect(configuration.config_path).to eq(config_path_existing)
+    expect(configuration.data).to eq(existing_data)
+  end
+end

data/spec/configurator_spec.rb

@@ -0,0 +1,104 @@
+require_relative 'spec_helper'
+require 'cliutils/messaging'
+require 'cliutils/configurator'
+require 'cliutils/ext/hash_extensions'
+require 'cliutils/prefs'
+require 'yaml'
+
+describe CLIUtils::Configuration do
+  include CLIUtils::Configuration
+
+  let(:config_path) { File.expand_path('support/configuration.yaml') }
+  let(:prefs_path) { File.expand_path('support/prefstest.yaml') }
+  let(:config) { CLIUtils::Configurator.new(config_path)}
+  let(:existing_data) { { my_app: {
+                            config_location: '/Users/bob/.my-app-config',
+                            log_level: 'WARN',
+                            version: '1.0.0' },
+                          user_data: {
+                            username: 'bob',
+                            age: 45 } } }
+
+  it 'adds a section to the config data' do
+    config.add_section(:test)
+    expect(config.data).to eq(existing_data.merge!(test: {}))
+  end
+
+  it 'raises an exception when trying to add an already-existing section' do
+    config.add_section(:test)
+    m = 'Section already exists: test'
+    expect { config.add_section(:test) }.to raise_error(RuntimeError, m)
+  end
+
+  it 'backs up the configuration file' do
+    backup_path = config.backup
+    expect(backup_path).to eq("#{ config_path }-#{ Time.now.to_i }")
+    FileUtils.rm(backup_path)
+  end
+
+  it 'deletes a section from the config data' do
+    config.add_section(:test)
+    config.add_section(:test2)
+    config.delete_section(:test)
+    expect(config.data).to eq(existing_data.merge!(test2: {}))
+  end
+
+  it 'raises an exception when trying to delete a nonexistent section' do
+    m = 'Cannot delete nonexistent section: test'
+    expect { config.delete_section(:test) }.to raise_error(RuntimeError, m)
+  end
+
+  it 'allows data retrieval via a hash or magic methods' do
+    config.add_section(:test)
+    config.data[:test].merge!(name: 'Bob')
+    expect(config.data[:test][:name]).to eq('Bob')
+    expect(config.test[:name]).to eq('Bob')
+  end
+
+  it 'resets the entire data collection' do
+    config.add_section(:test)
+    config.data[:test].merge!(name: 'Bob')
+    config.reset
+    expect(config.data).to eq({})
+  end
+
+  it 'saves its data to a file' do
+    config.add_section(:section1)
+    config.section1.merge!(a: 'test', b: 'test')
+    config.save
+
+    saved_data = YAML.load_file(config.config_path).deep_symbolize_keys
+    expect(saved_data).to eq(config.data)
+
+    config.delete_section(:section1)
+    config.save
+  end
+
+  it 'compares versions' do
+    config.add_section(:app_data)
+    config.app_data.merge!(VERSION: '1.0.0')
+    config.current_version = config.app_data[:VERSION]
+    config.last_version = '1.0.8'
+    config.compare_version do |c, l|
+      expect(c).to be < l
+    end
+  end
+
+  it 'successfully ingests Prefs into its data' do
+    config.ingest_prefs(CLIUtils::Prefs.new(prefs_path))
+    h = {
+      personal_info: {
+        superhero: nil,
+        batman_answer: nil,
+        superman_answer: nil,
+        no_clue: nil
+      }
+    }
+    expect(existing_data.merge!(h)).to eq(config.data)
+  end
+
+  it 'raises an exception when attempting to ingest invalid Prefs' do
+    m = 'Invaid Prefs class'
+    expect { config.ingest_prefs(123) }.to raise_error(RuntimeError, m)
+  end
+end

data/spec/ext/hash_extensions_spec.rb

@@ -0,0 +1,54 @@
+require_relative '../spec_helper'
+require 'cliutils/ext/hash_extensions'
+
+describe Hash do
+  it 'allows for deep merging' do
+    h1 = { key: 'value', key2: %w(value1, value2) }
+    h2 = { key: 'another_value', key3: { subkey1: 'value' } }
+    exp_result = { key: 'another_value', key2: ['value1,', 'value2'], key3: { subkey1: 'value' } }
+    actual_result = h1.deep_merge!(h2)
+
+    expect(actual_result).to eq(exp_result)
+  end
+
+  it 'allows for a new hash to be created with stringified keys' do
+    h = { key: { subkey1: 'value1', subkey2: { subsubkey1: 'value' } } }
+    exp_result = { 'key' => { 'subkey1' => 'value1', 'subkey2' => { 'subsubkey1' => 'value' } } }
+    actual_result = h.deep_stringify_keys
+
+    expect(actual_result).to_not eq(h)
+    expect(actual_result).to eq(exp_result)
+  end
+
+  it 'allows for inline key stringification' do
+    h = {key: {subkey1: 'value1', subkey2: {subsubkey1: 'value'}}}
+    exp_result = { 'key' => { 'subkey1' => 'value1', 'subkey2' => { 'subsubkey1' => 'value' } } }
+    actual_result = h.deep_stringify_keys!
+
+    expect(actual_result).to eq(h)
+    expect(actual_result).to eq(exp_result)
+  end
+
+  it 'allows for a new hash to be created with symbolized keys' do
+    h = { 'key' => { 'subkey1' => 'value1', 'subkey2' => { 'subsubkey1' => ['value1', 'value2']} } }
+    exp_result = { key: { subkey1: 'value1', subkey2: { subsubkey1: ['value1', 'value2']} } }
+    actual_result = h.deep_symbolize_keys
+
+    expect(actual_result).to_not eq(h)
+    expect(actual_result).to eq(exp_result)
+  end
+
+  it 'allows for inline key symbolization' do
+    h = { 'key' => { 'subkey1' => 'value1', 'subkey2' => { 'subsubkey1' => ['value1', 'value2']} } }
+    exp_result = { key: { subkey1: 'value1', subkey2: { subsubkey1: ['value1', 'value2']} } }
+    actual_result = h.deep_symbolize_keys!
+
+    expect(actual_result).to eq(h)
+    expect(actual_result).to eq(exp_result)
+  end
+
+  it 'can find a nested value by key' do
+    h = { key: { subkey1: 'value1', subkey2: { subsubkey1: 'subvalue1'} } }
+    h.recursive_find_by_key(:subsubkey1).should == 'subvalue1'
+  end
+end

data/spec/ext/logger_extensions_spec.rb

@@ -0,0 +1,20 @@
+require_relative '../spec_helper'
+require 'cliutils/ext/logger_extensions'
+
+describe Logger do
+  it 'allows custom levels to be attached' do
+    l = Logger.new(STDOUT)
+    l.formatter = proc do |severity, datetime, progname, msg|
+      puts "#{ severity }: #{ msg }"
+    end
+
+    out = capture_stdout { l.prompt('test') }
+    expect(out).to eq("PROMPT: test\n")
+
+    out = capture_stdout { l.section('test') }
+    expect(out).to eq("SECTION: test\n")
+
+    out = capture_stdout { l.success('test') }
+    expect(out).to eq("SUCCESS: test\n")
+  end
+end

data/spec/ext/string_extensions_spec.rb

@@ -0,0 +1,26 @@
+require_relative '../spec_helper'
+require 'cliutils/ext/string_extensions'
+
+describe String do
+  it 'outputs strings with preset custom colors' do
+    expect('blue string'.blue).to eq("\e[34mblue string\e[0m")
+    expect('cyan string'.cyan).to eq("\e[36mcyan string\e[0m")
+    expect('green string'.green).to eq("\e[32mgreen string\e[0m")
+    expect('purple string'.purple).to eq("\e[35mpurple string\e[0m")
+    expect('red string'.red).to eq("\e[31mred string\e[0m")
+    expect('white string'.white).to eq("\e[37mwhite string\e[0m")
+    expect('yellow string'.yellow).to eq("\e[33myellow string\e[0m")
+  end
+
+  it 'outputs strings with configurable custom colors' do
+    expect('crazy string'.colorize('34,42')).to eq("\e[34,42mcrazy string\e[0m")
+  end
+
+  it 'camel-cases strings' do
+    expect('my_long_snake_name'.camelize).to eq('MyLongSnakeName')
+  end
+
+  it 'snake-cases strings' do
+    expect('MyLongCamelName'.snakify).to eq('my_long_camel_name')
+  end
+end