active_model_serializers 0.9.0 → 0.10.12

data/lib/grape/active_model_serializers.rb

@@ -0,0 +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
+  module ActiveModelSerializers
+    extend ActiveSupport::Concern
+
+    included do
+      formatter :json, Grape::Formatters::ActiveModelSerializers
+      helpers Grape::Helpers::ActiveModelSerializers
+    end
+  end
+end

data/lib/grape/formatters/active_model_serializers.rb

@@ -0,0 +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 = 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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Helpers can be included in your Grape endpoint as: helpers Grape::Helpers::ActiveModelSerializers
+
+module Grape
+  module Helpers
+    module ActiveModelSerializers
+      # A convenience method for passing ActiveModelSerializers serializer options
+      #
+      # Example: To include relationships in the response: render(post, include: ['comments'])
+      #
+      # Example: To include pagination meta data: render(posts, meta: { page: posts.page, total_pages: posts.total_pages })
+      def render(resource, active_model_serializer_options = {})
+        env[:active_model_serializer_options] = active_model_serializer_options
+        resource
+      end
+    end
+  end
+end

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

metadata

@@ -1,16 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_model_serializers
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.12
 platform: ruby
 authors:
-- José Valim
-- Yehuda Katz
-- Santiago Pastorino
-autorequire: 
+- Steve Klabnik
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-08-22 00:00:00.000000000 Z
+date: 2020-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -18,95 +16,345 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: jsonapi-renderer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1.beta1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 0.1.1.beta1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: case_transform
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
-description: Making it easy to serialize models for client-side use
+        version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.3
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: json_schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: ActiveModel::Serializers allows you to generate your JSON in an object-oriented
+  and convention-driven manner.
 email:
-- jose.valim@gmail.com
-- wycats@gmail.com
-- santiago@wyeworks.com
+- steve@steveklabnik.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- CONTRIBUTING.md
-- DESIGN.textile
 - MIT-LICENSE
 - README.md
 - lib/action_controller/serialization.rb
-- lib/action_controller/serialization_test_case.rb
-- lib/active_model/array_serializer.rb
-- lib/active_model/default_serializer.rb
-- lib/active_model/serializable.rb
+- lib/active_model/serializable_resource.rb
 - lib/active_model/serializer.rb
-- lib/active_model/serializer/associations.rb
-- lib/active_model/serializer/config.rb
-- lib/active_model/serializer/generators/resource_override.rb
-- lib/active_model/serializer/generators/serializer/USAGE
-- lib/active_model/serializer/generators/serializer/scaffold_controller_generator.rb
-- lib/active_model/serializer/generators/serializer/serializer_generator.rb
-- lib/active_model/serializer/generators/serializer/templates/controller.rb
-- lib/active_model/serializer/generators/serializer/templates/serializer.rb
-- lib/active_model/serializer/railtie.rb
+- lib/active_model/serializer/adapter.rb
+- lib/active_model/serializer/adapter/attributes.rb
+- lib/active_model/serializer/adapter/base.rb
+- lib/active_model/serializer/adapter/json.rb
+- lib/active_model/serializer/adapter/json_api.rb
+- lib/active_model/serializer/adapter/null.rb
+- lib/active_model/serializer/array_serializer.rb
+- lib/active_model/serializer/association.rb
+- lib/active_model/serializer/attribute.rb
+- lib/active_model/serializer/belongs_to_reflection.rb
+- lib/active_model/serializer/collection_serializer.rb
+- lib/active_model/serializer/concerns/caching.rb
+- lib/active_model/serializer/error_serializer.rb
+- lib/active_model/serializer/errors_serializer.rb
+- lib/active_model/serializer/field.rb
+- lib/active_model/serializer/fieldset.rb
+- lib/active_model/serializer/has_many_reflection.rb
+- lib/active_model/serializer/has_one_reflection.rb
+- lib/active_model/serializer/lazy_association.rb
+- lib/active_model/serializer/link.rb
+- lib/active_model/serializer/lint.rb
+- lib/active_model/serializer/null.rb
+- lib/active_model/serializer/reflection.rb
 - lib/active_model/serializer/version.rb
-- lib/active_model/serializer_support.rb
 - lib/active_model_serializers.rb
-- test/fixtures/active_record.rb
-- test/fixtures/poro.rb
-- test/integration/action_controller/serialization_test.rb
-- test/integration/action_controller/serialization_test_case_test.rb
-- test/integration/active_record/active_record_test.rb
-- test/integration/generators/resource_generator_test.rb
-- test/integration/generators/scaffold_controller_generator_test.rb
-- test/integration/generators/serializer_generator_test.rb
-- test/test_app.rb
-- test/test_helper.rb
-- test/unit/active_model/array_serializer/except_test.rb
-- test/unit/active_model/array_serializer/key_format_test.rb
-- test/unit/active_model/array_serializer/meta_test.rb
-- test/unit/active_model/array_serializer/only_test.rb
-- test/unit/active_model/array_serializer/root_test.rb
-- test/unit/active_model/array_serializer/scope_test.rb
-- test/unit/active_model/array_serializer/serialization_test.rb
-- test/unit/active_model/default_serializer_test.rb
-- test/unit/active_model/serializer/associations/build_serializer_test.rb
-- test/unit/active_model/serializer/associations_test.rb
-- test/unit/active_model/serializer/attributes_test.rb
-- test/unit/active_model/serializer/config_test.rb
-- test/unit/active_model/serializer/filter_test.rb
-- test/unit/active_model/serializer/has_many_test.rb
-- test/unit/active_model/serializer/has_one_test.rb
-- test/unit/active_model/serializer/key_format_test.rb
-- test/unit/active_model/serializer/meta_test.rb
-- test/unit/active_model/serializer/options_test.rb
-- test/unit/active_model/serializer/root_test.rb
-- test/unit/active_model/serializer/scope_test.rb
+- lib/active_model_serializers/adapter.rb
+- lib/active_model_serializers/adapter/attributes.rb
+- lib/active_model_serializers/adapter/base.rb
+- lib/active_model_serializers/adapter/json.rb
+- lib/active_model_serializers/adapter/json_api.rb
+- lib/active_model_serializers/adapter/json_api/deserialization.rb
+- lib/active_model_serializers/adapter/json_api/error.rb
+- lib/active_model_serializers/adapter/json_api/jsonapi.rb
+- lib/active_model_serializers/adapter/json_api/link.rb
+- lib/active_model_serializers/adapter/json_api/meta.rb
+- lib/active_model_serializers/adapter/json_api/pagination_links.rb
+- lib/active_model_serializers/adapter/json_api/relationship.rb
+- lib/active_model_serializers/adapter/json_api/resource_identifier.rb
+- lib/active_model_serializers/adapter/null.rb
+- lib/active_model_serializers/callbacks.rb
+- lib/active_model_serializers/deprecate.rb
+- lib/active_model_serializers/deserialization.rb
+- lib/active_model_serializers/json_pointer.rb
+- lib/active_model_serializers/logging.rb
+- lib/active_model_serializers/lookup_chain.rb
+- lib/active_model_serializers/model.rb
+- lib/active_model_serializers/model/caching.rb
+- lib/active_model_serializers/railtie.rb
+- lib/active_model_serializers/register_jsonapi_renderer.rb
+- lib/active_model_serializers/serializable_resource.rb
+- lib/active_model_serializers/serialization_context.rb
+- lib/active_model_serializers/test.rb
+- lib/active_model_serializers/test/schema.rb
+- lib/active_model_serializers/test/serializer.rb
+- lib/generators/rails/USAGE
+- lib/generators/rails/resource_override.rb
+- lib/generators/rails/serializer_generator.rb
+- lib/generators/rails/templates/serializer.rb.erb
+- lib/grape/active_model_serializers.rb
+- lib/grape/formatters/active_model_serializers.rb
+- lib/grape/helpers/active_model_serializers.rb
+- lib/tasks/rubocop.rake
 homepage: https://github.com/rails-api/active_model_serializers
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -114,47 +362,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
-summary: Bringing consistency and object orientation to model serialization. Works
-  great for client-side MVC frameworks!
-test_files:
-- test/test_helper.rb
-- test/unit/active_model/serializer/config_test.rb
-- test/unit/active_model/serializer/associations/build_serializer_test.rb
-- test/unit/active_model/serializer/meta_test.rb
-- test/unit/active_model/serializer/root_test.rb
-- test/unit/active_model/serializer/filter_test.rb
-- test/unit/active_model/serializer/attributes_test.rb
-- test/unit/active_model/serializer/has_many_test.rb
-- test/unit/active_model/serializer/has_one_test.rb
-- test/unit/active_model/serializer/scope_test.rb
-- test/unit/active_model/serializer/associations_test.rb
-- test/unit/active_model/serializer/options_test.rb
-- test/unit/active_model/serializer/key_format_test.rb
-- test/unit/active_model/array_serializer/meta_test.rb
-- test/unit/active_model/array_serializer/root_test.rb
-- test/unit/active_model/array_serializer/except_test.rb
-- test/unit/active_model/array_serializer/scope_test.rb
-- test/unit/active_model/array_serializer/serialization_test.rb
-- test/unit/active_model/array_serializer/only_test.rb
-- test/unit/active_model/array_serializer/key_format_test.rb
-- test/unit/active_model/default_serializer_test.rb
-- test/integration/active_record/active_record_test.rb
-- test/integration/action_controller/serialization_test_case_test.rb
-- test/integration/action_controller/serialization_test.rb
-- test/integration/generators/resource_generator_test.rb
-- test/integration/generators/scaffold_controller_generator_test.rb
-- test/integration/generators/serializer_generator_test.rb
-- test/fixtures/poro.rb
-- test/fixtures/active_record.rb
-- test/test_app.rb
+summary: Conventions-based JSON generation for Rails.
+test_files: []