cliutils 1.2.7 → 1.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac9423ddd995d1468da91eff3b3abf630b7c5aa1
-  data.tar.gz: 6e430afb3d34414ee453b4fa70be21878f9a8c2f
+  metadata.gz: eb6abdf9f2796a668951e2178193ebfa1110b5bf
+  data.tar.gz: 6216f1699daa43bbd541d5c27037278000455b16
 SHA512:
-  metadata.gz: d96e9df275ed3a6272ae23c85023c82671b6af7e1168867a1f675904b50369e0567bd47b6e4c1183f471f928b56c20c4ba21883b82af35d5386e2fc240791218
-  data.tar.gz: 28cb0e9a8af04179edefaba915f7ecb6f3fcddc8d33e460323c28cb11924ebb5ae476578fcc74e023389246d09851c25e58d21cce12bc5ec7478a7a253b5a255
+  metadata.gz: 4283a18fa302cd1c59aee7d376da17930555b5362f46fda1fe6cb8853ea62ac417e129afc0ef97776c35cc1073678b37e7f88e862d4c05c74770015a8722d62b
+  data.tar.gz: 807478504596067deb636925a4d04a335abac239f775edd4079ac27efe784dd604412d94b24d564ae28190d35a6ba7b1cb8bf1e856fcc4ac86b43e0225d5e228

data/HISTORY.md

@@ -1,3 +1,8 @@
+# 1.2.8 (2014-04-08)
+
+* Global name changes
+* Some cleanup
+
 # 1.2.7 (2014-04-08)
 
 * Added more Behaviors
@@ -46,7 +51,7 @@
 
 # 1.0.7 (2014-03-30)
 
-* Modified Messenging targets to be a Hash for easier lookup/deletion
+* Modified Messaging targets to be a Hash for easier lookup/deletion
 
 # 1.0.6 (2014-03-30)
 
@@ -55,7 +60,7 @@
 # 1.0.5 (2014-03-30)
 
 * Fixed a bug with Configuration singleton
-* Fixed a bug with Messenging singleton
+* Fixed a bug with Messaging singleton
 
 # 1.0.4 (2014-03-29)
 

data/README.md

@@ -54,19 +54,19 @@ Note that although this README.md is extensive, it may not cover all methods. Ch
 CLIUtils offers:
 
 * [PrettyIO](#prettyio): nicer-looking CLI messages
-* [Messenging](#messenging): a system to display nicely-formatted messages to one or more tagets
+* [Messaging](#messaging): a system to display nicely-formatted messages to one or more tagets
 * [Configuration](#configuration): a app configuration manager
 * [Prefs](#prefs): a preferences prompter and manager
 
 ## PrettyIO
 
-First stop on our journey is better client IO. To activate, simply mix into your project:
+First stop on our journey is better client IO via `PrettyIO`. To activate, simply mix into your project:
 
 ```ruby
 include CLIUtils::PrettyIO
 ```
 
-PrettyIO affords you colorized strings:
+To start, `PrettyIO` affords you colorized strings:
 
 ```ruby
 puts 'A sample string'.red
@@ -92,29 +92,29 @@ puts 'A sample string'.colorize('35;42')
 ```
 ![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/prettyio-gnarly-text.png "Complex Colored Text via PrettyIO")
 
-Naturally, memorizing the ANSI color scheme is a pain, so PrettyIO gives you a convenient method to look up these color combinations:
+Naturally, memorizing the ANSI color scheme is a pain, so `PrettyIO` gives you a convenient method to look up these color combinations:
 
 ```ruby
 color_chart
 ```
 ![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/prettyio-color-chart.png "PrettyIO Color Chart")
 
-## Messenging
+## Messaging
 
-Throughout the life of your application, you will most likely want to send several messages to your user (warnings, errors, info, etc.). Messenging makes this a snap. It, too, is a mixin:
+Throughout the life of your application, you will most likely want to send several messages to your user (warnings, errors, info, etc.). `Messaging` makes this a snap. It, too, is a mixin:
 
 ```ruby
-include CLIUtils::Messenging
+include CLIUtils::Messaging
 ```
 
-Once mixed in, you get access to `messenger`, a type of Logger that uses PrettyIO to send nicely-formatted messages to your user. For example, if you'd like to warn your user:
+Once mixed in, you get access to `messenger`, a type of Logger that uses `PrettyIO` to send nicely-formatted messages to your user. For example, if you'd like to warn your user:
 
 ```ruby
 messenger.warn('Hey pal, you need to be careful.')
 ```
 ![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/messenger-warn.png "A Warning from Messenger")
 
-### Messenging Methods
+### Messaging Methods
 
 `messenger` gives you access to several basic methods:
 
@@ -145,7 +145,7 @@ messenger.info_block('Starting up...', 'Done!', multiline = false) { # do stuff
 
 ### Message Wrapping
 
-PrettyIO also gives `messenger` the ability to wrap your messages so that they don't span off into infinity. You can even control what the wrap limit (in characters) is:
+`PrettyIO` also gives `messenger` the ability to wrap your messages so that they don't span off into infinity. You can even control what the wrap limit (in characters) is:
 
 ```Ruby
 CLIUtils::PrettyIO.wrap_char_limit = 50
@@ -169,11 +169,11 @@ messenger.info("You answered: #{ p }")
 ```
 ![alt text](https://raw.githubusercontent.com/bachya/cli-utils/master/res/readme-images/prompting.png "Prompting")
 
-When you pass a default to `messenging.prompt`, hitting `Enter` (i.e., leaving the prompt blank) will return the value of the default.
+When you pass a default to `messaging.prompt`, hitting `Enter` (i.e., leaving the prompt blank) will return the value of the default.
 
 ### Logging
 
-Often, it's desirable to log messages as they appear to your user. `messenging` makes this a breeze by allowing you to attach and detach Logger instances at will.
+Often, it's desirable to log messages as they appear to your user. `messaging` makes this a breeze by allowing you to attach and detach Logger instances at will.
 
 For instance, let's say you wanted to log a few messages to both your user's STDOUT and to `file.txt`:
 
@@ -502,7 +502,6 @@ prefs.ask
 
 ```YAML
 validators:
-  - numeric      # Must be a number
   - alphabetic   # Must be made up of letters and spaces
   - alphanumeric # Must be made up of letters, numbers, and spaces
   - date         # Must be a parsable date (e.g., 2014-04-03)

data/lib/cliutils/constants.rb

@@ -1,5 +1,5 @@
 # Stores constants to use.
 module CLIUtils
   # The current version of the gem
-  VERSION = '1.2.7'
+  VERSION = '1.2.8'
 end

data/lib/cliutils/{messenging.rb → messaging.rb}

@@ -3,7 +3,7 @@ require 'cliutils/pretty_io'
 module CLIUtils
   #  CLIMessenger Module
   #  Outputs coordinated messages to a variety of targets.
-  module Messenging
+  module Messaging
     include PrettyIO
 
     # Hook that triggers when this module is included.

data/lib/cliutils/prefs/pref.rb

@@ -1,4 +1,4 @@
-require 'cliutils/messenging'
+require 'cliutils/messaging'
 require 'cliutils/prefs/pref_behavior'
 require 'cliutils/prefs/pref_validation'
 
@@ -6,7 +6,7 @@ module CLIUtils
   # Pref Class
   # An individual preference
   class Pref
-    include Messenging
+    include Messaging
 
     # Stores the answer to this Pref.
     # @return [String, Symbol]

data/lib/cliutils/prefs.rb

@@ -5,7 +5,7 @@ module CLIUtils
   # Engine to derive preferences from a YAML file, deliver
   # those to a user via a prompt, and collect the results.
   class Prefs
-    include Messenging
+    include Messaging
     # Stores the filepath (if it exists) to the prefs file.
     # @return [String]
     attr_reader :config_path

data/lib/cliutils/pretty_io.rb

@@ -48,7 +48,7 @@ module CLIUtils
       end
     end
 
-    # Empty method so that Messenging doesn't freak
+    # Empty method so that Messaging doesn't freak
     # out when passed a debug message.
     # @return [void]
     def debug(m); end
@@ -93,7 +93,7 @@ module CLIUtils
       end
     end
 
-    # Empty method so that Messenging doesn't freak
+    # Empty method so that Messaging doesn't freak
     # out when passed a debug message.
     # @return [void]
     def log(m); end

data/lib/cliutils.rb

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

data/test/messenging_test.rb

@@ -4,11 +4,11 @@ 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')
+require File.join(File.dirname(__FILE__), '..', 'lib/cliutils/messaging')
 
 # Tests for the Hash extension methods
-class TestMessenging < Test::Unit::TestCase
-  include CLIUtils::Messenging
+class TestMessaging < Test::Unit::TestCase
+  include CLIUtils::Messaging
 
   def setup
     @file1path = '/tmp/file1.txt'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cliutils
 version: !ruby/object:Gem::Version
-  version: 1.2.7
+  version: 1.2.8
 platform: ruby
 authors:
 - Aaron Bach
@@ -91,7 +91,7 @@ files:
 - lib/cliutils/ext/logger_extensions.rb
 - lib/cliutils/ext/string_extensions.rb
 - lib/cliutils/logger_delegator.rb
-- lib/cliutils/messenging.rb
+- lib/cliutils/messaging.rb
 - lib/cliutils/prefs.rb
 - lib/cliutils/prefs/pref.rb
 - lib/cliutils/prefs/pref_behavior.rb