ruby-development-toolbox 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42d8f788aa52a983b13a9296566e985e5ede304c
-  data.tar.gz: c546fb5c85dfbbeb996938636c4344e81a24c2a0
+  metadata.gz: f9bb887cbfc473c25506ca33604187b4b15a33f1
+  data.tar.gz: 25eef0d7c4cfbc4c698444642a02bd2328f24dae
 SHA512:
-  metadata.gz: 5ed4e05493bb3454c8ed026954d89c7dfe28ed796562aaf550b6e8b51c8578dacd757e03cdab382bbe6bfc1901804cbb91ccc1bf904a69e765363fccbea03dbb
-  data.tar.gz: 80a8d35c52b3ffe980ccd887b5edd707079b9d0d731f8f20dec8e0caf704387bbd362a17fd0293e26a67ba732a5b51a971ecd07b7b5e85c7f58ae99ac2a2a37c
+  metadata.gz: 9977bce3f042f36f8d9f191a944bb8359ba7da27187d9ff178ab66696141beb5d89de8453ef3841c285a496277e9164fa4dc42ba05015efea836c4e1e2dbe38e
+  data.tar.gz: dc32154bbe283c1114ef590ddc625293ae7ff835531cc19ce7190357a8257d03d429783b354a98664156088c218c6385c028f74665c406ec934ce0f5633f4a74

data/VERSION

@@ -1 +1 @@
-1.3.0
+1.3.1

data/lib/toolbox/array.rb

@@ -0,0 +1,41 @@
+class Array
+
+  ##
+  # Adds the ability to check if Array contains a subset of objects or a single object. See toolbox/array
+  #
+  def =~(other)
+    if other.is_a?(::Array)
+      other.each { |obj| return false unless self.include?(obj) }
+      true
+    else
+      self.include?(other)
+    end
+  end
+
+  alias_method :contains?, :=~
+
+end
+
+module Toolbox
+
+  ##
+  # This is to implement equivalence check for arrays. In the context of arrays,
+  # we use =~ as a means of checking if array1 is contained in array2; or if
+  # object is contained in array1
+  #
+  #   sample_array = [1, 2, 3]
+  #   puts sample_array =~ 3    ## This prints true
+  #   puts sample_array =~ 4    ## This prints false
+  #
+  # The other way is the following:
+  #
+  #   sample_array1 = [1, 2, 3]
+  #   sample_array2 = [1, 2, 3, 4]
+  #
+  #   puts sample_array2 =~ sample_array1   ## This prints true, because everything in array1 is in array2
+  #   puts sample_array1 =~ sample_array2   ## This prints false, because not everything in array2 is in array1
+  #
+  module Array
+  end
+
+end

data/ruby-development-toolbox.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: ruby-development-toolbox 1.3.0 ruby lib
+# stub: ruby-development-toolbox 1.3.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ruby-development-toolbox"
-  s.version = "1.3.0"
+  s.version = "1.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Peter Salas"]
-  s.date = "2014-06-21"
+  s.date = "2014-12-17"
   s.description = "A collection of useful utilities and libraries for Ruby development (not Rails)"
   s.email = "psalas+github@gmail.com"
   s.extra_rdoc_files = [
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/ruby-development-toolbox.rb",
+    "lib/toolbox/array.rb",
     "lib/toolbox/boolean.rb",
     "lib/toolbox/gem_specification.rb",
     "lib/toolbox/hash_diff.rb",
@@ -37,7 +38,10 @@ Gem::Specification.new do |s|
     "lib/toolbox/uuid.rb",
     "ruby-development-toolbox.gemspec",
     "test/helper.rb",
+    "test/representations/address.rb",
+    "test/representations/person.rb",
     "test/test_toolbox-integer.rb",
+    "test/test_toolbox_array.rb",
     "test/test_toolbox_json.rb"
   ]
   s.homepage = "http://github.com/gradeawarrior/ruby-development-toolbox"

data/test/representations/address.rb

@@ -0,0 +1,66 @@
+require 'json'
+
+class Address
+  include Comparable
+
+  attr_accessor :address1, :address2, :city, :state, :zip
+
+  def initialize(entity={})
+    @address1 = entity['address1']
+    @address2 = entity['address2']
+    @city = entity['city']
+    @state = entity['state']
+    @zip = entity['zip']
+  end
+
+  def ==(obj)
+    return false unless obj.is_a?(::Address)
+    return false unless @address1 == obj.address1
+    return false unless @address2 == obj.address2
+    return false unless @city == obj.city
+    return false unless @state == obj.state
+    return false unless @zip == obj.zip
+    true
+  end
+
+  def <=>(obj)
+    address1 = @address1 <=> obj.address1
+    address2 = @address2 <=> obj.address2
+    city = @city <=> obj.city
+    state = @state <=> obj.state
+    zip = @zip <=> obj.zip
+
+    case address1
+      when 0
+        case address2
+          when 0
+            case city
+              when 0
+                case state
+                  when 0
+                    zip
+                  else
+                    state
+                end
+              else
+                city
+            end
+          else
+            address2
+        end
+      else
+        address1
+    end
+  end
+
+  def to_json(*args)
+    {
+      :address1 => @address1,
+      :address2 => @address2,
+      :city => @city,
+      :state => @state,
+      :zip => @zip
+    }.to_json
+  end
+
+end

data/test/representations/person.rb

@@ -0,0 +1,47 @@
+require 'json'
+require 'representations/address'
+
+class Person
+  include Comparable
+
+  attr_accessor :first_name, :last_name, :email, :addresses
+
+  def initialize(entity={})
+    @first_name = entity['first_name']
+    @last_name = entity['last_name']
+    @email = entity['email']
+    @addresses = []
+    entity['addresses'].each { |address| @addresses << Address.new(address) } unless entity['addresses'].nil?
+  end
+
+  def ==(obj)
+    return false unless obj.is_a?(::Person)
+    return false unless @first_name == obj.first_name
+    return false unless @last_name == obj.last_name
+    return false unless @addresses.sort == obj.addresses.sort
+    true
+  end
+
+  def <=>(obj)
+    last_name_comparison = @last_name <=> obj.last_name
+    case last_name_comparison
+      when 0
+        @first_name <=> obj.first_name
+      else
+        last_name_comparison
+    end
+  end
+
+  def to_json(*args)
+    {
+      :first_name => @first_name,
+      :last_name => @last_name,
+      :email => @email,
+      :addresses => @addresses
+    }.to_json
+  end
+
+  def to_s
+    "#{@first_name} #{@last_name}"
+  end
+end

data/test/test_toolbox_array.rb

@@ -0,0 +1,109 @@
+require 'helper'
+require 'toolbox/array'
+require 'representations/person'
+
+class TestToolboxArray < Test::Unit::TestCase
+
+  PERSONS_ENTITY1 = [
+    {
+      'first_name' => 'C',
+      'last_name' => 'D',
+      'email' => 'CD@proofpoint.com',
+      'addresses' => [
+        'address1' => '12345 Foobar Way'
+      ]
+    },
+    {
+      'first_name' => 'A',
+      'last_name' => 'B',
+      'email' => 'AB@proofpoint.com'
+    }
+  ]
+  PERSONS_ENTITY2 = [
+    {
+      'first_name' => 'E',
+      'last_name' => 'F',
+      'email' => 'EF@proofpoint.com',
+      'addresses' => [
+        'address1' => '6789 Hello World Dr.',
+        'city' => 'Sunnyvale',
+        'state' => 'CA',
+        'zip' => '94536'
+      ]
+    },
+    {
+      'first_name' => 'C',
+      'last_name' => 'D',
+      'email' => 'CD@proofpoint.com',
+      'addresses' => [
+        'address1' => '12345 Foobar Way'
+      ]
+    },
+    {
+      'first_name' => 'A',
+      'last_name' => 'B',
+      'email' => 'AB@proofpoint.com'
+    }
+  ]
+  PERSONS1 = PERSONS_ENTITY1.inject([]) { |result, person_entity| result << Person.new(person_entity); result }
+  PERSONS2 = PERSONS_ENTITY2.inject([]) { |result, person_entity| result << Person.new(person_entity); result }
+
+  should 'be able to validate whether two arrays are the same' do
+    persons1 = PERSONS1.dup
+    persons1.sort!
+    persons2 = PERSONS1.dup
+
+    assert_equal false, persons1 == persons2, 'Expect that a sorted and an unsorted array should not equal each other'
+    assert_equal true, persons1 =~ persons2, 'Expect that sorted and an unsorted array with =~ equivalence check should be equal (regardless of order)'
+    assert_equal true, persons2 =~ persons1, 'Expect that sorted and an unsorted array (inverse) with =~ equivalence check should be equal (regardless of order)'
+  end
+
+  should 'be able to validate whether elements in persons1 are contained in persons2' do
+    persons1 = PERSONS1.dup
+    persons1.sort!
+    persons2 = PERSONS2.dup
+
+    assert_equal false, persons1 == persons2, 'Expect that two arrays with similar objects should not equal each other'
+    assert_equal false, persons1 =~ persons2, 'Expect that persons2 array is not contained in persons1 array'
+    assert_equal true, persons2 =~ persons1, 'Expect that persons1 array is contained in persons2 array'
+  end
+
+  should 'be able to validate whether element is contained in an array' do
+    person_exist = PERSONS2[1].dup
+    person_not_exist = PERSONS2[0].dup
+    persons = PERSONS1.dup
+
+    assert_equal false, persons =~ person_not_exist, 'Expect that EF@proofpoint.com does not exist in persons array'
+    assert_equal true, persons =~ person_exist, 'Expect that CD@proofpoint.com exists in persons array'
+  end
+
+  should 'be able to validate whether two arrays are the same (with alias method contains?)' do
+    persons1 = PERSONS1.dup
+    persons1.sort!
+    persons2 = PERSONS1.dup
+
+    assert_equal false, persons1 == persons2, 'Expect that a sorted and an unsorted array should not equal each other'
+    assert_equal true, persons1.contains?(persons2), 'Expect that sorted and an unsorted array with =~ equivalence check should be equal (regardless of order)'
+    assert_equal true, persons2.contains?(persons1), 'Expect that sorted and an unsorted array (inverse) with =~ equivalence check should be equal (regardless of order)'
+  end
+
+  should 'be able to validate whether elements in persons1 are contained in persons2 (with alias method contains?)' do
+    persons1 = PERSONS1.dup
+    persons1.sort!
+    persons2 = PERSONS2.dup
+
+    assert_equal false, persons1 == persons2, 'Expect that two arrays with similar objects should not equal each other'
+    assert_equal false, persons1.contains?(persons2), 'Expect that persons2 array is not contained in persons1 array'
+    assert_equal true, persons2.contains?(persons1), 'Expect that persons1 array is contained in persons2 array'
+  end
+
+  should 'be able to validate whether element is contained in an array (with alias method contains?)' do
+    person_exist = PERSONS2[1].dup
+    person_not_exist = PERSONS2[0].dup
+    persons = PERSONS1.dup
+
+    assert_equal false, persons.contains?(person_not_exist), 'Expect that EF@proofpoint.com does not exist in persons array'
+    assert_equal true, persons.contains?(person_exist), 'Expect that CD@proofpoint.com exists in persons array'
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-development-toolbox
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Peter Salas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-21 00:00:00.000000000 Z
+date: 2014-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
@@ -113,6 +113,7 @@ files:
 - Rakefile
 - VERSION
 - lib/ruby-development-toolbox.rb
+- lib/toolbox/array.rb
 - lib/toolbox/boolean.rb
 - lib/toolbox/gem_specification.rb
 - lib/toolbox/hash_diff.rb
@@ -121,7 +122,10 @@ files:
 - lib/toolbox/uuid.rb
 - ruby-development-toolbox.gemspec
 - test/helper.rb
+- test/representations/address.rb
+- test/representations/person.rb
 - test/test_toolbox-integer.rb
+- test/test_toolbox_array.rb
 - test/test_toolbox_json.rb
 homepage: http://github.com/gradeawarrior/ruby-development-toolbox
 licenses: