cheap_ams 0.10.5 → 0.10.6

data/test/lint_test.rb

@@ -7,27 +7,21 @@ module ActiveModel
 
       class CompliantResource
         def serializable_hash(options = nil)
-
         end
 
         def read_attribute_for_serialization(name)
-
         end
 
         def as_json(options = nil)
-
         end
 
         def to_json(options = nil)
-
         end
 
         def cache_key
-
         end
 
         def id
-
         end
 
         def self.model_name
@@ -38,7 +32,6 @@ module ActiveModel
       def setup
         @resource = CompliantResource.new
       end
-
     end
   end
 end

data/test/serializers/adapter_for_test.rb

@@ -20,7 +20,6 @@ module ActiveModel
         adapter = ActiveModel::Serializer.adapter
         assert_equal ActiveModel::Serializer::Adapter::Null, adapter
       ensure
-
       end
 
       def test_overwrite_adapter_with_class

data/test/serializers/associations_test.rb

@@ -4,7 +4,7 @@ module ActiveModel
   class Serializer
     class AssociationsTest < Minitest::Test
       class Model
-        def initialize(hash={})
+        def initialize(hash = {})
           @attributes = hash
         end
 
@@ -29,7 +29,7 @@ module ActiveModel
         @author.roles = []
         @blog = Blog.new({ name: 'AMS Blog' })
         @post = Post.new({ title: 'New Post', body: 'Body' })
-        @tag = Tag.new({name: '#hashtagged'})
+        @tag = Tag.new({ name: '#hashtagged' })
         @comment = Comment.new({ id: 1, body: 'ZOMG A COMMENT' })
         @post.comments = [@comment]
         @post.tags = [@tag]
@@ -39,7 +39,7 @@ module ActiveModel
         @post.author = @author
         @author.posts = [@post]
 
-        @post_serializer = PostSerializer.new(@post, {custom_options: true})
+        @post_serializer = PostSerializer.new(@post, { custom_options: true })
         @author_serializer = AuthorSerializer.new(@author)
         @comment_serializer = CommentSerializer.new(@comment)
       end
@@ -74,7 +74,7 @@ module ActiveModel
 
           assert_equal key, :tags
           assert_equal serializer, nil
-          assert_equal [{ attributes: { name: "#hashtagged" }}].to_json, options[:virtual_value].to_json
+          assert_equal [{ attributes: { name: '#hashtagged' } }].to_json, options[:virtual_value].to_json
         end
       end
 

data/test/serializers/attribute_test.rb

@@ -4,25 +4,25 @@ module ActiveModel
   class Serializer
     class AttributeTest < Minitest::Test
       def setup
-        @blog = Blog.new({ id: 1, name: 'AMS Hints', type: "stuff" })
+        @blog = Blog.new({ id: 1, name: 'AMS Hints', type: 'stuff' })
         @blog_serializer = AlternateBlogSerializer.new(@blog)
       end
 
       def test_attributes_definition
         assert_equal([:id, :title],
-                     @blog_serializer.class._attributes)
+          @blog_serializer.class._attributes)
       end
 
       def test_json_serializable_hash
         adapter = ActiveModel::Serializer::Adapter::Json.new(@blog_serializer)
-        assert_equal({blog: { id:1, title:"AMS Hints"}}, adapter.serializable_hash)
+        assert_equal({ blog: { id: 1, title: 'AMS Hints' } }, adapter.serializable_hash)
       end
 
       def test_attribute_inheritance_with_key
         inherited_klass = Class.new(AlternateBlogSerializer)
         blog_serializer = inherited_klass.new(@blog)
         adapter = ActiveModel::Serializer::Adapter::FlattenJson.new(blog_serializer)
-        assert_equal({:id=>1, :title=>"AMS Hints"}, adapter.serializable_hash)
+        assert_equal({ :id => 1, :title => 'AMS Hints' }, adapter.serializable_hash)
       end
 
       def test_multiple_calls_with_the_same_attribute
@@ -40,7 +40,7 @@ module ActiveModel
         end
 
         adapter = ActiveModel::Serializer::Adapter::Json.new(serializer.new(@blog))
-        assert_equal({ blog: { id: "AMS Hints" } }, adapter.serializable_hash)
+        assert_equal({ blog: { id: 'AMS Hints' } }, adapter.serializable_hash)
       end
 
       def test_type_attribute
@@ -52,10 +52,10 @@ module ActiveModel
         end
 
         adapter = ActiveModel::Serializer::Adapter::Json.new(attribute_serializer.new(@blog))
-        assert_equal({ blog: { type: 1} }, adapter.serializable_hash)
+        assert_equal({ blog: { type: 1 } }, adapter.serializable_hash)
 
         adapter = ActiveModel::Serializer::Adapter::Json.new(attributes_serializer.new(@blog))
-        assert_equal({ blog: { type: "stuff" } }, adapter.serializable_hash)
+        assert_equal({ blog: { type: 'stuff' } }, adapter.serializable_hash)
       end
     end
   end

data/test/serializers/attributes_test.rb

@@ -6,7 +6,7 @@ module ActiveModel
       def setup
         @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
         @profile_serializer = ProfileSerializer.new(@profile)
-        @comment = Comment.new(id: 1, body: "ZOMG!!", date: "2015")
+        @comment = Comment.new(id: 1, body: 'ZOMG!!', date: '2015')
         @serializer_klass = Class.new(CommentSerializer)
         @serializer_klass_with_new_attributes = Class.new(CommentSerializer) do
           attributes :date, :likes
@@ -15,18 +15,12 @@ module ActiveModel
 
       def test_attributes_definition
         assert_equal([:name, :description],
-                     @profile_serializer.class._attributes)
+          @profile_serializer.class._attributes)
       end
 
       def test_attributes_with_fields_option
-        assert_equal({name: 'Name 1'},
-                     @profile_serializer.attributes(fields: [:name]))
-      end
-
-      def test_required_fields
-        assert_equal({name: 'Name 1', description: 'Description 1'},
-                     @profile_serializer.attributes(fields: [:name, :description], required_fields: [:name]))
-
+        assert_equal({ name: 'Name 1' },
+          @profile_serializer.attributes(fields: [:name]))
       end
 
       def test_attributes_inheritance_definition
@@ -35,8 +29,8 @@ module ActiveModel
 
       def test_attributes_inheritance
         serializer = @serializer_klass.new(@comment)
-        assert_equal({id: 1, body: "ZOMG!!"},
-                     serializer.attributes)
+        assert_equal({ id: 1, body: 'ZOMG!!' },
+          serializer.attributes)
       end
 
       def test_attribute_inheritance_with_new_attribute_definition
@@ -46,8 +40,8 @@ module ActiveModel
 
       def test_attribute_inheritance_with_new_attribute
         serializer = @serializer_klass_with_new_attributes.new(@comment)
-        assert_equal({id: 1, body: "ZOMG!!", date: "2015", likes: nil},
-                     serializer.attributes)
+        assert_equal({ id: 1, body: 'ZOMG!!', date: '2015', likes: nil },
+          serializer.attributes)
       end
 
       def test_multiple_calls_with_the_same_attribute

data/test/serializers/cache_test.rb

@@ -9,7 +9,7 @@ module ActiveModel
         @post           = Post.new(title: 'New Post', body: 'Body')
         @bio            = Bio.new(id: 1, content: 'AMS Contributor')
         @author         = Author.new(name: 'Joao M. D. Moura')
-        @blog           = Blog.new(id: 999, name: "Custom blog", writer: @author, articles: [])
+        @blog           = Blog.new(id: 999, name: 'Custom blog', writer: @author, articles: [])
         @role           = Role.new(name: 'Great Author')
         @location       = Location.new(lat: '-23.550520', lng: '-46.633309')
         @place          = Place.new(name: 'Amazing Place')
@@ -58,9 +58,9 @@ module ActiveModel
       end
 
       def test_cache_options_definition
-        assert_equal({expires_in: 0.1, skip_digest: true}, @post_serializer.class._cache_options)
+        assert_equal({ expires_in: 0.1, skip_digest: true }, @post_serializer.class._cache_options)
         assert_equal(nil, @blog_serializer.class._cache_options)
-        assert_equal({expires_in: 1.day, skip_digest: true}, @comment_serializer.class._cache_options)
+        assert_equal({ expires_in: 1.day, skip_digest: true }, @comment_serializer.class._cache_options)
       end
 
       def test_fragment_cache_definition
@@ -118,7 +118,7 @@ module ActiveModel
         hash = render_object_with_cache(@location)
 
         assert_equal(hash, expected_result)
-        assert_equal({place: 'Nowhere'}, ActionController::Base.cache_store.fetch(@location.cache_key))
+        assert_equal({ place: 'Nowhere' }, ActionController::Base.cache_store.fetch(@location.cache_key))
       end
 
       def test_uses_file_digest_in_cache_key
@@ -131,20 +131,20 @@ module ActiveModel
       end
 
       def test_serializer_file_path_on_nix
-        path = "/Users/git/emberjs/ember-crm-backend/app/serializers/lead_serializer.rb"
+        path = '/Users/git/emberjs/ember-crm-backend/app/serializers/lead_serializer.rb'
         caller_line = "#{path}:1:in `<top (required)>'"
         assert_equal caller_line[ActiveModel::Serializer::CALLER_FILE], path
       end
 
       def test_serializer_file_path_on_windows
-        path = "c:/git/emberjs/ember-crm-backend/app/serializers/lead_serializer.rb"
+        path = 'c:/git/emberjs/ember-crm-backend/app/serializers/lead_serializer.rb'
         caller_line = "#{path}:1:in `<top (required)>'"
         assert_equal caller_line[ActiveModel::Serializer::CALLER_FILE], path
       end
 
       def test_digest_caller_file
         contents = "puts 'AMS rocks'!"
-        file = Tempfile.new("some_ruby.rb")
+        file = Tempfile.new('some_ruby.rb')
         file.write(contents)
         path = file.path
         caller_line = "#{path}:1:in `<top (required)>'"
@@ -155,6 +155,7 @@ module ActiveModel
       end
 
       private
+
       def render_object_with_cache(obj)
         ActiveModel::SerializableResource.new(obj).serializable_hash
       end

data/test/serializers/fieldset_test.rb

@@ -3,12 +3,11 @@ require 'test_helper'
 module ActiveModel
   class Serializer
     class FieldsetTest < Minitest::Test
-
       def test_fieldset_with_hash
-        fieldset = ActiveModel::Serializer::Fieldset.new({'post' => ['id', 'title'], 'coment' => ['body']})
+        fieldset = ActiveModel::Serializer::Fieldset.new({ 'post' => %w(id title), 'coment' => ['body'] })
 
         assert_equal(
-          {:post=>[:id, :title], :coment=>[:body]}, 
+          { :post => [:id, :title], :coment => [:body] },
           fieldset.fields
         )
       end
@@ -17,7 +16,7 @@ module ActiveModel
         fieldset = ActiveModel::Serializer::Fieldset.new(['title'], 'post')
 
         assert_equal(
-          {:post => [:title]}, 
+          { :post => [:title] },
           fieldset.fields
         )
       end

data/test/serializers/meta_test.rb

@@ -7,19 +7,19 @@ module ActiveModel
         ActionController::Base.cache_store.clear
         @blog = Blog.new(id: 1,
                          name: 'AMS Hints',
-                         writer: Author.new(id: 2, name: "Steve"),
-                         articles: [Post.new(id: 3, title: "AMS")])
+                         writer: Author.new(id: 2, name: 'Steve'),
+                         articles: [Post.new(id: 3, title: 'AMS')])
       end
 
       def test_meta_is_present_with_root
-        serializer = AlternateBlogSerializer.new(@blog, meta: {total: 10})
+        serializer = AlternateBlogSerializer.new(@blog, meta: { total: 10 })
         adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
         expected = {
           blog: {
             id: 1,
-            title: "AMS Hints"
+            title: 'AMS Hints'
           },
-          "meta" => {
+          'meta' => {
             total: 10
           }
         }
@@ -28,23 +28,23 @@ module ActiveModel
 
       def test_meta_is_not_included_when_root_is_missing
         # load_adapter uses FlattenJson Adapter
-        adapter = load_adapter(meta: {total: 10})
+        adapter = load_adapter(meta: { total: 10 })
         expected = {
           id: 1,
-          title: "AMS Hints"
+          title: 'AMS Hints'
         }
         assert_equal expected, adapter.as_json
       end
 
       def test_meta_key_is_used
-        serializer = AlternateBlogSerializer.new(@blog, meta: {total: 10}, meta_key: "haha_meta")
+        serializer = AlternateBlogSerializer.new(@blog, meta: { total: 10 }, meta_key: 'haha_meta')
         adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
         expected = {
           blog: {
             id: 1,
-            title: "AMS Hints"
+            title: 'AMS Hints'
           },
-          "haha_meta" => {
+          'haha_meta' => {
             total: 10
           }
         }
@@ -52,33 +52,33 @@ module ActiveModel
       end
 
       def test_meta_key_is_used_with_json_api
-        serializer = AlternateBlogSerializer.new(@blog, meta: {total: 10}, meta_key: "haha_meta")
+        serializer = AlternateBlogSerializer.new(@blog, meta: { total: 10 }, meta_key: 'haha_meta')
         adapter = ActiveModel::Serializer::Adapter::JsonApi.new(serializer)
         expected = {
           data: {
-            id: "1",
-            type: "blogs",
-            attributes: { title: "AMS Hints" }
+            id: '1',
+            type: 'blogs',
+            attributes: { title: 'AMS Hints' }
           },
-          "haha_meta" => { total: 10 }
+          'haha_meta' => { total: 10 }
         }
         assert_equal expected, adapter.as_json
       end
 
       def test_meta_is_not_present_on_arrays_without_root
-        serializer = ArraySerializer.new([@blog], meta: {total: 10})
+        serializer = ArraySerializer.new([@blog], meta: { total: 10 })
         # FlattenJSON doesn't have support to root
         adapter = ActiveModel::Serializer::Adapter::FlattenJson.new(serializer)
         expected = [{
           id: 1,
-          name: "AMS Hints",
+          name: 'AMS Hints',
           writer: {
             id: 2,
-            name: "Steve"
+            name: 'Steve'
           },
           articles: [{
             id: 3,
-            title: "AMS",
+            title: 'AMS',
             body: nil
           }]
         }]
@@ -86,20 +86,20 @@ module ActiveModel
       end
 
       def test_meta_is_present_on_arrays_with_root
-        serializer = ArraySerializer.new([@blog], meta: {total: 10}, meta_key: "haha_meta")
+        serializer = ArraySerializer.new([@blog], meta: { total: 10 }, meta_key: 'haha_meta')
         # JSON adapter adds root by default
         adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
         expected = {
           blogs: [{
             id: 1,
-            name: "AMS Hints",
+            name: 'AMS Hints',
             writer: {
               id: 2,
-              name: "Steve"
+              name: 'Steve'
             },
             articles: [{
               id: 3,
-              title: "AMS",
+              title: 'AMS',
               body: nil
             }]
           }],

data/test/serializers/root_test.rb

@@ -3,13 +3,12 @@ require 'test_helper'
 module ActiveModel
   class Serializer
     class RootTest < Minitest::Test
-
       def setup
         @virtual_value = VirtualValue.new(id: 1)
       end
 
       def test_overwrite_root
-        serializer = VirtualValueSerializer.new(@virtual_value, {root: 'smth'})
+        serializer = VirtualValueSerializer.new(@virtual_value, { root: 'smth' })
         assert_equal('smth', serializer.json_key)
       end
 
@@ -17,7 +16,6 @@ module ActiveModel
         serializer = VirtualValueSerializer.new(@virtual_value)
         assert_equal('virtual_value', serializer.json_key)
       end
-
     end
   end
 end

data/test/serializers/serializer_for_test.rb

@@ -26,7 +26,7 @@ module ActiveModel
         end
       end
 
-      class SerializerTest <  Minitest::Test
+      class SerializerTest < Minitest::Test
         class MyProfile < Profile
         end
         class CustomProfile

data/test/support/serialization_testing.rb

@@ -0,0 +1,13 @@
+class Minitest::Test
+  def before_setup
+    ActionController::Base.cache_store.clear
+  end
+
+  def with_adapter(adapter)
+    old_adapter = ActiveModel::Serializer.config.adapter
+    ActiveModel::Serializer.config.adapter = adapter
+    yield
+  ensure
+    ActiveModel::Serializer.config.adapter = old_adapter
+  end
+end

data/test/support/simplecov.rb

@@ -0,0 +1,6 @@
+# https://github.com/colszowka/simplecov/pull/400
+# https://github.com/ruby/ruby/blob/trunk/lib/English.rb
+unless defined?(English)
+  # The exception object passed to +raise+.
+  alias $ERROR_INFO $! # rubocop:disable Style/SpecialGlobalVars
+end

data/test/support/stream_capture.rb

@@ -1,7 +1,7 @@
 # Use cleaner stream testing interface from Rails 5 if available
 # see https://github.com/rails/rails/blob/29959eb59d/activesupport/lib/active_support/testing/stream.rb
 begin
-  require "active_support/testing/stream"
+  require 'active_support/testing/stream'
 rescue LoadError
   module ActiveSupport
     module Testing
@@ -29,7 +29,7 @@ rescue LoadError
         def capture(stream)
           stream = stream.to_s
           captured_stream = Tempfile.new(stream)
-          stream_io = eval("$#{stream}")
+          stream_io = eval("$#{stream}") # rubocop:disable Lint/Eval
           origin_stream = stream_io.dup
           stream_io.reopen(captured_stream)
 

data/test/test_helper.rb

@@ -1,5 +1,16 @@
 require 'bundler/setup'
 
+begin
+  require 'simplecov'
+  # HACK: till https://github.com/colszowka/simplecov/pull/400 is merged and released.
+  # Otherwise you may get:
+  # simplecov-0.10.0/lib/simplecov/defaults.rb:50: warning: global variable `$ERROR_INFO' not initialized
+  require 'support/simplecov'
+  AppCoverage.start
+rescue LoadError
+  STDERR.puts 'Running without SimpleCov'
+end
+
 require 'timecop'
 require 'rails'
 require 'action_controller'
@@ -13,7 +24,6 @@ require 'minitest/autorun'
 # Ensure backward compatibility with Minitest 4
 Minitest::Test = MiniTest::Unit::TestCase unless defined?(Minitest::Test)
 
-
 require 'capture_warnings'
 @capture_warnings = CaptureWarnings.new(fail_build = true)
 @capture_warnings.before_tests
@@ -23,7 +33,7 @@ if Minitest.respond_to?(:after_run)
   end
 else
   at_exit do
-    STDOUT.puts "Minitest.after_run not available."
+    STDOUT.puts 'Minitest.after_run not available.'
     @capture_warnings.after_tests
   end
 end
@@ -36,6 +46,8 @@ require 'support/rails_app'
 
 require 'support/test_case'
 
+require 'support/serialization_testing'
+
 require 'fixtures/active_record'
 
 require 'fixtures/poro'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cheap_ams
 version: !ruby/object:Gem::Version
-  version: 0.10.5
+  version: 0.10.6
 platform: ruby
 authors:
 - Steve Klabnik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-04 00:00:00.000000000 Z
+date: 2015-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -117,6 +117,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".simplecov"
 - ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
@@ -128,6 +131,7 @@ files:
 - cheap_ams.gemspec
 - docs/README.md
 - docs/general/adapters.md
+- docs/general/configuration_options.md
 - docs/general/getting_started.md
 - docs/howto/add_pagination_links.md
 - docs/howto/add_root_key.md
@@ -161,7 +165,8 @@ files:
 - lib/generators/serializer/USAGE
 - lib/generators/serializer/resource_override.rb
 - lib/generators/serializer/serializer_generator.rb
-- lib/generators/serializer/templates/serializer.rb
+- lib/generators/serializer/templates/serializer.rb.erb
+- lib/tasks/rubocop.rake
 - test/action_controller/adapter_selector_test.rb
 - test/action_controller/explicit_serializer_test.rb
 - test/action_controller/json_api/linked_test.rb
@@ -206,12 +211,13 @@ files:
 - test/serializers/options_test.rb
 - test/serializers/root_test.rb
 - test/serializers/serializer_for_test.rb
-- test/serializers/urls_test.rb
 - test/support/rails_app.rb
+- test/support/serialization_testing.rb
+- test/support/simplecov.rb
 - test/support/stream_capture.rb
 - test/support/test_case.rb
 - test/test_helper.rb
-homepage: 
+homepage: https://github.com/rails-api/active_model_serializers
 licenses:
 - MIT
 metadata: {}
@@ -280,8 +286,9 @@ test_files:
 - test/serializers/options_test.rb
 - test/serializers/root_test.rb
 - test/serializers/serializer_for_test.rb
-- test/serializers/urls_test.rb
 - test/support/rails_app.rb
+- test/support/serialization_testing.rb
+- test/support/simplecov.rb
 - test/support/stream_capture.rb
 - test/support/test_case.rb
 - test/test_helper.rb

data/test/serializers/urls_test.rb

@@ -1,26 +0,0 @@
-require 'test_helper'
-
-module ActiveModel
-  class Serializer
-    class UrlsTest < Minitest::Test
-
-      def setup
-        @profile = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
-        @post = Post.new({ title: 'New Post', body: 'Body' })
-        @comment = Comment.new({ id: 1, body: 'ZOMG A COMMENT' })
-        @post.comments = [@comment]
-
-        @profile_serializer = ProfileSerializer.new(@profile)
-        @post_serializer = PostSerializer.new(@post)
-      end
-
-      def test_urls_definition
-        assert_equal([:posts, :comments], @profile_serializer.class._urls)
-      end
-
-      def test_url_definition
-        assert_equal([:comments], @post_serializer.class._urls)
-      end
-    end
-  end
-end