parametric 0.2.19 → 0.2.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98676c8edebba19bd1adff020f5eadf9dce07e44f89125be4f0451d6bdee50cf
-  data.tar.gz: 5a5d0ecded864e5185d2b1d1cafe5eeb2307d92cf52c4111e7dd85ebe65c0321
+  metadata.gz: 61eb99562317fd43b8ea59c1ed4e48c13320ff04334d372c07b5c78efe7ebd22
+  data.tar.gz: ee09741be15edf7ff3082b285ae16549029e995eb5841518e7f4394f5c131049
 SHA512:
-  metadata.gz: 1a3b81c816a02516450bdeb70ddb5b804741481ec0084167f31cdddcef4c3734f25b0d69da022048d9889c7b47a462cd821bf3a4cef07d719aff9b57293e10ef
-  data.tar.gz: 5a2cd8dd4d68cd896901d744f656fca3385f6d3763bc05d62dbd1b6c53362a32092781e7bd57e439b27c6e0071d1179a0355372778d33b9c96f893e6fd4e07d3
+  metadata.gz: 9c994b498b30870bb501890ecb44fe007d8ea49ae0ab2737033b70388ba36036b12a6795cf392a712e8b2d5121aa86e875280c080cf9a4ac4af953db2784c1fd
+  data.tar.gz: 55e8c26767574c8090d144465c23be6fe0a170470f736173cbde5beb059a8adcd1ca4aa52ad9a56038bc487b00e4595e7257d31ad84227df5720fe276c964012

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

@@ -23,6 +23,10 @@ module Parametric
       @policies = []
     end
 
+    def ==(other)
+      other.is_a?(Field) && key == other.key && policies == other.policies && meta_data == other.meta_data
+    end
+
     def meta(hash = nil)
       @meta_data = @meta_data.merge(hash) if hash.is_a?(Hash)
       self
@@ -88,7 +92,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)
@@ -53,5 +61,9 @@ module Parametric
     def key
       @policy.key
     end
+
+    def ==(other)
+      key == other.key && meta_data == other.meta_data
+    end
   end
 end

data/lib/parametric/schema.rb

@@ -18,6 +18,10 @@ module Parametric
       @after_hooks = []
     end
 
+    def ==(other)
+      other.is_a?(Schema) && fields == other.fields
+    end
+
     def schema
       self
     end

data/lib/parametric/version.rb

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

data/spec/field_spec.rb

@@ -59,6 +59,24 @@ describe Parametric::Field do
     end
   end
 
+  describe '#==' do
+    it 'compares by key' do
+      field_a = described_class.new(:a_key, registry)
+      field_b = described_class.new(:a_key, registry)
+      field_c = described_class.new(:another_key, registry)
+      expect(field_a).to eq(field_b)
+      expect(field_a).not_to eq(field_c)
+    end
+
+    it 'compares by policies' do
+      field_a = described_class.new(:a_key, registry).type(:integer)
+      field_b = described_class.new(:a_key, registry).type(:integer)
+      field_c = described_class.new(:a_key, registry).type(:integer).options([1,2,3])
+      expect(field_a).to eq(field_b)
+      expect(field_a).not_to eq(field_c)
+    end
+  end
+
   describe "#policy" do
     it "coerces integer" do
       subject.policy(:integer)

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

@@ -46,6 +46,29 @@ describe Parametric::Schema do
     end
   end
 
+  specify '#==' do
+    schema2 = described_class.new do
+      field(:title).policy(:string).present
+      field(:price).policy(:integer).meta(label: "A price")
+      field(:status).policy(:string).options(['visible', 'hidden'])
+      field(:tags).policy(:split).policy(:array)
+      field(:description).policy(:string)
+      field(:variants).policy(:array).schema do
+        field(:name).policy(:string).present
+        field(:sku)
+        field(:stock).policy(:integer).default(1)
+        field(:available_if_no_stock).policy(:boolean).policy(:flexible_bool).default(false)
+      end
+    end
+
+    schema3 = described_class.new do
+      field(:title).policy(:string).present
+    end
+
+    expect(subject).to eq schema2
+    expect(subject).not_to eq schema3
+  end
+
   def resolve(schema, payload, &block)
     yield schema.resolve(payload)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parametric
 version: !ruby/object:Gem::Version
-  version: 0.2.19
+  version: 0.2.21
 platform: ruby
 authors:
 - Ismael Celis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-10 00:00:00.000000000 Z
+date: 2024-01-30 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