smart_params 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2378ae8b0fa20a7f05f0895eb820bf1f48c93c578f2f673ee4a0876f7b3abc6b
-  data.tar.gz: 5904cd2c17c7f1ae03d14f28389acdd5d9902ffbe31c6669e73ec64a10e296c1
+  metadata.gz: dee376c52b0335bfc7ae84b37b2fc1e10575b216ad11e131fbf858621fa7431f
+  data.tar.gz: cfa443e6596f128bc313a83d8e744ca586c52891eecab9011edb330cbf365d40
 SHA512:
-  metadata.gz: 7e77d8dc227e0d2460282aca3f1fc15286d49032b90feca3d2107172d0115d164b694d22d8af9cd4835d469ac9341e471025f9cf9e5421ab281b8b749725dc02
-  data.tar.gz: 0a93159bd0d057b1d9af2218a74c7112e47b9034b7fe22e0711184bde7c1eb4463e5d74af40d924668c9efa8f0693461953478c8ed30ebea5683aa7351ce9269
+  metadata.gz: b2ab41e38e0ad3411de6703a3f37e3c1f1fa3cdef75de1404729d329727883c269da29119667bcdf5ceb9f7528e60802b708567e1f2dacc72eed8dd99824f7b7
+  data.tar.gz: 0213e4c1bb2854ba43fd6ac7c8300726e882e486d94c9032f7964929239854fb9780f84dc81c7f45200ebc2e0113afb64a856cd6711aee9544f6d275d71603c0

data/README.md

@@ -148,6 +148,7 @@ Or install it yourself with:
   1. Read the [Code of Conduct](/CONDUCT.md)
   2. Fork it
   3. Create your feature branch (`git checkout -b my-new-feature`)
-  4. Commit your changes (`git commit -am 'Add some feature'`)
-  5. Push to the branch (`git push origin my-new-feature`)
-  6. Create new Pull Request
+  4. Test your code: `rake spec`
+  5. Commit your changes (`git commit -am 'Add some feature'`)
+  6. Push to the branch (`git push origin my-new-feature`)
+  7. Create new Pull Request

data/lib/smart_params.rb

@@ -6,7 +6,7 @@ require "active_support/core_ext/module/delegation"
 
 module SmartParams
   extend ActiveSupport::Concern
-  include Dry::Types.module
+  include Dry.Types()
 
   require_relative "smart_params/field"
   require_relative "smart_params/error"
@@ -68,12 +68,8 @@ module SmartParams
   # This function basically takes a list of fields and reduces them into a tree of values
   private def structure
     fields
-      .reject(&:empty?)
+      .reject(&:removable?)
       .map(&:to_hash)
-      .map do |hash|
-        # NOTE: okay, so this looks weird, but it's because the root type has no key
-        if hash.key?(nil) then hash.fetch(nil) else hash end
-      end
       .reduce(&:deep_merge)
   end
 

data/lib/smart_params/field.rb

@@ -1,14 +1,16 @@
 module SmartParams
   class Field
     attr_reader :keychain
-    attr_reader :value
     attr_reader :subfields
     attr_reader :type
 
-    def initialize(keychain:, type:, &nesting)
+    def initialize(keychain:, type:, nullable: false, &nesting)
       @keychain = Array(keychain)
       @subfields = Set.new
       @type = type
+      @nullable = nullable
+      @specified = false
+      @dirty = false
 
       if block_given?
         instance_eval(&nesting)
@@ -16,9 +18,52 @@ module SmartParams
     end
 
     def deep?
+      # We check @specified directly because we want to know if ANY
+      # subfields have been passed, not just ones that match the schema.
+      return false if nullable? && !!@specified
       subfields.present?
     end
 
+    def root?
+      keychain.size == 0
+    end
+
+    def value
+      @value || ({} if root?)
+    end
+
+    def nullable?
+      !!@nullable
+    end
+
+    def specified?
+      if nullable?
+        !!@specified && clean?
+      else
+        !!@specified
+      end
+    end
+
+    # For nullable hashes: Any keys not in the schema make the hash dirty.
+    # If a key is found that matches the schema, we can consider the hash
+    # clean.
+    def dirty?
+      !!@dirty
+    end
+
+    def clean?
+      return false if dirty?
+      return true if empty? || subfields.select { |sub| !sub.empty? }.any?
+      false
+    end
+
+    # Check if we should consider this value even when empty.
+    def allow_empty?
+      return true if specified? && nullable?
+      return subfields.select(&:allow_empty?).any?
+      false
+    end
+
     def claim(raw)
       return type[dug(raw)] if deep?
 
@@ -37,20 +82,48 @@ module SmartParams
       value.nil?
     end
 
+    # Should this field be removed from resulting hash?
+    def removable?
+      empty? && !allow_empty?
+    end
+
     def weight
       keychain.map(&:to_s)
     end
 
-    private def field(key, type:, &subfield)
-      @subfields << self.class.new(keychain: [*keychain, key], type: type, &subfield)
+    private def field(key, type:, nullable: false, &subfield)
+      @subfields << self.class.new(keychain: [*keychain, key], type: type, nullable: nullable, &subfield)
     end
 
+    # Very busy method with recent changes. TODO: clean-up
     private def dug(raw)
-      if keychain.empty?
-        raw
-      else
-        raw.dig(*keychain)
+      return raw if keychain.empty?
+
+      # If value provided is a hash, check if it's dirty. See #dirty? for
+      # more info.
+      if nullable?
+        hash = raw.dig(*keychain)
+        if hash.respond_to?(:keys)
+          others =  hash.keys - [keychain.last]
+          @dirty = others.any?
+        end
       end
+
+      # Trace the keychain to find out if the field is explicitly set in the
+      # input hash.
+      at = raw
+      exact = true
+      keychain.each { |key|
+        if at.respond_to?(:key?) && at.key?(key)
+          at = at[key]
+        else
+          exact = false
+          break
+        end
+      }
+      @specified = exact
+
+      raw.dig(*keychain)
     end
   end
 end

data/lib/smart_params/version.rb

@@ -1,3 +1,3 @@
 module SmartParams
-  VERSION = "2.3.1"
+  VERSION = "2.4.0"
 end

data/lib/smart_params_spec.rb

@@ -2,6 +2,8 @@ require "spec_helper"
 
 RSpec.describe SmartParams do
   let(:schema) { CreateAccountSchema.new(params) }
+  let(:nullable_schema) { NullableSchema.new(params) }
+  let(:nullable_required_subfield_schema) { NullableRequiredSubfieldSchema.new(params) }
 
   describe ".new" do
     context "with an empty params" do
@@ -42,7 +44,8 @@ RSpec.describe SmartParams do
           data: {
             type: "accounts",
             attributes: {
-              email: "kurtis@example.com"
+              email: "kurtis@example.com",
+              password: "secret"
             }
           },
           meta: {
@@ -155,7 +158,8 @@ RSpec.describe SmartParams do
           data: {
             type: "accounts",
             attributes: {
-              email: "kurtis@example.com"
+              email: "kurtis@example.com",
+              password: "secret"
             }
           },
           meta: {
@@ -234,7 +238,8 @@ RSpec.describe SmartParams do
           data: {
             type: "accounts",
             attributes: {
-              email: "kurtis@example.com"
+              email: "kurtis@example.com",
+              password: "secret"
             }
           },
           meta: {
@@ -322,7 +327,8 @@ RSpec.describe SmartParams do
           data: {
             type: "accounts",
             attributes: {
-              email: "kurtis@example.com"
+              email: "kurtis@example.com",
+              password: "secret"
             }
           },
           meta: {
@@ -368,4 +374,158 @@ RSpec.describe SmartParams do
       end
     end
   end
+
+  describe "nullable values" do
+    context "set to nil" do
+      subject {nullable_schema.to_hash}
+
+      let(:params) do
+        {
+          data: nil
+        }
+      end
+
+      it "returns explicit nil" do
+        expect(
+          subject
+        ).to match(
+          hash_including(
+            {
+              "data" => nil
+            }
+          )
+        )
+      end
+    end
+
+    context "provided matching data" do
+      subject {nullable_schema.to_hash}
+
+      let(:params) do
+        {
+          data: {
+            id: "1",
+            type: "people"
+          }
+        }
+      end
+
+      it "returns matching data" do
+        expect(
+          subject
+        ).to match(
+          hash_including(
+            {
+              "data" => hash_including(
+                {
+                  "id" => "1",
+                  "type" => "people"
+                }
+              )
+            }
+          )
+        )
+      end
+    end
+
+    context "not provided" do
+      subject {nullable_schema.to_hash}
+
+      let(:params) do
+        {
+        }
+      end
+
+      it "does not set nil relationship" do
+        expect(
+          subject
+        ).to match(
+          hash_excluding(
+            {
+              "data" => nil
+            }
+          )
+        )
+      end
+    end
+
+    context "with non matching subfield data" do
+      subject {nullable_schema.to_hash}
+
+      let(:params) do
+        {
+          data: {
+            is: "garbage"
+          }
+        }
+      end
+
+      it "does not provide data" do
+        expect(
+          subject
+        ).to match(
+          hash_excluding(
+            {
+              "data" => nil
+            }
+          )
+        )
+      end
+    end
+
+    context "specified with unclean data" do
+      subject {nullable_required_subfield_schema.to_hash}
+
+      let(:params) do
+        {
+          # This will raise an exception becase the data hash is specified
+          # but its required subfields are not.
+          data: {
+            is: 'garbage'
+          }
+        }
+      end
+
+      it "checks subfields" do
+        expect {
+          subject
+        }.to raise_exception(SmartParams::Error::InvalidPropertyType)
+      end
+    end
+
+    context "specified as null" do
+      subject {nullable_required_subfield_schema.to_hash}
+
+      let(:params) do
+        {
+          # This will not raise an error, since data is allowed to be null.
+          # Subfields will not be checked.
+          data: nil
+        }
+      end
+
+      it "checks subfields" do
+        expect {
+          subject
+        }.not_to raise_exception
+      end
+    end
+
+    context "unspecified with required subfield" do
+      subject {nullable_required_subfield_schema.to_hash}
+
+      let(:params) do
+        {
+          # In this case, the nullable data hash is not specified so we
+          # don't need to enforce constraints on subfields.
+        }
+      end
+
+      it "allows null value" do
+        expect {
+          subject
+        }.not_to raise_exception
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_params
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Kurtis Rainbolt-Greene
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-12 00:00:00.000000000 Z
+date: 2019-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -176,8 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Apply an organized and easy to maintain schema to request params