symilaa 0.0.1.1 → 0.0.2

data/README.md

@@ -1,3 +1,25 @@
 Hello.
 
-There will be some stuff here soon.
+Sometimes it is nice to compare two images with one another.  We find this
+particularly handy for testing browser screenshots.
+
+With Symilaa, this is particularly easy.
+
+1. How to do it.
+----------------
+
+```ruby
+one = Symilaa::Screenshot.new 'image.png'
+two = Symilaa::Screenshot.new 'slightly_different_image.png'
+three = Symilaa::Screenshot.new 'very_different_image.png'
+
+one == one
+#=> true
+one == two
+#=> false
+one.similar_to? two
+#=> true
+one.similar_to? three
+#=> false
+```
+That's it.  Have a nice life.

data/lib/symilaa/screenshot.rb

@@ -1,4 +1,5 @@
 require 'RMagick'
+require 'fileutils'
 
 module Symilaa
   class Screenshot
@@ -11,6 +12,10 @@ module Symilaa
     end
 
     def == other
+      FileUtils.cmp path, other.path
+    end
+
+    def similar_to? other
       this_one = Magick::Image.read(@path).first
       that_one = Magick::Image.read(other.path).first
 

data/lib/symilaa/version.rb

@@ -1,3 +1,3 @@
 module Symilaa
-  VERSION = "0.0.1.1"
+  VERSION = "0.0.2"
 end

data/test/symilaa/test_screenshot.rb

@@ -19,7 +19,7 @@ module Symilaa
       one = Screenshot.new GRYLLS
       two = Screenshot.new GRYLLS_SLIGHT_DIFF
 
-      assert one == two
+      refute one == two
     end
 
     def test_equality_when_identical
@@ -28,6 +28,27 @@ module Symilaa
 
       assert one == two
     end
+
+    def test_similar_when_identical
+      one = Screenshot.new GRYLLS
+      two = Screenshot.new GRYLLS
+
+      assert one.similar_to? two
+    end
+    
+    def test_similar_when_similar
+      one = Screenshot.new GRYLLS
+      two = Screenshot.new GRYLLS_SLIGHT_DIFF
+
+      assert one.similar_to? two
+    end
+   
+    def test_similar_when_different
+      one = Screenshot.new GRYLLS
+      two = Screenshot.new GRYLLS_DIFF
+
+      refute one.similar_to? two
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: symilaa
 version: !ruby/object:Gem::Version
-  version: 0.0.1.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-11-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &20562660 !ruby/object:Gem::Requirement
+  requirement: &16724680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20562660
+  version_requirements: *16724680
 - !ruby/object:Gem::Dependency
   name: rmagick
-  requirement: &20562000 !ruby/object:Gem::Requirement
+  requirement: &16723940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20562000
+  version_requirements: *16723940
 description: ! "Using the wonders of RMagick, this wonderful gem will produce a boolean
   result based on the computed similarity\n    of the two images passed."
 email: