active_model_serializers 0.10.0.rc4 → 0.10.0.rc5

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_model_serializers
 version: !ruby/object:Gem::Version
-  version: 0.10.0.rc4
+  version: 0.10.0.rc5
 platform: ruby
 authors:
 - Steve Klabnik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-27 00:00:00.000000000 Z
+date: 2016-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -115,33 +115,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
-  name: minitest-reporters
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: grape
   requirement: !ruby/object:Gem::Requirement
@@ -176,6 +176,26 @@ dependencies:
     - - ">="
       - !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: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '12.0'
 description: ActiveModel::Serializers allows you to generate your JSON in an object-oriented
   and convention-driven manner.
 email:
@@ -184,6 +204,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -192,19 +214,24 @@ files:
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
-- LICENSE.txt
+- MIT-LICENSE
 - README.md
 - Rakefile
 - active_model_serializers.gemspec
 - appveyor.yml
+- bin/bench
+- bin/bench_regression
+- bin/serve_benchmark
 - docs/ARCHITECTURE.md
-- docs/DESIGN.textile
 - docs/README.md
+- docs/STYLE.md
 - docs/general/adapters.md
 - docs/general/caching.md
 - docs/general/configuration_options.md
+- docs/general/deserialization.md
 - docs/general/getting_started.md
 - docs/general/instrumentation.md
+- docs/general/key_transforms.md
 - docs/general/logging.md
 - docs/general/rendering.md
 - docs/general/serializers.md
@@ -212,26 +239,23 @@ files:
 - docs/howto/add_pagination_links.md
 - docs/howto/add_root_key.md
 - docs/howto/outside_controller_use.md
+- docs/howto/passing_arbitrary_options.md
 - docs/howto/test.md
 - docs/integrations/ember-and-json-api.md
 - docs/integrations/grape.md
+- docs/jsonapi/errors.md
 - docs/jsonapi/schema.md
 - docs/jsonapi/schema/schema.json
+- docs/rfcs/0000-namespace.md
+- docs/rfcs/template.md
 - lib/action_controller/serialization.rb
 - lib/active_model/serializable_resource.rb
 - lib/active_model/serializer.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/cached_serializer.rb
-- lib/active_model/serializer/adapter/fragment_cache.rb
 - lib/active_model/serializer/adapter/json.rb
-- lib/active_model/serializer/adapter/json/fragment_cache.rb
 - lib/active_model/serializer/adapter/json_api.rb
-- lib/active_model/serializer/adapter/json_api/deserialization.rb
-- lib/active_model/serializer/adapter/json_api/fragment_cache.rb
-- lib/active_model/serializer/adapter/json_api/link.rb
-- lib/active_model/serializer/adapter/json_api/pagination_links.rb
 - lib/active_model/serializer/adapter/null.rb
 - lib/active_model/serializer/array_serializer.rb
 - lib/active_model/serializer/association.rb
@@ -243,6 +267,8 @@ files:
 - lib/active_model/serializer/collection_reflection.rb
 - lib/active_model/serializer/collection_serializer.rb
 - lib/active_model/serializer/configuration.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
@@ -250,16 +276,39 @@ files:
 - lib/active_model/serializer/include_tree.rb
 - lib/active_model/serializer/links.rb
 - lib/active_model/serializer/lint.rb
+- lib/active_model/serializer/meta.rb
+- lib/active_model/serializer/null.rb
 - lib/active_model/serializer/reflection.rb
 - lib/active_model/serializer/singular_reflection.rb
 - lib/active_model/serializer/type.rb
 - lib/active_model/serializer/version.rb
 - lib/active_model_serializers.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/cached_serializer.rb
 - lib/active_model_serializers/callbacks.rb
+- lib/active_model_serializers/deprecate.rb
 - lib/active_model_serializers/deserialization.rb
+- lib/active_model_serializers/fragment_cache.rb
+- lib/active_model_serializers/json_pointer.rb
+- lib/active_model_serializers/key_transform.rb
 - lib/active_model_serializers/logging.rb
 - lib/active_model_serializers/model.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
@@ -275,23 +324,32 @@ files:
 - test/action_controller/explicit_serializer_test.rb
 - test/action_controller/json/include_test.rb
 - test/action_controller/json_api/deserialization_test.rb
+- test/action_controller/json_api/errors_test.rb
 - test/action_controller/json_api/linked_test.rb
 - test/action_controller/json_api/pagination_test.rb
+- test/action_controller/json_api/transform_test.rb
 - test/action_controller/serialization_scope_name_test.rb
 - test/action_controller/serialization_test.rb
+- test/active_model_serializers/adapter_for_test.rb
+- test/active_model_serializers/cached_serializer_test.rb
+- test/active_model_serializers/fragment_cache_test.rb
+- test/active_model_serializers/json_pointer_test.rb
+- test/active_model_serializers/key_transform_test.rb
 - test/active_model_serializers/logging_test.rb
 - test/active_model_serializers/model_test.rb
 - test/active_model_serializers/railtie_test_isolated.rb
-- test/active_model_serializers/serialization_context_test.rb
+- test/active_model_serializers/serialization_context_test_isolated.rb
 - test/active_model_serializers/test/schema_test.rb
 - test/active_model_serializers/test/serializer_test.rb
 - test/active_record_test.rb
-- test/adapter/fragment_cache_test.rb
+- test/adapter/deprecation_test.rb
 - test/adapter/json/belongs_to_test.rb
 - test/adapter/json/collection_test.rb
 - test/adapter/json/has_many_test.rb
+- test/adapter/json/transform_test.rb
 - test/adapter/json_api/belongs_to_test.rb
 - test/adapter/json_api/collection_test.rb
+- test/adapter/json_api/errors_test.rb
 - test/adapter/json_api/fields_test.rb
 - test/adapter/json_api/has_many_embed_ids_test.rb
 - test/adapter/json_api/has_many_explicit_serializer_test.rb
@@ -302,12 +360,26 @@ files:
 - test/adapter/json_api/links_test.rb
 - test/adapter/json_api/pagination_links_test.rb
 - test/adapter/json_api/parse_test.rb
-- test/adapter/json_api/resource_type_config_test.rb
+- test/adapter/json_api/relationship_test.rb
+- test/adapter/json_api/relationships_test.rb
+- test/adapter/json_api/resource_identifier_test.rb
+- test/adapter/json_api/resource_meta_test.rb
 - test/adapter/json_api/toplevel_jsonapi_test.rb
+- test/adapter/json_api/transform_test.rb
+- test/adapter/json_api/type_test.rb
 - test/adapter/json_test.rb
 - test/adapter/null_test.rb
+- test/adapter/polymorphic_test.rb
 - test/adapter_test.rb
 - test/array_serializer_test.rb
+- test/benchmark/app.rb
+- test/benchmark/benchmarking_support.rb
+- test/benchmark/bm_caching.rb
+- test/benchmark/bm_transform.rb
+- test/benchmark/config.ru
+- test/benchmark/controllers.rb
+- test/benchmark/fixtures.rb
+- test/cache_test.rb
 - test/collection_serializer_test.rb
 - test/fixtures/active_record.rb
 - test/fixtures/poro.rb
@@ -321,17 +393,18 @@ files:
 - test/logger_test.rb
 - test/poro_test.rb
 - test/serializable_resource_test.rb
-- test/serializers/adapter_for_test.rb
 - test/serializers/association_macros_test.rb
 - test/serializers/associations_test.rb
 - test/serializers/attribute_test.rb
 - test/serializers/attributes_test.rb
-- test/serializers/cache_test.rb
+- test/serializers/caching_configuration_test_isolated.rb
 - test/serializers/configuration_test.rb
 - test/serializers/fieldset_test.rb
 - test/serializers/meta_test.rb
 - test/serializers/options_test.rb
+- test/serializers/read_attribute_for_serialization_test.rb
 - test/serializers/root_test.rb
+- test/serializers/serialization_test.rb
 - test/serializers/serializer_for_test.rb
 - test/support/custom_schemas/active_model_serializers/test/schema_test/my/index.json
 - test/support/isolated_unit.rb
@@ -344,15 +417,15 @@ files:
 - test/support/schemas/render_using_json_api.json
 - test/support/schemas/simple_json_pointers.json
 - test/support/serialization_testing.rb
-- test/support/simplecov.rb
-- test/support/stream_capture.rb
-- test/support/test_case.rb
 - test/test_helper.rb
 homepage: https://github.com/rails-api/active_model_serializers
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |
+  NOTE: The default key case for the JsonApi adapter has changed to dashed.
+  See https://github.com/rails-api/active_model_serializers/blob/master/docs/general/key_transform.md
+  for more information on configuring this behavior.
 rdoc_options: []
 require_paths:
 - lib
@@ -368,7 +441,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Conventions-based JSON generation for Rails.
@@ -377,23 +450,32 @@ test_files:
 - test/action_controller/explicit_serializer_test.rb
 - test/action_controller/json/include_test.rb
 - test/action_controller/json_api/deserialization_test.rb
+- test/action_controller/json_api/errors_test.rb
 - test/action_controller/json_api/linked_test.rb
 - test/action_controller/json_api/pagination_test.rb
+- test/action_controller/json_api/transform_test.rb
 - test/action_controller/serialization_scope_name_test.rb
 - test/action_controller/serialization_test.rb
+- test/active_model_serializers/adapter_for_test.rb
+- test/active_model_serializers/cached_serializer_test.rb
+- test/active_model_serializers/fragment_cache_test.rb
+- test/active_model_serializers/json_pointer_test.rb
+- test/active_model_serializers/key_transform_test.rb
 - test/active_model_serializers/logging_test.rb
 - test/active_model_serializers/model_test.rb
 - test/active_model_serializers/railtie_test_isolated.rb
-- test/active_model_serializers/serialization_context_test.rb
+- test/active_model_serializers/serialization_context_test_isolated.rb
 - test/active_model_serializers/test/schema_test.rb
 - test/active_model_serializers/test/serializer_test.rb
 - test/active_record_test.rb
-- test/adapter/fragment_cache_test.rb
+- test/adapter/deprecation_test.rb
 - test/adapter/json/belongs_to_test.rb
 - test/adapter/json/collection_test.rb
 - test/adapter/json/has_many_test.rb
+- test/adapter/json/transform_test.rb
 - test/adapter/json_api/belongs_to_test.rb
 - test/adapter/json_api/collection_test.rb
+- test/adapter/json_api/errors_test.rb
 - test/adapter/json_api/fields_test.rb
 - test/adapter/json_api/has_many_embed_ids_test.rb
 - test/adapter/json_api/has_many_explicit_serializer_test.rb
@@ -404,12 +486,26 @@ test_files:
 - test/adapter/json_api/links_test.rb
 - test/adapter/json_api/pagination_links_test.rb
 - test/adapter/json_api/parse_test.rb
-- test/adapter/json_api/resource_type_config_test.rb
+- test/adapter/json_api/relationship_test.rb
+- test/adapter/json_api/relationships_test.rb
+- test/adapter/json_api/resource_identifier_test.rb
+- test/adapter/json_api/resource_meta_test.rb
 - test/adapter/json_api/toplevel_jsonapi_test.rb
+- test/adapter/json_api/transform_test.rb
+- test/adapter/json_api/type_test.rb
 - test/adapter/json_test.rb
 - test/adapter/null_test.rb
+- test/adapter/polymorphic_test.rb
 - test/adapter_test.rb
 - test/array_serializer_test.rb
+- test/benchmark/app.rb
+- test/benchmark/benchmarking_support.rb
+- test/benchmark/bm_caching.rb
+- test/benchmark/bm_transform.rb
+- test/benchmark/config.ru
+- test/benchmark/controllers.rb
+- test/benchmark/fixtures.rb
+- test/cache_test.rb
 - test/collection_serializer_test.rb
 - test/fixtures/active_record.rb
 - test/fixtures/poro.rb
@@ -423,17 +519,18 @@ test_files:
 - test/logger_test.rb
 - test/poro_test.rb
 - test/serializable_resource_test.rb
-- test/serializers/adapter_for_test.rb
 - test/serializers/association_macros_test.rb
 - test/serializers/associations_test.rb
 - test/serializers/attribute_test.rb
 - test/serializers/attributes_test.rb
-- test/serializers/cache_test.rb
+- test/serializers/caching_configuration_test_isolated.rb
 - test/serializers/configuration_test.rb
 - test/serializers/fieldset_test.rb
 - test/serializers/meta_test.rb
 - test/serializers/options_test.rb
+- test/serializers/read_attribute_for_serialization_test.rb
 - test/serializers/root_test.rb
+- test/serializers/serialization_test.rb
 - test/serializers/serializer_for_test.rb
 - test/support/custom_schemas/active_model_serializers/test/schema_test/my/index.json
 - test/support/isolated_unit.rb
@@ -446,7 +543,5 @@ test_files:
 - test/support/schemas/render_using_json_api.json
 - test/support/schemas/simple_json_pointers.json
 - test/support/serialization_testing.rb
-- test/support/simplecov.rb
-- test/support/stream_capture.rb
-- test/support/test_case.rb
 - test/test_helper.rb
+has_rdoc: 

data/docs/DESIGN.textile

@@ -1 +0,0 @@
-<strong>This was the original design document for serializers.</strong> It is useful mostly for historical purposes as the public API has changed.
  def initialize(post, scope)
    @post, @scope = post, scope
  end
  def as_json
    { post: { title: @post.name, body: @post.body } }
  end
  def show
    @post = Post.find(params[:id])
    render json: @post
  end
  def initialize(post, scope)
    @post, @scope = post, scope
  end
  def serializable_hash
    { title: @post.name, body: @post.body }
  end
  def as_json
    { post: serializable_hash }
  end
  def initialize(post, scope)
    @post, @scope = post, scope
  end
  def as_json
    { post: serializable_hash }
  end
  def serializable_hash
    hash = post
    hash.merge!(super_data) if super?
    hash
  end
  def post
    { title: @post.name, body: @post.body }
  end
  def super_data
    { email: @post.email }
  end
  def super?
    @scope.superuser?
  end
  # For now, we use a very simple authorization structure. These tests will need
  # refactoring if we change that.
  plebe = OpenStruct.new(super?: false)
  god   = OpenStruct.new(super?: true)
  post  = OpenStruct.new(title: "Welcome to my blog!", body: "Blah blah blah", email: "tenderlove@gmail.com")
  test "a regular user sees just the title and body" do
    json = PostSerializer.new(post, plebe).to_json
    hash = JSON.parse(json)
    assert_equal post.title, hash.delete("title")
    assert_equal post.body, hash.delete("body")
    assert_empty hash
  end
  test "a superuser sees the title, body and email" do
    json = PostSerializer.new(post, god).to_json
    hash = JSON.parse(json)
    assert_equal post.title, hash.delete("title")
    assert_equal post.body, hash.delete("body")
    assert_equal post.email, hash.delete("email")
    assert_empty hash
  end
  # @param [~body, ~title, ~email] post the post to serialize
  # @param [~super] scope the authorization scope for this serializer
  def initialize(post, scope)
    @post, @scope = post, scope
  end
  # ...
+ActiveModel::Serializer+ to simplify our post serializer.
  attributes :title, :body
  def serializable_hash
    hash = attributes
    hash.merge!(super_data) if super?
    hash
  end
  def super_data
    { email: @post.email }
  end
  def super?
    @scope.superuser?
  end
+attributes+ that extracts those attributes from the post model.
  attributes :title, :body
  def attributes
    hash = super
    hash.merge!(email: post.email) if super?
    hash
  end
  def super?
    @scope.superuser?
  end
+attributes+. We can call +super+ to get the hash based on the attributes we declared, and then add in any additional
  attributes :title, :body
  has_many :comments
  def attributes
    hash = super
    hash.merge!(email: post.email) if super?
    hash
  end
  def super?
    @scope.superuser?
  end
  post: {
    title: "Hello Blog!",
    body: "This is my first post. Isn't it fabulous!",
    comments: [
      {
        title: "Awesome",
        body: "Your first post is great"
      }
    ]
  }
  def initialize(comment, scope)
    @comment, @scope = comment, scope
  end
  def serializable_hash
    { title: @comment.title }
  end
  def as_json
    { comment: serializable_hash }
  end
  post: {
    title: "Hello Blog!",
    body: "This is my first post. Isn't it fabulous!",
    comments: [{ title: "Awesome" }]
  }
+comments+ accessor on the post object. We can override the +comments+ accessor to limit the comments used
  attributes :title. :body
  has_many :comments
  def attributes
    hash = super
    hash.merge!(email: post.email) if super?
    hash
  end
  def comments
    post.comments_for(scope)
  end
  def super?
    @scope.superuser?
  end
+ActiveModel::Serializer+ will still embed the comments, but this time it will use just the comments
  has_many :followed_posts, :key => :posts
  has_one :owned_account, :key => :account
  has_many :followed_posts, :key => :posts, :serializer => CustomPostSerializer
  has_one :owne_account, :key => :account, :serializer => PrivateAccountSerializer
  post: {
    id: 1
    title: "Hello Blog!",
    body: "This is my first post. Isn't it fabulous!",
    comments: [1,2]
  },
  comments: [
    {
      id: 1
      title: "Awesome",
      body: "Your first post is great"
    },
    {
      id: 2
      title: "Not so awesome",
      body: "Why is it so short!"
    }
  ]
  attributes :id, :title, :body
  # define any logic for dealing with authorization-based attributes here
  attributes :title, :body
  has_many :comments
  def as_json
    { post: serializable_hash }.merge!(associations)
  end
  def serializable_hash
    post_hash = attributes
    post_hash.merge!(association_ids)
    post_hash
  end
  def attributes
    hash = super
    hash.merge!(email: post.email) if super?
    hash
  end
  def comments
    post.comments_for(scope)
  end
  def super?
    @scope.superuser?
  end
+associations+, creates a hash of all of the define associations, using their defined
+comments+ method.
  class CommentSerializer < ActiveModel::Serializer
    attributes :id, :title
  end
  # same as before
  # ...
  serialization_scope :current_app
  posts: [
    {
      title: "FIRST POST!",
      body: "It's my first pooooost"
    },
    { title: "Second post!",
      body: "Zomg I made it to my second post"
    }
  ]
  def serializable_array
    serializers.map do |serializer|
      serializer.serializable_hash
    end
  end
  def as_json
    hash = { root => serializable_array }
    hash.merge!(associations)
    hash
  end