collapsium 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39373bf60c53fa0099f0f3066725d0de62448e37
-  data.tar.gz: 460a9f149f29cd83210c72e5abd2715046329499
+  metadata.gz: 3d5aaed5e0ef8dd3a68421293d500d992152ad80
+  data.tar.gz: 54d67d56df16c00b74577fa9739991ef4d31b945
 SHA512:
-  metadata.gz: a1cf946152d25f4eadd5db380fc7907188b0152061b6d0be39e4676442ef272c8fb1efbfce2eba421be5e869466c09fced926dec919592d1cfc3d88228604acf
-  data.tar.gz: 39b05aa8b8d64e4608a56f241f7e97ade7a2379eb8867a315cd4480c2360d61cf4c51f90f2b5a67e421be6add9dacef01b96d3ef1c8d8d16c6d2485d4b1e570f
+  metadata.gz: 49b9758e50fa515fff8390fcd44ea17c65aca94ed6c3840eb0d4bea306e21a12b16b62aed98c637fb6905beec5d9d24958a9316a332391f6edaa20e84c486d0a
+  data.tar.gz: e702efb9a4addf4c669c3abd2b8c559ccab374896f29ef183ef6da9b580e128138e3dcd2d989ef0d826e43d1a14888b22d36d9f6f0a0369ab76f9228b01db14a

data/Gemfile.lock

@@ -1,18 +1,18 @@
 PATH
   remote: .
   specs:
-    collapsium (0.2.0)
+    collapsium (0.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.2.0)
-    codeclimate-test-reporter (0.5.0)
+    codeclimate-test-reporter (0.5.1)
       simplecov (>= 0.7.1, < 1.0.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
     json (1.8.3)
-    parser (2.3.1.0)
+    parser (2.3.1.2)
       ast (~> 2.2)
     powerpack (0.1.1)
     rainbow (2.1.0)
@@ -36,7 +36,7 @@ GEM
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.8.0)
+    ruby-progressbar (1.8.1)
     simplecov (0.11.2)
       docile (~> 1.1.0)
       json (~> 1.8)

data/lib/collapsium/prototype_match.rb

@@ -11,6 +11,9 @@ module Collapsium
   ##
   # Provides prototype matching for Hashes. See #prototype_match
   module PrototypeMatch
+    # Large negative integer for failures we can't express otherwise in scoring.
+    FAILURE = -2147483648
+
     ##
     # Given a prototype Hash, returns true if (recursively):
     # - this hash contains all the prototype's keys, and
@@ -23,22 +26,42 @@ module Collapsium
     #     not present in the prototype.
     # @return (Boolean) True if matching succeeds, false otherwise.
     def prototype_match(prototype, strict = false)
-      # Prototype contains keys not in the Hash,so that's a failure.
-      if not (prototype.keys - keys).empty?
-        return false
+      return prototype_match_score(prototype, strict) > 0
+    end
+
+    ##
+    # Calculates a matching score for matching the prototype. A score of 0 or
+    # less is not a match, and the higher the score, the better the match is.
+    #
+    # @param prototype (Hash) The prototype to match against.
+    # @param strict (Boolean) If true, this Hash may not contain keys that are
+    #     not present in the prototype.
+    # @return (Integer) Greater than zero for positive matches, equal to or
+    #     less than zero for mismatches.
+    def prototype_match_score(prototype, strict = false)
+      # The prototype contains keys that are not in the Hash. That's a failure,
+      # and the level of failure is the number of missing keys.
+      missing = (prototype.keys - keys).length
+      if missing > 0
+        return -missing
       end
 
       # In strict evaluation, the Hash may also not contain keys that are not
       # in the prototoype.
-      if strict and not (keys - prototype.keys).empty?
-        return false
+      if strict
+        missing = (keys - prototype.keys).length
+        if missing > 0
+          return -missing
+        end
       end
 
       # Now we have to examine the prototype's values.
+      score = 0
       prototype.each do |key, value|
         # We can skip any nil values in the prototype. They exist only to ensure
-        # the key is present.
+        # the key is present. We do increase the score for a matched key, though!
         if value.nil?
+          score += 1
           next
         end
 
@@ -46,25 +69,29 @@ module Collapsium
         # and we have to recurse into this Hash.
         if value.is_a?(Hash)
           if not self[key].is_a?(Hash)
-            return false
+            return FAILURE
           end
 
           self[key].extend(PrototypeMatch)
-          if not self[key].prototype_match(value)
-            return false
+          recurse_score = self[key].prototype_match_score(value)
+          if recurse_score < 0
+            return recurse_score
           end
+          score += recurse_score
 
           next
         end
 
         # Otherwise the prototype value must be equal to the Hash's value
-        if self[key] != value
-          return false
+        if self[key] == value
+          score += 1
+        else
+          score -= 1
         end
       end
 
-      # All other cases must be true.
-      return true
+      # Return score
+      return score
     end
   end # module PrototypeMatch
 end # module Collapsium

data/lib/collapsium/version.rb

@@ -8,5 +8,5 @@
 #
 module Collapsium
   # The current release version
-  VERSION = "0.2.0".freeze
+  VERSION = "0.2.1".freeze
 end

data/spec/prototype_match_spec.rb

@@ -15,36 +15,36 @@ describe ::Collapsium::PrototypeMatch do
     @hash.extend(::Collapsium::PrototypeMatch)
   end
 
-  it "matches a prototype containing any individual key (non-strict)" do
+  it "scores positively a prototype containing any individual key (non-strict)" do
     # Keys exist in hash
-    expect(@hash.prototype_match('a' => nil)).to be_truthy
-    expect(@hash.prototype_match('b' => nil)).to be_truthy
-    expect(@hash.prototype_match(c: nil)).to be_truthy
+    expect(@hash.prototype_match_score('a' => nil)).to be > 0
+    expect(@hash.prototype_match_score('b' => nil)).to be > 0
+    expect(@hash.prototype_match_score(c: nil)).to be > 0
 
     # Key doesn't exist in hash
-    expect(@hash.prototype_match(foo: nil)).to be_falsy
+    expect(@hash.prototype_match_score(foo: nil)).to be <= 0
   end
 
-  it "does't match a prototype containing an individual key in strict mode" do
-    expect(@hash.prototype_match({ 'a' => nil }, true)).to be_falsy
+  it "scores negatively a prototype containing an individual key in strict mode" do
+    expect(@hash.prototype_match_score({ 'a' => nil }, true)).to be <= 0
   end
 
-  it "matches nested prototypes (non-strict)" do
+  it "scores positively nested prototypes (non-strict)" do
     proto = {
       c: {
         'd' => nil,
       }
     }
-    expect(@hash.prototype_match(proto)).to be_truthy
+    expect(@hash.prototype_match_score(proto)).to be > 0
   end
 
-  it "doesn't match nested prototypes (strict)" do
+  it "scores negatively nested prototypes (strict)" do
     proto = {
       c: {
         'd' => nil,
       }
     }
-    expect(@hash.prototype_match(proto, true)).to be_falsy
+    expect(@hash.prototype_match_score(proto, true)).to be <= 0
   end
 
   it "fails if a value type mismatches a prototype value's type" do
@@ -53,7 +53,7 @@ describe ::Collapsium::PrototypeMatch do
         'd' => {},
       }
     }
-    expect(@hash.prototype_match(proto)).to be_falsy
+    expect(@hash.prototype_match_score(proto)).to be <= 0
   end
 
   it "fails if a value mismatches a prototype value" do
@@ -62,6 +62,25 @@ describe ::Collapsium::PrototypeMatch do
         'd' => 42,
       }
     }
-    expect(@hash.prototype_match(proto)).to be_falsy
+    expect(@hash.prototype_match_score(proto)).to be <= 0
+  end
+
+  it "succeeds if a value matches a prototype value" do
+    proto = {
+      c: {
+        'd' => 4,
+      }
+    }
+    expect(@hash.prototype_match_score(proto)).to be > 0
+  end
+
+  it "matches prototypes" do
+    # Keys exist in hash
+    expect(@hash.prototype_match('a' => nil)).to be_truthy
+    expect(@hash.prototype_match('b' => nil)).to be_truthy
+    expect(@hash.prototype_match(c: nil)).to be_truthy
+
+    # Key doesn't exist in hash
+    expect(@hash.prototype_match(foo: nil)).to be_falsey
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: collapsium
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jens Finkhaeuser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-16 00:00:00.000000000 Z
+date: 2016-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler