rspec-deep-ignore-order-matcher 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alexey Mogilnikov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,24 @@
+# RSpec Deep Matcher
+
+This gem adds a custom matcher to RSpec to recursively compare nested Ruby data-structures consisting of `Hash` and `Array` elements.
+An order of elements in an array is ignored.
+
+## Install
+```
+sudo gem install rspec-deep-ignore-order-matcher
+```
+or add to your `Gemfile`
+```
+gem 'rspec-deep-ignore-order-matcher'
+```
+
+## Example
+```
+describe 'Products' do
+	it "should ignore order of product's tags" do
+		expected = [{ :product => { :title => 'Product 1', :tags => ['large', 'blue', 'heavy'] } }]
+		actual = [{ :product => { :title => 'Product 1', :tags => ['blue', 'large', 'heavy'] } }]
+		actual.should be_deep_equal expected
+	end
+end
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rspec-deep-ignore-order-matcher.rb

@@ -0,0 +1,40 @@
+require 'rspec'
+require 'rspec-deep-ignore-order-matcher/version'
+
+RSpec::Matchers.define :be_deep_equal do |expected|
+	match { |actual| m1 actual, expected }
+
+	failure_message_for_should do |actual|
+		"expected that #{actual} would be deep equal with #{expected}"
+	end
+
+	failure_message_for_should_not do |actual|
+		"expected that #{actual} would not be deep equal with #{expected}"
+	end
+
+	description do
+		"be deep equal with #{expected}"
+	end
+
+	def m1(actual, expected)
+		return arrays_matches?(actual, expected) if expected.is_a?(Array) && actual.is_a?(Array)
+		return hashes_matches?(actual, expected) if expected.is_a?(Hash) && actual.is_a?(Hash)
+		expected == actual
+	end
+
+	def arrays_matches?(actual, expected)
+		exp = expected.clone
+		actual.each do |a|
+			index = exp.find_index { |e| m1 a, e }
+			return false if index.nil?
+			exp.delete_at(index)
+		end
+		exp.length == 0
+	end
+
+	def hashes_matches?(actual, expected)
+		return false unless actual.keys == expected.keys
+		actual.each { |key, value| return false unless m1 value, expected[key] }
+		true
+	end
+end

data/lib/rspec-deep-ignore-order-matcher/version.rb

@@ -0,0 +1,9 @@
+module Deep
+	module Ignore
+		module Order
+			module Matcher
+				VERSION = "0.0.1"
+			end
+		end
+	end
+end

data/rspec-deep-ignore-order-matcher.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec-deep-ignore-order-matcher/version'
+
+Gem::Specification.new do |gem|
+	gem.name = "rspec-deep-ignore-order-matcher"
+	gem.version = Deep::Ignore::Order::Matcher::VERSION
+	gem.authors = ["Alexey Mogilnikov"]
+	gem.email = ["alexey@mogilnikov.name"]
+	gem.description = %q{This gem adds a custom matcher to RSpec to recursively compare nested Ruby data-structures consisting of `Hash` and `Array` elements. An order of elements in an array is ignored.}
+	gem.summary = %q{A custom matcher to RSpec to recursively compare nested Ruby data-structures consisting of `Hash` and `Array` elements.}
+	gem.homepage = 'https://github.com/amogil/rspec-deep-ignore-order-matcher'
+
+	gem.files = `git ls-files`.split($/)
+	gem.executables = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+	gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+	gem.require_paths = ["lib"]
+
+	gem.add_development_dependency 'rspec', '~> 2.6'
+	gem.add_development_dependency 'simplecov'
+end

data/spec/matcher_spec.rb

@@ -0,0 +1,36 @@
+require 'rspec'
+require 'rspec-deep-ignore-order-matcher'
+
+describe Deep::Ignore::Order::Matcher do
+
+	it 'should matches usual values' do
+		['an_string', 1, 13.5, nil, [1, 2, 3], { :a => 1, :b => 2 }].each_slice(2) do |value1, value2|
+			value1.should be_deep_equal value1
+			value2.should be_deep_equal value2
+			value1.should_not be_deep_equal value2
+			value2.should_not be_deep_equal value1
+		end
+	end
+
+	it 'should ignore order in plain arrays' do
+		actual = Array.new(5) { Random.rand(1000) }
+		expected = actual.sort
+		actual.should be_deep_equal expected
+	end
+
+	it 'should match deep structs' do
+		actual = [{ :a => 1, :b => 'str', :c => [1, 2, 3] }, [{ :a => [2, { :a => 4 }] }, { :b => 2 }, { :c => 3 }]]
+		expected = [{ :a => 1, :b => 'str', :c => [3, 1, 2] }, [{ :b => 2 }, { :a => [{ :a => 4 }, 2] }, { :c => 3 }]]
+		actual.should be_deep_equal expected
+		actual[0][:c].push(4)
+		actual.should_not be_deep_equal expected
+	end
+
+	it 'should do not match partials' do
+		[1, 2, 3].should_not be_deep_equal [1, 2]
+		[1, 2].should_not be_deep_equal [1, 2, 3]
+		{ :a => 1, :b => 2 }.should_not be_deep_equal({ :a => 1 })
+		{ :a => 1 }.should_not be_deep_equal({ :a => 1, :b => 2 })
+	end
+
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: rspec-deep-ignore-order-matcher
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alexey Mogilnikov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem adds a custom matcher to RSpec to recursively compare nested
+  Ruby data-structures consisting of `Hash` and `Array` elements. An order of elements
+  in an array is ignored.
+email:
+- alexey@mogilnikov.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec-deep-ignore-order-matcher.rb
+- lib/rspec-deep-ignore-order-matcher/version.rb
+- rspec-deep-ignore-order-matcher.gemspec
+- spec/matcher_spec.rb
+homepage: https://github.com/amogil/rspec-deep-ignore-order-matcher
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A custom matcher to RSpec to recursively compare nested Ruby data-structures
+  consisting of `Hash` and `Array` elements.
+test_files:
+- spec/matcher_spec.rb