smart_params 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 206bff3d4e4763f790bc5d296263c8a458bf76c163280844e752f3ddcf2afda4
-  data.tar.gz: 18b5369df20904317d59390c2d67d8901418a79505f14cc07a7a61af506f4dab
+  metadata.gz: fefed41179430e01ed431251aa5b42a279d21d9e8789500f39c7de54092d72a9
+  data.tar.gz: d247325e2b0b1dacdcd6f9680d6fcf8629d81bc1b7416d699efdc5141b5c0660
 SHA512:
-  metadata.gz: 24dad20aa68d5931967b8eee4c06b9060694a427cb06c5e6f691f5cb6cf2708e6e62999010f40fd68a92ce56942bca53194028a9fa65f6d79685efae477df11b
-  data.tar.gz: 7c2c04f1c992610a382cb429d9182ebfdc038a2c49c25b5d25c6a04e5205c1198ed4d4663db385c0179270183ae2afd8cb1cd1deab5cb0da5854bebb7daf9997
+  metadata.gz: 384fe2938d4cf4fe73a45c69620d5d5017a5c38358fcb8bd14d617693231571e8bee7dbd19ce6091d3fa3a547199f21db781c7ed9b7633b44c0bbfc5a80a5099
+  data.tar.gz: ae916f2a969e10be1fc7cbdfa116a1fb89c3a5b3970fdd6771297b1d7ea56222fa9c9414625bc658d6b50b27d5e10b0ced5af328524455fe5bf5e8ae7c3430cd

data/lib/smart_params.rb

@@ -1,8 +1,8 @@
-require "ostruct"
 require "dry-types"
 require "recursive-open-struct"
 require "active_support/concern"
 require "active_support/core_ext/object"
+require "active_support/core_ext/module/delegation"
 
 module SmartParams
   extend ActiveSupport::Concern
@@ -20,15 +20,11 @@ module SmartParams
     @safe = safe
     @raw = raw
     @schema = self.class.instance_variable_get(:@schema)
-    @fields = [@schema, *unfold(@schema.subfields)]
-      .sort_by(&:weight)
-      .each { |field| field.claim(raw) }
+    @fields = [@schema, *unfold(@schema.subfields)].sort_by(&:weight).each { |field| field.claim(raw) }
   rescue SmartParams::Error::InvalidPropertyType => invalid_property_type_exception
-    if safe?
-      raise invalid_property_type_exception
-    else
-      @exception = invalid_property_type_exception
-    end
+    raise invalid_property_type_exception if safe?
+
+    @exception = invalid_property_type_exception
   end
 
   def payload
@@ -39,25 +35,27 @@ module SmartParams
     end
   end
 
-  def as_json(options = nil)
+  def to_hash(options = nil)
     if @exception.present?
       @exception.as_json(options)
     else
       structure.as_json(options)
     end
   end
+  alias_method :as_json, :to_hash
 
-  def fetch(key, default = KeyError)
-    if default == KeyError
-      as_json.fetch(key, default)
-    else
-      as_json.fetch(key)
-    end
-  end
-
-  def dig(*keys)
-    as_json.dig(*keys)
-  end
+  delegate :[], to: :to_hash
+  delegate :fetch, to: :to_hash
+  delegate :fetch_values, to: :to_hash
+  delegate :merge, to: :to_hash
+  delegate :keys, to: :to_hash
+  delegate :key?, to: :to_hash
+  delegate :has_key?, to: :to_hash
+  delegate :values, to: :to_hash
+  delegate :value?, to: :to_hash
+  delegate :has_value?, to: :to_hash
+  delegate :dig, to: :to_hash
+  delegate :to_s, to: :to_hash
 
   def method_missing(name, *arguments, &block)
     if payload.respond_to?(name)

data/lib/smart_params/version.rb

@@ -1,3 +1,3 @@
 module SmartParams
-  VERSION = "2.2.0"
+  VERSION = "2.3.0"
 end

data/lib/smart_params_spec.rb

@@ -34,6 +34,8 @@ RSpec.describe SmartParams do
   end
 
   describe "#payload" do
+    subject {schema.payload}
+
     context "with a reasonably good params" do
       let(:params) do
         {
@@ -60,27 +62,25 @@ RSpec.describe SmartParams do
         }
       end
 
-      it "returns the type" do
-        expect(schema.payload.data.type).to eq("accounts")
+      it "has a chain path data.type" do
+        expect(subject.data.type).to eq("accounts")
       end
 
-      it "returns the email" do
-        expect(schema.data.attributes.email).to eq("kurtis@example.com")
+      it "has a chain path data.attributes.email" do
+        expect(subject.data.attributes.email).to eq("kurtis@example.com")
       end
 
-      it "returns the password" do
-        expect(schema.data.attributes.password).to be_kind_of(String)
+      it "has a chain path data.attributes.password" do
+        expect(subject.data.attributes.password).to be_kind_of(String)
       end
 
-      it "returns the jsonapi version" do
-        expect(schema.meta.jsonapi_version).to eq("1.0")
+      it "has a chain path meta.jsonapi_version" do
+        expect(subject.meta.jsonapi_version).to eq("1.0")
       end
     end
   end
 
-  describe "#as_json" do
-    subject {schema.as_json}
-
+  shared_examples "native types" do
     context "with extra params" do
       let(:params) do
         {
@@ -95,7 +95,7 @@ RSpec.describe SmartParams do
         }
       end
 
-      it "returns as json" do
+      it "returns as native data types" do
         expect(
           subject
         ).to match(
@@ -128,7 +128,7 @@ RSpec.describe SmartParams do
         }
       end
 
-      it "returns as json" do
+      it "returns as native data types" do
         expect(
           subject
         ).to match(
@@ -175,7 +175,7 @@ RSpec.describe SmartParams do
         }
       end
 
-      it "returns as json" do
+      it "returns as native data types" do
         expect(
           subject
         ).to match(
@@ -212,4 +212,160 @@ RSpec.describe SmartParams do
       end
     end
   end
+
+  describe "#to_hash" do
+    subject {schema.to_hash}
+
+    include_examples "native types"
+  end
+
+  describe "#as_json" do
+    subject {schema.as_json}
+
+    include_examples "native types"
+  end
+
+  describe "#fetch" do
+    subject {schema.fetch("data")}
+
+    context "with a reasonably good params" do
+      let(:params) do
+        {
+          data: {
+            type: "accounts",
+            attributes: {
+              email: "kurtis@example.com"
+            }
+          },
+          meta: {
+            jsonapi_version: "1.0"
+          },
+          included: [
+            {
+              data: {
+                id: "a",
+                type: "widget",
+                attributes: {
+                  title: "Widget A",
+                }
+              }
+            }
+          ]
+        }
+      end
+
+      it "returns the native type" do
+        expect(
+          subject
+        ).to match(
+          hash_including(
+            {
+              "type" => "accounts",
+              "attributes" => hash_including(
+                {
+                  "email" => "kurtis@example.com",
+                  "password" => an_instance_of(String)
+                }
+              )
+            }
+          )
+        )
+      end
+    end
+  end
+
+  describe "#dig" do
+    subject {schema.dig("data", "attributes", "email")}
+
+    context "with a reasonably good params" do
+      let(:params) do
+        {
+          data: {
+            type: "accounts",
+            attributes: {
+              email: "kurtis@example.com"
+            }
+          },
+          meta: {
+            jsonapi_version: "1.0"
+          },
+          included: [
+            {
+              data: {
+                id: "a",
+                type: "widget",
+                attributes: {
+                  title: "Widget A",
+                }
+              }
+            }
+          ]
+        }
+      end
+
+      it "returns the native type" do
+        expect(
+          subject
+        ).to eq(
+          "kurtis@example.com"
+        )
+      end
+    end
+  end
+
+  describe "#fetch_values" do
+    subject {schema.fetch_values("data", "meta")}
+
+    context "with a reasonably good params" do
+      let(:params) do
+        {
+          data: {
+            type: "accounts",
+            attributes: {
+              email: "kurtis@example.com"
+            }
+          },
+          meta: {
+            jsonapi_version: "1.0"
+          },
+          included: [
+            {
+              data: {
+                id: "a",
+                type: "widget",
+                attributes: {
+                  title: "Widget A",
+                }
+              }
+            }
+          ]
+        }
+      end
+
+      it "returns the native type" do
+        expect(
+          subject
+        ).to match(
+          [
+            hash_including(
+              {
+                "type" => "accounts",
+                "attributes" => hash_including(
+                  {
+                    "email" => "kurtis@example.com",
+                    "password" => an_instance_of(String)
+                  }
+                )
+              }
+            ),
+            hash_including(
+              {
+                "jsonapi_version" => "1.0"
+              }
+            )
+          ]
+        )
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_params
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Kurtis Rainbolt-Greene
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-30 00:00:00.000000000 Z
+date: 2018-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler