cliutils 1.0.0

data/test/configurator_test.rb

@@ -0,0 +1,50 @@
+require 'fileutils'
+require 'test/unit'
+
+require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/configurator')
+
+class TestConfigurator < Test::Unit::TestCase
+  def setup
+    @config_path = '/tmp/test.config'
+    @config = CLIUtils::Configurator.new(@config_path)
+  end
+
+  def teardown
+    FileUtils.rm(@config_path) if File.exists?(@config_path)
+  end
+
+  def test_add_section
+    @config.add_section(:test)
+    assert_equal(@config.data, {test: {}})
+  end
+
+  def test_delete_section
+    @config.add_section(:test)
+    @config.add_section(:test2)
+    @config.delete_section(:test)
+    assert_equal(@config.data, {test2: {}})
+  end
+
+  def test_accessing
+    @config.add_section(:test)
+    @config.data[:test].merge!(name: 'Bob')
+    assert_equal(@config.test, {name: 'Bob'})
+  end
+
+  def test_reset
+    @config.add_section(:test)
+    @config.data[:test].merge!(name: 'Bob')
+    @config.reset
+    assert_equal(@config.data, {})
+  end
+
+  def test_save
+    @config.add_section(:section1)
+    @config.section1.merge!({ a: 'test', b: 'test' })
+    @config.save
+    
+    File.open(@config_path, 'r') do |f|
+      assert_output("---\nsection1:\n  a: test\n  b: test\n") { puts f.read }
+    end
+  end
+end

data/test/hash_extensions_test.rb

@@ -0,0 +1,50 @@
+require 'test/unit'
+
+require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/ext/Hash+Extensions')
+
+class TestHashExtensions < Test::Unit::TestCase
+  def test_deep_merge!
+    h1 = {key: 'value', key2: ['value1', 'value2']}
+    h2 = {key3: {subkey1: 'value1'}, key: 'another_value'}
+    exp_result = {:key=>"another_value", :key2=>["value1", "value2"], :key3=>{:subkey1=>"value1"}}
+    actual_result = h1.deep_merge!(h2)
+    
+    assert_equal(exp_result, actual_result)
+  end
+  
+  def test_deep_stringify_keys
+    h = {key: {subkey1: 'value1', subkey2: {subsubkey1: 'value'}}}
+    exp_result = {'key' => {'subkey1' => 'value1', 'subkey2' => {'subsubkey1' => 'value'}}}
+    actual_result = h.deep_stringify_keys
+    
+    assert_not_equal(h, actual_result)
+    assert_equal(exp_result, actual_result)
+  end
+  
+  def test_deep_stringify_keys!
+    h = {key: {subkey1: 'value1', subkey2: {subsubkey1: 'value'}}}
+    exp_result = {'key' => {'subkey1' => 'value1', 'subkey2' => {'subsubkey1' => 'value'}}}
+    actual_result = h.deep_stringify_keys!
+    
+    assert_equal(h, actual_result)
+    assert_equal(exp_result, actual_result)
+  end
+  
+  def test_deep_symbolize_keys
+    h = {'key' => {'subkey1' => 'value1', 'subkey2' => {'subsubkey1' => 'value'}}}
+    exp_result = {key: {subkey1: 'value1', subkey2: {subsubkey1: 'value'}}}
+    actual_result = h.deep_symbolize_keys
+    
+    assert_not_equal(h, actual_result)
+    assert_equal(exp_result, actual_result)
+  end
+
+  def test_deep_symbolize_keys!
+    h = {'key' => {'subkey1' => 'value1', 'subkey2' => {'subsubkey1' => 'value'}}}
+    exp_result = {key: {subkey1: 'value1', subkey2: {subsubkey1: 'value'}}}
+    actual_result = h.deep_symbolize_keys!
+    
+    assert_equal(h, actual_result)
+    assert_equal(exp_result, actual_result)
+  end
+end

data/test/logger_extensions_test.rb

@@ -0,0 +1,16 @@
+require 'test/unit'
+
+require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/ext/Logger+Extensions')
+
+class TestLoggerExtensions < Test::Unit::TestCase
+  def test_custom_level
+    l = Logger.new(STDOUT)
+    l.formatter = proc do |severity, datetime, progname, msg|
+      puts "#{ severity }: #{ msg }"
+    end
+    
+    assert_output("PROMPT: test\n")  { l.prompt('test')  }
+    assert_output("SECTION: test\n") { l.section('test') }
+    assert_output("SUCCESS: test\n") { l.success('test') }
+  end
+end

data/test/messenging_test.rb

@@ -0,0 +1,53 @@
+require 'fileutils'
+require 'logger'
+require 'test/unit'
+
+require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/ext/String+Extensions')
+require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/pretty-io')
+require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/logger-delegator')
+require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/messenging')
+
+class TestMessenging < Test::Unit::TestCase
+  include CLIUtils::Messenging
+  
+  def setup
+    @file1path = '/tmp/file1.txt'
+  end
+
+  def teardown
+    FileUtils.rm(@file1path) if File.exists?(@file1path)
+  end
+  
+  def test_stdout_output
+    assert_output('# This is error'.red + "\n") { messenger.send(:error, 'This is error') }
+    assert_output('# This is info'.blue + "\n") { messenger.send(:info, 'This is info') }
+    assert_output('---> This is section'.purple + "\n") { messenger.send(:section, 'This is section') }
+    assert_output('# This is success'.green + "\n") { messenger.send(:success, 'This is success') }
+    assert_output('# This is warn'.yellow + "\n") { messenger.send(:warn, 'This is warn') }
+  end
+  
+  def test_wrapping
+    CLIUtils::PrettyIO.wrap_at(35)
+    
+    long_str = 'This is a really long string that should wrap itself at some point, okay?'
+    expected_str = long_str.gsub(/\n/, ' ').gsub(/(.{1,#{CLIUtils::PrettyIO.wrap_limit - 2}})(\s+|$)/, "# \\1\n").strip
+    assert_output(expected_str.blue + "\n") { messenger.send(:info, long_str) }
+  end
+
+  def test_attach_detach
+    file_logger = Logger.new(@file1path)
+    file_logger.formatter = proc do |severity, datetime, progname, msg|
+      "#{ severity }: #{ msg }\n"
+    end
+    
+    messenger.attach(file_logger)
+    messenger.send(:info, 'Info test')
+    messenger.send(:error, 'Error test')
+    messenger.detach(file_logger)
+    messenger.send(:warn, 'Warn test')
+    
+    File.open(@file1path, 'r') do |f|
+      assert_output("INFO: Info test\nERROR: Error test\n") { puts f.read.lines[1..-1].join }
+    end
+  end
+end

data/test/prefs_test.rb

@@ -0,0 +1,29 @@
+require 'fileutils'
+require 'test/unit'
+require 'yaml'
+
+require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/ext/Hash+Extensions')
+require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/prefs')
+
+class TestPrefs < Test::Unit::TestCase
+  def setup
+    @prefs_arr = [{:prompt=>"What is the hostname of your DD-WRT router?", :default=>"192.168.1.1", :key=>"hostname", :section=>"ssh_info"}, {:prompt=>"What is the SSH username of your DD-WRT router?", :default=>"root", :key=>"username", :section=>"ssh_info"}, {:prompt=>"What SSH port does your DD-WRT router use?", :default=>22, :key=>"port", :section=>"ssh_info"}, {:prompt=>"How do you use password or key authentication?", :default=>"password", :key=>"auth_method", :section=>"ssh_info", :options=>["password", "key"]}, {:prompt=>"Where is your key located?", :default=>"~/.ssh", :key=>"key_location", :section=>"ssh_info", :requirements=>[{:key=>"auth_method", :value=>"key"}]}, {:prompt=>"What is your password?", :key=>"password", :section=>"ssh_info", :requirements=>[{:key=>"auth_method", :value=>"password"}]}]
+    
+    @prefs_filepath = '/tmp/prefstest.yaml'
+    FileUtils.cp(File.join(File.dirname(__FILE__), '..', 'test/test_files/prefstest.yaml'), @prefs_filepath)
+  end
+
+  def teardown
+    FileUtils.rm(@prefs_filepath) if File.exists?(@prefs_filepath)
+  end
+
+  def test_file_creation
+    p = CLIUtils::Prefs.new(@prefs_filepath)
+    assert_equal(YAML::load_file(@prefs_filepath).deep_symbolize_keys!, p.prompts)
+  end
+
+  def test_hash_creation
+    p = CLIUtils::Prefs.new(@prefs_arr)
+    assert_equal({:prompts => @prefs_arr}.deep_symbolize_keys!, p.prompts)
+  end
+end

data/test/string_extesions_test.rb

@@ -0,0 +1,14 @@
+require 'test/unit'
+
+require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/ext/String+Extensions')
+
+class TestStringExtensions < Test::Unit::TestCase
+  def test_custom_colors
+    assert_output("\e[34mtest\e[0m\n") { puts 'test'.blue }
+    assert_output("\e[36mtest\e[0m\n") { puts 'test'.cyan }
+    assert_output("\e[32mtest\e[0m\n") { puts 'test'.green }
+    assert_output("\e[35mtest\e[0m\n") { puts 'test'.purple }
+    assert_output("\e[31mtest\e[0m\n") { puts 'test'.red }
+    assert_output("\e[33mtest\e[0m\n") { puts 'test'.yellow }
+  end
+end

data/test/test_files/prefstest.yaml

@@ -0,0 +1,33 @@
+prompts:
+  - prompt: What is the hostname of your DD-WRT router?
+    default: 192.168.1.1
+    key: hostname
+    section: ssh_info
+  - prompt: What is the SSH username of your DD-WRT router?
+    default: root
+    key: username
+    section: ssh_info
+  - prompt: What SSH port does your DD-WRT router use?
+    default: 22
+    key: port
+    section: ssh_info
+  - prompt: Do you use password or key authentication?
+    default: password
+    key: auth_method
+    section: ssh_info
+    options: ['password', 'key']
+  - prompt: Where is your key located?
+    default: ~/.ssh
+    key: key_location
+    section: ssh_info
+    requirements:
+      - key: auth_method
+        value: key
+  - prompt: What is your password?
+    key: password
+    section: ssh_info
+    requirements:
+      - key: auth_method
+        value: password
+      
+    

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: cliutils
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aaron Bach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-29 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: rdoc
+  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: 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'
+description: A library of functionality designed to alleviate common tasks and headaches
+  when developing command-line (CLI) apps in Ruby.
+email:
+- bachya1208@googlemail.com
+executables:
+- cliutils
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".DS_Store"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- README.rdoc
+- Rakefile
+- bin/cliutils
+- cliutils.gemspec
+- features/cli_manager.feature
+- features/step_definitions/cli_manager_steps.rb
+- features/support/env.rb
+- html/CLIUtils.html
+- html/CLIUtils/Configuration.html
+- html/CLIUtils/Configurator.html
+- html/CLIUtils/LoggerDelegator.html
+- html/CLIUtils/Messenging.html
+- html/CLIUtils/Prefs.html
+- html/CLIUtils/PrettyIO.html
+- html/Hash.html
+- html/Logger.html
+- html/Object.html
+- html/README_md.html
+- html/String.html
+- html/created.rid
+- html/fonts.css
+- html/fonts/Lato-Light.ttf
+- html/fonts/Lato-LightItalic.ttf
+- html/fonts/Lato-Regular.ttf
+- html/fonts/Lato-RegularItalic.ttf
+- html/fonts/SourceCodePro-Bold.ttf
+- html/fonts/SourceCodePro-Regular.ttf
+- html/images/add.png
+- html/images/arrow_up.png
+- html/images/brick.png
+- html/images/brick_link.png
+- html/images/bug.png
+- html/images/bullet_black.png
+- html/images/bullet_toggle_minus.png
+- html/images/bullet_toggle_plus.png
+- html/images/date.png
+- html/images/delete.png
+- html/images/find.png
+- html/images/loadingAnimation.gif
+- html/images/macFFBgHack.png
+- html/images/package.png
+- html/images/page_green.png
+- html/images/page_white_text.png
+- html/images/page_white_width.png
+- html/images/plugin.png
+- html/images/ruby.png
+- html/images/tag_blue.png
+- html/images/tag_green.png
+- html/images/transparent.png
+- html/images/wrench.png
+- html/images/wrench_orange.png
+- html/images/zoom.png
+- html/index.html
+- html/js/darkfish.js
+- html/js/jquery.js
+- html/js/navigation.js
+- html/js/search.js
+- html/js/search_index.js
+- html/js/searcher.js
+- html/rdoc.css
+- html/table_of_contents.html
+- lib/.DS_Store
+- lib/cliutils.rb
+- lib/cliutils/configuration.rb
+- lib/cliutils/configurator.rb
+- 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/messenging.rb
+- lib/cliutils/prefs.rb
+- lib/cliutils/pretty-io.rb
+- lib/cliutils/version.rb
+- res/readme-images/messenger-types-1.png
+- res/readme-images/messenger-warn.png
+- res/readme-images/multi-logger.png
+- res/readme-images/prettyio-color-chart.png
+- res/readme-images/prettyio-gnarly-text.png
+- res/readme-images/prettyio-red-text.png
+- res/readme-images/prompting.png
+- res/readme-images/wrapping.png
+- test/configurator_test.rb
+- test/hash_extensions_test.rb
+- test/logger_extensions_test.rb
+- test/messenging_test.rb
+- test/prefs_test.rb
+- test/string_extesions_test.rb
+- test/test_files/prefstest.yaml
+homepage: https://github.com/bachya/cli-utils
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--title"
+- CLIUtils
+- "--main"
+- README.md
+- "-ri"
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Sugary goodness for Ruby CLI apps.
+test_files:
+- features/cli_manager.feature
+- features/step_definitions/cli_manager_steps.rb
+- features/support/env.rb
+- test/configurator_test.rb
+- test/hash_extensions_test.rb
+- test/logger_extensions_test.rb
+- test/messenging_test.rb
+- test/prefs_test.rb
+- test/string_extesions_test.rb
+- test/test_files/prefstest.yaml
+has_rdoc: true