dry_serialization 0.4.3.2 → 0.4.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d7c4bec9452452abc391dabd00b7deccee9b2d8ea982cc4cfcdc094f61814cd
-  data.tar.gz: 3aa07db6818832c84bd3321e95f5f3dba4e2302faa5523808becc52e86d4fe9b
+  metadata.gz: 32515881ad6106083773deb7252ed369d179aa499c8955760459c29e740da85c
+  data.tar.gz: b3bfffa4bed91ee6abc05edc66f45d07cee9a56b0865a143c7e5e24880ae9756
 SHA512:
-  metadata.gz: 743725f638b0c868057b26100b7b59affb0cfd61cb6846728ceed417703a338a0ddee470fb72fa9b9a3548621ef43a11df7113514e01228cbc58d9c6ebdcb600
-  data.tar.gz: b9aea7143976de05280cc31effa33a41b91a5c1d135296f2352c08dc63127ab83b4dd05ab9a7d9f3fd6e76d10dca0b5e85f5f329770f9d176025c1721d1c0d82
+  metadata.gz: e23aa1a8f4a0b4d27b4c8d2f664c8e149421afa0e4cc2dacd7198cb38f2c43863affe03bb75fe13dfab715b212920facaa42ae4c8fcfe71ef51dd7f8bc8a6db2
+  data.tar.gz: daa8252dcdd1f0aec8e2acc0e8ed61beed8b4f6999cfe20c5de643c52360111793a0946335359e59411f81fcf667f05086556174c334af3939726c466f072cb7

data/README.md

@@ -1,7 +1,6 @@
 # DrySerialization
 
-![AppVeyor](https://img.shields.io/appveyor/build/mikeyduece/dry_serialization?style=plastic)
-![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/mikeyduece/dry_serialization?style=plastic)
+[![Gem Version](https://badge.fury.io/rb/dry_serialization.svg)](https://badge.fury.io/rb/dry_serialization)
 ![GitHub issues](https://img.shields.io/github/issues-raw/mikeyduece/dry_serialization?style=plastic)
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/dry_serialization`. To experiment with that code, run `bin/console` for an interactive prompt.
@@ -27,13 +26,33 @@ Or install it yourself as:
 ## Usage
 
 - Install with rails generator
-  * currently supported serializers are `:blueprinter`
+  * currently supported serializers are [jsonapi_serializer](https://github.com/jsonapi-serializer/jsonapi-serializer) and [blueprinter](https://github.com/procore/blueprinter)
   
 
     `rails g dry_serialization:<serializer_name>:install`
     
 
+- This gem will assume you have an api controller, and create one if you do not. This is to further keep the api separate from the web controllers. 
+  - The inclusion of the module corresponding to your chosen serializer gem will give you access to `#serialized_resource`.
+    - The `#serialized_resource` method also takes an optional 'options' hash. For `jsonapi-serializer`, that can come in the form of the `include` hash and/or `meta` or any of the other options available through that gem. Please see their documentation for all options.
+    - Similarly for `blueprinter` it will also take an optional options hash. Again, please see the official documentation in their repo.
+  ```ruby
+  user = User.find(params[:id])
+  render json: serialized_resource(user, UserSerializer) # UserSerializer can be substituted with UserBlueprint if that is the gem you've chosen.
+  ```
+  
+- SerializationHelper
+  - This module provides success and error response helper methods. 
+  - In your controller you can use them like so:
+  ```ruby
+  def create
+    user = User.create(create_user_params)
+    return error_response(user.errors) unless user.errors.empty?
     
+    success_response(user, UserSerializer, :created)
+  end
+  ```
+  - Both methods take an optional argument for the status. You can either use the symbol representation or the number code.
     
 
 ## Development

data/dry_serialization.gemspec

@@ -30,5 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'activerecord'
   spec.add_development_dependency 'sqlite3', '~> 1.4'
   spec.add_development_dependency 'yard', '~> 0.9.11'
-  spec.add_development_dependency 'fast_jsonapi'
+  spec.add_development_dependency 'jsonapi_serializer'
 end

data/lib/dry_serialization.rb

@@ -1,7 +1,8 @@
 require "dry_serialization/version"
 require "dry_serialization/blueprinter"
-require "dry_serialization/fast_jsonapi"
+require "dry_serialization/jsonapi_serializer"
 require "dry_serialization/concerns/serialization_helper"
+require "dry_serialization/concerns/deserializable"
 
 module DrySerialization
   

data/lib/dry_serialization/concerns/deserializable.rb

@@ -0,0 +1,71 @@
+module DrySerialization
+  module Concerns
+    module Deserializable
+      
+      def deserialized_payload(base_params, object = nil)
+        attrs = attributes(base_params)
+        id = dig_id(base_params, object)
+        attrs.merge!(id: id) if id
+        
+        build_nested_relationships(attrs, base_params)
+      end
+      
+      private
+      
+      def build_nested_relationships(attrs, base_params)
+        relations = relationships(base_params)
+        attrs.merge!(transform_object_values(relations))
+      end
+      
+      def transform_object_values(relations)
+        relations.to_h.each_with_object({}) do |(key, data), acc|
+          key = "#{key}_attributes" unless key.end_with?('_attributes')
+          acc[key] ||= transform_relationships_to_get_attributes(data)
+          transform_nested_relationships_to_get_attributes(acc[key], data)
+        end
+      end
+      
+      def transform_nested_relationships_to_get_attributes(parent_relation_hash, data)
+        nested_relationships = data[:data].respond_to?(:key?) ? relationships(data) : nil
+        return unless nested_relationships
+        
+        nested_relationships.each do |(relation, rel_data)|
+          hash = { "#{relation}_attributes": transform_relationships_to_get_attributes(rel_data) }
+          parent_relation_hash.merge!(hash)
+        end
+      end
+      
+      def transform_relationships_to_get_attributes(object)
+        case object[:data]
+          when Hash
+            object[:attributes] || object.dig(:data, :attributes)
+          when Array
+            object[:data].map do |e|
+              attrs = transform_relationships_to_get_attributes({ data: e })
+              attrs.merge!(transform_object_values(e[:relationships]))
+            end
+          else
+            return
+        end
+      end
+      
+      def dig_id(base_params, object)
+        return unless object
+        
+        base_params.dig(:data, :id)
+        send("#{object}_id")
+      rescue
+        nil
+      end
+      
+      def attributes(base_params)
+        base_params.dig(:data, :attributes)
+      end
+      
+      def relationships(base_params)
+        base_params.dig(:data, :relationships)
+      end
+    
+    end
+  end
+end

data/lib/dry_serialization/{fast_jsonapi.rb → jsonapi_serializer.rb}

@@ -1,4 +1,4 @@
-module DrySerialization::FastJsonapi
+module DrySerialization::JsonapiSerializer
   
   def serialized_resource(resource, serializer, options = {})
     if resource.is_a?(ActiveRecord::Relation) || resource.is_a?(Array)

data/lib/dry_serialization/version.rb

@@ -1,3 +1,3 @@
 module DrySerialization
-  VERSION = "0.4.3.2"
+  VERSION = "0.4.4.3"
 end

data/lib/generators/base_generator.rb

@@ -5,7 +5,7 @@ class BaseGenerator < Rails::Generators::Base
   SERIALIZERS = {
     ams: 'ActiveModelSerializers',
     blueprinter: 'Blueprinter',
-    fast_jsonapi: 'FastJsonapi'
+    jsonapi_serializer: 'JsonapiSerializer'
   }
   
   def self.exit_on_failure?
@@ -14,7 +14,7 @@ class BaseGenerator < Rails::Generators::Base
   
   private
   
-  # Removes other serialization gems, currently just AMS and FastJsonapi
+  # Removes other serialization gems, currently just AMS and JsonapiSerializer
   def remove_other_supported_gems(*gems)
     gems = [gems] unless gems.is_a?(Array)
     return if gems.empty?

data/lib/generators/dry_serialization/blueprinter/install_generator.rb

@@ -7,7 +7,7 @@ module DrySerialization
       
       # Add blueprinter gem to gemfile after dry_serialization declaration and bundles the newly declared gem
       def install_blueprinter
-        remove_other_supported_gems(SERIALIZERS[:ams], SERIALIZERS[:fast_jsonapi])
+        remove_other_supported_gems(SERIALIZERS[:ams], SERIALIZERS[:jsonapi_serializer])
         
         puts "Installing #{SERIALIZERS[:blueprinter]}..."
         insert_into_file('Gemfile',

data/lib/generators/dry_serialization/{fast_jsonapi → jsonapi_serializer}/install_generator.rb

@@ -1,21 +1,21 @@
 require 'generators/base_generator'
 
 module DrySerialization
-  module FastJsonapi
+  module JsonapiSerializer
     class InstallGenerator < BaseGenerator
       source_root File.expand_path("../../../templates", __FILE__)
       
       # Add blueprinter gem to gemfile after dry_serialization declaration and bundles the newly declared gem
-      def install_blueprinter
+      def install_jsonapi_serializer
         remove_other_supported_gems(SERIALIZERS[:blueprinter], SERIALIZERS[:ams])
         
-        puts "Installing #{SERIALIZERS[:blueprinter]}..."
+        puts "Installing #{SERIALIZERS[:jsonapi_serializer]}..."
         insert_into_file('Gemfile',
-                         "\ngem 'fast_jsonapi'",
-                         after: "gem 'dry_serialization', source: 'https://gem.fury.io/mikeyduece-gems/'")
+                         "\ngem 'jsonapi_serializer'",
+                         after: "gem 'dry_serialization'")
         run 'bundle install'
         
-        helper_include(SERIALIZERS[:fast_jsonapi])
+        helper_include(SERIALIZERS[:jsonapi_serializer])
       end
     
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry_serialization
 version: !ruby/object:Gem::Version
-  version: 0.4.3.2
+  version: 0.4.4.3
 platform: ruby
 authors:
 - Mike Heft
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-10 00:00:00.000000000 Z
+date: 2020-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.9.11
 - !ruby/object:Gem::Dependency
-  name: fast_jsonapi
+  name: jsonapi_serializer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -162,12 +162,13 @@ files:
 - dry_serialization.gemspec
 - lib/dry_serialization.rb
 - lib/dry_serialization/blueprinter.rb
+- lib/dry_serialization/concerns/deserializable.rb
 - lib/dry_serialization/concerns/serialization_helper.rb
-- lib/dry_serialization/fast_jsonapi.rb
+- lib/dry_serialization/jsonapi_serializer.rb
 - lib/dry_serialization/version.rb
 - lib/generators/base_generator.rb
 - lib/generators/dry_serialization/blueprinter/install_generator.rb
-- lib/generators/dry_serialization/fast_jsonapi/install_generator.rb
+- lib/generators/dry_serialization/jsonapi_serializer/install_generator.rb
 - lib/generators/templates/api_controller.rb
 homepage:
 licenses: