active_model_serializers 0.9.3 → 0.9.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 78c340a2e3f13f2c481239a485597b288d1bad45
-  data.tar.gz: 41820649a307a90c8bcae4739e3dc32a77a45711
+SHA256:
+  metadata.gz: e9f526564b9458ceea3d9391ddbf81cf996ff713dbb217bcec1c22931b4cd028
+  data.tar.gz: ac5641428e5b17ffa605bc7337f8f77000354a2a47f1a5ed7244ab50cdca84b2
 SHA512:
-  metadata.gz: ef0646d4c09ba21a4a8182c9fa01931ba619faeeefbf0dfb1492fa5f8769b6ce5c6ac2962d13b09224943191cf70e79ab8e360da5923fadc1f5eaf8213c24ea1
-  data.tar.gz: ab87b438037b55acf490d9ac6327abc01fed66cb06638bd12e235e0d3e3f8471a09144315762b866bba13958b60fa38dd02f9e9173d1dfff069ad310e02cec7b
+  metadata.gz: af47a8298fbc563716f0c7b4a9e0d92b85243ead1b0ccac561703d17f09574a3e65f280adedbb24ee7d65c0634c4ca343c58aa665628ff75d7e220b89025e91d
+  data.tar.gz: 6974a26799a967fbb8b172092be014deb775909a52cf10cf4e7dc88b5c05c96f6b6acbb3d245f9ad9032c743c2048c1afd8335d3a899c3111f2d6b48015800f7

data/CHANGELOG.md

@@ -1,3 +1,110 @@
+## 0.09.x
+
+### [0-9-stable](https://github.com/rails-api/active_model_serializers/compare/v0.9.8...0-9-stable)
+
+### [v0.9.8 (2020-12-10)](https://github.com/rails-api/active_model_serializers/compare/v0.9.7...v0.9.8)
+
+- [#2373](https://github.com/rails-api/active_model_serializers/pull/2373) Fix Rails 6.0 deprecation warnings. (@supremebeing7)
+
+### [v0.9.7 (2017-05-01)](https://github.com/rails-api/active_model_serializers/compare/v0.9.6...v0.9.7)
+
+- [#2080](https://github.com/rails-api/active_model_serializers/pull/2080) remove `{ payload: nil }` from `!serialize.active_model_serializers` ActiveSupport::Notification. `payload` never had a value.  Changes, for example `{ serializer: 'ActiveModel::DefaultSerializer', payload: nil }` to be `{ serializer: 'ActiveModel::DefaultSerializer' }` (@yosiat)
+
+### [v0.9.6 (2017-01-10)](https://github.com/rails-api/active_model_serializers/compare/v0.9.5...v0.9.6)
+
+- [#2008](https://github.com/rails-api/active_model_serializers/pull/2008) Fix warning on Thor. (@kirs)
+
+### [v0.9.5 (2016-03-30)](https://github.com/rails-api/active_model_serializers/compare/v0.9.4...v0.9.5)
+
+- [#1607](https://github.com/rails-api/active_model_serializers/pull/1607) Merge multiple nested associations. (@Hirtenknogger)
+
+### [v0.9.4 (2016-01-05)](https://github.com/rails-api/active_model_serializers/compare/v0.9.3...v0.9.4)
+
+- [#752](https://github.com/rails-api/active_model_serializers/pull/752) Tiny improvement of README 0-9-stable (@basiam)
+- [#749](https://github.com/rails-api/active_model_serializers/pull/749) remove trailing whitespace (@shwoodard)
+- [#717](https://github.com/rails-api/active_model_serializers/pull/717) fixed issue with rendering Hash which appears in rails 4.2.0.beta4 (@kurko, @greshny)
+- [#790](https://github.com/rails-api/active_model_serializers/pull/790) pass context to ArraySerializer (@lanej)
+- [#797](https://github.com/rails-api/active_model_serializers/pull/797) Fix and test for #490 (@afn)
+- [#813](https://github.com/rails-api/active_model_serializers/pull/813) Allow to define custom serializer for given class (@jtomaszewski)
+- [#841](https://github.com/rails-api/active_model_serializers/pull/841) Fix issue with embedding multiple associations under the same root key (@antstorm)
+- [#748](https://github.com/rails-api/active_model_serializers/pull/748) Propagate serialization_options across associations (@raphaelpereira)
+
+### [v0.9.3 (2015/01/21 20:29 +00:00)](https://github.com/rails-api/active_model_serializers/compare/v0.9.2...v0.9.3)
+
+Features:
+- [#774](https://github.com/rails-api/active_model_serializers/pull/774) Fix nested include attributes (@nhocki)
+- [#771](https://github.com/rails-api/active_model_serializers/pull/771) Make linked resource type names consistent with root names (@sweatypitts)
+- [#696](https://github.com/rails-api/active_model_serializers/pull/696) Explicitly set serializer for associations (@ggordon)
+- [#700](https://github.com/rails-api/active_model_serializers/pull/700) sparse fieldsets (@arenoir)
+- [#768](https://github.com/rails-api/active_model_serializers/pull/768) Adds support for `meta` and `meta_key` attribute (@kurko)
+
+### [v0.9.2](https://github.com/rails-api/active_model_serializers/compare/v0.9.1...v0.9.2)
+
+### [v0.9.1 (2014/12/04 11:54 +00:00)](https://github.com/rails-api/active_model_serializers/compare/v0.9.0...v0.9.1)
+
+- [#707](https://github.com/rails-api/active_model_serializers/pull/707) A Friendly Note on Which AMS Version to Use (@jherdman)
+- [#730](https://github.com/rails-api/active_model_serializers/pull/730) Fixes nested has_many links in JSONAPI (@kurko)
+- [#718](https://github.com/rails-api/active_model_serializers/pull/718) Allow overriding the adapter with render option (@ggordon)
+- [#720](https://github.com/rails-api/active_model_serializers/pull/720) Rename attribute with :key (0.8.x compatibility) (@ggordon)
+- [#728](https://github.com/rails-api/active_model_serializers/pull/728) Use type as key for linked resources (@kurko)
+- [#729](https://github.com/rails-api/active_model_serializers/pull/729) Use the new beta build env on Travis (@joshk)
+- [#703](https://github.com/rails-api/active_model_serializers/pull/703) Support serializer and each_serializer options in renderer (@ggordon, @mieko)
+- [#727](https://github.com/rails-api/active_model_serializers/pull/727) Includes links inside of linked resources (@kurko)
+- [#726](https://github.com/rails-api/active_model_serializers/pull/726) Bugfix: include nested has_many associations (@kurko)
+- [#722](https://github.com/rails-api/active_model_serializers/pull/722) Fix infinite recursion (@ggordon)
+- [#1](https://github.com/rails-api/active_model_serializers/pull/1) Allow for the implicit use of ArraySerializer when :each_serializer is specified (@mieko)
+- [#692](https://github.com/rails-api/active_model_serializers/pull/692) Include 'linked' member for json-api collections (@ggordon)
+- [#714](https://github.com/rails-api/active_model_serializers/pull/714) Define as_json instead of to_json (@guilleiguaran)
+- [#710](https://github.com/rails-api/active_model_serializers/pull/710) JSON-API: Don't include linked section if associations are empty (@guilleiguaran)
+- [#711](https://github.com/rails-api/active_model_serializers/pull/711) Fixes rbx gems bundling on TravisCI (@kurko)
+- [#709](https://github.com/rails-api/active_model_serializers/pull/709) Add type key when association name is different than object type (@guilleiguaran)
+- [#708](https://github.com/rails-api/active_model_serializers/pull/708) Handle correctly null associations (@guilleiguaran)
+- [#691](https://github.com/rails-api/active_model_serializers/pull/691) Fix embed option for associations (@jacob-s-son)
+- [#689](https://github.com/rails-api/active_model_serializers/pull/689) Fix support for custom root in JSON-API adapter (@guilleiguaran)
+- [#685](https://github.com/rails-api/active_model_serializers/pull/685) Serialize ids as strings in JSON-API adapter (@guilleiguaran)
+- [#684](https://github.com/rails-api/active_model_serializers/pull/684) Refactor adapters to implement support for array serialization (@guilleiguaran)
+- [#682](https://github.com/rails-api/active_model_serializers/pull/682) Include root by default in JSON-API serializers (@guilleiguaran)
+- [#625](https://github.com/rails-api/active_model_serializers/pull/625) Add DSL for urls (@JordanFaust)
+- [#677](https://github.com/rails-api/active_model_serializers/pull/677) Add support for embed: :ids option for in associations (@guilleiguaran)
+- [#681](https://github.com/rails-api/active_model_serializers/pull/681) Check superclasses for Serializers (@quainjn)
+- [#680](https://github.com/rails-api/active_model_serializers/pull/680) Add support for root keys (@NullVoxPopuli)
+- [#675](https://github.com/rails-api/active_model_serializers/pull/675) Support Rails 4.2.0 (@tricknotes)
+- [#667](https://github.com/rails-api/active_model_serializers/pull/667) Require only activemodel instead of full rails (@guilleiguaran)
+- [#653](https://github.com/rails-api/active_model_serializers/pull/653) Add "_test" suffix to JsonApi::HasManyTest filename. (@alexgenco)
+- [#631](https://github.com/rails-api/active_model_serializers/pull/631) Update build badge URL (@craiglittle)
+
+### [v0.9.0](https://github.com/rails-api/active_model_serializers/compare/v0.9.0.alpha1...v0.9.0)
+
+### [0.9.0.alpha1 - January 7, 2014](https://github.com/rails-api/active_model_serializers/compare/d72b66d4c...v0.9.0.alpha1)
+
+### 0.9.0.pre
+
+* The following methods were removed
+  - Model#active\_model\_serializer
+  - Serializer#include!
+  - Serializer#include?
+  - Serializer#attr\_disabled=
+  - Serializer#cache
+  - Serializer#perform\_caching
+  - Serializer#schema (needs more discussion)
+  - Serializer#attribute
+  - Serializer#include\_#{name}? (filter method added)
+  - Serializer#attributes (took a hash)
+
+* The following things were added
+  - Serializer#filter method
+  - CONFIG object
+
+* Remove support for ruby 1.8 versions.
+
+* Require rails >= 3.2.
+
+* Serializers for associations are being looked up in a parent serializer's namespace first. Same with controllers' namespaces.
+
+* Added a "prefix" option in case you want to use a different version of serializer.
+
+* Serializers default namespace can be set in `default_serializer_options` and inherited by associations.
+
 # VERSION 0.9.0.pre
 
 * The following methods were removed

data/README.md

@@ -85,7 +85,7 @@ it exists, use it to serialize the `Post`.
 
 This also works with `respond_with`, which uses `to_json` under the hood. Also
 note that any options passed to `render :json` will be passed to your
-serializer and available as `@options` inside.
+serializer and available as `@serialization_options` inside.
 
 To specify a custom serializer for an object, you can specify the
 serializer when you render the object:
@@ -251,11 +251,11 @@ BlogSerializer.new(object, key_format: :lower_camel)
 
 You can specify that serializers use unsuffixed names as association keys by default.
 
-`````ruby
+```ruby
 ActiveModel::Serializer.setup do |config|
   config.default_key_type = :name
 end
-````
+```
 
 This will build association keys like `comments` or `author` instead of `comment_ids` or `author_id`.
 
@@ -339,6 +339,7 @@ And it's also safe to mutate keys argument by doing keys.delete(:author)
 in case you want to avoid creating two extra arrays. Note that if you do an
 in-place modification, you still need to return the modified array.
 
+### Alias Attribute
 If you would like the key in the outputted JSON to be different from its name
 in ActiveRecord, you can declare the attribute with the different name
 and redefine that method:
@@ -377,7 +378,7 @@ The above usage of `:meta` will produce the following:
 If you would like to change the meta key name you can use the `:meta_key` option:
 
 ```ruby
-render json: @posts, serializer: CustomArraySerializer, meta_object: {total: 10}, meta_key: 'meta_object'
+render json: @posts, serializer: CustomArraySerializer, meta_object: { total: 10 }, meta_key: :meta_object
 ```
 
 The above usage of `:meta_key` will produce the following:
@@ -755,18 +756,18 @@ end
     "title": "New post",
     "attachments": [
       {
-        "type": "image"
+        "type": "image",
         "image": {
-          "id": 3
-          "name": "logo"
+          "id": 3,
+          "name": "logo",
           "url": "http://images.com/logo.jpg"
         }
       },
       {
-        "type": "video"
+        "type": "video",
         "video": {
-          "id": 12
-          "uid": "XCSSMDFWW"
+          "id": 12,
+          "uid": "XCSSMDFWW",
           "source": "youtube"
         }
       }
@@ -793,11 +794,11 @@ end
     "title": "New post",
     "attachment_ids": [
       {
-        "type": "image"
+        "type": "image",
         "id": 12
       },
       {
-        "type": "video"
+        "type": "video",
         "id": 3
       }
     ]
@@ -931,7 +932,7 @@ now generates:
 class PostSerializer < ApplicationSerializer
   attributes :id
 end
-````
+```
 
 # Design and Implementation Guidelines
 

data/lib/action_controller/serialization.rb

@@ -60,7 +60,15 @@ module ActionController
     private
 
     def namespace_for_serializer
-      @namespace_for_serializer ||= self.class.parent unless self.class.parent == Object
+      @namespace_for_serializer ||= namespace_for_class(self.class) unless namespace_for_class(self.class) == Object
+    end
+
+    def namespace_for_class(klass)
+      if Module.method_defined?(:module_parent)
+        klass.module_parent
+      else
+        klass.parent
+      end
     end
 
     def default_serializer(resource)

data/lib/active_model/array_serializer.rb

@@ -15,17 +15,18 @@ module ActiveModel
       @object          = object
       @scope           = options[:scope]
       @root            = options.fetch(:root, self.class._root)
-      @polymorphic   = options.fetch(:polymorphic, false)
+      @polymorphic     = options.fetch(:polymorphic, false)
       @meta_key        = options[:meta_key] || :meta
       @meta            = options[@meta_key]
       @each_serializer = options[:each_serializer]
       @resource_name   = options[:resource_name]
       @only            = options[:only] ? Array(options[:only]) : nil
       @except          = options[:except] ? Array(options[:except]) : nil
+      @context         = options[:context]
       @namespace       = options[:namespace]
       @key_format      = options[:key_format] || options[:each_serializer].try(:key_format)
     end
-    attr_accessor :object, :scope, :root, :meta_key, :meta, :key_format
+    attr_accessor :object, :scope, :root, :meta_key, :meta, :key_format, :context
 
     def json_key
       key = root.nil? ? @resource_name : root
@@ -35,7 +36,7 @@ module ActiveModel
 
     def serializer_for(item)
       serializer_class = @each_serializer || Serializer.serializer_for(item, namespace: @namespace) || DefaultSerializer
-      serializer_class.new(item, scope: scope, key_format: key_format, only: @only, except: @except, polymorphic: @polymorphic, namespace: @namespace)
+      serializer_class.new(item, scope: scope, key_format: key_format, context: @context, only: @only, except: @except, polymorphic: @polymorphic, namespace: @namespace)
     end
 
     def serializable_object(options={})
@@ -63,10 +64,5 @@ module ActiveModel
       end
     end
 
-    private
-
-    def instrumentation_keys
-      [:object, :scope, :root, :meta_key, :meta, :each_serializer, :resource_name, :key_format]
-    end
   end
 end

data/lib/active_model/default_serializer.rb

@@ -15,18 +15,14 @@ module ActiveModel
     end
 
     def as_json(options={})
-      instrument('!serialize') do
+      instrument do
         return [] if @object.nil? && @wrap_in_array
         hash = @object.as_json
         @wrap_in_array ? [hash] : hash
       end
     end
+
     alias serializable_hash as_json
     alias serializable_object as_json
-
-    private
-    def instrumentation_keys
-      [:object, :wrap_in_array]
-    end
   end
 end

data/lib/active_model/serializable.rb

@@ -2,12 +2,14 @@ require 'active_model/serializable/utils'
 
 module ActiveModel
   module Serializable
+    INSTRUMENTATION_KEY = '!serialize.active_model_serializers'.freeze
+
     def self.included(base)
       base.extend Utils
     end
 
     def as_json(options={})
-      instrument('!serialize') do
+      instrument do
         if root = options.fetch(:root, json_key)
           hash = { root => serializable_object(options) }
           hash.merge!(serializable_data)
@@ -19,9 +21,7 @@ module ActiveModel
     end
 
     def serializable_object_with_notification(options={})
-      instrument('!serialize') do
-        serializable_object(options)
-      end
+      instrument { serializable_object(options) }
     end
 
     def serializable_data
@@ -33,7 +33,11 @@ module ActiveModel
     end
 
     def namespace
-      get_namespace && Utils._const_get(get_namespace)
+      if module_name = get_namespace
+        Serializer.serializers_cache.fetch_or_store(module_name) do
+          Utils._const_get(module_name)
+        end
+      end
     end
 
     def embedded_in_root_associations
@@ -47,16 +51,9 @@ module ActiveModel
       modules[0..-2].join('::') if modules.size > 1
     end
 
-    def instrument(action, &block)
-      payload = instrumentation_keys.inject({ serializer: self.class.name }) do |payload, key|
-        payload[:payload] = self.instance_variable_get(:"@#{key}")
-        payload
-      end
-      ActiveSupport::Notifications.instrument("#{action}.active_model_serializers", payload, &block)
-    end
-
-    def instrumentation_keys
-      [:object, :scope, :root, :meta_key, :meta, :wrap_in_array, :only, :except, :key_format]
+    def instrument(&block)
+      payload = { serializer: self.class.name }
+      ActiveSupport::Notifications.instrument(INSTRUMENTATION_KEY, payload, &block)
     end
   end
 end

data/lib/active_model/serializer.rb

@@ -4,6 +4,7 @@ require 'active_model/serializer/association'
 require 'active_model/serializer/config'
 
 require 'thread'
+require 'concurrent/map'
 
 module ActiveModel
   class Serializer
@@ -56,14 +57,19 @@ end
       attr_reader :key_format
 
       def serializer_for(resource, options = {})
-        if resource.respond_to?(:to_ary)
+        if resource.respond_to?(:serializer_class)
+          resource.serializer_class
+        elsif resource.respond_to?(:to_ary)
           if Object.constants.include?(:ArraySerializer)
             ::ArraySerializer
           else
             ArraySerializer
           end
         else
-          _const_get build_serializer_class(resource, options)
+          klass_name = build_serializer_class(resource, options)
+          Serializer.serializers_cache.fetch_or_store(klass_name) do
+            _const_get(klass_name)
+          end
         end
       end
 
@@ -98,6 +104,10 @@ end
         associate(Association::HasMany, *attrs)
       end
 
+      def serializers_cache
+        @serializers_cache ||= Concurrent::Map.new
+      end
+
       private
 
       def strip_attribute(attr)
@@ -161,7 +171,7 @@ end
       end
     end
 
-    def associations
+    def associations(options={})
       associations = self.class._associations
       included_associations = filter(associations.keys)
       associations.each_with_object({}) do |(name, association), hash|
@@ -178,7 +188,7 @@ end
             if association.embed_namespace?
               hash = hash[association.embed_namespace] ||= {}
             end
-            hash[association.embedded_key] = serialize association
+            hash[association.embedded_key] = serialize association, options
           end
         end
       end
@@ -201,8 +211,14 @@ end
         if included_associations.include? name
           association_serializer = build_serializer(association)
           # we must do this always because even if the current association is not
-          # embeded in root, it might have its own associations that are embeded in root
-          hash.merge!(association_serializer.embedded_in_root_associations) {|key, oldval, newval| [newval, oldval].flatten }
+          # embedded in root, it might have its own associations that are embedded in root
+          hash.merge!(association_serializer.embedded_in_root_associations) do |key, oldval, newval|
+            if oldval.respond_to?(:to_ary)
+              [oldval, newval].flatten.uniq
+            else
+              oldval.merge(newval) { |_, oldval, newval| [oldval, newval].flatten.uniq }
+            end
+          end
 
           if association.embed_in_root?
             if association.embed_in_root_key?
@@ -236,8 +252,8 @@ end
       end
     end
 
-    def serialize(association)
-      build_serializer(association).serializable_object
+    def serialize(association,options={})
+      build_serializer(association).serializable_object(options)
     end
 
     def serialize_ids(association)
@@ -282,7 +298,7 @@ end
       self.serialization_options = options
       return @wrap_in_array ? [] : nil if @object.nil?
       hash = attributes
-      hash.merge! associations
+      hash.merge! associations(options)
       hash = convert_keys(hash) if key_format.present?
       hash = { :type => type_name(@object), type_name(@object) => hash } if @polymorphic
       @wrap_in_array ? [hash] : hash

data/lib/active_model/serializer/association/has_one.rb

@@ -12,7 +12,7 @@ module ActiveModel
         end
 
         def serializer_class(object, options = {})
-          serializer_from_options || serializer_from_object(object, options) || default_serializer
+          (serializer_from_options unless object.nil?) || serializer_from_object(object, options) || default_serializer
         end
 
         def build_serializer(object, options = {})