cliutils 2.1.4 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d62e541400b381493e5a6699ba4db68e959cdc06
-  data.tar.gz: 2e733795f7de8268159811bd1a457e21066575f5
+  metadata.gz: 31b393aa656e5f0af3f63b272675069a58441286
+  data.tar.gz: fd649fe5090c1112c810e1b12b09d0120b43ac71
 SHA512:
-  metadata.gz: a600e5780fccddf0d6d86031e383085b3f07d971ab8378de2d1ef0544bdb85f6846ae6fe9ad0348602eb8b0381efe1b81316bff5c3531ef20faffd4e26469dfe
-  data.tar.gz: d305f17fa6e613e0ab963f32103e333386977af6f1382379de9011fc4b527b5d9c518d50e104fad5951d0fff9d99e756872927d71ccb92e79b4839fe4482d7d2
+  metadata.gz: 0f042f15114fb441f842918907ce8be6ff18a26e51b921e77fe749b59818411d66bcbd94c6194b4aca23a27b5474970ff35ee32e203ccb0ed6b55831f9266383
+  data.tar.gz: a79310fbc362ba89a2b538c60c523314dbc17b22463f630763f28057e0e05e34632536eecc514a98403a22ea5c4dd1bd6a7a58640284f765a7106f491482245a

data/.gitignore

@@ -5,3 +5,5 @@ pkg
 bin
 .tmp
 Gemfile.lock
+coverage
+npm-debug.log

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 rvm:
+  - 2.1.1
   - 2.1.0
-  - 2.0.0
+  - 2.0
   - 1.9.3
-  - jruby-19mode
+  - rbx

data/Gemfile

@@ -1,6 +1,13 @@
 source 'https://rubygems.org'
 
+gem 'simplecov', require: false
 gem 'coveralls', require: false
 
+platforms :rbx do
+  gem 'racc'
+  gem 'rubysl', '~> 2.0'
+  gem 'psych'
+end
+
 # Specify your gem's dependencies in cliutils.gemspec
 gemspec

data/HISTORY.md

@@ -1,3 +1,10 @@
+# 2.2.0 (2014-04-26)
+
+* More robust `Messaging` that allows for logging of prompts
+* Complete RSpec tests (moving on from Test Unit)
+* Removed useless `info_block` method
+* Several bugfixes
+
 # 2.1.4 (2014-04-26)
 
 * Slightly more robust Time regex in TimeValidator

data/README.md

@@ -2,6 +2,7 @@ CLIUtils
 ====
 [![Build Status](https://travis-ci.org/bachya/cliutils.svg?branch=master)](https://travis-ci.org/bachya/cliutils)
 [![Gem Version](https://badge.fury.io/rb/cliutils.svg)](http://badge.fury.io/rb/cliutils)
+[![Coverage Status](http://img.shields.io/coveralls/bachya/cliutils/master.svg)](https://coveralls.io/r/bachya/cliutils?branch=master)
 
 CLIUtils is a library of functionality designed to alleviate common tasks and headaches when developing command-line (CLI) apps in Ruby.
 
@@ -35,10 +36,11 @@ CLIUtils offers:
 
 CLIUtils is certified against the following:
 
+* Ruby 2.1.1
 * Ruby 2.1.0
 * Ruby 2.0.0
 * Ruby 1.9.3
-* jruby-19mode
+* Latest RBX
 
 # Installation
 

data/Rakefile

@@ -20,6 +20,13 @@ Rake::TestTask.new do |t|
   t.test_files = FileList['test/*_test.rb', 'test/**/*_test.rb']
 end
 
+require 'rspec/core/rake_task'
+desc "Run the specs."
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+  t.verbose = false
+end
+
 desc "Release CLIUtils version #{version}"
 task :release => :build do
   unless `git branch` =~ /^\* master$/
@@ -41,4 +48,4 @@ task :build do
   FileUtils.mv("./cliutils-#{version}.gem", "pkg")
 end
 
-task :default => :test
+task :default => [:spec] #:yard

data/cliutils.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency('bundler', '~> 1.5')
   spec.add_development_dependency('rake', '~> 0')
+  spec.add_development_dependency('rspec', '2.14.1')
   spec.add_development_dependency('yard', '0.8.7.4')
   spec.add_runtime_dependency('launchy', '2.4.2')
 end

data/lib/cliutils/configuration.rb

@@ -27,7 +27,7 @@ module CLIUtils
     # a Configurator.
     # @return [Configurator]
     def configuration
-      if !@@configuration.nil?
+      if @@configuration
         @@configuration
       else
         fail 'Attempted to access `configuration` before ' \

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.4'
+  VERSION = '2.2.0'
 end

data/lib/cliutils/ext/hash_extensions.rb

@@ -2,20 +2,24 @@
 # Contains many convenient methods borrowed from Rails
 # http://api.rubyonrails.org/classes/Hash.html
 class Hash
-  # Deep merges a hash into the current one.
+  # Deep merges a hash into the current one. Returns
+  # a new copy of the hash.
   # @param [Hash] other_hash The hash to merge in
-  # @yield &block
   # @return [Hash] The original Hash
-  def deep_merge!(other_hash, &block)
-    other_hash.each_pair do |k, v|
-      tv = self[k]
-      if tv.is_a?(Hash) && v.is_a?(Hash)
-        self[k] = tv.deep_merge(v, &block)
-      else
-        self[k] = block && tv ? block.call(k, tv, v) : v
-      end
+  def deep_merge(other_hash)
+    self.merge(other_hash) do |key, oldval, newval|
+      oldval = oldval.to_hash if oldval.respond_to?(:to_hash)
+      newval = newval.to_hash if newval.respond_to?(:to_hash)
+      oldval.class.to_s == 'Hash' && newval.class.to_s == 'Hash' ? oldval.deep_merge(newval) : newval
     end
-    self
+  end
+
+  # Deep merges a hash into the current one. Does
+  # the replacement inline.
+  # @param [Hash] other_hash The hash to merge in
+  # @return [Hash] The original Hash
+  def deep_merge!(other_hash)
+    replace(deep_merge(other_hash))
   end
 
   # Recursively turns all Hash keys into strings and
@@ -66,6 +70,7 @@ class Hash
   # key and returns the value (if there is one).
   # http://stackoverflow.com/a/2239847/327179
   # @param [<Symbol, String>] key The key to search for
+  # @yield
   # @return [Multiple]
   def recursive_find_by_key(key)
     # Create a stack of hashes to search through for the needle which
@@ -86,7 +91,6 @@ class Hash
         end
       end
     end
-    yield if block_given?
   end
 
   private

data/lib/cliutils/messaging.rb

@@ -1,128 +1,14 @@
-require 'cliutils/pretty_io'
+require 'cliutils/messenger'
 
 module CLIUtils
   #  CLIMessenger Module
   #  Outputs coordinated messages to a variety of targets.
   module Messaging
-    include PrettyIO
-
-    # Hook that triggers when this module is included.
-    # @param [Object] k The includer object
-    # @return [void]
-    def self.included(k)
-      k.extend(self)
-    end
-
-    # Empty method so that Messaging doesn't freak out when passed a debug
-    # message.
-    # @return [void]
-    def debug(m); end
-
-    # Returns a default instance of LoggerDelegator that delegates to STDOUT
-    # only.
-    # @return [LoggerDelegator]
-    def default_instance
-      stdout_logger = Logger.new(STDOUT)
-      stdout_logger.formatter = proc do |severity, datetime, progname, msg|
-        send(severity.downcase, msg)
-      end
-
-      LoggerDelegator.new(STDOUT: stdout_logger)
-    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 [Boolean] 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
-
     # Singleton method to return (or initialize, if needed)
     # a LoggerDelegator.
     # @return [LoggerDelegator]
     def messenger
-      @@messenger ||= default_instance
-    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
-
-    # 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
+      @@messenger ||= CLIUtils::Messenger.new
     end
   end
 end

data/lib/cliutils/messenger.rb

@@ -0,0 +1,109 @@
+require 'cliutils/pretty_io'
+require 'readline'
+
+module CLIUtils
+  class Messenger
+    include PrettyIO
+
+    # The endpoints to which delegation occurs.
+    # @return [Array]
+    attr_reader :targets
+
+    # Attaches a new target to delegate to.
+    # @param [Hash] target A hash describing a reference key and a Logger
+    # @return [void]
+    def attach(target)
+      fail "Cannot add invalid target: #{ target }" unless target.is_a?(Hash)
+      @targets.merge!(target)
+    end
+
+    # Empty method so that Messaging doesn't freak out when passed a debug
+    # message.
+    # @return [void]
+    def debug(m)
+      @targets.each { |_, t| t.debug(m) }
+    end
+
+    # Detaches a delegation target.
+    # @param [<String, Symbol>] target_name The target to remove
+    # @return [void]
+    def detach(target_name)
+      unless @targets.key?(target_name)
+        fail "Cannot detach invalid target: #{ target_name }"
+      end
+      @targets.delete(target_name)
+    end
+
+    # Outputs a formatted-red error message.
+    # @param [String] m The message to output
+    # @return [void]
+    def error(m)
+      puts _word_wrap(m, '# ').red
+      @targets.each { |_, t| t.error(m) }
+    end
+
+    # Outputs a formatted-blue informational message.
+    # @param [String] m The message to output
+    # @return [void]
+    def info(m)
+      puts _word_wrap(m, '# ').blue
+      @targets.each { |_, t| t.info(m) }
+    end
+
+    def info_block(*params)
+      warn('As of 2.2.0, `info_block` is deprecated and nonfunctioning.')
+    end
+
+    def initialize(targets = {})
+      @targets = targets
+    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
+    # @return [String]
+    def prompt(prompt, default = nil)
+      Readline.completion_append_character = nil
+      Readline.completion_proc = Proc.new do |str|
+        Dir[str + '*'].grep( /^#{ Regexp.escape(str) }/ )
+      end
+
+      p = "# #{ prompt }#{ default.nil? ? ':' : " [default: #{ default }]:" } "
+      r = ''
+      choice = Readline.readline(p.cyan)
+      if choice.nil? || choice.empty?
+        r = default
+      else
+        r = choice
+      end
+
+      @targets.each { |_, t| t.prompt("Answer to '#{ prompt }': #{ r }") }
+      r
+    end
+
+    # Outputs a formatted-purple section message.
+    # @param [String] m The message to output
+    # @return [void]
+    def section(m)
+      puts _word_wrap(m, '---> ').purple
+      @targets.each { |_, t| t.section(m) }
+    end
+
+    # Outputs a formatted-green success message.
+    # @param [String] m The message to output
+    # @return [void]
+    def success(m)
+      puts _word_wrap(m, '# ').green
+      @targets.each { |_, t| t.success(m) }
+    end
+
+    # Outputs a formatted-yellow warning message.
+    # @param [String] m The message to output
+    # @return [void]
+    def warn(m)
+      puts _word_wrap(m, '# ').yellow
+      @targets.each { |_, t| t.warn(m) }
+    end
+  end
+end

data/lib/cliutils/prefs/pref.rb

@@ -120,7 +120,7 @@ module CLIUtils
 
       valid_option_chosen = false
       until valid_option_chosen
-        response = prompt(@prompt_text, default)
+        response = messenger.prompt(@prompt_text, default)
         if validate(response)
           valid_option_chosen = true
           @answer = evaluate_behaviors(response)
@@ -190,11 +190,11 @@ module CLIUtils
     # Evaluates the pre-prompt Hash and does the right thing. :)
     # @return [void]
     def _eval_pre
-      info(@pre[:message])
-      prompt('Press enter to continue')
+      messenger.info(@pre[:message])
+      messenger.prompt('Press enter to continue')
 
       if (@pre[:action])
-        action_obj = _init_action(@pre[:action][:name])
+        action_obj = _init_action(@pre[:action])
         action_obj.run if action_obj
       end
     end
@@ -202,11 +202,11 @@ module CLIUtils
     # Evaluates the post-prompt Hash and does the right thing. :)
     # @return [void]
     def _eval_post
-      info(@post[:message])
-      prompt('Press enter to continue')
+      messenger.info(@post[:message])
+      messenger.prompt('Press enter to continue')
 
       if (@post[:action])
-        action_obj = _init_action(@post[:action][:name])
+        action_obj = _init_action(@post[:action])
         action_obj.run if action_obj
       end
     end
@@ -217,8 +217,8 @@ module CLIUtils
     # @return [void]
     def _init_action(path_or_name)
       obj = _load_asset(ASSET_TYPE_ACTION, path_or_name)
-      unless obj.nil?
-        obj.parameters = @pre[:action][:parameters]
+      unless obj.nil? || @pre[:parameters].nil?
+        obj.parameters = @pre[:parameters]
       end
       obj
     end
@@ -258,7 +258,7 @@ module CLIUtils
         # If the file exists, we're assuming that the user
         # passed a filepath.
         asset_found = true
-        asset_path = File.expand_path(path_or_name) if path_or_name.start_with?('~')
+        asset_path = File.expand_path(path_or_name)
         asset_name = File.basename(path_or_name, '.*').camelize
       end