trick_bag 0.64.3 → 0.65.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28ae94cfcd0c241ef6cd4d87ecae15af4a9929bf
-  data.tar.gz: ed2d558acf885889dff1ac5d187ffaaad87dd502
+  metadata.gz: 8b34121c64f4b175d63fe000e9580a2eb02941bf
+  data.tar.gz: fbd4317c8832954b89d7b55c4cbb3fd3824aaa49
 SHA512:
-  metadata.gz: 5cee6f95c71a61a9e4b7fed223afdbea81957a7befca0b4fff3b7ba2d39db48f5c1ce63f91d17bf95124c7756ce5834bb08f42f50a6471244097f3fbb33eebeb
-  data.tar.gz: 129f258783beb2feec46186284e07a0f1af10181ae538f1b10e5bf3785a924ae40b6130dc298f52debc32776f8d841371046c868b36290c6da1452dd87acf6bb
+  metadata.gz: 5a00d89a5c4d466c72221b506ef17f39d10ffe07b156ba03da8978a878b80e5ee7892374ba52303c102e65396629164c616587cd5313a1a427d1ef0211f57403
+  data.tar.gz: b1db69949c83dcf4b4ef3c7e69a9fe3a35191ca8d90bb0b6d3868d23aa09baf850aff9e1135c331cc21e343cddab452df1be5a69d6c2cbafe606918f24642f17

data/.travis.yml

@@ -1,5 +1,11 @@
 language: ruby
 
+
+# This intended to fix bundler bug in Ruby 1.9.3 (see https://github.com/travis-ci/travis-ci/issues/5239)
+before_install:
+  - gem install bundler
+
+
 rvm:
 - 2.0.0
 - 1.9.3

data/RELEASE_NOTES.md

@@ -1,3 +1,13 @@
+## v0.64.5
+
+* Modified .travis.yml. as per suggestion on web to fix bundler problem:
+NoMethodError: undefined method `spec' for nil:NilClass
+
+## v0.64.4
+
+* Fix net-ssh version error on Ruby versions < 2.  v0.64.2 did not work.
+
+
 ## v0.64.3
 
 * Fix retry_until_true_or_timeout bug.

data/lib/trick_bag.rb

@@ -1,7 +1,4 @@
 # Load all *.rb files in lib/trick_bag and below.
-# Use a lambda so that the intermediate variables do not survive this file.
-->() {
-  start_dir = File.join(File.dirname(__FILE__), 'trick_bag') # the lib directory
-  file_mask = "#{start_dir}/**/*.rb"
-  Dir[file_mask].each { |file| require file }
-}.()
+start_dir = File.join(File.dirname(__FILE__), 'trick_bag') # the lib directory
+file_mask = "#{start_dir}/**/*.rb"
+Dir[file_mask].each { |file| require file }

data/lib/trick_bag/collections/collection_access.rb

@@ -1,9 +1,28 @@
-# Supports access to nested hashes with a string instead of multiple []'s.
-# Inspired by Josh Szmajda's dot_notation gem at https://github.com/joshsz/dot_notation,
+# Supports access to nested hashes, arrays, etc., with a string instead of multiple []'s.
+# (e.g. 'myhostname.interfaces.0' instead of ['myhostname']['interfaces'][0])
+#
+# Inspired by Josh Szmajda's dot_notation gem at https://github.com/joshsz/dot_notation.
+#
+# The examples below assume a variable 'h' containing { x: [:red, :green, :blue] }
+#
+# 2 approaches are supported:
+#
+# 1) a method named 'access' to which you pass the aggregate object (collection)
+#    the keys as a single string or as an array, and, optionally, the separator
+#    character (which defaults to '.')
+#
+# 2) a lambda returned by the 'accessor' method that holds on to the collection so that
+#    you can call the lambda as if it were the object itself. This lambda calls the
+#    aforementioned 'access' method to do the main work.
+#
+# Please see the documentation of the methods below for further information.
+
 
 module TrickBag
 module CollectionAccess
 
+  class Error < RuntimeError; end
+
   module_function
 
 
@@ -28,7 +47,7 @@ module CollectionAccess
       begin
         Integer(object)
       rescue
-        raise "Key cannot be converted to an Integer: #{object}"
+        raise Error.new("Key cannot be converted to an Integer: #{object}")
       end
     end
 
@@ -39,7 +58,7 @@ module CollectionAccess
         when String
           key_string_or_array.split(separator)
         else
-          raise "Invalid data type: #{key_string_or_array.class}"
+          raise Error.new("Invalid data type: #{key_string_or_array.class}")
       end
     end
 
@@ -53,7 +72,7 @@ module CollectionAccess
         return_object = return_object[key]
       rescue => e
         this_key = keys[0..index].join(separator)
-        raise "Error occurred processing key [#{this_key}] in [#{key_string_or_array}]: #{e}"
+        raise Error.new("Error occurred processing key [#{this_key}] in [#{key_string_or_array}]: #{e}")
       end
     end
     return_object

data/lib/trick_bag/collections/linked_list.rb

@@ -93,7 +93,7 @@ class LinkedList
   def to_a
     current_node = @first
     array = []
-    while current_node != nil
+    while current_node
       array << current_node.value
       current_node = current_node.next
     end

data/lib/trick_bag/enumerables/buffered_enumerable.rb

@@ -13,7 +13,7 @@ module Enumerables
 #
 # Also supported is an optional fetch notification, a method or lambda that will
 # be called whenever a fetch is done.  This can be useful to update counters,
-# provide user feedback (e.g. a progress bar)
+# provide user feedback (e.g. a progress bar), etc.
 #
 # This is useful, for example, in network requests, when multiple requests can be sent
 # one immediately after another, and the responses can be collected as a group,
@@ -23,7 +23,7 @@ module Enumerables
 # to avoid the need to allow the lambda to modify the data array reference,
 # needlessly copying arrays,
 # and to eliminate the need for garbage collecting many array objects
-# (though the latter is not that important).
+# (though the latter is rarely important).
 class BufferedEnumerable
 
   include Enumerable

data/lib/trick_bag/enumerables/compound_enumerable.rb

@@ -52,12 +52,12 @@ class CompoundEnumerable
   def initialize(mode, keys, *enumerables)
 
     validate_inputs = ->do
-      raise "Mode must be either :yields_arrays or :yields_hashes" unless [:yields_arrays, :yields_hashes].include?(mode)
-      raise "Keys not provided" if mode == :yields_hashes && (! keys.is_a?(Array))
-      raise "No enumerables provided" if enumerables.empty?
+      raise ArgumentError.new("Mode must be either :yields_arrays or :yields_hashes") unless [:yields_arrays, :yields_hashes].include?(mode)
+      raise ArgumentError.new("Keys not provided") if mode == :yields_hashes && (! keys.is_a?(Array))
+      raise ArgumentError.new("No enumerables provided") if enumerables.empty?
 
       if mode == :yields_hashes && (keys.size != enumerables.size)
-        raise "Key array size (#{keys.size}) is different from enumerables size (#{enumerables.size})."
+        raise ArgumentError.new("Key array size (#{keys.size}) is different from enumerables size (#{enumerables.size}).")
       end
 
     end
@@ -106,6 +106,7 @@ class CompoundEnumerable
       new_values
     end
 
+    # TODO: Move conditional behavior outside of loop.
     enumerable.each do |thing|
       mode == :yields_arrays ? as_array.(thing) : as_hash.(thing)
     end

data/lib/trick_bag/formatters/formatters.rb

@@ -16,6 +16,10 @@ module Formatters
   # duration_to_s(1000.234567) => "16 m, 40.23456699999997 s"
   def duration_to_s(seconds)
 
+    unless seconds.is_a?(::Numeric)
+      raise ArgumentError.new("#{seconds} must be a number but is a #{seconds.class}.")
+    end
+
     seconds_in_minute = 60
     seconds_in_hour = 60 * seconds_in_minute
     seconds_in_day = 24 *seconds_in_hour
@@ -56,7 +60,7 @@ module Formatters
   # This is to disable the Diffy warning message "No newline at end of file"
   def end_with_nl(object)
     string = object.to_s
-    needs_modifying = string && string.size > 0 && string[-1] != "\n"
+    needs_modifying = string.size > 0 && string[-1] != "\n"
     needs_modifying ? "#{string}\n" : string
   end
 
@@ -107,7 +111,8 @@ module Formatters
     }
 
     unless strategies.keys.include?(strategy)
-      raise "Unsupported strategy: #{strategy}. Must be one of [#{strategies.keys.sort.join(', ')}]."
+      message = "Unsupported strategy: #{strategy}. Must be one of [#{strategies.keys.sort.join(', ')}]."
+      raise ArgumentError.new(message)
     end
 
     strategies[strategy].()

data/lib/trick_bag/io/text_mode_status_updater.rb

@@ -27,7 +27,9 @@ class TextModeStatusUpdater
   # Since this method uses ASCII escape sequences that would look messy in a file,
   # this method will silently return if the output stream is not a TTY, unless
   # @force_output_non_tty has been set to true.
-  def print
+  #
+  # @param args Optional arguments to be passed to the text generator
+  def print(*args)
 
     # If output is being redirected, don't print anything; it will look like garbage;
     # But if output was forced (e.g. to write to a string), then allow it.
@@ -38,7 +40,7 @@ class TextModeStatusUpdater
     else
       @outstream.print(move_cursor_left_text(@prev_text_length))
     end
-    text = @text_generator.().to_s
+    text = @text_generator.(*args).to_s
     @prev_text_length = text.length
     @outstream.print(clear_to_end_of_line_text + text)
   end

data/lib/trick_bag/operators/operators.rb

@@ -7,8 +7,9 @@ module Operators
   #
   # Ex: multi_eq(1, 1, 1, 2) => false; multi_eq(1, 1, 1, 1) => true
   def multi_eq(*values)
-    values = values.first if values.is_a?(Array) && values.size == 1
-    raise "Must be called with at least 2 parameters" if values.size < 2
+    # If there is only 1 arg, it must be an array of at least 2 elements.
+    values = values.first if values.first.is_a?(Array) && values.size == 1
+    raise ArgumentError.new("Must be called with at least 2 parameters; was: #{values.inspect}") if values.size < 2
     values[1..-1].all? { |value| value == values.first }
   end
 end

data/lib/trick_bag/system.rb

@@ -21,7 +21,7 @@ module System
   def command_available?(command)
     raise "Cannot be called on a non-Posix operating system." unless OS.posix?
     system("which #{command} > /dev/null")
-   end
+  end
 
 end
 end

data/lib/trick_bag/validations/object_validations.rb

@@ -3,6 +3,8 @@ module Validations
 
   module_function
 
+  class ObjectValidationError < RuntimeError;  end
+
 
   # Returns an array containing each symbol in vars for which the
   # corresponding instance variable  in the specified object is nil.
@@ -17,7 +19,7 @@ module Validations
   def raise_on_nil_instance_vars(object, vars)
     nil_vars = nil_instance_vars(object, vars)
     unless nil_vars.empty?
-      raise "The following instance variables were nil: #{nil_vars.join(', ')}."
+      raise ObjectValidationError.new("The following instance variables were nil: #{nil_vars.join(', ')}.")
     end
   end
 end

data/lib/trick_bag/validations/other_validations.rb

@@ -1,6 +1,8 @@
 module TrickBag
 module Validations
 
+  class InvalidValueError < RuntimeError;  end
+
   module_function
 
   # Used to succinctly (for the caller) check to see that a value provided by the caller
@@ -25,7 +27,7 @@ module Validations
     if missing
       values_display_array = output_with_inspect ? valid_values.map(&:inspect) : valid_values.map(&:to_s)
       message = "Invalid #{label} '#{value}'; must be one of: [#{values_display_array.join(', ')}]."
-      raise message
+      raise InvalidValueError.new(message)
     end
   end
 

data/lib/trick_bag/version.rb

@@ -1,3 +1,3 @@
 module TrickBag
-  VERSION = '0.64.3'
+  VERSION = '0.65.0'
 end

data/spec/trick_bag/collections/collection_access_spec.rb

@@ -55,14 +55,14 @@ describe CollectionAccess do
 
     it 'raises an error when accessing an invalid key' do
       h = { 'h' => ['a', 'b'] }
-      expect(-> { CollectionAccess.access(h, 'x.1.2') }).to raise_error
-      expect(-> { CollectionAccess.access(h, [x, 1, 2]) }).to raise_error
+      expect(-> { CollectionAccess.access(h, 'x.1.2') }).to raise_error(Error)
+      expect(-> { CollectionAccess.access(h, ['x', 1, 2]) }).to raise_error(Error)
     end
 
     it 'raises an error when accessing a string that should be a number' do
       h = { 'x' => ['a', 'b'] }
-      expect(-> { CollectionAccess.access(h, 'x.x') }).to raise_error
-      expect(-> { CollectionAccess.access(h, [x, x]) }).to raise_error
+      expect(-> { CollectionAccess.access(h, 'x.x') }).to raise_error(Error)
+      expect(-> { CollectionAccess.access(h, ['x', 'x']) }).to raise_error(Error)
     end
   end
 

data/spec/trick_bag/enumerables/compound_enumerable_spec.rb

@@ -9,17 +9,17 @@ module Enumerables
     context 'input validations' do
 
       specify 'an initialization error will be raised if no enumerables are specified' do
-        expect(->{ CompoundEnumerable.array_enumerable() }).to raise_error
-        expect(->{ CompoundEnumerable.hash_enumerable([:key]) }).to raise_error
+        expect(->{ CompoundEnumerable.array_enumerable() }).to raise_error(ArgumentError)
+        expect(->{ CompoundEnumerable.hash_enumerable([:key]) }).to raise_error(ArgumentError)
       end
 
       specify 'an initialization error will be raised if mode is not :yields_arrays or :yields_hashes' do
-        expect(->{ CompoundEnumerable.new(:bad_mode, [], [])}).to raise_error
+        expect(->{ CompoundEnumerable.new(:bad_mode, [], [])}).to raise_error(ArgumentError)
       end
 
       specify 'an initialization error will be raised if key array size != enumerables size in :yields_hashes mode' do
-        expect(->{ CompoundEnumerable.new(:yields_hashes, [:key1, :key2], [])}).to raise_error
-        expect(->{ CompoundEnumerable.hash_enumerable([:key1, :key2], [])}).to raise_error
+        expect(->{ CompoundEnumerable.new(:yields_hashes, [:key1, :key2], [])}).to raise_error(ArgumentError)
+        expect(->{ CompoundEnumerable.hash_enumerable([:key1, :key2], [])}).to raise_error(ArgumentError)
       end
     end
 

data/spec/trick_bag/enumerables/filtered_enumerable_spec.rb

@@ -7,7 +7,7 @@ module Enumerables
   describe FilteredEnumerable do
 
     let (:even_filter) { ->(n) { n.even? } }
-    specify 'with no filter it behaves as a regular enumberable' do
+    specify 'with no filter it behaves as a regular enumerable' do
       e = FilteredEnumerable.new([1,2,3])
       expect(e.to_a).to eq([1, 2, 3])
     end
@@ -35,6 +35,17 @@ module Enumerables
       expect(FilteredEnumerable.new([]).each).to be_a(Enumerator)
     end
 
+    specify 'multiple enumerators on the same collection work correctly' do
+      array = (1..7).to_a
+
+      is_even_enumerable          = FilteredEnumerable.new(array, ->(x) { x.even? })
+      is_odd_enumerable           = FilteredEnumerable.new(array, ->(x) { x.odd?  })
+      is_multiple_of_3_enumerable = FilteredEnumerable.new(array, ->(x) { x % 3 == 0 })
+
+      expect(is_even_enumerable.to_a).to           eq([2, 4, 6])
+      expect(is_odd_enumerable.to_a).to            eq([1, 3, 5, 7])
+      expect(is_multiple_of_3_enumerable.to_a).to  eq([3, 6])
+    end
   end
 end
 end

data/spec/trick_bag/formatters/formatters_spec.rb

@@ -10,7 +10,7 @@ describe Formatters do
   context ".duration_to_s" do
 
     specify "it will not permit a non-number" do
-      expect(->() { Formatters.duration_to_s([])}).to raise_error
+      expect(->() { Formatters.duration_to_s([])}).to raise_error(ArgumentError)
     end
 
     expect_output_for_input = ->(expected_output, input) do
@@ -54,6 +54,10 @@ describe Formatters do
       expect(Formatters.end_with_nl(nil)).to eq('')
     end
 
+    specify 'it returns false\n for false' do
+      expect(Formatters.end_with_nl(false)).to eq("false\n")
+    end
+
     specify "it converts a number and then adds a new line" do
       expect(Formatters.end_with_nl(3)).to eq("3\n")
     end
@@ -88,7 +92,7 @@ describe Formatters do
     end
 
     specify "a bad strategy will result in a raised error" do
-      expect(->() { Formatters.dos2unix('', :not_a_strategy) }).to raise_error
+      expect(->() { Formatters.dos2unix('', :not_a_strategy) }).to raise_error(ArgumentError)
     end
   end
 

data/spec/trick_bag/meta/classes_spec.rb

@@ -33,11 +33,11 @@ end
     it 'should remove the class' do
       fn = -> do
         class ClassPatchTestClass; end
-        ClassPatchTestClass.new # to illustrate that it's available
+        expect(ClassPatchTestClass.new.class).to eq(ClassPatchTestClass) # to illustrate that it's available
         Classes.undef_class('ClassPatchTestClass', TrickBag::Meta)
       end
       fn.()
-      expect(->{ ClassPatchTestClass.new }).to raise_error
+      expect(->{ ClassPatchTestClass.new }).to raise_error(NameError)
     end
   end
 

data/spec/trick_bag/numeric/bitmap_spec.rb

@@ -10,7 +10,7 @@ describe Bitmap do
 
 
   specify 'the constructor should not permit being explicitly called outside the class' do
-    expect(-> { Bitmap.new }).to raise_error
+    expect(-> { Bitmap.new(1) }).to raise_error(NoMethodError)
   end
 
 

data/spec/trick_bag/numeric/totals_spec.rb

@@ -15,7 +15,7 @@ module Numeric
       expect(Totals.map_percent_of_total([2, 4, 6, 8])).to eq([10, 20, 30, 40])
     end
 
-    it "returns an empty array when handed an empty array" do
+    it "returns an empty array when passed an empty array" do
       expect(Totals.map_percent_of_total([])).to eq([])
       expect(Totals.map_fraction_of_total([])).to eq([])
     end

data/spec/trick_bag/operators/operators_spec.rb

@@ -7,11 +7,11 @@ module TrickBag
     context "multi_eq" do
 
       specify "that calling with no params raises an error" do
-        expect(->{ Operators.multi_eq() }).to raise_error
+        expect(->{ Operators.multi_eq() }).to raise_error(ArgumentError)
       end
 
-      specify "that calling with no params raises an error" do
-        expect(->{ Operators.multi_eq(1) }).to raise_error
+      specify "that calling with 1 param raises an error" do
+        expect(->{ Operators.multi_eq(1) }).to raise_error(ArgumentError)
       end
 
       test_return_value = ->(true_or_false, *values) do

data/spec/trick_bag/validations/object_validations_spec.rb

@@ -8,15 +8,18 @@ module TrickBag
 
     include Validations
 
+    ObjectValidationError = TrickBag::Validations::ObjectValidationError
+
     specify 'a missing instance variable should raise an error' do
       vars = [:@this_name_could_not_possibly_be_defined_as_a_real_variable]
-      expect(-> { raise_on_nil_instance_vars(self, vars) }).to raise_error
+      expect(-> { raise_on_nil_instance_vars(self, vars) }).to raise_error(ObjectValidationError)
     end
 
     specify 'an existing instance variable should NOT raise an error' do
       vars = [:@foo]
       -> { class AbCdEfG; def initialize; @foo = 'hi'; end; end }.()
       expect(-> { raise_on_nil_instance_vars(AbCdEfG.new, vars) }).not_to raise_error
+      Meta::Classes.undef_class('AbCdEfG')
     end
   end
 end

data/spec/trick_bag/validations/other_validations_spec.rb

@@ -8,12 +8,14 @@ module TrickBag
 
     include Validations
 
+    InvalidValueError = TrickBag::Validations::InvalidValueError
+
     specify "*no* error is raised if the value is included" do
       expect(->{raise_on_invalid_value('foo', ['foo']) }).not_to raise_error
     end
 
     specify "an error *is* raised if the value is not included" do
-      expect(->{raise_on_invalid_value('foo', []) }).to raise_error
+      expect(->{raise_on_invalid_value('foo', []) }).to raise_error(InvalidValueError)
     end
 
     specify "the error message is correct" do

data/trick_bag.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "diffy", '~> 3.0'
 
 
-  if RUBY_VERSION >= '2'
+  if RUBY_VERSION.split('.').first.to_i >= 2
     spec.add_dependency 'net-ssh'
   else
     spec.add_dependency 'net-ssh', '= 2.9.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trick_bag
 version: !ruby/object:Gem::Version
-  version: 0.64.3
+  version: 0.65.0
 platform: ruby
 authors:
 - Keith Bennett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-04 00:00:00.000000000 Z
+date: 2017-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os
@@ -221,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Miscellaneous general useful tools.