cheap_ams 0.10.0.rc2

data/test/serializers/associations_test.rb

@@ -0,0 +1,150 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class AssociationsTest < Minitest::Test
+      class Model
+        def initialize(hash={})
+          @attributes = hash
+        end
+
+        def read_attribute_for_serialization(name)
+          @attributes[name]
+        end
+
+        def method_missing(meth, *args)
+          if meth.to_s =~ /^(.*)=$/
+            @attributes[$1.to_sym] = args[0]
+          elsif @attributes.key?(meth)
+            @attributes[meth]
+          else
+            super
+          end
+        end
+      end
+
+      def setup
+        @author = Author.new(name: 'Steve K.')
+        @author.bio = nil
+        @author.roles = []
+        @blog = Blog.new({ name: 'AMS Blog' })
+        @post = Post.new({ title: 'New Post', body: 'Body' })
+        @tag = Tag.new({name: '#hashtagged'})
+        @comment = Comment.new({ id: 1, body: 'ZOMG A COMMENT' })
+        @post.comments = [@comment]
+        @post.tags = [@tag]
+        @post.blog = @blog
+        @comment.post = @post
+        @comment.author = nil
+        @post.author = @author
+        @author.posts = [@post]
+
+        @post_serializer = PostSerializer.new(@post, {custom_options: true})
+        @author_serializer = AuthorSerializer.new(@author)
+        @comment_serializer = CommentSerializer.new(@comment)
+      end
+
+      def test_has_many_and_has_one
+        @author_serializer.associations.each do |association|
+          key = association.key
+          serializer = association.serializer
+          options = association.options
+
+          case key
+          when :posts
+            assert_equal({}, options)
+            assert_kind_of(ActiveModel::Serializer.config.array_serializer, serializer)
+          when :bio
+            assert_equal({}, options)
+            assert_nil serializer
+          when :roles
+            assert_equal({}, options)
+            assert_kind_of(ActiveModel::Serializer.config.array_serializer, serializer)
+          else
+            flunk "Unknown association: #{key}"
+          end
+        end
+      end
+
+      def test_has_many_with_no_serializer
+        PostWithTagsSerializer.new(@post).associations.each do |association|
+          key = association.key
+          serializer = association.serializer
+          options = association.options
+
+          assert_equal key, :tags
+          assert_equal serializer, nil
+          assert_equal [{ attributes: { name: "#hashtagged" }}].to_json, options[:virtual_value].to_json
+        end
+      end
+
+      def test_serializer_options_are_passed_into_associations_serializers
+        association = @post_serializer
+                        .associations
+                        .detect { |assoc| assoc.key == :comments }
+
+        assert association.serializer.first.custom_options[:custom_options]
+      end
+
+      def test_belongs_to
+        @comment_serializer.associations.each do |association|
+          key = association.key
+          serializer = association.serializer
+
+          case key
+          when :post
+            assert_kind_of(PostSerializer, serializer)
+          when :author
+            assert_nil serializer
+          else
+            flunk "Unknown association: #{key}"
+          end
+
+          assert_equal({}, association.options)
+        end
+      end
+
+      def test_belongs_to_with_custom_method
+        assert(
+          @post_serializer.associations.any? do |association|
+            association.key == :blog
+          end
+        )
+      end
+
+      def test_associations_inheritance
+        inherited_klass = Class.new(PostSerializer)
+
+        assert_equal(PostSerializer._reflections, inherited_klass._reflections)
+      end
+
+      def test_associations_inheritance_with_new_association
+        inherited_klass = Class.new(PostSerializer) do
+          has_many :top_comments, serializer: CommentSerializer
+        end
+
+        assert(
+          PostSerializer._reflections.all? do |reflection|
+            inherited_klass._reflections.include?(reflection)
+          end
+        )
+
+        assert(
+          inherited_klass._reflections.any? do |reflection|
+            reflection.name == :top_comments
+          end
+        )
+      end
+
+      def test_associations_custom_keys
+        serializer = PostWithCustomKeysSerializer.new(@post)
+
+        expected_association_keys = serializer.associations.map(&:key)
+
+        assert expected_association_keys.include? :reviews
+        assert expected_association_keys.include? :writer
+        assert expected_association_keys.include? :site
+      end
+    end
+  end
+end

data/test/serializers/attribute_test.rb

@@ -0,0 +1,62 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class AttributeTest < Minitest::Test
+      def setup
+        @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)
+      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)
+      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)
+      end
+
+      def test_multiple_calls_with_the_same_attribute
+        serializer_class = Class.new(ActiveModel::Serializer) do
+          attribute :title
+          attribute :title
+        end
+
+        assert_equal([:title], serializer_class._attributes)
+      end
+
+      def test_id_attribute_override
+        serializer = Class.new(ActiveModel::Serializer) do
+          attribute :name, key: :id
+        end
+
+        adapter = ActiveModel::Serializer::Adapter::Json.new(serializer.new(@blog))
+        assert_equal({ blog: { id: "AMS Hints" } }, adapter.serializable_hash)
+      end
+
+      def test_type_attribute
+        attribute_serializer = Class.new(ActiveModel::Serializer) do
+          attribute :id, key: :type
+        end
+        attributes_serializer = Class.new(ActiveModel::Serializer) do
+          attributes :type
+        end
+
+        adapter = ActiveModel::Serializer::Adapter::Json.new(attribute_serializer.new(@blog))
+        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)
+      end
+    end
+  end
+end

data/test/serializers/attributes_test.rb

@@ -0,0 +1,63 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class AttributesTest < Minitest::Test
+      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")
+        @serializer_klass = Class.new(CommentSerializer)
+        @serializer_klass_with_new_attributes = Class.new(CommentSerializer) do
+          attributes :date, :likes
+        end
+      end
+
+      def test_attributes_definition
+        assert_equal([:name, :description],
+                     @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]))
+
+      end
+
+      def test_attributes_inheritance_definition
+        assert_equal([:id, :body], @serializer_klass._attributes)
+      end
+
+      def test_attributes_inheritance
+        serializer = @serializer_klass.new(@comment)
+        assert_equal({id: 1, body: "ZOMG!!"},
+                     serializer.attributes)
+      end
+
+      def test_attribute_inheritance_with_new_attribute_definition
+        assert_equal([:id, :body, :date, :likes], @serializer_klass_with_new_attributes._attributes)
+        assert_equal([:id, :body], CommentSerializer._attributes)
+      end
+
+      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)
+      end
+
+      def test_multiple_calls_with_the_same_attribute
+        serializer_class = Class.new(ActiveModel::Serializer) do
+          attributes :id, :title
+          attributes :id, :title, :title, :body
+        end
+
+        assert_equal([:id, :title, :body], serializer_class._attributes)
+      end
+    end
+  end
+end

data/test/serializers/cache_test.rb

@@ -0,0 +1,164 @@
+require 'test_helper'
+require 'tempfile'
+module ActiveModel
+  class Serializer
+    class CacheTest < Minitest::Test
+      def setup
+        ActionController::Base.cache_store.clear
+        @comment        = Comment.new(id: 1, body: 'ZOMG A COMMENT')
+        @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: [])
+        @role           = Role.new(name: 'Great Author')
+        @location       = Location.new(lat: '-23.550520', lng: '-46.633309')
+        @place          = Place.new(name: 'Amazing Place')
+        @author.posts   = [@post]
+        @author.roles   = [@role]
+        @role.author    = @author
+        @author.bio     = @bio
+        @bio.author     = @author
+        @post.comments  = [@comment]
+        @post.author    = @author
+        @comment.post   = @post
+        @comment.author = @author
+        @post.blog      = @blog
+        @location.place = @place
+
+        @location_serializer = LocationSerializer.new(@location)
+        @bio_serializer      = BioSerializer.new(@bio)
+        @role_serializer     = RoleSerializer.new(@role)
+        @post_serializer     = PostSerializer.new(@post)
+        @author_serializer   = AuthorSerializer.new(@author)
+        @comment_serializer  = CommentSerializer.new(@comment)
+        @blog_serializer     = BlogSerializer.new(@blog)
+      end
+
+      def test_cache_definition
+        assert_equal(ActionController::Base.cache_store, @post_serializer.class._cache)
+        assert_equal(ActionController::Base.cache_store, @author_serializer.class._cache)
+        assert_equal(ActionController::Base.cache_store, @comment_serializer.class._cache)
+      end
+
+      def test_cache_key_definition
+        assert_equal('post', @post_serializer.class._cache_key)
+        assert_equal('writer', @author_serializer.class._cache_key)
+        assert_equal(nil, @comment_serializer.class._cache_key)
+      end
+
+      def test_cache_key_interpolation_with_updated_at
+        render_object_with_cache(@author)
+        assert_equal(nil, ActionController::Base.cache_store.fetch(@author.cache_key))
+        assert_equal(@author_serializer.attributes.to_json, ActionController::Base.cache_store.fetch("#{@author_serializer.class._cache_key}/#{@author_serializer.object.id}-#{@author_serializer.object.updated_at.strftime("%Y%m%d%H%M%S%9N")}").to_json)
+      end
+
+      def test_default_cache_key_fallback
+        render_object_with_cache(@comment)
+        assert_equal(@comment_serializer.attributes.to_json, ActionController::Base.cache_store.fetch(@comment.cache_key).to_json)
+      end
+
+      def test_cache_options_definition
+        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)
+      end
+
+      def test_fragment_cache_definition
+        assert_equal([:name], @role_serializer.class._cache_only)
+        assert_equal([:content], @bio_serializer.class._cache_except)
+      end
+
+      def test_associations_separately_cache
+        ActionController::Base.cache_store.clear
+        assert_equal(nil, ActionController::Base.cache_store.fetch(@post.cache_key))
+        assert_equal(nil, ActionController::Base.cache_store.fetch(@comment.cache_key))
+
+        Timecop.freeze(Time.now) do
+          render_object_with_cache(@post)
+
+          assert_equal(@post_serializer.attributes, ActionController::Base.cache_store.fetch(@post.cache_key))
+          assert_equal(@comment_serializer.attributes, ActionController::Base.cache_store.fetch(@comment.cache_key))
+        end
+      end
+
+      def test_associations_cache_when_updated
+        # Clean the Cache
+        ActionController::Base.cache_store.clear
+
+        Timecop.freeze(Time.now) do
+          # Generate a new Cache of Post object and each objects related to it.
+          render_object_with_cache(@post)
+
+          # Check if it cached the objects separately
+          assert_equal(@post_serializer.attributes, ActionController::Base.cache_store.fetch(@post.cache_key))
+          assert_equal(@comment_serializer.attributes, ActionController::Base.cache_store.fetch(@comment.cache_key))
+
+          # Simulating update on comments relationship with Post
+          new_comment            = Comment.new(id: 2, body: 'ZOMG A NEW COMMENT')
+          new_comment_serializer = CommentSerializer.new(new_comment)
+          @post.comments         = [new_comment]
+
+          # Ask for the serialized object
+          render_object_with_cache(@post)
+
+          # Check if the the new comment was cached
+          assert_equal(new_comment_serializer.attributes, ActionController::Base.cache_store.fetch(new_comment.cache_key))
+          assert_equal(@post_serializer.attributes, ActionController::Base.cache_store.fetch(@post.cache_key))
+        end
+      end
+
+      def test_fragment_fetch_with_virtual_associations
+        expected_result = {
+          id: @location.id,
+          lat: @location.lat,
+          lng: @location.lng,
+          place: 'Nowhere'
+        }
+
+        hash = render_object_with_cache(@location)
+
+        assert_equal(hash, expected_result)
+        assert_equal({place: 'Nowhere'}, ActionController::Base.cache_store.fetch(@location.cache_key))
+      end
+
+      def test_uses_file_digest_in_cache_key
+        render_object_with_cache(@blog)
+        assert_equal(@blog_serializer.attributes, ActionController::Base.cache_store.fetch(@blog.cache_key_with_digest))
+      end
+
+      def test_cache_digest_definition
+        assert_equal(::Model::FILE_DIGEST, @post_serializer.class._cache_digest)
+      end
+
+      def test_serializer_file_path_on_nix
+        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"
+        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.write(contents)
+        path = file.path
+        caller_line = "#{path}:1:in `<top (required)>'"
+        file.close
+        assert_equal ActiveModel::Serializer.digest_caller_file(caller_line), Digest::MD5.hexdigest(contents)
+      ensure
+        file.unlink
+      end
+
+      private
+      def render_object_with_cache(obj)
+        ActiveModel::SerializableResource.new(obj).serializable_hash
+      end
+    end
+  end
+end
+

data/test/serializers/configuration_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class ConfigurationTest < Minitest::Test
+      def test_array_serializer
+        assert_equal ActiveModel::Serializer::ArraySerializer, ActiveModel::Serializer.config.array_serializer
+      end
+
+      def test_default_adapter
+        assert_equal :flatten_json, ActiveModel::Serializer.config.adapter
+      end
+    end
+  end
+end

data/test/serializers/fieldset_test.rb

@@ -0,0 +1,26 @@
+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']})
+
+        assert_equal(
+          {:post=>[:id, :title], :coment=>[:body]}, 
+          fieldset.fields
+        )
+      end
+
+      def test_fieldset_with_array_of_fields_and_root_name
+        fieldset = ActiveModel::Serializer::Fieldset.new(['title'], 'post')
+
+        assert_equal(
+          {:post => [:title]}, 
+          fieldset.fields
+        )
+      end
+    end
+  end
+end

data/test/serializers/meta_test.rb

@@ -0,0 +1,121 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class MetaTest < Minitest::Test
+      def setup
+        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")])
+      end
+
+      def test_meta_is_present_with_root
+        serializer = AlternateBlogSerializer.new(@blog, meta: {total: 10})
+        adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
+        expected = {
+          blog: {
+            id: 1,
+            title: "AMS Hints"
+          },
+          "meta" => {
+            total: 10
+          }
+        }
+        assert_equal expected, adapter.as_json
+      end
+
+      def test_meta_is_not_included_when_root_is_missing
+        # load_adapter uses FlattenJson Adapter
+        adapter = load_adapter(meta: {total: 10})
+        expected = {
+          id: 1,
+          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")
+        adapter = ActiveModel::Serializer::Adapter::Json.new(serializer)
+        expected = {
+          blog: {
+            id: 1,
+            title: "AMS Hints"
+          },
+          "haha_meta" => {
+            total: 10
+          }
+        }
+        assert_equal expected, adapter.as_json
+      end
+
+      def test_meta_key_is_used_with_json_api
+        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" }
+          },
+          "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})
+        # FlattenJSON doesn't have support to root
+        adapter = ActiveModel::Serializer::Adapter::FlattenJson.new(serializer)
+        expected = [{
+          id: 1,
+          name: "AMS Hints",
+          writer: {
+            id: 2,
+            name: "Steve"
+          },
+          articles: [{
+            id: 3,
+            title: "AMS",
+            body: nil
+          }]
+        }]
+        assert_equal expected, adapter.as_json
+      end
+
+      def test_meta_is_present_on_arrays_with_root
+        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",
+            writer: {
+              id: 2,
+              name: "Steve"
+            },
+            articles: [{
+              id: 3,
+              title: "AMS",
+              body: nil
+            }]
+          }],
+          'haha_meta' => {
+            total: 10
+          }
+        }
+        assert_equal expected, adapter.as_json
+      end
+
+      private
+
+      def load_adapter(options)
+        options = options.merge(adapter: :flatten_json, serializer: AlternateBlogSerializer)
+        ActiveModel::SerializableResource.new(@blog, options)
+      end
+    end
+  end
+end

data/test/serializers/options_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class OptionsTest < Minitest::Test
+      def setup
+        @profile = Profile.new(name: 'Name 1', description: 'Description 1')
+      end
+
+      def test_options_are_accessible
+        @profile_serializer = ProfileSerializer.new(@profile, my_options: :accessible)
+        assert @profile_serializer.arguments_passed_in?
+      end
+
+      def test_no_option_is_passed_in
+        @profile_serializer = ProfileSerializer.new(@profile)
+        refute @profile_serializer.arguments_passed_in?
+      end
+    end
+  end
+end

data/test/serializers/root_test.rb

@@ -0,0 +1,23 @@
+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'})
+        assert_equal('smth', serializer.json_key)
+      end
+
+      def test_underscore_in_root
+        serializer = VirtualValueSerializer.new(@virtual_value)
+        assert_equal('virtual_value', serializer.json_key)
+      end
+
+    end
+  end
+end