hashema 0.1.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 663a42c26082914a797a078f3c45be35d9819726
+  data.tar.gz: 94a947af82292a51ccac8bee2034309275e23e61
+SHA512:
+  metadata.gz: 963f4928cf2664b10735f72c094f72eec7a12af292ff3b96d94b8c2f657ee2f818bb6be469521b54d173e7df98006c1402ef6975a521c2ed575bed682c2360f8
+  data.tar.gz: 1c30aaec10287aae3b1234297f312f8081249522e3ab8b9b630160565c1433f09c019e2af0e9eba2bb1cec6b4e7c6660fb6f01555e85e7f7b82f09280076e2bc

data/README.md

@@ -111,6 +111,13 @@ expect(
 )
 ```
 
+### Making a hash key optional
+
+```ruby
+expect({entree: "eggs"})
+  .to conform_to_schema({entree: String, side: Hashema::Optional(String)})
+```
+
 ## RSpec matcher options
 
 ### with_indifferent_access

data/lib/hashema.rb

@@ -3,3 +3,4 @@ require 'hashema/version'
 require 'hashema/conform_to_schema'
 require 'hashema/compiler'
 require 'hashema/schema'
+require 'hashema/optional'

data/lib/hashema/compiler.rb

@@ -12,6 +12,8 @@ module Hashema
 
     def compile(thing)
       case thing
+      when Hashema::Optional
+        Hashema::OptionalValueInHash.new(compile(thing.expected))
       when ::Array
         if thing.size == 1
           Hashema::Array.new(compile(thing[0]))

data/lib/hashema/optional.rb

@@ -0,0 +1,9 @@
+require_relative 'schema'
+
+module Hashema
+  Optional = Struct.new(:expected)
+
+  def self.Optional(value)
+    Optional.new(value)
+  end
+end

data/lib/hashema/schema.rb

@@ -1,3 +1,5 @@
+require "set"
+
 module Hashema
   class Schema < Struct.new(:expected)
     # A Schema is a Comparison factory.
@@ -5,6 +7,10 @@ module Hashema
       self.class.const_get('Comparison').new(actual, expected)
     end
 
+    def required_if_map_value?
+      true
+    end
+
     def inspect
       expected.inspect
     end
@@ -147,7 +153,7 @@ module Hashema
       end
 
       def missing_keys
-        @missing_keys ||= expected_keys - actual_keys
+        @missing_keys ||= demanded_keys - actual_keys
       end
 
       def matching_keys
@@ -162,6 +168,12 @@ module Hashema
         @expected_keys ||= Set.new(expected.keys)
       end
 
+      def demanded_keys
+        @demanded_keys ||= Set.new(expected_keys.select { |key|
+          fetch(key, expected).required_if_map_value?
+        })
+      end
+
       def actual_keys
         @actual_keys ||= Set.new(actual.keys)
       end
@@ -198,15 +210,13 @@ module Hashema
 
       def extra_keys
         @extra_keys ||= actual.keys.reject do |key|
-          expected.has_key? symbol_to_string key or
-            expected.has_key? string_to_symbol key
+          has_key?(key, expected)
         end
       end
 
       def missing_keys
-        @missing_keys ||= expected.keys.reject do |key|
-          actual.has_key? symbol_to_string key or
-            actual.has_key? string_to_symbol key
+        @missing_keys ||= expected.keys.select do |key|
+          !has_key?(key, actual) and fetch(key, expected).required_if_map_value?
         end
       end
 
@@ -216,6 +226,10 @@ module Hashema
           Set.new(actual.keys.map(&method(:symbol_to_string)))
       end
 
+      def has_key?(key, hash)
+        hash.has_key?(symbol_to_string key) or hash.has_key?(string_to_symbol key)
+      end
+
       def fetch(key, hash)
         return hash[symbol_to_string key] if hash.has_key? symbol_to_string key
         return hash[string_to_symbol key] if hash.has_key? string_to_symbol key
@@ -239,6 +253,21 @@ module Hashema
     end
   end
 
+  class OptionalValueInHash < Schema
+    def required_if_map_value?
+      false
+    end
+
+    class Comparison < Hashema::Comparison
+
+      private
+
+      def find_mismatches
+        expected.compare(actual).mismatches
+      end
+    end
+  end
+
   class Mismatch < Struct.new(:actual, :expected, :location, :verb)
     def self.at(location, original)
       new original.actual,

data/lib/hashema/validator.rb

@@ -4,8 +4,7 @@ module Hashema
   class Validator
     def initialize(actual, schema, options={})
       @actual = actual
-      @schema = schema
-      @schema = compile schema, options
+      @schema = Compiler.compile schema, options
     end
 
     def valid?
@@ -18,10 +17,6 @@ module Hashema
 
     private
 
-    def compile(schema, options={})
-      Hashema::Compiler.compile(schema, options)
-    end
-
     def comparison
       @comparison ||= @schema.compare(@actual)
     end

data/lib/hashema/version.rb

@@ -1,5 +1,5 @@
 module Hashema
   module Version
-    STRING = '0.1.1'
+    STRING = '0.2.0'
   end
 end

metadata

@@ -1,30 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: hashema
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Ben Christel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-04 00:00:00.000000000 Z
+date: 2020-03-26 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.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
 description: Assert that JSONable objects conform to a schema
@@ -34,38 +31,38 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- License.txt
+- README.md
 - lib/hashema.rb
 - lib/hashema/compiler.rb
 - lib/hashema/conform_to_schema.rb
+- lib/hashema/optional.rb
 - lib/hashema/schema.rb
 - lib/hashema/validator.rb
 - lib/hashema/version.rb
-- License.txt
-- README.md
 homepage: http://github.com/benchristel/hashema
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 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.23
+rubygems_version: 2.5.2.3
 signing_key: 
-specification_version: 3
-summary: hashema-0.1.1
+specification_version: 4
+summary: hashema-0.2.0
 test_files: []