decanter 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7ee762570171d13eede776ea7715f54e3daa9228e09b8a83f278c857eaeb04c
-  data.tar.gz: 4dee8cfa404faeb3362925832d53b4e55c0f82cddd2427416c0fdf79a66ff85e
+  metadata.gz: 033f0c72ec50bb90c9853ffe63ebc76b8a887431535b8df3b9a16e1525d57962
+  data.tar.gz: 6fa983058d3a8d1c1df2285ef931ff0f9c271b7c8f43cdafa78ebf9119911ca2
 SHA512:
-  metadata.gz: dd1b076ac0cbe78783ab19b4ae43d8fb7d87bd46b76155ec08dcbdfb55638415667c1ad19ccdeff4f81e0b0482c2ef32292a1686df648ee52e0b3ce4824ea069
-  data.tar.gz: d34c06b627f4c1b4773829cd9e3003f3a8eb167a97acfa55be361628078d8230d8be1664d576d49eb6de9705d56f95c478ff52c56c2c656b1882d167df69e499
+  metadata.gz: 5551658bbbf3d094a1d04e8154133b707b802cb314f291f1bc70f5cd224964b85a70a583a104553ee4e246cb2673f3d36b5d65e4991c0fb4d41d9771e26192be
+  data.tar.gz: 343bdd635126c2ba52cb8cb27a0610104ac54d921f047137cce465ae908e48d473260c1d358d5e695dec10fff8334c173962e438d18cb0f373bf8138643c0aec

data/CONTRIBUTING.md

@@ -33,4 +33,4 @@ For any non-trivial change, we prefer an issue to be created first. This helps u
 ### Sending a Pull Request
 If this is your first Pull Request, we recommend learning how to navigate GitHub via this free video tutorial: [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
 
-The LaunchPad Lab team monitors this repository for pull requests. Once a pull request has been created from a forked repository that **meets all the guidelines** outlined in the [Pull Request Checklist](.github/PULL_REQUEST_TEMPLATE.md), we will review the request and either merge it, request changes, or close it with an explanation. We aim to respond to pull requests within 48 hours. 
+The LaunchPad Lab team monitors this repository for pull requests. Once a pull request has been created from a forked repository that **meets all the guidelines** outlined in the [Pull Request Checklist](.github/PULL_REQUEST_TEMPLATE.md), we will review the request and either merge it, request changes, or close it with an explanation. We aim to respond to pull requests within 48 hours.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    decanter (3.3.0)
+    decanter (3.4.0)
       actionpack (>= 4.2.10)
       activesupport (~> 5.2)
       rails-html-sanitizer (>= 1.0.4)

data/README.md

@@ -15,6 +15,7 @@ gem 'decanter', '~> 3.0'
 - [Basic Usage](#basic-usage)
   - [Decanters](#decanters)
   - [Generators](#generators)
+  - [Decanting Collections](#decanting-collections)
   - [Nested resources](#nested-resources)
   - [Default parsers](#default-parsers)
   - [Parser options](#parser-options)
@@ -70,6 +71,37 @@ rails g decanter Trip name:string start_date:date end_date:date
 rails g parser TruncatedString
 ```
 
+### Decanting Collections
+
+Decanter can decant a collection of a resource, applying the patterns used in the [fast JSON API gem](https://github.com/Netflix/fast_jsonapi#collection-serialization):
+
+```rb
+# app/controllers/trips_controller.rb
+
+  def create
+    trip_params = {
+      trips: [
+        { name: 'Disney World', start_date: '12/24/2018', end_date: '12/28/2018' },
+        { name: 'Yosemite', start_date: '5/1/2017', end_date: '5/4/2017' }
+      ]
+    }
+    decanted_trip_params = TripDecanter.decant(trip_params[:trips])
+    Trip.create(decanted_trip_params) # bulk create trips with decanted params
+  end
+```
+
+#### Control Over Decanting Collections
+
+You can use the `is_collection` option for explicit control over decanting collections.
+
+`decanted_trip_params = TripDecanter.decant(trip_params[:trips], is_collection: true)`
+
+If this option is not provided, autodetect logic is used to determine if the providing incoming params holds a single object or collection of objects.
+
+- `nil` or not provided: will try to autodetect single vs collection
+- `true` will always treat the incoming params args as *collection*
+- `false` will always treat incoming params args as *single object*
+
 ### Nested resources
 
 Decanters can declare relationships using `ActiveRecord`-style declarators:

data/lib/decanter/core.rb

@@ -8,7 +8,6 @@ module Decanter
     end
 
     module ClassMethods
-
       def input(name, parsers=nil, **options)
         # Convert all input names to symbols to correctly calculate handled vs. unhandled keys
         input_names = [name].flatten.map(&:to_sym)

data/lib/decanter/extensions.rb

@@ -20,7 +20,6 @@ module Decanter
     end
 
     module ClassMethods
-
       def decant_create(args, **options)
         self.new(decant(args, options))
             .save(context: options[:context])
@@ -36,12 +35,28 @@ module Decanter
       end
 
       def decant(args, options={})
+        is_collection?(args, options[:is_collection]) ? decant_collection(args, options) : decant_args(args, options)
+      end
+
+      def decant_collection(args, options)
+        args.map { |resource| decant_args(resource, options) }
+      end
+
+      def decant_args(args, options)
         if specified_decanter = options[:decanter]
           Decanter.decanter_from(specified_decanter)
         else
           Decanter.decanter_for(self)
         end.decant(args)
       end
+
+      private
+
+      # leveraging the approach used in the [fast JSON API gem](https://github.com/Netflix/fast_jsonapi#collection-serialization)
+      def is_collection?(args, collection_option=nil)
+        return collection_option[:is_collection] unless collection_option.nil?
+        args.respond_to?(:size) && !args.respond_to?(:each_pair)
+      end
     end
 
     module ActiveRecordExtensions

data/lib/decanter/version.rb

@@ -1,3 +1,3 @@
 module Decanter
-  VERSION = '3.3.0'.freeze
+  VERSION = '3.4.0'.freeze
 end

data/lib/generators/rails/decanter_generator.rb

@@ -2,12 +2,12 @@ module Rails
   module Generators
     class DecanterGenerator < NamedBase
       source_root File.expand_path('../templates', __FILE__)
-      check_class_collision :suffix => 'Decanter'
+      check_class_collision suffix: 'Decanter'
       ASSOCIATION_TYPES = [:has_many, :has_one, :belongs_to]
 
-      argument :attributes, :type => :array, :default => [], :banner => 'field:type field:type'
+      argument :attributes, type: :array, default: [], banner: 'field:type field:type'
 
-      class_option :parent, :type => :string, :desc => 'The parent class for the generated decanter'
+      class_option :parent, type: :string, desc: 'The parent class for the generated decanter'
 
       def create_decanter_file
         template 'decanter.rb.erb', File.join('app/decanters', class_path, "#{file_name}_decanter.rb")

data/lib/generators/rails/parser_generator.rb

@@ -2,9 +2,9 @@ module Rails
   module Generators
     class ParserGenerator < NamedBase
       source_root File.expand_path('../templates', __FILE__)
-      check_class_collision :suffix => 'Parser'
+      check_class_collision suffix: 'Parser'
 
-      class_option :parent, :type => :string, :desc => 'The parent class for the generated parser'
+      class_option :parent, type: :string, desc: 'The parent class for the generated parser'
 
       def create_parser_file
         template 'parser.rb.erb', File.join('lib/decanter/parsers', class_path, "#{file_name}_parser.rb")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decanter
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Ryan Francis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-03 00:00:00.000000000 Z
+date: 2020-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack