smart_params 4.1.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51307d488e1178966b88bac2344fbbdf03f0d99468d810c8c3d1b5f4337563be
-  data.tar.gz: 89a122fe01133ea7906a3edf35f3b8158ebe05d63377ae75783f06dfdc289482
+  metadata.gz: 72ea358328d6d2de0b7cb159c3f7a02eaeeba1114428d0dd1eef74033311a4b5
+  data.tar.gz: 3b864136adce02b4393645f42e56f46086b4a7b0b8a1e75a326ffcb0ab3a6b49
 SHA512:
-  metadata.gz: be60295f1c9144554bad8cd96b99cf28c288ee6881a813af72c7c49ff6dbb84a73972ed0da21defccce6b7146b9454abeeadc5c0000aaea01c2f91be3448a5f2
-  data.tar.gz: ce85f9a928fb36067586e1ece4cd2372c4e97be76363ef31c2793581d718fcac5f48c010482b539fcff1cb0872bc97968414732a7a3ea1f5d88635de71ebf0b3
+  metadata.gz: b6020bd0591d343040c21882a091e6bb9535132f116e6c538ea60edbe4f7da15581dafae6158d37fe81d0aa52f920827e416af88fdd25e4ea9e6da182a719096
+  data.tar.gz: 20c54169633985ed7febf49f4b5028c0b375017f793d6a3f0ee172ea9ce41e72869ec745cc5e6e854fdd4f6c3ae989e80cce6806f3b1e286e6e8be92c8f45c10

data/README.md

@@ -11,19 +11,19 @@ So lets say you have a complex set of incoming data, say a JSON:API-specificatio
 class CreateAccountSchema
   include SmartParams
 
-  schema type: Strict::Hash do
-    field :data, type: Strict::Hash do
-      field :id, type: Coercible::String.optional
+  schema do
+    field :data, subschema: true do
+      field :id, type: Coercible::String, nullable: true
       field :type, type: Strict::String
-      field :attributes, type: Strict::Hash.optional do
-        field :email, type: Strict::String.optional
-        field :username, type: Strict::String.optional
-        field :name, type: Strict::String.optional
-        field :password, type: Strict::String.optional.default { SecureRandom.hex(32) }
+      field :attributes, subschema: true, nullable: true do
+        field :email, type: Strict::String, nullable: true
+        field :username, type: Strict::String, nullable: true
+        field :name, type: Strict::String, nullable: true
+        field :password, type: Strict::String.default { SecureRandom.hex(32) }, nullable: true
       end
     end
-    field :meta, type: Strict::Hash.optional
-    field :included, type: Strict::Array.optional
+    field :meta, Strict::Hash, nullable: true
+    field :included, type: Strict::Array, nullable: true
   end
 end
 ```

data/lib/smart_params/error/invalid_property_type.rb

@@ -6,16 +6,22 @@ module SmartParams
       attr_reader :keychain
       attr_reader :wanted
       attr_reader :raw
+      attr_reader :missing_key
 
-      def initialize(keychain:, wanted:, raw:)
+      def initialize(keychain:, wanted:, raw:, missing_key: nil)
         super
         @keychain = keychain
         @wanted = wanted
         @raw = raw
+        @missing_key = missing_key
       end
 
       def message
-        "expected #{keychain.inspect} to be #{wanted.name}, but was #{raw.inspect}"
+        if missing_key
+          "expected #{keychain.inspect} to be #{wanted.name} with key #{missing_key.inspect}, but is #{raw.inspect}"
+        else
+          "expected #{keychain.inspect} to be #{wanted.name}, but is #{raw.inspect}"
+        end
       end
 
       def as_json

data/lib/smart_params/error/invalid_property_type_spec.rb

@@ -3,13 +3,23 @@
 require "spec_helper"
 
 RSpec.describe SmartParams::Error::InvalidPropertyType do
-  let(:error) { described_class.new(keychain: [:data], wanted: SmartParams::Strict::Hash, raw: "") }
-
   describe "#message" do
     subject { error.message }
 
-    it "returns the message" do
-      expect(subject).to eq("expected [:data] to be Hash, but was \"\"")
+    context "when the error is about the type mismatch" do
+      let(:error) { described_class.new(keychain: [:data], wanted: SmartParams::Strict::Hash, raw: "") }
+
+      it "returns the message" do
+        expect(subject).to eq("expected [:data] to be Hash, but is \"\"")
+      end
+    end
+
+    context "when the error is about a missing key" do
+      let(:error) { described_class.new(keychain: [:data], wanted: SmartParams::Strict::Hash.schema(data: SmartParams::Strict::String), raw: {}, missing_key: :data) }
+
+      it "returns the message" do
+        expect(subject).to eq("expected [:data] to be Hash with key :data, but is {}")
+      end
     end
   end
 end

data/lib/smart_params/field.rb

@@ -5,18 +5,36 @@ module SmartParams
     attr_reader :keychain
     attr_reader :subfields
     attr_reader :type
+    attr_reader :nullable
+    attr_reader :key
 
-    def initialize(keychain:, type:, nullable: false, &nesting)
+    def inspect
+      "#<#{self.class.name}:#{__id__} #{[
+        ('subschema' if @subschema),
+        ("#/#{@keychain.join('/')}" if @keychain),
+        ("-> #{type.name}" if @type),
+        ("= #{@value.inspect}" if @value)
+      ].compact.join(' ')}>"
+    end
+
+    def initialize(keychain:, type:, key: nil, subschema: false, nullable: false, &nesting)
+      @key = key
       @keychain = Array(keychain)
       @subfields = Set.new
       @type = type
       @nullable = nullable
+      @subschema = subschema
       @specified = false
       @dirty = false
 
-      return unless nesting
+      instance_eval(&nesting) if nesting
 
-      instance_eval(&nesting)
+      if subschema
+        @type = @type.schema(subfields.reduce({}) do |mapping, field|
+          mapping.merge("#{field.key}#{'?' if field.nullable}": field.type)
+        end).with_key_transform(&:to_sym)
+      end
+      @type = @type.optional if nullable
     end
 
     def deep?
@@ -72,8 +90,10 @@ module SmartParams
       return type[dug(raw)] if deep?
 
       @value = type[dug(raw)]
-    rescue Dry::Types::ConstraintError
+    rescue Dry::Types::ConstraintError => _constraint_exception
       raise SmartParams::Error::InvalidPropertyType.new(keychain:, wanted: type, raw: keychain.empty? ? raw : raw.dig(*keychain))
+    rescue Dry::Types::MissingKeyError => missing_key_exception
+      raise SmartParams::Error::InvalidPropertyType.new(keychain:, wanted: type, raw: keychain.empty? ? raw : raw.dig(*keychain), missing_key: missing_key_exception.key)
     end
 
     def to_hash
@@ -95,9 +115,8 @@ module SmartParams
       keychain.map(&:to_s)
     end
 
-    private def field(key, type:, nullable: false, &subfield)
-      type |= SmartParams::Strict::Nil if nullable
-      @subfields << self.class.new(keychain: [*keychain, key], type:, nullable:, &subfield)
+    private def field(key, subschema: false, type: SmartParams::Hash, nullable: false, &subfield)
+      @subfields << self.class.new(key:, keychain: [*keychain, key], type:, nullable:, subschema:, &subfield)
     end
 
     # Very busy method with recent changes. TODO: clean-up

data/lib/smart_params/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SmartParams
-  VERSION = "4.1.0"
+  VERSION = "5.0.0"
 end

data/lib/smart_params.rb

@@ -24,10 +24,14 @@ module SmartParams
     @schema = self.class.instance_variable_get(:@schema)[name]
 
     @fields = [@schema, *unfold(@schema.subfields)].sort_by(&:weight).each { |field| field.claim(raw) }
-  rescue SmartParams::Error::InvalidPropertyType => e
-    raise e if safe?
+  rescue SmartParams::Error::InvalidPropertyType => invalid_property_exception
+    raise invalid_property_exception if safe?
 
-    @exception = e
+    @exception = invalid_property_exception
+  end
+
+  def inspect
+    "#<#{self.class.name}:#{__id__} @fields=#{@fields.inspect} @raw=#{@raw.inspect}>"
   end
 
   def payload
@@ -96,9 +100,9 @@ module SmartParams
   end
 
   class_methods do
-    def schema(name: :default, type:, &definitions)
+    def schema(name: :default, type: Hash, subschema: false, &definitions)
       @schema ||= {}
-      @schema[name] = Field.new(keychain: [], type:, &definitions)
+      @schema[name] = Field.new(keychain: [], type:, subschema:, &definitions)
     end
   end
 end

data/lib/smart_params_spec.rb

@@ -12,12 +12,12 @@ RSpec.describe SmartParams do
       let(:params) { {} }
 
       it "throws an error with a message detailing the invalid property type and given properties" do
-        expect { schema }.to raise_exception(SmartParams::Error::InvalidPropertyType, "expected [:data] to be Hash, but was nil")
+        expect { schema }.to raise_exception(SmartParams::Error::InvalidPropertyType, "expected [:data] to be Hash, but is nil")
       end
 
       it "throws an error with the missing property and given properties" do
         expect { schema }.to raise_exception do |exception|
-          expect(exception).to have_attributes(keychain: [:data], wanted: SmartParams::Strict::Hash, raw: nil)
+          expect(exception).to have_attributes(keychain: [:data], wanted: a_kind_of(Dry::Types::Constrained), raw: nil)
         end
       end
     end
@@ -26,12 +26,12 @@ RSpec.describe SmartParams do
       let(:params) { { data: "" } }
 
       it "throws an error with a message detailing the invalid property, expected type, given type, and given value" do
-        expect { schema }.to raise_exception(SmartParams::Error::InvalidPropertyType, "expected [:data] to be Hash, but was \"\"")
+        expect { schema }.to raise_exception(SmartParams::Error::InvalidPropertyType, "expected [:data] to be Hash, but is \"\"")
       end
 
       it "throws an error with the invalid property, expected type, given type, and given value" do
         expect { schema }.to raise_exception do |exception|
-          expect(exception).to have_attributes(keychain: [:data], wanted: SmartParams::Strict::Hash, raw: "")
+          expect(exception).to have_attributes(keychain: [:data], wanted: a_kind_of(Dry::Types::Constrained), raw: "")
         end
       end
     end
@@ -456,18 +456,20 @@ RSpec.describe SmartParams do
       let(:params) do
         {
           data: {
+            id: "x",
+            type: "y",
             is: "garbage"
           }
         }
       end
 
-      it "does not provide data" do
+      it "does not return key that isn't specified" do
         expect(
           subject
         ).to match(
           hash_excluding(
             {
-              "data" => nil
+              "is" => "garbage"
             }
           )
         )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_params
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Kurtis Rainbolt-Greene
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-08 00:00:00.000000000 Z
+date: 2023-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport