active_model_serializers 0.8.3 → 0.10.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94274a9d3a573ae8f656719aef33825cabb68673
-  data.tar.gz: b1d614a90149ec109b67e963464c232d0b5ed3f1
+  metadata.gz: f97fe4e6870c3e3338fb3415b762d451f07f2b9d
+  data.tar.gz: a911ae55792f5fa60ddd9f198b21f3d9960d3647
 SHA512:
-  metadata.gz: cc3140d1676014d8ce4aa0add253d247c55652a689cb83e7f7f7a71a81ae8d7c601fc5e2d261d415e243857a479a15156d0a84a67beb1c72475ef51c063cdfca
-  data.tar.gz: cfc92ac9bb7dfca07cebdd32ef4a120aa5784cc7f1a6bfc8a65900b553be736b174b6bbf22fb7ebd55e8295ea1d118373245396e3c0ac883e954ab27e925bca2
+  metadata.gz: 639b8b33bd971772668ead59b6e38b7f0e2aa5f36c4c680876a9241aeaa51b77e70efdfc5d8af84f9bd3bf9b5646848a8b1ad30c3e0927a98ca14fe9106410f7
+  data.tar.gz: 9b61116bd804ea07f9294792e73d8736b3f06b5919739c304689bf0cf9d9ef7974467eb1fef4929a5ceb6ca9629d95067761428a6f8fa86cebb870bb4d1b3d05

data/.gitignore

@@ -4,15 +4,20 @@
 .config
 .yardoc
 Gemfile.lock
+Gemfile.local
 InstalledFiles
 _yardoc
 coverage
 doc/
 lib/bundler/man
 pkg
+Vagrantfile
+.vagrant
 rdoc
 spec/reports
 test/tmp
 test/version_tmp
 tmp
 *.swp
+.ruby-version
+.ruby-gemset

data/.rubocop.yml

@@ -0,0 +1,82 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - config/initializers/forbidden_yaml.rb
+    - !ruby/regexp /(vendor|bundle|bin|db|tmp)\/.*/
+  RunRailsCops: true
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+Style/IndentationConsistency:
+  Exclude:
+    - lib/active_model/serializer/adapter/flatten_json.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/fragment_cache.rb
+    - lib/active_model/serializer/adapter/json_api/pagination_links.rb
+    - lib/active_model/serializer/adapter/null.rb
+
+Style/IndentationWidth:
+  Exclude:
+    - lib/active_model/serializer/adapter/flatten_json.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/fragment_cache.rb
+    - lib/active_model/serializer/adapter/json_api/pagination_links.rb
+    - lib/active_model/serializer/adapter/null.rb
+
+Style/AccessModifierIndentation:
+  Exclude:
+    - lib/active_model/serializer/adapter/flatten_json.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/fragment_cache.rb
+    - lib/active_model/serializer/adapter/json_api/pagination_links.rb
+    - lib/active_model/serializer/adapter/null.rb
+
+Lint/NestedMethodDefinition:
+  Enabled: false
+  Exclude:
+    - test/action_controller/serialization_test.rb
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Metrics/AbcSize:
+  Max: 35 # TODO: Lower to 15
+
+Metrics/ClassLength:
+  Max: 261 # TODO: Lower to 100
+  Exclude:
+    - test/**/*.rb
+
+Metrics/CyclomaticComplexity:
+  Max: 7 # TODO: Lower to 6
+
+Metrics/LineLength:
+  Max: 251 # TODO: Lower to 80
+
+Metrics/MethodLength:
+  Max: 106 # TODO: Lower to 10
+
+Metrics/PerceivedComplexity:
+  Max: 9 # TODO: Lower to 7
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Style/Documentation:
+  Enabled: false
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented

data/.rubocop_todo.yml

@@ -0,0 +1,315 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-08-31 04:23:33 -0500 using RuboCop version 0.33.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: AllowSafeAssignment.
+Lint/AssignmentInCondition:
+  Exclude:
+    - 'lib/active_model/serializer/adapter/json_api.rb'
+
+# Offense count: 1
+Lint/EmptyEnsure:
+  Exclude:
+    - 'test/serializers/adapter_for_test.rb'
+
+# Offense count: 1
+Lint/HandleExceptions:
+  Exclude:
+    - 'Rakefile'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Exclude:
+    - 'lib/active_model/serializer/adapter/json_api/fragment_cache.rb'
+
+# Offense count: 9
+# Cop supports --auto-correct.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/active_model/serializer/adapter.rb'
+    - 'lib/active_model/serializer/adapter/null.rb'
+    - 'lib/active_model/serializer/pass_through_serializer.rb'
+    - 'test/fixtures/poro.rb'
+    - 'test/lint_test.rb'
+
+# Offense count: 1
+Lint/UselessAccessModifier:
+  Exclude:
+    - 'lib/active_model/serializable_resource.rb'
+
+# Offense count: 3
+Lint/UselessAssignment:
+  Exclude:
+    - 'bench/perf.rb'
+    - 'lib/active_model/serializer/adapter/json_api/fragment_cache.rb'
+    - 'test/test_helper.rb'
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Rails/Date:
+  Exclude:
+    - 'test/fixtures/poro.rb'
+
+# Offense count: 8
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Rails/TimeZone:
+  Exclude:
+    - 'test/action_controller/serialization_test.rb'
+    - 'test/fixtures/poro.rb'
+    - 'test/serializers/cache_test.rb'
+
+# Offense count: 16
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle, SupportedLastArgumentHashStyles.
+Style/AlignHash:
+  Exclude:
+    - 'test/action_controller/json_api/pagination_test.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/AndOr:
+  Exclude:
+    - 'lib/active_model/serializer/lint.rb'
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, ProceduralMethods, FunctionalMethods, IgnoredMethods.
+Style/BlockDelimiters:
+  Enabled: false
+
+# Offense count: 46
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/BracesAroundHashParameters:
+  Exclude:
+    - 'test/action_controller/adapter_selector_test.rb'
+    - 'test/action_controller/json_api/pagination_test.rb'
+    - 'test/action_controller/serialization_test.rb'
+    - 'test/adapter/json_api/linked_test.rb'
+    - 'test/adapter/json_api/pagination_links_test.rb'
+    - 'test/adapter/null_test.rb'
+    - 'test/adapter_test.rb'
+    - 'test/array_serializer_test.rb'
+    - 'test/serializable_resource_test.rb'
+    - 'test/serializers/associations_test.rb'
+    - 'test/serializers/attribute_test.rb'
+    - 'test/serializers/attributes_test.rb'
+    - 'test/serializers/fieldset_test.rb'
+    - 'test/serializers/root_test.rb'
+    - 'test/serializers/urls_test.rb'
+
+# Offense count: 167
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Offense count: 5
+# Cop supports --auto-correct.
+Style/CommentIndentation:
+  Exclude:
+    - 'active_model_serializers.gemspec'
+
+# Offense count: 1
+Style/DoubleNegation:
+  Exclude:
+    - 'lib/active_model/serializable_resource.rb'
+
+# Offense count: 1
+Style/EachWithObject:
+  Exclude:
+    - 'lib/active_model/serializer/fieldset.rb'
+
+# Offense count: 3
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/active_model/serializer.rb'
+    - 'lib/active_model/serializer/adapter/json_api.rb'
+    - 'test/capture_warnings.rb'
+
+# Offense count: 12
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues.
+Style/HashSyntax:
+  Enabled: false
+
+# Offense count: 9
+# Cop supports --auto-correct.
+Style/IndentArray:
+  Exclude:
+    - 'test/adapter/json/has_many_test.rb'
+    - 'test/adapter/json_api/json_api_test.rb'
+    - 'test/adapter/json_api/pagination_links_test.rb'
+    - 'test/adapter/json_test.rb'
+
+# Offense count: 8
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/IndentHash:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/IndentationConsistency:
+  Exclude:
+    - 'test/action_controller/serialization_scope_name_test.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: Width.
+Style/IndentationWidth:
+  Exclude:
+    - 'lib/active_model/serializable_resource.rb'
+    - 'lib/active_model/serializer/fieldset.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/Lambda:
+  Exclude:
+    - 'lib/active_model/serializer.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/MethodCallParentheses:
+  Exclude:
+    - 'lib/active_model/serializer/adapter/json.rb'
+    - 'lib/active_model/serializer/adapter/json_api.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/MethodDefParentheses:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/MultilineOperationIndentation:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/NegatedIf:
+  Exclude:
+    - 'lib/action_controller/serialization.rb'
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
+Style/Next:
+  Exclude:
+    - 'lib/active_model/serializer/adapter/json_api.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/NumericLiterals:
+  MinDigits: 7
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'active_model_serializers.gemspec'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/PerlBackrefs:
+  Exclude:
+    - 'test/fixtures/poro.rb'
+    - 'test/serializers/associations_test.rb'
+
+# Offense count: 6
+# Configuration parameters: NamePrefix, NamePrefixBlacklist.
+Style/PredicateName:
+  Exclude:
+    - 'lib/active_model/serializer/adapter.rb'
+    - 'lib/active_model/serializer/adapter/json_api.rb'
+    - 'lib/active_model/serializer/associations.rb'
+    - 'test/action_controller/json_api/linked_test.rb'
+
+# Offense count: 7
+# Cop supports --auto-correct.
+Style/RedundantSelf:
+  Exclude:
+    - 'lib/active_model/serializer.rb'
+    - 'lib/active_model/serializer/associations.rb'
+    - 'test/fixtures/poro.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowAsExpressionSeparator.
+Style/Semicolon:
+  Exclude:
+    - 'lib/active_model/serializer/fieldset.rb'
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/SignalException:
+  Exclude:
+    - 'lib/active_model/serializer.rb'
+    - 'lib/active_model/serializer/adapter.rb'
+    - 'lib/active_model/serializer/fieldset.rb'
+    - 'lib/active_model/serializer/pass_through_serializer.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowIfMethodIsEmpty.
+Style/SingleLineMethods:
+  Exclude:
+    - 'test/serializers/serializer_for_test.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+# Offense count: 1
+Style/StructInheritance:
+  Exclude:
+    - 'bench/perf.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: IgnoredMethods.
+Style/SymbolProc:
+  Exclude:
+    - 'lib/generators/serializer/serializer_generator.rb'
+
+# Offense count: 8
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/TrailingBlankLines:
+  Exclude:
+    - 'lib/active_model/serializer/pass_through_serializer.rb'
+    - 'lib/generators/serializer/serializer_generator.rb'
+    - 'test/adapter/fragment_cache_test.rb'
+    - 'test/adapter/json_api/json_api_test.rb'
+    - 'test/adapter/null_test.rb'
+    - 'test/serializers/cache_test.rb'
+    - 'test/serializers/fieldset_test.rb'
+    - 'test/support/stream_capture.rb'
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleForMultiline, SupportedStyles.
+Style/TrailingComma:
+  Exclude:
+    - 'test/action_controller/adapter_selector_test.rb'
+    - 'test/action_controller/serialization_test.rb'
+    - 'test/adapter/json_api/belongs_to_test.rb'
+    - 'test/adapter/json_api/linked_test.rb'
+
+# Offense count: 1
+Style/UnlessElse:
+  Exclude:
+    - 'lib/active_model/serializer.rb'

data/.simplecov

@@ -0,0 +1,99 @@
+# https://github.com/colszowka/simplecov#using-simplecov-for-centralized-config
+# see https://github.com/colszowka/simplecov/blob/master/lib/simplecov/defaults.rb
+# vim: set ft=ruby
+
+## DEFINE VARIABLES
+@minimum_coverage = ENV.fetch('COVERAGE_MINIMUM') {
+  case (defined?(RUBY_ENGINE) && RUBY_ENGINE) || "ruby"
+  when 'jruby', 'rbx'
+    96.0
+  else
+    98.1
+  end
+}.to_f.round(2)
+# rubocop:disable Style/DoubleNegation
+ENV['FULL_BUILD'] ||= ENV['CI']
+@running_ci       = !!(ENV['FULL_BUILD'] =~ /\Atrue\z/i)
+@generate_report  = @running_ci || !!(ENV['COVERAGE'] =~ /\Atrue\z/i)
+@output = STDOUT
+# rubocop:enable Style/DoubleNegation
+
+## CONFIGURE SIMPLECOV
+SimpleCov.pid = $$ # In case there's any forking
+
+SimpleCov.profiles.define 'app' do
+  coverage_dir 'coverage'
+  load_profile 'test_frameworks'
+
+  add_group 'Libraries', 'lib'
+
+  add_group 'Long files' do |src_file|
+    src_file.lines.count > 100
+  end
+  class MaxLinesFilter < SimpleCov::Filter
+    def matches?(source_file)
+      source_file.lines.count < filter_argument
+    end
+  end
+  add_group 'Short files', MaxLinesFilter.new(5)
+
+  # Exclude these paths from analysis
+  add_filter '/config/'
+  add_filter '/db/'
+  add_filter 'tasks'
+end
+
+## START TRACKING COVERAGE (before activating SimpleCov)
+require 'coverage'
+Coverage.start
+
+## ADD SOME CUSTOM REPORTING AT EXIT
+SimpleCov.at_exit do
+  header = "#{'*' * 20} SimpleCov Results #{'*' * 20}"
+  @output.puts
+  @output.puts header
+  @output.puts SimpleCov.result.format!
+  percent = Float(SimpleCov.result.covered_percent)
+  if percent < @minimum_coverage
+    @output.puts "Spec coverage was not high enough: "\
+    "#{percent.round(2)} is < #{@minimum_coverage}%\n"
+    exit 1 if @generate_report
+  else
+    @output.puts "Nice job! Spec coverage (#{percent.round(2)}) "\
+    "is still at or above #{@minimum_coverage}%\n"
+  end
+  @output.puts
+  @output.puts '*' * header.size
+end
+
+## CAPTURE CONFIG IN CLOSURE 'AppCoverage.start'
+## to defer running until test/test_helper.rb is loaded.
+# rubocop:disable Style/MultilineBlockChain
+AppCoverage = Class.new do
+  def initialize(&block)
+    @block = block
+  end
+
+  def start
+    @block.call
+  end
+end.new do
+  SimpleCov.start 'app'
+  if @generate_report
+    if @running_ci
+      require 'codeclimate-test-reporter'
+      @output.puts '[COVERAGE] Running with SimpleCov Simple Formatter and CodeClimate Test Reporter'
+      formatters = [
+        SimpleCov::Formatter::SimpleFormatter,
+        CodeClimate::TestReporter::Formatter
+      ]
+    else
+      @output.puts '[COVERAGE] Running with SimpleCov HTML Formatter'
+      formatters = [SimpleCov::Formatter::HTMLFormatter]
+    end
+  else
+    formatters = []
+  end
+  SimpleCov.formatters = formatters
+end
+# rubocop:enable Style/MultilineBlockChain

data/.travis.yml

@@ -1,28 +1,34 @@
 language: ruby
+
+sudo: false
+
+cache:
+  bundler: true
+
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
   - 2.0.0
-  - ree
-  - jruby-18mode
+  - 2.1
+  - 2.2
   - jruby-19mode
   - rbx-2
-gemfile:
-  - Gemfile
-  - Gemfile.edge
+  - ruby-head
+
+install:
+  - bundle install --retry=3
+
+script:
+  - bundle exec rake
+  - bundle exec rake rubocop
+
+env:
+  - "RAILS_VERSION=4.0"
+  - "RAILS_VERSION=4.1"
+  - "RAILS_VERSION=4.2"
+  - "RAILS_VERSION=master"
+
 matrix:
   allow_failures:
-    - gemfile: Gemfile.edge
-  exclude:
-    # Edge Rails is only compatible with 1.9.3
-    - gemfile: Gemfile.edge
-      rvm: 1.8.7
-    - gemfile: Gemfile.edge
-      rvm: 1.9.2
-    - gemfile: Gemfile.edge
-      rvm: ree
-    - gemfile: Gemfile.edge
-      rvm: jruby-18mode
-    - gemfile: Gemfile.edge
-      rvm: rbx-18mode
+    - rvm: ruby-head
+    - env: "RAILS_VERSION=master"
+  fast_finish: true

data/CHANGELOG.md

@@ -1,67 +1,14 @@
-# UNRELEASED
-
-# VERSION 0.8.1
-
-* Fix bug whereby a serializer using 'options' would blow up.
-
-# VERSION 0.8.0
-
-* Attributes can now have optional types.
-
-* A new DefaultSerializer ensures that POROs behave the same way as ActiveModels.
-
-* If you wish to override ActiveRecord::Base#to_Json, you can now require
-  'active_record/serializer_override'. We don't recommend you do this, but
-  many users do, so we've left it optional.
-
-* Fixed a bug where ActionController wouldn't always have MimeResponds.
-
-* An optinal caching feature allows you to cache JSON & hashes that AMS uses.
-  Adding 'cached true' to your Serializers will turn on this cache.
-
-* URL helpers used inside of Engines now work properly.
-
-* Serializers now can filter attributes with `only` and `except`:
-
-  ```
-  UserSerializer.new(user, only: [:first_name, :last_name])
-  UserSerializer.new(user, except: :first_name)
-  ```
-
-* Basic Mongoid support. We now include our mixins in the right place.
-
-* On Ruby 1.8, we now generate an `id` method that properly serializes `id`
-  columns. See issue #127 for more.
-
-* Add an alias for `scope` method to be the name of the context. By default
-  this is `current_user`. The name is automatically set when using
-  `serialization_scope` in the controller.
-
-* Pass through serialization options (such as `:include`) when a model
-  has no serializer defined.
-
-# VERSION 0.7.0
-
-* ```embed_key``` option to allow embedding by attributes other than IDs
-* Fix rendering nil with custom serializer
-* Fix global ```self.root = false```
-* Add support for specifying the serializer for an association as a String
-* Able to specify keys on the attributes method
-* Serializer Reloading via ActiveSupport::DescendantsTracker
-* Reduce double map to once; Fixes datamapper eager loading.
-
-# VERSION 0.6.0
-
-* Serialize sets properly
-* Add root option to ArraySerializer
-* Support polymorphic associations
-* Support :each_serializer in ArraySerializer
-* Add `scope` method to easily access the scope in the serializer
-* Fix regression with Rails 3.2.6; add Rails 4 support
-* Allow serialization_scope to be disabled with serialization_scope nil
-* Array serializer should support pure ruby objects besides serializers
-
-# VERSION 0.5.0 (May 16, 2012)
-
-* First tagged version
-* Changes generators to always generate an ApplicationSerializer
+### 0.10.0
+
+  * adds adapters pattern
+  * adds support for `meta` and `meta_key` [@kurko]
+  * adds method to override association [@kurko]
+  * adds `has_one` attribute for backwards compatibility [@ggordon]
+  * adds JSON API support 1.0 [@benedikt]
+  * adds fragment cache support [@joaomdmoura]
+  * adds cache support to attributes and associations [@joaomdmoura]
+  * uses model name to determine the type [@lsylvester]
+  * remove root key option and split JSON adapter [@joaomdmoura]
+  * adds FlattenJSON as default adapter [@joaomdmoura]
+  * adds support for `pagination links` at top level of JsonApi adapter [@bacarini]
+  * adds extended format for `include` option to JSONAPI adapter [@beauby]