strong_json 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0035c9edc36454dc79ce83f91e948c91c7a10935cc4c7dc1ab3c50113c209100
-  data.tar.gz: b77289a1d16f20e2f29875e5156917f984587ad70f6d9bddd4aa4d7a62f40cb9
+  metadata.gz: bd9a6dd9efbb0ccca7cd5dfc14a415b4f408138724e5c4a4fe58d7fcc8fccafe
+  data.tar.gz: 02a451a69abca02dfdb418b13302b3bb6545cf23b0ec302698b65d2127d6f6d4
 SHA512:
-  metadata.gz: d230d14df235f9831ea73287abd9aa6018053ead823a7816bb73516adfc3599e29d727295055ab2439c6342592ebe1331e91a74df775adff8f550524b5be2d41
-  data.tar.gz: ac439273a3b6ef148f2f135b3f3c9820caf25831f8bfaae554971830b1c009d42242a6a614b7786eb2669c551e356eb66823375f2bbecf9f2a372bb9b3154228
+  metadata.gz: 4026edd18f863953d03652c5ea691a5ad6a88ba1db2ca8f5181da60974ebd70d10cf6cb09bc0d836583e285a9279d70b1dda43178881a3da37093e40ffd793b3
+  data.tar.gz: e2ca4033fe34c2f9b433c6a92f8b44484b7f30dfb89ca10fb5b0bed8a21370eb463e8444f5d28c3575c133bb879868c762fba36620a78f27b0886df59f1f970a

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+## 1.1.0 (2019-06-09)
+
+* [#15](https://github.com/soutaro/strong_json/pull/15): Add `hash` type
+
 ## 1.0.1 (2019-05-29)
 
 * Improve enum error reporting

data/README.md

@@ -86,6 +86,11 @@ object(attrs).prohibit!(Set.new([:created_at, :updated_at]))  # Destructive vers
 * The value must be an array
 * All elements in the array must be value of given `type`
 
+### hash(type)
+
+* The value must be an object
+* All values in the object must be value of given `type`
+
 ### optional(type)
 
 * The value can be `nil` (or not contained in an object)

data/lib/strong_json/type.rb

@@ -202,7 +202,7 @@ class StrongJSON
       end
 
       def coerce(object, path: ErrorPath.root(self))
-        unless object.is_a?(Hash)
+        unless object.is_a?(::Hash)
           raise TypeError.new(path: path, value: object)
         end
 
@@ -336,6 +336,37 @@ class StrongJSON
       end
     end
 
+    class Hash
+      include Match
+      include WithAlias
+
+      # @dynamic type
+      attr_reader :type
+
+      def initialize(type)
+        @type = type
+      end
+
+      def coerce(value, path: ErrorPath.root(self))
+        if value.is_a?(::Hash)
+          (_ = {}).tap do |result|
+            value.each do |k, v|
+              result[k] = type.coerce(v, path: path.dig(key: k, type: type))
+            end
+          end
+        else
+          raise TypeError.new(path: path, value: value)
+        end
+      end
+
+      def ==(other)
+        if other.is_a?(Hash)
+          # @type var other: Hash<any>
+          other.type == type
+        end
+      end
+    end
+
     class UnexpectedAttributeError < StandardError
       # @dynamic path, attribute
       attr_reader :path, :attribute

data/lib/strong_json/types.rb

@@ -91,5 +91,13 @@ class StrongJSON
     def enum?(*types, detector: nil)
       optional(enum(*types, detector: detector))
     end
+
+    def hash(type)
+      StrongJSON::Type::Hash.new(type)
+    end
+
+    def hash?(type)
+      optional(hash(type))
+    end
   end
 end

data/lib/strong_json/version.rb

@@ -1,5 +1,5 @@
 class StrongJSON
   # @dynamic initialize, let
   
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/sig/strong_json.rbi

@@ -49,6 +49,8 @@ module StrongJSON::Types
   def literal?: <'x> ('x) -> Type::Optional<'x>
   def enum: <'x> (*_Schema<any>, ?detector: Type::detector?) -> Type::Enum<'x>
   def enum?: <'x> (*_Schema<any>, ?detector: Type::detector?) -> Type::Optional<'x>
+  def (incompatible) hash: <'x> (_Schema<'x>) -> Type::Hash<'x>
+  def hash?: <'x> (_Schema<'x>) -> Type::Optional<Hash<Symbol, 'x>>
 end
 
 class StrongJSON::ErrorReporter

data/sig/type.rbi

@@ -59,18 +59,18 @@ class StrongJSON::Type::Object<'t>
   include Match
   include WithAlias
 
-  attr_reader fields: Hash<Symbol, _Schema<any>>
+  attr_reader fields: ::Hash<Symbol, _Schema<any>>
   attr_reader ignored_attributes: :any | Set<Symbol> | nil
   attr_reader prohibited_attributes: Set<Symbol>
 
-  def initialize: (Hash<Symbol, _Schema<'t>>, ignored_attributes: :any | Set<Symbol> | nil, prohibited_attributes: Set<Symbol>) -> any
+  def initialize: (::Hash<Symbol, _Schema<'t>>, ignored_attributes: :any | Set<Symbol> | nil, prohibited_attributes: Set<Symbol>) -> any
   def coerce: (any, ?path: ErrorPath) -> 't
 
   def ignore: (:any | Set<Symbol> | nil) -> self
   def ignore!: (:any | Set<Symbol> | nil) -> self
   def prohibit: (Set<Symbol>) -> self
   def prohibit!: (Set<Symbol>) -> self
-  def update_fields: <'x> { (Hash<Symbol, _Schema<any>>) -> void } -> Object<'x>
+  def update_fields: <'x> { (::Hash<Symbol, _Schema<any>>) -> void } -> Object<'x>
 end
 
 type StrongJSON::Type::detector = ^(any) -> _Schema<any>?
@@ -114,3 +114,12 @@ class StrongJSON::Type::UnexpectedAttributeError < StandardError
   def type: -> _Schema<any>
 end
 
+class StrongJSON::Type::Hash<'t>
+  include Match
+  include WithAlias
+
+  attr_reader type: _Schema<'t>
+
+  def initialize: (_Schema<'t>) -> any
+  def coerce: (any, ?path: ErrorPath) -> ::Hash<Symbol, 't>
+end

data/spec/hash_spec.rb

@@ -0,0 +1,32 @@
+require "strong_json"
+
+describe StrongJSON::Type::Hash do
+  let(:number) { StrongJSON::Type::Base.new(:number) }
+
+  describe "#coerce" do
+    it "returns a hash" do
+      type = StrongJSON::Type::Hash.new(number)
+      expect(type.coerce({ foo: 123, bar: 234 })).to eq({ foo: 123, bar: 234 })
+    end
+
+    it "raises an error if number is given" do
+      type = StrongJSON::Type::Hash.new(number)
+
+      expect {
+        type.coerce(1)
+      }.to raise_error(StrongJSON::Type::TypeError) {|error|
+        expect(error.path.to_s).to eq("$")
+      }
+    end
+
+    it "raises an error if hash value is unexpected" do
+      type = StrongJSON::Type::Hash.new(number)
+
+      expect {
+        type.coerce({ foo: "hello" })
+      }.to raise_error(StrongJSON::Type::TypeError) {|error|
+        expect(error.path.to_s).to eq("$.foo")
+      }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strong_json
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-28 00:00:00.000000000 Z
+date: 2019-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,6 +95,7 @@ files:
 - spec/case_subsumption_operator_spec.rb
 - spec/enum_spec.rb
 - spec/error_spec.rb
+- spec/hash_spec.rb
 - spec/json_spec.rb
 - spec/literal_spec.rb
 - spec/object_spec.rb
@@ -131,6 +132,7 @@ test_files:
 - spec/case_subsumption_operator_spec.rb
 - spec/enum_spec.rb
 - spec/error_spec.rb
+- spec/hash_spec.rb
 - spec/json_spec.rb
 - spec/literal_spec.rb
 - spec/object_spec.rb