active_model_serializers 0.8.3 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94274a9d3a573ae8f656719aef33825cabb68673
-  data.tar.gz: b1d614a90149ec109b67e963464c232d0b5ed3f1
+  metadata.gz: 6a3bbd628ea9a29ba5746a2d18be35b679992e82
+  data.tar.gz: f8b574ecfb45e609b89beba0f7d729e22bbe1fe9
 SHA512:
-  metadata.gz: cc3140d1676014d8ce4aa0add253d247c55652a689cb83e7f7f7a71a81ae8d7c601fc5e2d261d415e243857a479a15156d0a84a67beb1c72475ef51c063cdfca
-  data.tar.gz: cfc92ac9bb7dfca07cebdd32ef4a120aa5784cc7f1a6bfc8a65900b553be736b174b6bbf22fb7ebd55e8295ea1d118373245396e3c0ac883e954ab27e925bca2
+  metadata.gz: 59beee726674129f3fa5445858efc7b7c4ca7eefe28bb2923f7a975196406e17daab06a9e29ecbc4afdeb438cb9d214a277db1ff44b966521d8aab14d99af541
+  data.tar.gz: a392e8ebfc339b793844fc3140f03d57d05d4ce6c2e4aaef80290dbfa0b84321b35fbaecacf077560177c91645a6af87a6827184e91678c7fc89489a14551f06

data/.travis.yml

@@ -1,28 +1,34 @@
 language: ruby
+sudo: false
 rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-  - ree
-  - jruby-18mode
+  # - 1.8.7
+  # - ree
+  # - jruby-18mode
+  # - 1.9.2
+  # - 1.9.3
   - jruby-19mode
+  - 2.0.0
+  - 2.1
+  - 2.2
   - rbx-2
-gemfile:
-  - Gemfile
-  - Gemfile.edge
+install: bundle install --path=vendor/bundle --retry=3 --jobs=3
+cache:
+  directories:
+    - vendor/bundle
+script:
+  - bundle exec rake ci
+env:
+  # - "RAILS_VERSION=3.0"
+  # - "RAILS_VERSION=3.1"
+  # - "RAILS_VERSION=3.2"
+  - "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: 1.8.7
+  # - ree
+  # - jruby-18mode
+  # - rvm: 1.9.2
+  fast_finish: true

data/CHANGELOG.md

@@ -1,10 +1,34 @@
 # UNRELEASED
 
-# VERSION 0.8.1
+### v0.8.4 (2017-09-19)
+
+- [#1675](https://github.com/rails-api/active_model_serializers/pull/1675) Fix memory leak with :scope_name.
+  Supplying :scope_name causes `ActiveModel::Serializer#initialize` to
+  define a method on the class, which retains a reference to the
+  serializer instance. (@Botje)
+- [#1276](https://github.com/rails-api/active_model_serializers/pull/1276) Fix serializers were never including associations on cache hits (@kieran)
+- [#1503](https://github.com/rails-api/active_model_serializers/pull/1503) Add documentation with example to `README` for POROs and alternative ORMs (@feministy)
+- [#1376](https://github.com/rails-api/active_model_serializers/pull/1376) Test against Rails >= 4.0, Ruby >= 1.9.3 and remove Ruby 1.8 and 1.9.2 support (@bf4, @mhuggins)
+
+### v0.8.3 (2014-12-10)
+- [#753](https://github.com/rails-api/active_model_serializers/pull/753) Test against Ruby 2.2 on Travis CI (@tricknotes)
+- [#745](https://github.com/rails-api/active_model_serializers/pull/745) Missing a word (@jockee)
+
+### v0.8.2 (2014/09/01 21:00 +00:00)
+- [#612](https://github.com/rails-api/active_model_serializers/pull/612) Feature/adapter (@bolshakov)
+  * adds adapters pattern
+- [#615](https://github.com/rails-api/active_model_serializers/pull/615) Rails does not support const_defined? in development mode (@tpitale)
+- [#613](https://github.com/rails-api/active_model_serializers/pull/613) README: typo fix on attributes (@spk)
+- [#614](https://github.com/rails-api/active_model_serializers/pull/614) Fix rails 4.0.x build. (@arthurnn)
+- [#610](https://github.com/rails-api/active_model_serializers/pull/610) ArraySerializer (@bolshakov)
+- [#607](https://github.com/rails-api/active_model_serializers/pull/607) ruby syntax highlights (@zigomir)
+- [#602](https://github.com/rails-api/active_model_serializers/pull/602) Add DSL for associations (@JordanFaust)
+
+### 0.8.1 (May 6, 2013)
 
 * Fix bug whereby a serializer using 'options' would blow up.
 
-# VERSION 0.8.0
+### 0.8.0 (May 5, 2013)
 
 * Attributes can now have optional types.
 
@@ -40,7 +64,7 @@
 * Pass through serialization options (such as `:include`) when a model
   has no serializer defined.
 
-# VERSION 0.7.0
+## [0.7.0 (March 6, 2013)](https://github.com/rails-api/active_model_serializers/commit/fabdc621ff97fbeca317f6301973dd4564b9e695)
 
 * ```embed_key``` option to allow embedding by attributes other than IDs
 * Fix rendering nil with custom serializer
@@ -50,7 +74,7 @@
 * Serializer Reloading via ActiveSupport::DescendantsTracker
 * Reduce double map to once; Fixes datamapper eager loading.
 
-# VERSION 0.6.0
+## 0.6.0 (October 22, 2012)
 
 * Serialize sets properly
 * Add root option to ArraySerializer
@@ -61,7 +85,18 @@
 * 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)
+## 0.05.x
+
+### [0.5.2 (June 5, 2012)](https://github.com/rails-api/active_model_serializers/commit/615afd125c260432d456dc8be845867cf87ea118#diff-0c5c12f311d3b54734fff06069efd2ac)
+
+### [0.5.1 (May 23, 2012)](https://github.com/rails-api/active_model_serializers/commit/00194ec0e41831802fcbf893a34c0bb0853ebe14#diff-0c5c12f311d3b54734fff06069efd2ac)
+
+### [0.5.0 (May 16, 2012)](https://github.com/rails-api/active_model_serializers/commit/33d4842dcd35c7167b0b33fc0abcf00fb2c92286)
 
 * First tagged version
 * Changes generators to always generate an ApplicationSerializer
+
+## [0.1.0 (December 21, 2011)](https://github.com/rails-api/active_model_serializers/commit/1e0c9ef93b96c640381575dcd30be07ac946818b)
+
+## First Commit as [Rails Serializers 0.0.1](https://github.com/rails-api/active_model_serializers/commit/d72b66d4c5355b0ff0a75a04895fcc4ea5b0c65e)
+  (December 1, 2011).

data/Gemfile

@@ -2,3 +2,37 @@ source 'https://rubygems.org'
 
 # Specify gem dependencies in active_model_serializers.gemspec
 gemspec
+
+version = ENV['RAILS_VERSION'] || '4.0'
+
+if version == 'master'
+  gem 'rack', github: 'rack/rack'
+  gem 'arel', github: 'rails/arel'
+  git 'https://github.com/rails/rails.git' do
+    gem 'railties'
+    gem 'activesupport'
+    gem 'activemodel'
+    gem 'actionpack'
+    gem 'activerecord', group: :test
+    # Rails 5
+    gem 'actionview'
+  end
+else
+  gem_version = "~> #{version}.0"
+  gem 'railties', gem_version
+  gem 'activesupport', gem_version
+  gem 'activemodel', gem_version
+  gem 'actionpack', gem_version
+  gem 'activerecord', gem_version, group: :test
+end
+
+# https://github.com/bundler/bundler/blob/89a8778c19269561926cea172acdcda241d26d23/lib/bundler/dependency.rb#L30-L54
+@windows_platforms = [:mswin, :mingw, :x64_mingw]
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: (@windows_platforms + [:jruby])
+
+# JRuby versions before 9.x report their version as "1.9.x" or lower, so lock these to an older version of mime-types
+if defined?(JRUBY_VERSION) and Gem::ruby_version < Gem::Version.new("2.0.0")
+  gem 'mime-types', '< 3'
+end

data/README.md

@@ -45,18 +45,35 @@ the serializer generator:
 $ rails g serializer post
 ```
 
-### Support for PORO's and other ORM's.
+### Support for POROs and other ORMs.
 
 Currently `ActiveModel::Serializers` adds serialization support to all models
-that descend from `ActiveRecord` or include `Mongoid::Document`. If you are
-using another ORM, or if you are using objects that are `ActiveModel`
-compliant but do not descend from `ActiveRecord` or include
-`Mongoid::Document`, you must add an include statement for
-`ActiveModel::SerializerSupport` to make models serializable. If you
-also want to make collections serializable, you should include
+that descend from `ActiveRecord` or include `Mongoid::Document`. If you are:
+
+- using another ORM, or
+- using objects that are `ActiveModel` compliant but do not descend from
+`ActiveRecord` *or* include `Mongoid::Document`
+
+You must add an include statement for `ActiveModel::SerializerSupport` to
+make models serializable. 
+
+If you also want to make collections serializable, you should include
 `ActiveModel::ArraySerializerSupport` into your ORM's
 relation/criteria class.
 
+Example model (`app/models/avatar.rb`):
+
+```ruby
+class Avatar
+  include ActiveModel::SerializerSupport
+  # etc, etc
+end
+```
+
+If your classes follow the naming conventions prescribed by `ActiveModel`,
+you don't need to do anything different in your controller to render the
+serialized json.
+
 # ActiveModel::Serializer
 
 All new serializers descend from ActiveModel::Serializer

data/Rakefile

@@ -7,6 +7,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
+  t.ruby_opts = ['-r./test/test_helper.rb']
   t.verbose = true
 end
 
@@ -16,3 +17,6 @@ task :bench do
 end
 
 task :default => :test
+
+desc 'CI test task'
+task :ci => :default

data/appveyor.yml

@@ -0,0 +1,27 @@
+version: '{build}'
+
+skip_tags: true
+
+environment:
+  matrix:
+    - ruby_version: "200"
+    - ruby_version: "200-x64"
+    - ruby_version: "21"
+    - ruby_version: "21-x64"
+
+cache:
+  - vendor/bundle
+
+install:
+  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
+  - ruby --version
+  - gem --version
+  - gem install bundler
+  - bundler --version
+  - bundle platform
+  - bundle install --path=vendor/bundle --retry=3 --jobs=3
+
+test_script:
+  - bundle exec rake ci
+
+build: off

data/lib/active_model/serializer.rb

@@ -294,9 +294,7 @@ module ActiveModel
 
       scope_name = @options[:scope_name]
       if scope_name && !respond_to?(scope_name)
-        self.class.class_eval do
-          define_method scope_name, lambda { scope }
-        end
+        self.singleton_class.send :alias_method, scope_name, :scope
       end
     end
 
@@ -353,13 +351,16 @@ module ActiveModel
     # Returns a hash representation of the serializable
     # object without the root.
     def serializable_hash
-      if perform_caching?
+      @node = if perform_caching?
         cache.fetch expand_cache_key([self.class.to_s.underscore, cache_key, 'serializable-hash']) do
           _serializable_hash
         end
       else
         _serializable_hash
       end
+
+      include_associations! if @object.present? && _embed
+      @node
     end
 
     def include_associations!
@@ -476,9 +477,7 @@ module ActiveModel
 
     def _serializable_hash
       return nil if @object.nil?
-      @node = attributes
-      include_associations! if _embed
-      @node
+      attributes
     end
 
     def perform_caching?

data/lib/active_model/serializers/version.rb

@@ -1,5 +1,5 @@
 module ActiveModel
   class Serializer
-    VERSION = "0.8.3"
+    VERSION = "0.8.4"
   end
 end

data/test/caching_test.rb

@@ -35,6 +35,42 @@ class CachingTest < ActiveModel::TestCase
     end
   end
 
+  class Parent
+    def id
+      'parent1'
+    end
+
+    def name
+      'Kieran'
+    end
+
+    def children
+      [ Child.new ]
+    end
+
+    def read_attribute_for_serialization(name)
+      send name
+    end
+  end
+
+  class Child
+    def id
+      'child1'
+    end
+
+    def name
+      'Joshua'
+    end
+
+    def parent
+      Parent.new
+    end
+
+    def read_attribute_for_serialization(name)
+      send name
+    end
+  end
+
   def test_serializers_have_a_cache_store
     ActiveModel::Serializer.cache = NullStore.new
 
@@ -93,4 +129,49 @@ class CachingTest < ActiveModel::TestCase
     assert_equal instance.serializable_array, serializer.cache.read('array_serializer/cache-key/serializable-array')
     assert_equal instance.to_json, serializer.cache.read('array_serializer/cache-key/to-json')
   end
+
+  def test_cached_serializers_return_associations
+
+    child_serializer = Class.new(ActiveModel::Serializer) do
+      cached true
+      attributes :name
+
+      def self.to_s
+        'child_serializer'
+      end
+
+      def cache_key
+        object.name
+      end
+    end
+
+    parent_serializer = Class.new(ActiveModel::Serializer) do
+      cached true
+      attributes :name
+
+      has_many :children, serializer: child_serializer, embed: :ids, include: true
+
+      def self.to_s
+        'parent_serializer'
+      end
+
+      def cache_key
+        object.name
+      end
+    end
+
+
+    parent_serializer.cache = NullStore.new
+    child_serializer.cache = NullStore.new
+
+    instance = parent_serializer.new Parent.new, root: :parent
+
+    initial_keys = instance.as_json.keys
+
+    assert_equal(initial_keys, [:children, :parent])
+
+    cached_keys = instance.as_json.keys
+
+    assert_equal(cached_keys, [:children, :parent])
+  end
 end

data/test/serialization_test.rb

@@ -242,9 +242,13 @@ class RenderJsonTest < ActionController::TestCase
 
   def test_render_json_with_callback
     get :render_json_hello_world_with_callback
-    assert_equal 'alert({"hello":"world"})', @response.body
-    # For JSONP, Rails 3 uses application/json, but Rails 4 uses text/javascript
-    assert_match %r(application/json|text/javascript), @response.content_type.to_s
+    if Rails::VERSION::MAJOR == 3
+      assert_equal 'alert({"hello":"world"})', @response.body
+      assert_match %r(application/json), @response.content_type.to_s
+    else
+      assert_equal '/**/alert({"hello":"world"})', @response.body
+      assert_match %r(text/javascript), @response.content_type.to_s
+    end
   end
 
   def test_render_json_with_custom_content_type

data/test/serializer_test.rb

@@ -1370,6 +1370,7 @@ class SerializerTest < ActiveModel::TestCase
     end
 
     data_class = Class.new do
+      include ActiveModel::Serializers::JSON
       attr_accessor :title, :body
     end
 

data/test/test_fakes.rb

@@ -199,6 +199,7 @@ class SomeSerializer < ActiveModel::Serializer
 end
 
 class SomeObject < Struct.new(:some)
+  include ActiveModel::Serializers::JSON
 end
 
 # Set up some classes for polymorphic testing

data/test/test_helper.rb

@@ -1,13 +1,36 @@
 require "rubygems"
 require "bundler/setup"
 
+require 'rails'
+require 'action_controller'
+require 'action_controller/test_case'
+require 'action_controller/railtie'
+require 'active_support/json'
+
+gem 'minitest'
+require 'minitest/autorun'
+if defined?(Minitest::Test)
+  $minitest_version = 5 # rubocop:disable Style/GlobalVars
+  # Minitest 5
+  # https://github.com/seattlerb/minitest/blob/e21fdda9d/lib/minitest/autorun.rb
+  # https://github.com/seattlerb/minitest/blob/e21fdda9d/lib/minitest.rb#L45-L59
+else
+  $minitest_version = 4 # rubocop:disable Style/GlobalVars
+  # Minitest 4
+  # https://github.com/seattlerb/minitest/blob/644a52fd0/lib/minitest/autorun.rb
+  # https://github.com/seattlerb/minitest/blob/644a52fd0/lib/minitest/unit.rb#L768-L787
+  # Ensure backward compatibility with Minitest 4
+  Minitest = MiniTest unless defined?(Minitest)
+  Minitest::Test = MiniTest::Unit::TestCase
+  def Minitest.after_run(&block)
+    MiniTest::Unit.after_tests(&block)
+  end
+end
+
+
 require "pry"
 
 require "active_model_serializers"
-require "active_support/json"
-require "minitest/autorun"
-
-require 'rails'
 
 module TestHelper
   Routes = ActionDispatch::Routing::RouteSet.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_model_serializers
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.4
 platform: ruby
 authors:
 - José Valim
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-10 00:00:00.000000000 Z
+date: 2017-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -80,11 +80,11 @@ files:
 - CHANGELOG.md
 - DESIGN.textile
 - Gemfile
-- Gemfile.edge
 - MIT-LICENSE.txt
 - README.md
 - Rakefile
 - active_model_serializers.gemspec
+- appveyor.yml
 - bench/perf.rb
 - cruft.md
 - lib/action_controller/serialization.rb
@@ -128,9 +128,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Bringing consistency and object orientation to model serialization. Works
   great for client-side MVC frameworks!
-test_files: []
+test_files:
+- test/array_serializer_test.rb
+- test/association_test.rb
+- test/caching_test.rb
+- test/generators_test.rb
+- test/no_serialization_scope_test.rb
+- test/serialization_scope_name_test.rb
+- test/serialization_test.rb
+- test/serializer_support_test.rb
+- test/serializer_test.rb
+- test/test_fakes.rb
+- test/test_helper.rb

data/Gemfile.edge

@@ -1,9 +0,0 @@
-source 'http://rubygems.org'
-
-gemspec
-
-gem 'rails', github: 'rails/rails'
-
-# Current dependencies of edge rails
-gem 'journey', github: 'rails/journey'
-gem 'activerecord-deprecated_finders' , github: 'rails/activerecord-deprecated_finders'