parametric 0.2.18 → 0.2.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 403aac3495b3e90bc32cf01c0229b83497d37413fb43b6180c3dafd0a9ec36b9
-  data.tar.gz: a8396d8ab3831e7c93d1643f96562ff0d5fe1ddaa8794dfe7ed8993bd4732cd5
+  metadata.gz: 0a4f53d13fdfe4476f9467127b58740f86b8f301979b56940eb9e228fd588225
+  data.tar.gz: 5b26af44589c43bc2825a75e988318eefc3147581183a4c4cc65af5b98a47fed
 SHA512:
-  metadata.gz: dbd04349edf7e8f4777ef7c681ec8f16d2cf570d915088fae04942760415d9fd88123741b68957839b21d7145d97b83b6cf6911fce5f0e2db806d34a304e1a0d
-  data.tar.gz: 9851e0d8f4e5e48d38870027c8a987fbf65f264a8c9dfaafe74080ff463e3783267f605eae09ce65b1f43547a27935ae532fd75120d60823fd24e8bf09bd0c4d
+  metadata.gz: a5f7fbdfee4363b05e2044439499bd17954552b6a8c9b95442a613969e4775dcc2d05ee2340ba06df3b55b12df2414a16b672fe76c5b1ee2485ba6dede5cbdf7
+  data.tar.gz: 9ea239bd608ef85e8f92a07060e10aff57b0552b92562b4e4ea1507e1a91a71173382565fd7f198d8f3a2595756b8a6badeb46638de14997fd15bf13250e4910

data/README.md

@@ -293,6 +293,21 @@ Like `:declared`, it stops the policy chain if a key is not in input, but it als
 field(:name).policy(:declared_no_default).present
 ```
 
+### :nullable
+
+Check that key is present in input. If value is `nil`, processing and validations stop, but key is still included in output.
+
+```ruby
+schema = Parametric::Schema.new do
+  field(:age).nullable.type(:integer).policy(:gt: 21)
+end
+
+schema.resolve(age: '22').output[:age] # 22
+schema.resolve(age: 10).errors[:age] # has error because < 21
+schema.resolve(age: nil).output[:age] # nil, no errors
+schema.resolve({}).output[:age] # nil, no errors
+```
+
 ### :gt
 
 Validate that the value is greater than a number
@@ -387,6 +402,12 @@ class MyPolicyRunner
     true
   end
 
+  # If this policy is not eligible, should the key and value be included in the output?
+  # @return [Boolean]
+  def include_non_eligible_in_ouput?
+    true
+  end
+
   # If [false], add [#message] to result errors and halt processing field.
   # @return [Boolean]
   def valid?

data/lib/parametric/field.rb

@@ -88,7 +88,7 @@ module Parametric
         begin
           pol = policy.build(key, value, payload:, context:)
           if !pol.eligible?
-            eligible = false
+            eligible = pol.include_non_eligible_in_ouput?
             if has_default?
               eligible = true
               value = default_block.call(key, payload, context)

data/lib/parametric/field_dsl.rb

@@ -22,5 +22,9 @@ module Parametric
     def options(opts)
       policy :options, opts
     end
+
+    def nullable
+      policy :nullable
+    end
   end
 end

data/lib/parametric/nullable_policy.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Parametric
+  # A policy that allows a field to be nullable.
+  # Fields with nil values are not processed further, and the value is returned as-is.
+  # @example
+  #   field(:age).nullable.type(:integer)
+  #   field(:age).nullable.type(:integer).required
+  #
+  class NullablePolicy
+    def meta_data; {}; end
+
+    def build(key, value, payload:, context:)
+      Runner.new(key, value, payload, context)
+    end
+
+    class Runner
+      def initialize(key, value, payload, context)
+        @key = key
+        @value = value
+        @payload = payload
+        @context = context
+      end
+
+      # Should this policy run at all?
+      # returning [false] halts the field policy chain.
+      # @return [Boolean]
+      def eligible?
+        @payload.key?(@key) && !@value.nil?
+      end
+
+      # If this policy is not eligible, should the key and value be included in the output?
+      # @return [Boolean]
+      def include_non_eligible_in_ouput?
+        true
+      end
+
+      # If [false], add [#message] to result errors and halt processing field.
+      # @return [Boolean]
+      def valid?
+        true
+      end
+
+      # Coerce the value, or return as-is.
+      # @return [Any]
+      def value
+        @value
+      end
+
+      # Error message for this policy
+      # @return [String]
+      def message
+        ''
+      end
+    end
+  end
+end

data/lib/parametric/policies.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'parametric/nullable_policy'
+
 module Parametric
   module Policies
     class Format
@@ -59,6 +61,7 @@ module Parametric
   Parametric.policy :format, Policies::Format
   Parametric.policy :email, Policies::Format.new(EMAIL_REGEXP, 'invalid email')
   Parametric.policy :value, Policies::Value
+  Parametric.policy :nullable, Parametric::NullablePolicy
 
   Parametric.policy :noop do
     eligible do |value, key, payload|

data/lib/parametric/policy_adapter.rb

@@ -14,6 +14,14 @@ module Parametric
         @policy.eligible?(@raw_value, @key, @payload)
       end
 
+      # If a policy is not #eligible?, use this to decide if its key
+      # should still be included in output hash.
+      #
+      # @return [Boolean]
+      def include_non_eligible_in_ouput?
+        false
+      end
+
       # @return [Boolean]
       def valid?
         @policy.valid?(value, @key, @payload)

data/lib/parametric/schema.rb

@@ -76,6 +76,8 @@ module Parametric
         meta = field.meta_data.dup
         sc = meta.delete(:schema)
         meta[:structure] = sc.schema.structure if sc
+        one_of = meta.delete(:one_of)
+        meta[:one_of] = one_of.values.map(&:structure) if one_of
         obj[field.key] = meta
       end
     end

data/lib/parametric/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Parametric
-  VERSION = '0.2.18'
+  VERSION = '0.2.20'
 end

data/spec/nullable_policy_spec.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'nullable policy' do
+  specify 'dealing with nil values' do
+    schema = Parametric::Schema.new do
+      field(:age).nullable.type(:integer)
+    end
+
+    expect(schema.resolve({ age: 10 }).output[:age]).to eq 10
+    expect(schema.resolve({ age: '10' }).output[:age]).to eq 10
+    expect(schema.resolve({ age: nil }).output[:age]).to eq nil
+    expect(schema.resolve({ age: false }).output[:age]).to be false
+    expect(schema.resolve({ nope: 1 }).output.key?(:age)).to be true
+  end
+
+  specify 'with required/present types' do
+    schema = Parametric::Schema.new do
+      field(:age).nullable.type(:integer).present.policy(:gt, 9)
+    end
+
+    schema.resolve({ age: '10' }).tap do |r|
+      expect(r.output[:age]).to eq 10
+      expect(r.errors.any?).to be false
+    end
+
+    schema.resolve({ age: '7' }).tap do |r|
+      expect(r.output[:age]).to eq 7
+      expect(r.errors.any?).to be true
+    end
+
+    schema.resolve({ age: nil }).tap do |r|
+      expect(r.output[:age]).to eq nil
+      expect(r.errors.any?).to be false
+    end
+
+    schema.resolve({}).tap do |r|
+      expect(r.output.key?(:age)).to be true
+      expect(r.output[:age]).to eq nil
+      expect(r.errors.any?).to be false
+    end
+  end
+
+  specify 'interacting with custom types that validate' do
+    Parametric.policy :validating_integer do
+      exp = /^\d+$/
+
+      validate do |value, _key, _context|
+        !!(value.to_s =~ exp)
+      end
+
+      coerce do |value, _key, _context|
+        if value.to_s =~ exp
+          value.to_i
+        else
+          value
+        end
+      end
+
+      message do
+        'error!'
+      end
+    end
+
+    schema = Parametric::Schema.new do
+      field(:age).nullable.type(:validating_integer)
+    end
+
+    expect(schema.resolve({ age: 10 }).output[:age]).to eq 10
+    expect(schema.resolve({ age: '10' }).output[:age]).to eq 10
+    schema.resolve({ age: 'nope' }).tap do |r|
+      expect(r.output[:age]).to eq 'nope'
+      expect(r.errors.any?).to be true
+    end
+    schema.resolve({ age: nil }).tap do |r|
+      expect(r.output.key?(:age)).to be(true)
+      expect(r.output[:age]).to eq nil
+      expect(r.errors.any?).to be false
+    end
+    expect(schema.resolve({ age: nil }).output[:age]).to eq nil
+    expect(schema.resolve({ nope: 1 }).output.key?(:age)).to be true
+  end
+
+  specify 'interacting with required fields' do
+    schema = Parametric::Schema.new do
+      field(:age).nullable.type(:integer).required
+    end
+
+    result = schema.resolve({})
+    expect(result.output.key?(:age)).to be(true)
+    expect(result.output[:age]).to eq nil
+    expect(result.errors['$.age']).to eq nil
+  end
+
+  specify 'copying policies via Field#from' do
+    source_schema = Parametric::Schema.new do
+      field(:age).nullable.type(:integer).required
+    end
+
+    target_schema = Parametric::Schema.new do |sc, _|
+      source_schema.fields.each do |key, f|
+        sc.field(key).from(f)
+      end
+    end
+
+    result = target_schema.resolve({})
+    expect(result.output[:age]).to eq nil
+    expect(result.errors['$.age']).to eq nil
+  end
+end

data/spec/schema_spec.rb

@@ -307,6 +307,29 @@ describe Parametric::Schema do
       expect(result.valid?).to be true
       expect(result.output).to eq({ type: 'user', sub: { name: 'Joe', age: 30 } })
     end
+
+    specify '#structure' do
+      user_or_company = Parametric::TaggedOneOf.new do |sub|
+        sub.on('user', user_schema)
+        sub.on('company', company_schema)
+      end
+
+      schema = described_class.new do |sc, _|
+        sc.field(:type).type(:string)
+        sc.field(:sub).type(:object).tagged_one_of(user_or_company.index_by(:type))
+      end
+
+      structure = schema.structure
+      structure.dig(:sub).tap do |sub|
+        expect(sub[:type]).to eq :object
+        expect(sub[:one_of][0][:name][:type]).to eq :string
+        expect(sub[:one_of][0][:name][:required]).to be true
+        expect(sub[:one_of][0][:name][:present]).to be true
+        expect(sub[:one_of][0][:age][:type]).to eq :integer
+
+        expect(sub[:one_of][1][:company_code][:type]).to eq :string
+      end
+    end
   end
 
   describe "#ignore" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parametric
 version: !ruby/object:Gem::Version
-  version: 0.2.18
+  version: 0.2.20
 platform: ruby
 authors:
 - Ismael Celis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-10 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -76,6 +76,7 @@ files:
 - lib/parametric/dsl.rb
 - lib/parametric/field.rb
 - lib/parametric/field_dsl.rb
+- lib/parametric/nullable_policy.rb
 - lib/parametric/policies.rb
 - lib/parametric/policy_adapter.rb
 - lib/parametric/registry.rb
@@ -89,6 +90,7 @@ files:
 - spec/dsl_spec.rb
 - spec/expand_spec.rb
 - spec/field_spec.rb
+- spec/nullable_policy_spec.rb
 - spec/policies_spec.rb
 - spec/schema_lifecycle_hooks_spec.rb
 - spec/schema_spec.rb
@@ -115,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.18
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: DSL for declaring allowed parameters with options, regexp patern and default
@@ -125,6 +127,7 @@ test_files:
 - spec/dsl_spec.rb
 - spec/expand_spec.rb
 - spec/field_spec.rb
+- spec/nullable_policy_spec.rb
 - spec/policies_spec.rb
 - spec/schema_lifecycle_hooks_spec.rb
 - spec/schema_spec.rb