ruby-development-toolbox 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb8812228dbf4c77838554d27566cae8f832ab53
-  data.tar.gz: f9e5833f6ab5c4e33585e880fb44be462fc3e7af
+  metadata.gz: 664d3ef4c0c0e9946f9d2d2ea0cdc16a20174beb
+  data.tar.gz: 04c4ae771e114310d5ec10c23111033ef91497d9
 SHA512:
-  metadata.gz: 419279191eebfe1310d442fc74ebc7168db049b7c6e4bc09fd26cf29b4b206f30792df7afe94c30fa46d02b3836eb12d6c16443710352b805814d90f95f70cef
-  data.tar.gz: ee1167210568156f1be94755a83dd21b3968280a7a3d8566a0547b40defd61a925e14f9c21e9df3984efdf53e931057208e8e665d599683a287e997210ca143b
+  metadata.gz: ce2305afc283e4d452f37af764a6db03fd2ac9db3b39401d329a79c0b5c33e15f2a4ab9d355b13ef72b72a78503e80c47cd7dfd6f3cba6d9bab2b60a636a5574
+  data.tar.gz: a0012109a92a998c685b046318cf66d15c514b96cfc7ec50031e845ae4e500c8d2a563a6d34333805f42836013dd5b97e279701e33acb1143f41866ab6691c4c

data/README.md

@@ -40,7 +40,7 @@ The projects homepage can be found [here](https://github.com/gradeawarrior/ruby-
 
 # Development
 
-The project is built by [jeweler](https://github.com/technicalpickles/jeweler). See the project's page for more details about how to manage this gem. However, I will list out quick quidance on a typical release.
+The project is built by [jeweler](https://github.com/technicalpickles/jeweler). See the project's page for more details about how to manage this gem. However, I will list out quick guidance on a typical release.
 
 ## Active Gem Development
 

data/VERSION

@@ -1 +1 @@
-1.0.3
+1.1.0

data/lib/toolbox/hash_diff.rb

@@ -0,0 +1,153 @@
+##
+# Extends the functionality of a Hash to be able to perform (i) diff and (ii) similarity operations
+#
+class Hash
+
+  ##
+  # Provides diff capabilities on a Hash. This implementation is slightly customized for
+  # Proofpoint Prism service-records, but otherwise should work on any Hash
+  #
+  def diff(other, svc_record_map = nil)
+    svc_record_map = {} unless svc_record_map.kind_of?(Hash)
+    (self.keys + other.keys).uniq.inject({}) do |memo, key|
+      rkeys = svc_record_map[key] || [key]
+      rkeys.each do |rkey|
+        diff_key = (rkeys.size > 1 || (key != rkey)) ? "#{key} --> #{rkey}" : rkey
+        if self[key].kind_of?(Hash) && other[rkey].kind_of?(Hash)
+          memo[diff_key] = self[key].diff(other[rkey])
+        elsif self[rkey] != other[rkey]
+          memo[diff_key] = [self[key], other[rkey]]
+        end
+      end
+      memo
+    end
+  end
+
+  ##
+  # Provides similarity capabilities on a Hash. This implementation is slightly optimized for
+  # Proofpoint Prism service-records, but otherwise should work on any Hash
+  #
+  # == Parameters
+  #
+  #   other
+  #
+  def similarity(other, svc_record_map = nil)
+    svc_record_map = {} unless svc_record_map.kind_of?(Hash)
+    (self.keys + other.keys).uniq.inject({}) do |memo, key|
+      rkeys = svc_record_map.has_key?(key) ? svc_record_map[key] : [key]
+      rkeys.each do |rkey|
+        diff_key = (rkeys.size > 1 || (key != rkey)) ? "#{key} --> #{rkey}" : rkey
+        if self[key].kind_of?(Hash) && other[rkey].kind_of?(Hash)
+          memo[diff_key] = self[key].similarity(other[rkey])
+        elsif self[key] == other[rkey]
+          memo[diff_key] = self[key]
+        end
+      end
+      memo
+    end
+  end
+
+  ##
+  # Utility for deleting any Prism service-record keys that I don't want to do a diff/similarity on
+  #
+  def clean
+    ['svc_id', 'name', 'environment_name', 'type', 'subtype', 'note'].each { |k| self.delete k }
+    self.keys.each do |svc_record_name|
+      self[svc_record_name].clean() if self[svc_record_name].kind_of?(Hash)
+    end
+    self.keys.each do |key|
+      if self[key].kind_of?(Hash) && self[key].empty?
+        self.delete(key)
+      elsif self[key].kind_of?(Hash)
+        self[key].clean
+        self.delete(key) if self[key].empty?
+      end
+    end
+    self
+  end
+
+  ##
+  # Utility for counting the number of leaf nodes in a Hash-Array structure. A leaf node is determined
+  # to be anything that is a non-Hash
+  #
+  def count_leafs
+    self.keys.inject(0) do |result, element|
+      if self[element].kind_of?(Hash)
+        result+=self[element].count_leafs
+      else
+        result+=1
+      end
+    end
+  end
+
+  ##
+  # Return only the List of Prism service-records; if the List is empty, then return the original Hash with no filters
+  # applied.
+  #
+  # == Parameters
+  #
+  #   filter_keys   : an array of keys to exclude
+  #   filter_values : an array of values to exclude
+  #
+  def filter(filter_keys = nil, filter_values = nil)
+    filter_keys = Array.new unless filter_keys.kind_of?(Array)
+    filter_values = Array.new unless filter_values.kind_of?(Array)
+    result = filter_keys.empty? ? self : Hash.new
+    filter_keys.each do |key|
+      self.keys.each do |svc_record|
+        if svc_record.match(/^#{key}$/)
+          result[svc_record] = self[svc_record]
+        elsif svc_record.match(/^#{key} -->/)
+          result[svc_record] = self[svc_record]
+        end
+      end
+    end
+    filter_values.each do |filter_value|
+      result.keys.each do |key|
+        if result[key].kind_of?(Hash)
+          result[key] = result[key].filter(nil, filter_values)
+          result.delete(key) if result[key].keys.empty?
+        elsif result[key].kind_of?(Array) && key.match(/version/).nil?
+          filter_triggered = false
+          result[key].each do |diff_value|
+            filter_triggered = diff_value =~ /#{filter_value}/
+            break if filter_triggered
+          end
+          result.delete(key) if filter_triggered
+        end
+      end
+    end
+    result
+  end
+end
+
+##
+# Extends the functionality of a Hash to be able to perform (i) diff and (ii) similarity operations
+# For implementation details, see the Hash class for the extended functions
+#
+# == Usage
+#
+# Working with HashDiff module can be very simple, for example:
+#
+#     require 'toolbox/hash_diff'
+#     require 'yaml'
+#
+#     hash1 = {
+#       :foo => 'bar',
+#       :bar => 'hello',
+#       :hello => 'world',
+#       :this => { :exists => 'yay!' }
+#     }
+#
+#     hash2 = {
+#       :foo => 'bar',
+#       :hello => 'Hi',
+#       :this => { :exists => 'yay!' },
+#       :hey => { :this => "Doesn't exist", :but => "oh well" }
+#     }
+#
+#     puts hash1.diff(hash2).to_yaml
+#     puts hash1.similarity(hash2).to_yaml
+#
+module HashDiff
+end

data/lib/toolbox/uuid.rb

@@ -0,0 +1,38 @@
+##
+# A generic UUID class
+#
+# == Usage
+#
+#     $ irb
+#     require 'toolbox/uuid'
+#       => true
+#     UUID.generate
+#       => "0a391631-22ba-40ea-af2e-65a64de4a42b"
+#     UUID.generate
+#       => "092516ba-a2f4-45cf-9e1d-c5e63342aaa4"
+#
+class UUID
+
+  ##
+  # Generate a random UUID.
+  #
+  # Attempts a few different ways, hopefully one of them work. If all fails, die.
+  #
+  def self.generate
+    begin
+      require 'securerandom'
+      return SecureRandom.uuid()
+
+    rescue Exception => e
+      if (File.exist?("/usr/bin/uuidgen")) # Centos e2fsprogs package
+        uuid = `/usr/bin/uuidgen`
+        return uuid.chomp
+      elsif (File.exist?("/usr/bin/uuid")) # Debian uuid package
+        uuid = `/usr/bin/uuid`
+        return uuid.chomp
+      end
+    end
+    abort("Unable to generate UUIDs")
+  end
+
+end

data/ruby-development-toolbox.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "ruby-development-toolbox"
-  s.version = "1.0.3"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter Salas"]
-  s.date = "2014-02-20"
+  s.date = "2014-02-21"
   s.description = "A collection of useful utilities and libraries for Ruby development (not Rails)"
   s.email = "psalas+github@gmail.com"
   s.extra_rdoc_files = [
@@ -28,6 +28,8 @@ Gem::Specification.new do |s|
     "VERSION",
     "lib/ruby-development-toolbox.rb",
     "lib/toolbox/boolean.rb",
+    "lib/toolbox/hash_diff.rb",
+    "lib/toolbox/uuid.rb",
     "ruby-development-toolbox.gemspec",
     "test/helper.rb",
     "test/test_ruby-development-toolbox.rb"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-development-toolbox
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Peter Salas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-20 00:00:00.000000000 Z
+date: 2014-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
@@ -114,6 +114,8 @@ files:
 - VERSION
 - lib/ruby-development-toolbox.rb
 - lib/toolbox/boolean.rb
+- lib/toolbox/hash_diff.rb
+- lib/toolbox/uuid.rb
 - ruby-development-toolbox.gemspec
 - test/helper.rb
 - test/test_ruby-development-toolbox.rb