active_model_serializers 0.8.3 → 0.10.0.rc2

data/Rakefile

@@ -1,18 +1,12 @@
-#!/usr/bin/env rake
 require "bundler/gem_tasks"
-require "rake/testtask"
 
-desc 'Run tests'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-end
+require 'rake/testtask'
 
-desc 'Benchmark'
-task :bench do
-  load 'bench/perf.rb' 
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.ruby_opts = ['-r./test/test_helper.rb']
+  t.verbose = true
 end
 
 task :default => :test

data/active_model_serializers.gemspec

@@ -1,24 +1,26 @@
-# -*- encoding: utf-8 -*-
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_model/serializer/version'
 
-$:.unshift File.expand_path("../lib", __FILE__)
-require "active_model/serializers/version"
+Gem::Specification.new do |spec|
+  spec.name          = "active_model_serializers"
+  spec.version       = ActiveModel::Serializer::VERSION
+  spec.authors       = ["Steve Klabnik"]
+  spec.email         = ["steve@steveklabnik.com"]
+  spec.summary       = %q{Conventions-based JSON generation for Rails.}
+  spec.description   = %q{ActiveModel::Serializers allows you to generate your JSON in an object-oriented and convention-driven manner.}
+  spec.homepage      = "https://github.com/rails-api/active_model_serializers"
+  spec.license       = "MIT"
 
-Gem::Specification.new do |gem|
-  gem.authors       = ["José Valim", "Yehuda Katz"]
-  gem.email         = ["jose.valim@gmail.com", "wycats@gmail.com"]
-  gem.description   = %q{Making it easy to serialize models for client-side use}
-  gem.summary       = %q{Bringing consistency and object orientation to model serialization. Works great for client-side MVC frameworks!}
-  gem.homepage      = "https://github.com/rails-api/active_model_serializers"
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  gem.name          = "active_model_serializers"
-  gem.require_paths = ["lib"]
-  gem.version       = ActiveModel::Serializer::VERSION
+  spec.add_dependency "activemodel", ">= 4.0"
 
-  gem.add_dependency 'activemodel', '>= 3.0'
-  gem.add_development_dependency "rails", ">= 3.0"
-  gem.add_development_dependency "pry"
-  gem.add_development_dependency "minitest"
+  spec.add_development_dependency "rails", ">= 4.0"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
 end

data/lib/action_controller/serialization.rb

@@ -1,32 +1,13 @@
+require 'active_support/core_ext/class/attribute'
+
 module ActionController
-  # Action Controller Serialization
-  #
-  # Overrides render :json to check if the given object implements +active_model_serializer+
-  # as a method. If so, use the returned serializer instead of calling +to_json+ on the object.
-  #
-  # This module also provides a serialization_scope method that allows you to configure the
-  # +serialization_scope+ of the serializer. Most apps will likely set the +serialization_scope+
-  # to the current user:
-  #
-  #    class ApplicationController < ActionController::Base
-  #      serialization_scope :current_user
-  #    end
-  #
-  # If you need more complex scope rules, you can simply override the serialization_scope:
-  #
-  #    class ApplicationController < ActionController::Base
-  #      private
-  #
-  #      def serialization_scope
-  #        current_user
-  #      end
-  #    end
-  #
   module Serialization
     extend ActiveSupport::Concern
 
     include ActionController::Renderers
 
+    ADAPTER_OPTION_KEYS = [:include, :fields, :adapter]
+
     included do
       class_attribute :_serialization_scope
       self._serialization_scope = :current_user
@@ -37,21 +18,49 @@ module ActionController
         respond_to?(_serialization_scope, true)
     end
 
-    def default_serializer_options
+    def get_serializer(resource)
+      @_serializer ||= @_serializer_opts.delete(:serializer)
+      @_serializer ||= ActiveModel::Serializer.serializer_for(resource)
+
+      if @_serializer_opts.key?(:each_serializer)
+        @_serializer_opts[:serializer] = @_serializer_opts.delete(:each_serializer)
+      end
+
+      @_serializer
+    end
+
+    def use_adapter?
+      !(@_adapter_opts.key?(:adapter) && !@_adapter_opts[:adapter])
     end
 
     [:_render_option_json, :_render_with_renderer_json].each do |renderer_method|
       define_method renderer_method do |resource, options|
-        json = ActiveModel::Serializer.build_json(self, resource, options)
+        @_adapter_opts, @_serializer_opts =
+          options.partition { |k, _| ADAPTER_OPTION_KEYS.include? k }.map { |h| Hash[h] }
+
+        if use_adapter? && (serializer = get_serializer(resource))
+
+          @_serializer_opts[:scope] ||= serialization_scope
+          @_serializer_opts[:scope_name] = _serialization_scope
 
-        if json
-          super(json, options)
+          # omg hax
+          object = serializer.new(resource, @_serializer_opts)
+          adapter = ActiveModel::Serializer::Adapter.create(object, @_adapter_opts)
+          super(adapter, options)
         else
           super(resource, options)
         end
       end
     end
 
+    def rescue_with_handler(exception)
+      @_serializer = nil
+      @_serializer_opts = nil
+      @_adapter_opts = nil
+
+      super(exception)
+    end
+
     module ClassMethods
       def serialization_scope(scope)
         self._serialization_scope = scope

data/lib/active_model/serializer/adapter/flatten_json.rb

@@ -0,0 +1,12 @@
+module ActiveModel
+  class Serializer
+    class Adapter
+      class FlattenJson < Json
+        def serializable_hash(options = {})
+          super
+          @result
+        end
+      end
+    end
+  end
+end

data/lib/active_model/serializer/adapter/fragment_cache.rb

@@ -0,0 +1,78 @@
+module ActiveModel
+  class Serializer
+    class Adapter
+      class FragmentCache
+
+        attr_reader :serializer
+
+        def initialize(adapter, serializer, options)
+          @options    = options
+          @adapter    = adapter
+          @serializer = serializer
+        end
+
+        def fetch
+          klass = serializer.class
+          # It will split the serializer into two, one that will be cached and other wont
+          serializers = fragment_serializer(serializer.object.class.name, klass)
+
+          # Instanciate both serializers
+          cached_serializer     = serializers[:cached].constantize.new(serializer.object)
+          non_cached_serializer = serializers[:non_cached].constantize.new(serializer.object)
+
+          cached_adapter     = @adapter.class.new(cached_serializer, @options)
+          non_cached_adapter = @adapter.class.new(non_cached_serializer, @options)
+
+          # Get serializable hash from both
+          cached_hash     = cached_adapter.serializable_hash
+          non_cached_hash = non_cached_adapter.serializable_hash
+
+          # Merge both results
+          @adapter.fragment_cache(cached_hash, non_cached_hash)
+        end
+
+        private
+
+        def cached_attributes(klass, serializers)
+          attributes            = serializer.class._attributes
+          cached_attributes     = (klass._cache_only) ? klass._cache_only : attributes.reject {|attr| klass._cache_except.include?(attr) }
+          non_cached_attributes = attributes - cached_attributes
+
+          cached_attributes.each do |attribute|
+            options = serializer.class._attributes_keys[attribute]
+            options ||= {}
+            # Add cached attributes to cached Serializer
+            serializers[:cached].constantize.attribute(attribute, options)
+          end
+
+          non_cached_attributes.each do |attribute|
+            options = serializer.class._attributes_keys[attribute]
+            options ||= {}
+            # Add non-cached attributes to non-cached Serializer
+            serializers[:non_cached].constantize.attribute(attribute, options)
+          end
+        end
+
+        def fragment_serializer(name, klass)
+          cached     = "#{name.capitalize}CachedSerializer"
+          non_cached = "#{name.capitalize}NonCachedSerializer"
+
+          Object.const_set cached, Class.new(ActiveModel::Serializer) unless Object.const_defined?(cached)
+          Object.const_set non_cached, Class.new(ActiveModel::Serializer) unless Object.const_defined?(non_cached)
+
+          klass._cache_options       ||= {}
+          klass._cache_options[:key] = klass._cache_key if klass._cache_key
+
+          cached.constantize.cache(klass._cache_options)
+
+          cached.constantize.fragmented(serializer)
+          non_cached.constantize.fragmented(serializer)
+
+          serializers = {cached: cached, non_cached: non_cached}
+          cached_attributes(klass, serializers)
+          serializers
+        end
+      end
+    end
+  end
+end

data/lib/active_model/serializer/adapter/json/fragment_cache.rb

@@ -0,0 +1,15 @@
+module ActiveModel
+  class Serializer
+    class Adapter
+      class Json < Adapter
+        class FragmentCache
+
+          def fragment_cache(cached_hash, non_cached_hash)
+            non_cached_hash.merge cached_hash
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/active_model/serializer/adapter/json.rb

@@ -0,0 +1,50 @@
+require 'active_model/serializer/adapter/json/fragment_cache'
+
+module ActiveModel
+  class Serializer
+    class Adapter
+      class Json < Adapter
+        def serializable_hash(options = {})
+          if serializer.respond_to?(:each)
+            @result = serializer.map{|s| FlattenJson.new(s).serializable_hash }
+          else
+            @hash = {}
+
+            @core = cache_check(serializer) do
+              serializer.attributes(options)
+            end
+
+            serializer.each_association do |name, association, opts|
+              if association.respond_to?(:each)
+                array_serializer = association
+                @hash[name] = array_serializer.map do |item|
+                  cache_check(item) do
+                    item.attributes(opts)
+                  end
+                end
+              else
+                if association && association.object
+                  @hash[name] = cache_check(association) do
+                    association.attributes(options)
+                  end
+                elsif opts[:virtual_value]
+                  @hash[name] = opts[:virtual_value]
+                else
+                  @hash[name] = nil
+                end
+              end
+            end
+            @result = @core.merge @hash
+          end
+
+          { root => @result }
+        end
+
+        def fragment_cache(cached_hash, non_cached_hash)
+          Json::FragmentCache.new().fragment_cache(cached_hash, non_cached_hash)
+        end
+
+      end
+    end
+  end
+end

data/lib/active_model/serializer/adapter/json_api/fragment_cache.rb

@@ -0,0 +1,23 @@
+module ActiveModel
+  class Serializer
+    class Adapter
+      class JsonApi < Adapter
+        class FragmentCache
+
+          def fragment_cache(root, cached_hash, non_cached_hash)
+            hash              = {}
+            core_cached       = cached_hash.first
+            core_non_cached   = non_cached_hash.first
+            no_root_cache     = cached_hash.delete_if {|key, value| key == core_cached[0] }
+            no_root_non_cache = non_cached_hash.delete_if {|key, value| key == core_non_cached[0] }
+            cached_resource   = (core_cached[1]) ? core_cached[1].deep_merge(core_non_cached[1]) : core_non_cached[1]
+            hash = (root) ? { root => cached_resource } : cached_resource
+
+            hash.deep_merge no_root_non_cache.deep_merge no_root_cache
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/active_model/serializer/adapter/json_api.rb

@@ -0,0 +1,156 @@
+require 'active_model/serializer/adapter/json_api/fragment_cache'
+
+module ActiveModel
+  class Serializer
+    class Adapter
+      class JsonApi < Adapter
+        def initialize(serializer, options = {})
+          super
+          @hash = { data: [] }
+
+          if fields = options.delete(:fields)
+            @fieldset = ActiveModel::Serializer::Fieldset.new(fields, serializer.json_key)
+          else
+            @fieldset = options[:fieldset]
+          end
+        end
+
+        def serializable_hash(options = {})
+          if serializer.respond_to?(:each)
+            serializer.each do |s|
+              result = self.class.new(s, @options.merge(fieldset: @fieldset)).serializable_hash
+              @hash[:data] << result[:data]
+
+              if result[:included]
+                @hash[:included] ||= []
+                @hash[:included] |= result[:included]
+              end
+            end
+          else
+            @hash[:data] = attributes_for_serializer(serializer, @options)
+            add_resource_relationships(@hash[:data], serializer)
+          end
+          @hash
+        end
+
+        def fragment_cache(cached_hash, non_cached_hash)
+          root = false if @options.include?(:include)
+          JsonApi::FragmentCache.new().fragment_cache(root, cached_hash, non_cached_hash)
+        end
+
+        private
+
+        def add_relationships(resource, name, serializers)
+          resource[:relationships] ||= {}
+          resource[:relationships][name] ||= { data: [] }
+          resource[:relationships][name][:data] += serializers.map { |serializer| { type: serializer.type, id: serializer.id.to_s } }
+        end
+
+        def add_relationship(resource, name, serializer, val=nil)
+          resource[:relationships] ||= {}
+          resource[:relationships][name] = { data: nil }
+
+          if serializer && serializer.object
+            resource[:relationships][name][:data] = { type: serializer.type, id: serializer.id.to_s }
+          end
+        end
+
+        def add_included(resource_name, serializers, parent = nil)
+          unless serializers.respond_to?(:each)
+            return unless serializers.object
+            serializers = Array(serializers)
+          end
+          resource_path = [parent, resource_name].compact.join('.')
+          if include_assoc?(resource_path)
+            @hash[:included] ||= []
+
+            serializers.each do |serializer|
+              attrs = attributes_for_serializer(serializer, @options)
+
+              add_resource_relationships(attrs, serializer, add_included: false)
+
+              @hash[:included].push(attrs) unless @hash[:included].include?(attrs)
+            end
+          end
+
+          serializers.each do |serializer|
+            serializer.each_association do |name, association, opts|
+              add_included(name, association, resource_path) if association
+            end if include_nested_assoc? resource_path
+          end
+        end
+
+        def attributes_for_serializer(serializer, options)
+          if serializer.respond_to?(:each)
+            result = []
+            serializer.each do |object|
+              result << resource_object_for(object, options)
+            end
+          else
+            result = resource_object_for(serializer, options)
+          end
+          result
+        end
+
+        def resource_object_for(serializer, options)
+          options[:fields] = @fieldset && @fieldset.fields_for(serializer)
+          options[:required_fields] = [:id, :type]
+
+          cache_check(serializer) do
+            attributes = serializer.attributes(options)
+
+            result = {
+              id: attributes.delete(:id).to_s,
+              type: attributes.delete(:type)
+            }
+
+            result[:attributes] = attributes if attributes.any?
+            result
+          end
+        end
+
+        def include_assoc?(assoc)
+          return false unless @options[:include]
+          check_assoc("#{assoc}$")
+        end
+
+        def include_nested_assoc?(assoc)
+          return false unless @options[:include]
+          check_assoc("#{assoc}.")
+        end
+
+        def check_assoc(assoc)
+          include_opt = @options[:include]
+          include_opt = include_opt.split(',') if include_opt.is_a?(String)
+          include_opt.any? do |s|
+            s.match(/^#{assoc.gsub('.', '\.')}/)
+          end
+        end
+
+        def add_resource_relationships(attrs, serializer, options = {})
+          options[:add_included] = options.fetch(:add_included, true)
+
+          serializer.each_association do |name, association, opts|
+            attrs[:relationships] ||= {}
+
+            if association.respond_to?(:each)
+              add_relationships(attrs, name, association)
+            else
+              if opts[:virtual_value]
+                add_relationship(attrs, name, nil, opts[:virtual_value])
+              else
+                add_relationship(attrs, name, association)
+              end
+            end
+
+            if options[:add_included]
+              Array(association).each do |association|
+                add_included(name, association)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_model/serializer/adapter/null.rb

@@ -0,0 +1,11 @@
+module ActiveModel
+  class Serializer
+    class Adapter
+      class Null < Adapter
+        def serializable_hash(options = {})
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/active_model/serializer/adapter.rb

@@ -0,0 +1,96 @@
+require 'active_model/serializer/adapter/fragment_cache'
+
+module ActiveModel
+  class Serializer
+    class Adapter
+      extend ActiveSupport::Autoload
+      autoload :Json
+      autoload :FlattenJson
+      autoload :Null
+      autoload :JsonApi
+
+      attr_reader :serializer
+
+      def initialize(serializer, options = {})
+        @serializer = serializer
+        @options = options
+      end
+
+      def serializable_hash(options = {})
+        raise NotImplementedError, 'This is an abstract method. Should be implemented at the concrete adapter.'
+      end
+
+      def as_json(options = {})
+        hash = serializable_hash(options)
+        include_meta(hash) unless self.class == FlattenJson
+        hash
+      end
+
+      def self.create(resource, options = {})
+        override = options.delete(:adapter)
+        klass = override ? adapter_class(override) : ActiveModel::Serializer.adapter
+        klass.new(resource, options)
+      end
+
+      def self.adapter_class(adapter)
+        "ActiveModel::Serializer::Adapter::#{adapter.to_s.classify}".safe_constantize
+      end
+
+      def fragment_cache(*args)
+        raise NotImplementedError, 'This is an abstract method. Should be implemented at the concrete adapter.'
+      end
+
+      private
+
+     def cache_check(serializer)
+        @cached_serializer = serializer
+        @klass             = @cached_serializer.class
+        if is_cached?
+          @klass._cache.fetch(cache_key, @klass._cache_options) do
+            yield
+          end
+        elsif is_fragment_cached?
+          FragmentCache.new(self, @cached_serializer, @options).fetch
+        else
+          yield
+        end
+      end
+
+      def is_cached?
+        @klass._cache && !@klass._cache_only && !@klass._cache_except
+      end
+
+      def is_fragment_cached?
+        @klass._cache_only && !@klass._cache_except || !@klass._cache_only && @klass._cache_except
+      end
+
+      def cache_key
+        parts = []
+        parts << object_cache_key
+        parts << @klass._cache_digest unless @klass._cache_options && @klass._cache_options[:skip_digest]
+        parts.join("/")
+      end
+
+      def object_cache_key
+        (@klass._cache_key) ? "#{@klass._cache_key}/#{@cached_serializer.object.id}-#{@cached_serializer.object.updated_at}" : @cached_serializer.object.cache_key
+      end
+
+      def meta
+        serializer.meta if serializer.respond_to?(:meta)
+      end
+
+      def meta_key
+        serializer.meta_key || "meta"
+      end
+
+      def root
+        serializer.json_key.to_sym if serializer.json_key
+      end
+
+      def include_meta(json)
+        json[meta_key] = meta if meta
+        json
+      end
+    end
+  end
+end

data/lib/active_model/serializer/array_serializer.rb

@@ -0,0 +1,35 @@
+module ActiveModel
+  class Serializer
+    class ArraySerializer
+      include Enumerable
+      delegate :each, to: :@objects
+
+      attr_reader :meta, :meta_key
+
+      def initialize(objects, options = {})
+        @resource = objects
+        @objects  = objects.map do |object|
+          serializer_class = options.fetch(
+            :serializer,
+            ActiveModel::Serializer.serializer_for(object)
+          )
+          serializer_class.new(object, options.except(:serializer))
+        end
+        @meta     = options[:meta]
+        @meta_key = options[:meta_key]
+      end
+
+      def json_key
+        if @objects.first
+          @objects.first.json_key.pluralize
+        else
+          @resource.name.downcase.pluralize if @resource.try(:name)
+        end
+      end
+
+      def root=(root)
+        @objects.first.root = root if @objects.first
+      end
+    end
+  end
+end

data/lib/active_model/serializer/configuration.rb

@@ -0,0 +1,13 @@
+module ActiveModel
+  class Serializer
+    module Configuration
+      include ActiveSupport::Configurable
+      extend ActiveSupport::Concern
+
+      included do |base|
+        base.config.array_serializer = ActiveModel::Serializer::ArraySerializer
+        base.config.adapter = :flatten_json
+      end
+    end
+  end
+end