sleeping_king_studios-tools 0.1.3 → 0.2.0.beta.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4b7111cf4b4f6b005040f3040ce4f00fda6703e
-  data.tar.gz: dd2acf0424f4b3e8502c6da84d15572632844249
+  metadata.gz: 6e8dad1b2f806deaa242881f79db4d56f4058dfb
+  data.tar.gz: 3ff535315372519db5ab455483baec4499e401e4
 SHA512:
-  metadata.gz: fcce92c9ac9b43e9bc348a7fa3fe3ea54dd1ea4572fec9b7b2a59907f03a3504a8a65eb2927b09d8252b662f8ef35fa18db999dc6ff7b7da7037a0db3d7a1992
-  data.tar.gz: 0640a33c51657bc9ad86aab8778cb54d8428b56748fc648b0ead8909d84e2d5b13fde40228758c01aa911b33ba21fbc60dcd9630a7bdf7aec8ab38e4c59dc220
+  metadata.gz: 0a168b831645d542efbdafa26cb99a751047a887a49bf3b1b09dc9947aea0883c7fe097577222295c15c8ed7aece5563e50cc906404ef9333f4bb98226a48b9b
+  data.tar.gz: 4534a229197c7d499f7ef958f25a33b7a89b0450d219240ad0d78ead2892f0c5c12502bab509db2fdd98beb7f4ad4b11fa5d5e091ceb05c017d1fe73b77c1aff

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Pre-release Versions
 
+### 0.2.0
+
+Split EnumerableTools into ArrayTools and HashTools.
+
+Implement ArrayTools#deep_dup, HashTools#deep_dup and ObjectTools#deep_dup.
+
 ### 0.1.3
 
 Properly support both keywords and optional arguments in ObjectTools#apply.

data/README.md

@@ -12,41 +12,79 @@ Hi, I'm Rob Smith, a Ruby Engineer and the developer of this library. I use thes
 
 ## Tools
 
-### Enumerable Tools
+### Array Tools
 
-    require 'sleeping_king_studios/tools/enumerable_tools'
+    require 'sleeping_king_studios/tools/array_tools'
 
-Tools for working with enumerable objects, such as arrays and hashes.
+Tools for working with array-like enumerable objects.
 
 #### `#count_values`
 
-Counts the number of times each value appears in the enumerable object, or if a block is given, calls the block with each item and counts the number of times each result appears.
+Counts the number of times each value appears in the array, or if a block is given, calls the block with each item and counts the number of times each result appears.
 
-    EnumerableTools.count_values([1, 1, 1, 2, 2, 3])
+    ArrayTools.count_values([1, 1, 1, 2, 2, 3])
     #=> { 1 => 3, 2 => 2, 3 => 1 }
 
-    EnumerableTools.count_values([1, 1, 1, 2, 2, 3]) { |i| i ** 2 }
+    ArrayTools.count_values([1, 1, 1, 2, 2, 3]) { |i| i ** 2 }
     #=> { 1 => 3, 4 => 2, 9 => 1 }
 
-    EnumerableTools.count_values([1, 1, 1, 2, 2, 3], &:even?)
+    ArrayTools.count_values([1, 1, 1, 2, 2, 3], &:even?)
     #=> { false => 4, true => 2 }
 
+#### `#deep_dup`
+
+Creates a deep copy of the object by returning a new Array with deep copies of each array item. See also ObjectTools#deep_dup[#label-Object+Tools].
+
+    ary = ['one', 'two', 'three']
+    cpy = ArrayTools.deep_dup ary
+
+    cpy << 'four'
+    #=> ['one', 'two', 'three', 'four']
+    ary
+    #=> ['one', 'two', 'three']
+
+    cpy.first.sub!(/on/, 'vu'); cpy
+    #=> ['vun', 'two', 'three', 'four']
+    ary
+    #=> ['one', 'two', 'three']
+
 #### `#humanize_list`
 
 Accepts a list of values and returns a human-readable string of the values, with the format based on the number of items.
 
     # With One Item
-    EnumerableTools.humanize_list(['spam'])
+    ArrayTools.humanize_list(['spam'])
     #=> 'spam'
 
     # With Two Items
-    EnumerableTools.humanize_list(['spam', 'eggs'])
+    ArrayTools.humanize_list(['spam', 'eggs'])
     #=> 'spam and eggs'
 
     # With Three Or More Items
-    EnumerableTools.humanize_list(['spam', 'eggs', 'bacon', 'spam'])
+    ArrayTools.humanize_list(['spam', 'eggs', 'bacon', 'spam'])
     #=> 'spam, eggs, bacon, and spam'
 
+### Hash Tools
+
+Tools for working with array-like enumerable objects.
+
+#### `#deep_dup`
+
+Creates a deep copy of the object by returning a new Hash with deep copies of each key and value. See also ObjectTools#deep_dup[#label-Object+Tools].
+
+    hsh = { :one => 'one', :two => 'two', :three => 'three' }
+    cpy = HashTools.deep_dup hsh
+
+    cpy.update :four => 'four'
+    #=> { :one => 'one', :two => 'two', :three => 'three', :four => 'four' }
+    hsh
+    #=> { :one => 'one', :two => 'two', :three => 'three' }
+
+    cpy[:one].sub!(/on/, 'vu'); cpy
+    #=> { :one => 'vun', :two => 'two', :three => 'three', :four => 'four' }
+    hsh
+    #=> { :one => 'one', :two => 'two', :three => 'three' }
+
 ### Integer Tools
 
 Tools for working with integers and fixnums.
@@ -110,6 +148,40 @@ Takes a proc or lambda and invokes it with the given object as receiver, with an
     ObjectTools.apply my_object, my_proc
     #=> Writes 'A mock object says "Greetings, programs!"' to STDOUT.
 
+#### `#deep_dup`
+
+Creates a deep copy of the object. If the object is an Array, returns a new Array with deep copies of each array item (see ArrayTools#deep_dup[#label-Array+Tools]). If the object is a Hash, returns a new Hash with deep copies of each hash key and value (see HashTools#deep_dup[#label-Hash+Tools]). Otherwise, returns Object#dup.
+
+    data = {
+      :songs = [
+        {
+          :name   => 'Welcome to the Jungle',
+          :artist => "Guns N' Roses",
+          :album  => 'Appetite for Destruction'
+        }, # end hash
+        {
+          :name   => 'Hells Bells',
+          :artist => 'AC/DC',
+          :album  => 'Back in Black'
+        }, # end hash
+        {
+          :name   => "Knockin' on Heaven's Door",
+          :artist => 'Bob Dylan',
+          :album  => 'Pat Garrett & Billy The Kid'
+        } # end hash
+      ] # end array
+    } # end hash
+
+    copy = ObjectTools.deep_dup data
+
+    copy[:songs] << { :name => 'Sympathy for the Devil', :artist => 'The Rolling Stones', :album => 'Beggars Banquet' }
+    data[:songs].count
+    #=> 3
+
+    copy[:songs][1][:name] = 'Shoot to Thrill'
+    data[:songs][1]
+    #=> { :name => 'Hells Bells', :artist => 'AC/DC', :album => 'Back in Black' }
+
 #### `#eigenclass`, `#metaclass`
 
 Returns the object's eigenclass.

data/lib/sleeping_king_studios/tools/array_tools.rb

@@ -0,0 +1,111 @@
+# lib/sleeping_king_studios/tools/array_tools.rb
+
+require 'sleeping_king_studios/tools'
+require 'sleeping_king_studios/tools/object_tools'
+
+module SleepingKingStudios::Tools
+  # Tools for working with array-like enumerable objects.
+  module ArrayTools
+    extend self
+
+    # @overload count_values(values)
+    #   Counts the number of times each value appears in the enumerable object.
+    #
+    #   @example
+    #     ArrayTools.count_values([1, 1, 1, 2, 2, 3])
+    #     #=> { 1 => 3, 2 => 2, 3 => 1 }
+    #
+    #   @param [Array<Object>] values The values to count.
+    #
+    #   @return [Hash{Object, Integer}] The number of times each value appears
+    #     in the enumerable object.
+    #
+    # @overload count_values(values, &block)
+    #   Calls the block with each item and counts the number of times each
+    #   result appears.
+    #
+    #   @example
+    #     ArrayTools.count_values([1, 1, 1, 2, 2, 3]) { |i| i ** 2 }
+    #     #=> { 1 => 3, 4 => 2, 9 => 1 }
+    #
+    #   @param [Array<Object>] values The values to count.
+    #
+    #   @return [Hash{Object, Integer}] The number of times each result
+    #     appears.
+    #
+    #   @yield item An item in the array to be converted to a countable result.
+    def count_values values, &block
+      values.each.with_object({}) do |item, hsh|
+        value = block_given? ? block.call(item) : item
+        hsh[value] = hsh.fetch(value, 0) + 1
+      end # each
+    end # method count_values
+
+    # Creates a deep copy of the object by returning a new Array with deep
+    # copies of each array item.
+    #
+    # @param [Array<Object>] ary The array to copy.
+    #
+    # @return [Array] The copy of the array.
+    def deep_dup ary
+      ary.map { |obj| ObjectTools.deep_dup obj }
+    end # method deep_dup
+
+    # Accepts a list of values and returns a human-readable string of the
+    # values, with the format based on the number of items.
+    #
+    # @example With Zero Items
+    #   ArrayTools.humanize_list([])
+    #   #=> ''
+    #
+    # @example With One Item
+    #   ArrayTools.humanize_list(['spam'])
+    #   #=> 'spam'
+    #
+    # @example With Two Items
+    #   ArrayTools.humanize_list(['spam', 'eggs'])
+    #   #=> 'spam and eggs'
+    #
+    # @example With Three Or More Items
+    #   ArrayTools.humanize_list(['spam', 'eggs', 'bacon', 'spam'])
+    #   #=> 'spam, eggs, bacon, and spam'
+    #
+    # @example With Three Or More Items And Options
+    #   ArrayTools.humanize_list(['spam', 'eggs', 'bacon', 'spam'], :last_separator => ' or ')
+    #   #=> 'spam, eggs, bacon, or spam'
+    #
+    # @param [Array<String>] values The list of values to format. Will be
+    #   coerced to strings using #to_s.
+    # @param [Hash] options Optional configuration hash.
+    # @option options [String] :last_separator The value to use to separate
+    #   the final pair of values. Defaults to " and " (note the leading and
+    #   trailing spaces). Will be combined with the :separator for lists of
+    #   length 3 or greater.
+    # @option options [String] :separator The value to use to separate pairs
+    #   of values before the last in lists of length 3 or greater. Defaults to
+    #   ", " (note the trailing space).
+    #
+    # @return [String] The formatted string.
+    def humanize_list values, options = {}
+      separator = options.fetch(:separator, ', ')
+      last_separator = options.fetch(:last_separator, ' and ')
+
+      case values.count
+      when 0
+        ''
+      when 1
+        values.first.to_s
+      when 2
+        "#{values[0]}#{last_separator}#{values[1]}"
+      else
+        if last_separator =~ /\A,?\s*/
+          last_separator = last_separator.sub /\A,?\s*/, separator
+        else
+          last_separator = "#{separator}#{last_separator}"
+        end # if-else
+
+        "#{values[0...-1].join(separator)}#{last_separator}#{values.last}"
+      end # case
+    end # method humanize_list
+  end # module
+end # module

data/lib/sleeping_king_studios/tools/enumerable_tools.rb

@@ -1,100 +1,8 @@
 # lib/sleeping_king_studios/tools/enumerable_tools.rb
 
-require 'sleeping_king_studios/tools'
+require 'sleeping_king_studios/tools/array_tools'
 
 module SleepingKingStudios::Tools
-  # Tools for working with enumerable objects, such as arrays and hashes.
-  module EnumerableTools
-    extend self
-
-    # @overload count_values(values)
-    #   Counts the number of times each value appears in the enumerable object.
-    #
-    #   @example
-    #     ArrayTools.count_values([1, 1, 1, 2, 2, 3])
-    #     #=> { 1 => 3, 2 => 2, 3 => 1 }
-    #
-    #   @param [Array<Object>] values The values to count.
-    #
-    #   @return [Hash{Object, Integer}] The number of times each value appears
-    #     in the enumerable object.
-    #
-    # @overload count_values(values, &block)
-    #   Calls the block with each item and counts the number of times each
-    #   result appears.
-    #
-    #   @example
-    #     ArrayTools.count_values([1, 1, 1, 2, 2, 3]) { |i| i ** 2 }
-    #     #=> { 1 => 3, 4 => 2, 9 => 1 }
-    #
-    #   @param [Array<Object>] values The values to count.
-    #
-    #   @return [Hash{Object, Integer}] The number of times each result
-    #     appears.
-    #
-    #   @yield item An item in the array to be converted to a countable result.
-    def count_values values, &block
-      values.each.with_object({}) do |item, hsh|
-        value = block_given? ? block.call(item) : item
-        hsh[value] = hsh.fetch(value, 0) + 1
-      end # each
-    end # method count_values
-
-    # Accepts a list of values and returns a human-readable string of the
-    # values, with the format based on the number of items.
-    #
-    # @example With Zero Items
-    #   ArrayTools.humanize_list([])
-    #   #=> ''
-    #
-    # @example With One Item
-    #   ArrayTools.humanize_list(['spam'])
-    #   #=> 'spam'
-    #
-    # @example With Two Items
-    #   ArrayTools.humanize_list(['spam', 'eggs'])
-    #   #=> 'spam and eggs'
-    #
-    # @example With Three Or More Items
-    #   ArrayTools.humanize_list(['spam', 'eggs', 'bacon', 'spam'])
-    #   #=> 'spam, eggs, bacon, and spam'
-    #
-    # @example With Three Or More Items And Options
-    #   ArrayTools.humanize_list(['spam', 'eggs', 'bacon', 'spam'], :last_separator => ' or ')
-    #   #=> 'spam, eggs, bacon, or spam'
-    #
-    # @param [Array<String>] values The list of values to format. Will be
-    #   coerced to strings using #to_s.
-    # @param [Hash] options Optional configuration hash.
-    # @option options [String] :last_separator The value to use to separate
-    #   the final pair of values. Defaults to " and " (note the leading and
-    #   trailing spaces). Will be combined with the :separator for lists of
-    #   length 3 or greater.
-    # @option options [String] :separator The value to use to separate pairs
-    #   of values before the last in lists of length 3 or greater. Defaults to
-    #   ", " (note the trailing space).
-    #
-    # @return [String] The formatted string.
-    def humanize_list values, options = {}
-      separator = options.fetch(:separator, ', ')
-      last_separator = options.fetch(:last_separator, ' and ')
-
-      case values.count
-      when 0
-        ''
-      when 1
-        values.first.to_s
-      when 2
-        "#{values[0]}#{last_separator}#{values[1]}"
-      else
-        if last_separator =~ /\A,?\s*/
-          last_separator = last_separator.sub /\A,?\s*/, separator
-        else
-          last_separator = "#{separator}#{last_separator}"
-        end # if-else
-
-        "#{values[0...-1].join(separator)}#{last_separator}#{values.last}"
-      end # case
-    end # method humanize_list
-  end # module
+  # Alias for ArrayTools to ensure backward compatibility.
+  EnumerableTools = ArrayTools
 end # module

data/lib/sleeping_king_studios/tools/hash_tools.rb

@@ -0,0 +1,23 @@
+# lib/sleeping_king_studios/tools/hash_tools.rb
+
+require 'sleeping_king_studios/tools'
+require 'sleeping_king_studios/tools/object_tools'
+
+module SleepingKingStudios::Tools
+  # Tools for working with hash-like enumerable objects.
+  module HashTools
+    extend self
+
+    # Creates a deep copy of the object by returning a new Hash with deep
+    # copies of each key and value.
+    #
+    # @param [Hash<Object>] hsh The hash to copy.
+    #
+    # @return [Hash] The copy of the hash.
+    def deep_dup hsh
+      hsh.each.with_object(Hash.new) do |(key, value), copy|
+        copy[ObjectTools.deep_dup key] = ObjectTools.deep_dup(value)
+      end # each
+    end # method deep_dup
+  end # module
+end # module

data/lib/sleeping_king_studios/tools/object_tools.rb

@@ -37,6 +37,27 @@ module SleepingKingStudios::Tools
       end
     end # method apply
 
+    # Creates a deep copy of the object. If the object is an Array, returns a
+    # new Array with deep copies of each array item. If the object is a Hash,
+    # returns a new Hash with deep copies of each hash key and value. Otherwise,
+    # returns Object#dup.
+    #
+    # @param [Object] obj The object to copy.
+    #
+    # @return The copy of the object.
+    def deep_dup obj
+      case obj
+      when FalseClass, Fixnum, Float, NilClass, Symbol, TrueClass
+        obj
+      when Array
+        ArrayTools.deep_dup obj
+      when Hash
+        HashTools.deep_dup obj
+      else
+        obj.respond_to?(:deep_dup) ? obj.deep_dup : obj.dup
+      end # case
+    end # method deep_dup
+
     # Returns the object's eigenclass.
     #
     # @param [Object] object The object for which an eigenclass is required.
@@ -48,3 +69,6 @@ module SleepingKingStudios::Tools
     alias_method :metaclass, :eigenclass
   end # module
 end # module
+
+require 'sleeping_king_studios/tools/array_tools'
+require 'sleeping_king_studios/tools/hash_tools'

data/lib/sleeping_king_studios/tools/semantic_version.rb

@@ -20,9 +20,6 @@ module SleepingKingStudios
     #
     # @see http://semver.org
     module SemanticVersion
-      # @api private
-      FETCH_DEFAULT = Object.new.freeze
-
       # Error class for handling missing constants in a version definition.
       class InvalidVersionError < StandardError; end
 
@@ -97,6 +94,8 @@ module SleepingKingStudios
 
       private
 
+      FETCH_DEFAULT = Object.new.freeze
+
       def const_fetch name, default = FETCH_DEFAULT
         if self.const_defined?(name)
           return self.const_get(name).to_s

data/lib/sleeping_king_studios/tools/version.rb

@@ -10,9 +10,13 @@ module SleepingKingStudios
     module Version
       extend SleepingKingStudios::Tools::SemanticVersion
 
+      private
+
       MAJOR = 0
-      MINOR = 1
-      PATCH = 3
+      MINOR = 2
+      PATCH = 0
+      PRERELEASE = 'beta'
+      BUILD = 0
     end # module
 
     VERSION = Version.to_gem_version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sleeping_king_studios-tools
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0.beta.0
 platform: ruby
 authors:
 - Rob "Merlin" Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-21 00:00:00.000000000 Z
+date: 2016-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,60 +16,68 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.10.3.2
+        version: '10.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
-    - - ">="
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.3.2
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '8.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: 8.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '8.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: 8.2.2
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-sleeping_king_studios
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 2.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 2.1.1
 description: |
   A library of utility services and concerns to expand the functionality of core
   classes without polluting the global namespace.
@@ -83,7 +91,9 @@ files:
 - LICENSE
 - README.md
 - lib/sleeping_king_studios/tools.rb
+- lib/sleeping_king_studios/tools/array_tools.rb
 - lib/sleeping_king_studios/tools/enumerable_tools.rb
+- lib/sleeping_king_studios/tools/hash_tools.rb
 - lib/sleeping_king_studios/tools/integer_tools.rb
 - lib/sleeping_king_studios/tools/object_tools.rb
 - lib/sleeping_king_studios/tools/semantic_version.rb
@@ -104,9 +114,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1
@@ -114,3 +124,4 @@ signing_key:
 specification_version: 4
 summary: A library of utility services and concerns.
 test_files: []
+has_rdoc: