active_model_serializers 0.10.0 → 0.10.11

data/lib/active_model_serializers/register_jsonapi_renderer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Based on discussion in https://github.com/rails/rails/pull/23712#issuecomment-184977238,
 # the JSON API media type will have its own format/renderer.
 #
@@ -22,43 +24,56 @@
 # render jsonapi: model
 #
 # No wrapper format needed as it does not apply (i.e. no `wrap_parameters format: [jsonapi]`)
+module ActiveModelSerializers
+  module Jsonapi
+    MEDIA_TYPE = 'application/vnd.api+json'.freeze
+    HEADERS = {
+      response: { 'CONTENT_TYPE'.freeze => MEDIA_TYPE },
+      request:  { 'ACCEPT'.freeze => MEDIA_TYPE }
+    }.freeze
 
-module ActiveModelSerializers::Jsonapi
-  MEDIA_TYPE = 'application/vnd.api+json'.freeze
-  HEADERS = {
-    response: { 'CONTENT_TYPE'.freeze => MEDIA_TYPE },
-    request:  { 'ACCEPT'.freeze => MEDIA_TYPE }
-  }.freeze
-  module ControllerSupport
-    def serialize_jsonapi(json, options)
-      options[:adapter] = :json_api
-      options.fetch(:serialization_context) { options[:serialization_context] = ActiveModelSerializers::SerializationContext.new(request) }
-      get_serializer(json, options)
-    end
-  end
-end
+    def self.install
+      # actionpack/lib/action_dispatch/http/mime_types.rb
+      Mime::Type.register MEDIA_TYPE, :jsonapi
+
+      if Rails::VERSION::MAJOR >= 5
+        ActionDispatch::Request.parameter_parsers[:jsonapi] = parser
+      else
+        ActionDispatch::ParamsParser::DEFAULT_PARSERS[Mime[:jsonapi]] = parser
+      end
 
-# actionpack/lib/action_dispatch/http/mime_types.rb
-Mime::Type.register ActiveModelSerializers::Jsonapi::MEDIA_TYPE, :jsonapi
+      # ref https://github.com/rails/rails/pull/21496
+      ActionController::Renderers.add :jsonapi do |json, options|
+        json = serialize_jsonapi(json, options).to_json(options) unless json.is_a?(String)
+        self.content_type ||= Mime[:jsonapi]
+        self.response_body = json
+      end
+    end
 
-parsers = Rails::VERSION::MAJOR >= 5 ? ActionDispatch::Http::Parameters : ActionDispatch::ParamsParser
-media_type = Mime::Type.lookup(ActiveModelSerializers::Jsonapi::MEDIA_TYPE)
+    # Proposal: should actually deserialize the JSON API params
+    # to the hash format expected by `ActiveModel::Serializers::JSON`
+    # actionpack/lib/action_dispatch/http/parameters.rb
+    def self.parser
+      lambda do |body|
+        data = JSON.parse(body)
+        data = { _json: data } unless data.is_a?(Hash)
+        data.with_indifferent_access
+      end
+    end
 
-# Proposal: should actually deserialize the JSON API params
-# to the hash format expected by `ActiveModel::Serializers::JSON`
-# actionpack/lib/action_dispatch/http/parameters.rb
-parsers::DEFAULT_PARSERS[media_type] = lambda do |body|
-  data = JSON.parse(body)
-  data = { :_json => data } unless data.is_a?(Hash)
-  data.with_indifferent_access
+    module ControllerSupport
+      def serialize_jsonapi(json, options)
+        options[:adapter] = :json_api
+        options.fetch(:serialization_context) do
+          options[:serialization_context] = ActiveModelSerializers::SerializationContext.new(request)
+        end
+        get_serializer(json, options)
+      end
+    end
+  end
 end
 
-# ref https://github.com/rails/rails/pull/21496
-ActionController::Renderers.add :jsonapi do |json, options|
-  json = serialize_jsonapi(json, options).to_json(options) unless json.is_a?(String)
-  self.content_type ||= media_type
-  self.response_body = json
-end
+ActiveModelSerializers::Jsonapi.install
 
 ActiveSupport.on_load(:action_controller) do
   include ActiveModelSerializers::Jsonapi::ControllerSupport

data/lib/active_model_serializers/serializable_resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module ActiveModelSerializers
@@ -14,8 +16,8 @@ module ActiveModelSerializers
     # @return the serializable_resource, ready for #as_json/#to_json/#serializable_hash.
     def initialize(resource, options = {})
       @resource = resource
-      @adapter_opts, @serializer_opts =
-        options.partition { |k, _| ADAPTER_OPTION_KEYS.include? k }.map { |h| Hash[h] }
+      @adapter_opts = options.select { |k, _| ADAPTER_OPTION_KEYS.include? k }
+      @serializer_opts = options.reject { |k, _| ADAPTER_OPTION_KEYS.include? k }
     end
 
     def serialization_scope=(scope)
@@ -38,9 +40,10 @@ module ActiveModelSerializers
 
     def find_adapter
       return resource unless serializer?
-      ActiveModelSerializers::Adapter.create(serializer_instance, adapter_opts)
-    rescue ActiveModel::Serializer::CollectionSerializer::NoSerializerError
-      resource
+      adapter = catch :no_serializer do
+        ActiveModelSerializers::Adapter.create(serializer_instance, adapter_opts)
+      end
+      adapter || resource
     end
 
     def serializer_instance
@@ -49,12 +52,12 @@ module ActiveModelSerializers
 
     # Get serializer either explicitly :serializer or implicitly from resource
     # Remove :serializer key from serializer_opts
-    # Replace :serializer key with :each_serializer if present
+    # Remove :each_serializer if present and set as :serializer key
     def serializer
       @serializer ||=
         begin
           @serializer = serializer_opts.delete(:serializer)
-          @serializer ||= ActiveModel::Serializer.serializer_for(resource)
+          @serializer ||= ActiveModel::Serializer.serializer_for(resource, serializer_opts)
 
           if serializer_opts.key?(:each_serializer)
             serializer_opts[:serializer] = serializer_opts.delete(:each_serializer)

data/lib/active_model_serializers/serialization_context.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/array/extract_options'
 module ActiveModelSerializers
   class SerializationContext
     class << self
@@ -22,9 +25,15 @@ module ActiveModelSerializers
 
     attr_reader :request_url, :query_parameters, :key_transform
 
-    def initialize(request, options = {})
-      @request_url = request.original_url[/\A[^?]+/]
-      @query_parameters = request.query_parameters
+    def initialize(*args)
+      options = args.extract_options!
+      if args.size == 1
+        request = args.pop
+        options[:request_url] = request.original_url[/\A[^?]+/]
+        options[:query_parameters] = request.query_parameters
+      end
+      @request_url = options.delete(:request_url)
+      @query_parameters = options.delete(:query_parameters)
       @url_helpers = options.delete(:url_helpers) || self.class.url_helpers
       @default_url_options = options.delete(:default_url_options) || self.class.default_url_options
     end

data/lib/active_model_serializers/test/schema.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModelSerializers
   module Test
     module Schema
@@ -60,11 +62,11 @@ module ActiveModelSerializers
         attr_reader :document_store
 
         def controller_path
-          request.filtered_parameters[:controller]
+          request.filtered_parameters.with_indifferent_access[:controller]
         end
 
         def action
-          request.filtered_parameters[:action]
+          request.filtered_parameters.with_indifferent_access[:action]
         end
 
         def schema_directory

data/lib/active_model_serializers/test/serializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 module ActiveModelSerializers
   module Test

data/lib/active_model_serializers/test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveModelSerializers
   module Test
     extend ActiveSupport::Autoload

data/lib/active_model_serializers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_model'
 require 'active_support'
 require 'active_support/core_ext/object/with_options'
@@ -5,15 +7,19 @@ require 'active_support/core_ext/string/inflections'
 require 'active_support/json'
 module ActiveModelSerializers
   extend ActiveSupport::Autoload
-  autoload :Model
-  autoload :Callbacks
-  autoload :Deserialization
-  autoload :SerializableResource
-  autoload :Logging
-  autoload :Test
-  autoload :Adapter
-  autoload :JsonPointer
-  autoload :Deprecate
+  eager_autoload do
+    autoload :Model
+    autoload :Callbacks
+    autoload :SerializableResource
+    autoload :SerializationContext
+    autoload :Logging
+    autoload :Test
+    autoload :Adapter
+    autoload :JsonPointer
+    autoload :Deprecate
+    autoload :LookupChain
+    autoload :Deserialization
+  end
 
   class << self; attr_accessor :logger; end
   self.logger = ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT))
@@ -31,8 +37,27 @@ module ActiveModelSerializers
     [file, lineno]
   end
 
+  # Memoized default include directive
+  # @return [JSONAPI::IncludeDirective]
+  def self.default_include_directive
+    @default_include_directive ||= JSONAPI::IncludeDirective.new(config.default_includes, allow_wildcard: true)
+  end
+
+  def self.silence_warnings
+    original_verbose = $VERBOSE
+    $VERBOSE = nil
+    yield
+  ensure
+    $VERBOSE = original_verbose
+  end
+
+  def self.eager_load!
+    super
+    ActiveModel::Serializer.eager_load!
+  end
+
   require 'active_model/serializer/version'
   require 'active_model/serializer'
   require 'active_model/serializable_resource'
-  require 'active_model_serializers/railtie' if defined?(::Rails)
+  require 'active_model_serializers/railtie' if defined?(::Rails::Railtie)
 end

data/lib/generators/rails/resource_override.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'rails/generators'
 require 'rails/generators/rails/resource/resource_generator'
 
 module Rails
   module Generators
     class ResourceGenerator
-      hook_for :serializer, default: true, boolean: true
+      hook_for :serializer, default: true, type: :boolean
     end
   end
 end

data/lib/generators/rails/serializer_generator.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module Rails
   module Generators
     class SerializerGenerator < NamedBase
       source_root File.expand_path('../templates', __FILE__)
-      check_class_collision :suffix => 'Serializer'
+      check_class_collision suffix: 'Serializer'
 
-      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 serializer'
+      class_option :parent, type: :string, desc: 'The parent class for the generated serializer'
 
       def create_serializer_file
         template 'serializer.rb.erb', File.join('app/serializers', class_path, "#{file_name}_serializer.rb")
@@ -25,7 +27,7 @@ module Rails
       def parent_class_name
         if options[:parent]
           options[:parent]
-        elsif defined?(::ApplicationSerializer)
+        elsif 'ApplicationSerializer'.safe_constantize
           'ApplicationSerializer'
         else
           'ActiveModel::Serializer'

data/lib/grape/active_model_serializers.rb

@@ -1,14 +1,18 @@
+# frozen_string_literal: true
+
 # To add Grape support, require 'grape/active_model_serializers' in the base of your Grape endpoints
 # Then add 'include Grape::ActiveModelSerializers' to enable the formatter and helpers
 require 'active_model_serializers'
 require 'grape/formatters/active_model_serializers'
 require 'grape/helpers/active_model_serializers'
 
-module Grape::ActiveModelSerializers
-  extend ActiveSupport::Concern
+module Grape
+  module ActiveModelSerializers
+    extend ActiveSupport::Concern
 
-  included do
-    formatter :json, Grape::Formatters::ActiveModelSerializers
-    helpers Grape::Helpers::ActiveModelSerializers
+    included do
+      formatter :json, Grape::Formatters::ActiveModelSerializers
+      helpers Grape::Helpers::ActiveModelSerializers
+    end
   end
 end

data/lib/grape/formatters/active_model_serializers.rb

@@ -1,15 +1,34 @@
+# frozen_string_literal: true
+
 # A Grape response formatter that can be used as 'formatter :json, Grape::Formatters::ActiveModelSerializers'
 #
 # Serializer options can be passed as a hash from your Grape endpoint using env[:active_model_serializer_options],
 # or better yet user the render helper in Grape::Helpers::ActiveModelSerializers
+
+require 'active_model_serializers/serialization_context'
+
 module Grape
   module Formatters
     module ActiveModelSerializers
       def self.call(resource, env)
-        serializer_options = {}
-        serializer_options.merge!(env[:active_model_serializer_options]) if env[:active_model_serializer_options]
+        serializer_options = build_serializer_options(env)
         ::ActiveModelSerializers::SerializableResource.new(resource, serializer_options).to_json
       end
+
+      def self.build_serializer_options(env)
+        ams_options = env[:active_model_serializer_options] || {}
+
+        # Add serialization context
+        ams_options.fetch(:serialization_context) do
+          request = env['grape.request']
+          ams_options[:serialization_context] = ::ActiveModelSerializers::SerializationContext.new(
+            request_url: request.url[/\A[^?]+/],
+            query_parameters: request.params
+          )
+        end
+
+        ams_options
+      end
     end
   end
 end

data/lib/grape/helpers/active_model_serializers.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 # Helpers can be included in your Grape endpoint as: helpers Grape::Helpers::ActiveModelSerializers
+
 module Grape
   module Helpers
     module ActiveModelSerializers

data/lib/tasks/rubocop.rake

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+begin
+  require 'rubocop'
+  require 'rubocop/rake_task'
+rescue LoadError # rubocop:disable Lint/HandleExceptions
+else
+  require 'rbconfig'
+  # https://github.com/bundler/bundler/blob/1b3eb2465a/lib/bundler/constants.rb#L2
+  windows_platforms = /(msdos|mswin|djgpp|mingw)/
+  if RbConfig::CONFIG['host_os'] =~ windows_platforms
+    desc 'No-op rubocop on Windows-- unsupported platform'
+    task :rubocop do
+      puts 'Skipping rubocop on Windows'
+    end
+  elsif defined?(::Rubinius)
+    desc 'No-op rubocop to avoid rbx segfault'
+    task :rubocop do
+      puts 'Skipping rubocop on rbx due to segfault'
+      puts 'https://github.com/rubinius/rubinius/issues/3499'
+    end
+  else
+    Rake::Task[:rubocop].clear if Rake::Task.task_defined?(:rubocop)
+    patterns = [
+      'Gemfile',
+      'Rakefile',
+      'lib/**/*.{rb,rake}',
+      'config/**/*.rb',
+      'app/**/*.rb',
+      'test/**/*.rb'
+    ]
+    desc 'Execute rubocop'
+    RuboCop::RakeTask.new(:rubocop) do |task|
+      task.options = ['--rails', '--display-cop-names', '--display-style-guide']
+      task.formatters = ['progress']
+      task.patterns = patterns
+      task.fail_on_error = true
+    end
+
+    namespace :rubocop do
+      desc 'Auto-gen rubocop config'
+      task :auto_gen_config do
+        options = ['--auto-gen-config'].concat patterns
+        require 'benchmark'
+        result = 0
+        cli = RuboCop::CLI.new
+        time = Benchmark.realtime do
+          result = cli.run(options)
+        end
+        puts "Finished in #{time} seconds" if cli.options[:debug]
+        abort('RuboCop failed!') if result.nonzero?
+      end
+    end
+  end
+end