contrast 0.2.2 → 1.0.0

data/README.md

@@ -1,29 +1,43 @@
 # Contrast [![Build Status](https://secure.travis-ci.org/darrencauthon/contrast.png?branch=master)](http://travis-ci.org/darrencauthon/contrast)
 
-TODO: Write a gem description
+This gem is meant to assist in comparing objects to others, most notably in tests and specs.
 
-## Installation
+## Usage
 
-Add this line to your application's Gemfile:
+Require contrast.
 
-    gem 'contrast'
+````ruby
+require 'contrast'
+````
 
-And then execute:
+Let's say you have two objects, like so:
 
-    $ bundle
+````ruby
+john = Person.new first_name: 'John', last_name: 'Galt', gender: 'm'
+howard = Person.new first_name: 'Howard', last_name: 'Roark', gender: 'm'
+````
 
-Or install it yourself as:
+You can contrast the two objects, providing the attributes by which to compare them:
 
-    $ gem install contrast
+````ruby
+john.contrast_with howard, [:first_name, :last_name, :gender]
+# {:first_name=>{:actual_value=>"Howard", :expected_value=>"John"},
+#  :last_name=>{:actual_value=>"Roark", :expected_value=>"Galt"}}
+````
 
-## Usage
+Note that it did not show a result for gender, as they matched.
+
+If you call contrast_with!, an exception will be thrown if the two objects do not match based on the provided fields.
+
+````ruby
+john.contrast_with! howard, [:first_name, :last_name, :gender]
+# An exception was just thrown, showing the fields that do not match in the message.
+````
 
-TODO: Write usage instructions here
+You can also compare objects to hashes, and hashes to hashes:
 
-## Contributing
+````ruby
+john.contrast_with { first_name: 'Dagny', gender: 'f' }, [:gender]
+# {:gender=>{:actual_value=>"m", :expected_value=>"f"}}
+````
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/Rakefile

@@ -6,6 +6,7 @@ task :default => [:test]
 
 Rake::TestTask.new do |t|
   t.libs.push "lib"
-  t.test_files = FileList['spec/contrast/*_spec.rb']
+  t.test_files = FileList['spec/contrast/*_spec.rb',
+                          'spec/*_spec.rb']
   t.verbose = true
 end

data/lib/contrast/detective.rb

@@ -7,21 +7,22 @@ module Contrast
     end
 
     def examine(a, b)
-      keys = @fields.select do |field| 
+      Hash[fields_that_do_not_match(a, b).map do |key|
+        [key, { :actual_value => get_the_value(a, key),
+                :expected_value => get_the_value(b, key) }]
+      end]
+    end
+
+    private
+
+    def fields_that_do_not_match(a, b)
+      @fields.select do |field| 
         first = get_the_value(a, field)
         second = get_the_value(b, field)
         the_values_the_do_not_match(first, second)
       end
-      result = {}
-      keys.each do |key|
-        result[key] = {:actual_value => get_the_value(a, key),
-                       :expected_value => get_the_value(b, key)}
-      end
-      result
     end
 
-    private
-
     def get_the_value(object, field)
       begin
         object[field]

data/lib/contrast/matching_exception.rb

@@ -1,7 +1,13 @@
 require 'awesome_print'
 module Contrast
   class MatchingException < StandardError  
+
+    def initialize(results)
+      @results = results
+    end
+
     attr_accessor :results
+
     def to_s
       return 'The results did not match, but I cannot tell you why.' if results.nil? || results.empty?
       return self.results.ai

data/lib/contrast/version.rb

@@ -1,3 +1,3 @@
 module Contrast
-  VERSION = "0.2.2"
+  VERSION = "1.0.0"
 end

data/lib/contrast_with.rb

@@ -6,10 +6,6 @@ class Object
 
   def contrast_with!(other, fields)
     results = self.contrast_with(other, fields)
-    if results.any?
-      exception = Contrast::MatchingException.new
-      exception.results = results
-      raise exception
-    end
+    raise Contrast::MatchingException.new(results) if results.any?
   end
 end

data/spec/contrast/matching_exception_spec.rb

@@ -4,15 +4,13 @@ describe Contrast::MatchingException do
   describe "#to_s" do
     it 'no results: The results did not match, but I cannot tell you why.' do
       [nil, []]. each do |value|
-        error = Contrast::MatchingException.new
-        error.results = value
+        error = Contrast::MatchingException.new value
         get_message_for(error).must_equal 'The results did not match, but I cannot tell you why.'
       end
     end
 
     it "results: Run them through awesome print" do
-      error = Contrast::MatchingException.new
-      error.results = {:result => nil}
+      error = Contrast::MatchingException.new( {:result => nil} )
       error.results.expects(:ai).returns('expected results')
       get_message_for(error).must_equal 'expected results'
     end

data/spec/contrast_with_spec.rb

@@ -34,7 +34,7 @@ describe 'contrast with!' do
     Contrast::Detective.any_instance.expects(:examine).
       with(first, second).returns(result)
 
-    exception_thrown = -> { first.contrast_with!(second, fields) }.
+    exception_thrown = lambda { first.contrast_with!(second, fields) }.
       call_safely { true }
 
     exception_thrown.must_equal true
@@ -48,7 +48,7 @@ describe 'contrast with!' do
     Contrast::Detective.any_instance.expects(:examine).
       with(first, second).returns(result)
 
-    exception_thrown = -> { first.contrast_with!(second, fields); false }.
+    exception_thrown = lambda { first.contrast_with!(second, fields); false }.
       call_safely { true }
 
     exception_thrown.must_equal false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contrast
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-12 00:00:00.000000000 Z
+date: 2012-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: subtle
@@ -113,12 +113,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1837560623878563679
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1837560623878563679
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24