active_model_serializers_custom 0.10.90

data/test/generators/scaffold_controller_generator_test.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'generators/rails/resource_override'
+
+class ResourceGeneratorTest < Rails::Generators::TestCase
+  destination File.expand_path('../../../tmp/generators', __FILE__)
+  setup :prepare_destination, :copy_routes
+
+  tests Rails::Generators::ResourceGenerator
+  arguments %w(account)
+
+  def test_serializer_file_is_generated
+    run_generator
+
+    assert_file 'app/serializers/account_serializer.rb', /class AccountSerializer < ActiveModel::Serializer/
+  end
+
+  private
+
+  def copy_routes
+    config_dir = File.join(destination_root, 'config')
+    FileUtils.mkdir_p(config_dir)
+    File.write(File.join(config_dir, 'routes.rb'), 'Rails.application.routes.draw {}')
+  end
+end

data/test/generators/serializer_generator_test.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'generators/rails/resource_override'
+require 'generators/rails/serializer_generator'
+
+class SerializerGeneratorTest < Rails::Generators::TestCase
+  destination File.expand_path('../../../tmp/generators', __FILE__)
+  setup :prepare_destination
+
+  tests Rails::Generators::SerializerGenerator
+  arguments %w(account name:string description:text business:references)
+
+  def test_generates_a_serializer
+    run_generator
+    assert_file 'app/serializers/account_serializer.rb', /class AccountSerializer < ActiveModel::Serializer/
+  end
+
+  def test_generates_a_namespaced_serializer
+    run_generator ['admin/account']
+    assert_file 'app/serializers/admin/account_serializer.rb', /class Admin::AccountSerializer < ActiveModel::Serializer/
+  end
+
+  def test_uses_application_serializer_if_one_exists
+    stub_safe_constantize(expected: 'ApplicationSerializer') do
+      run_generator
+      assert_file 'app/serializers/account_serializer.rb', /class AccountSerializer < ApplicationSerializer/
+    end
+  end
+
+  def test_uses_given_parent
+    Object.const_set(:ApplicationSerializer, Class.new)
+    run_generator ['Account', '--parent=MySerializer']
+    assert_file 'app/serializers/account_serializer.rb', /class AccountSerializer < MySerializer/
+  ensure
+    Object.send :remove_const, :ApplicationSerializer
+  end
+
+  def test_generates_attributes_and_associations
+    run_generator
+    assert_file 'app/serializers/account_serializer.rb' do |serializer|
+      assert_match(/^  attributes :id, :name, :description$/, serializer)
+      assert_match(/^  has_one :business$/, serializer)
+      assert_match(/^end\n*\z/, serializer)
+    end
+  end
+
+  def test_with_no_attributes_does_not_add_extra_space
+    run_generator ['account']
+    assert_file 'app/serializers/account_serializer.rb' do |content|
+      if RUBY_PLATFORM =~ /mingw/
+        assert_no_match(/\r\n\r\nend/, content)
+      else
+        assert_no_match(/\n\nend/, content)
+      end
+    end
+  end
+
+  private
+
+  def stub_safe_constantize(expected:)
+    String.class_eval do
+      alias_method :old, :safe_constantize
+    end
+    String.send(:define_method, :safe_constantize) do
+      Class if self == expected
+    end
+
+    yield
+  ensure
+    String.class_eval do
+      undef_method :safe_constantize
+      alias_method :safe_constantize, :old
+      undef_method :old
+    end
+  end
+end

data/test/grape_test.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+TestHelper.silence_warnings do
+  require 'grape'
+end
+require 'grape/active_model_serializers'
+require 'kaminari'
+require 'kaminari/hooks'
+::Kaminari::Hooks.init
+
+module ActiveModelSerializers
+  class GrapeTest < ActiveSupport::TestCase
+    include Rack::Test::Methods
+    module Models
+      def self.model1
+        ARModels::Post.new(id: 1, title: 'Dummy Title', body: 'Lorem Ipsum')
+      end
+
+      def self.model2
+        ARModels::Post.new(id: 2, title: 'Second Dummy Title', body: 'Second Lorem Ipsum')
+      end
+
+      def self.all
+        @all ||=
+          begin
+            model1.save!
+            model2.save!
+            ARModels::Post.all
+          end
+      end
+
+      def self.reset_all
+        ARModels::Post.delete_all
+        @all = nil
+      end
+
+      def self.collection_per
+        2
+      end
+
+      def self.collection
+        @collection ||=
+          begin
+            Kaminari.paginate_array(
+              [
+                Profile.new(id: 1, name: 'Name 1', description: 'Description 1', comments: 'Comments 1'),
+                Profile.new(id: 2, name: 'Name 2', description: 'Description 2', comments: 'Comments 2'),
+                Profile.new(id: 3, name: 'Name 3', description: 'Description 3', comments: 'Comments 3'),
+                Profile.new(id: 4, name: 'Name 4', description: 'Description 4', comments: 'Comments 4'),
+                Profile.new(id: 5, name: 'Name 5', description: 'Description 5', comments: 'Comments 5')
+              ]
+            ).page(1).per(collection_per)
+          end
+      end
+    end
+
+    class GrapeTest < Grape::API
+      format :json
+      TestHelper.silence_warnings do
+        include Grape::ActiveModelSerializers
+      end
+
+      def self.resources(*)
+        TestHelper.silence_warnings do
+          super
+        end
+      end
+
+      resources :grape do
+        get '/render' do
+          render Models.model1
+        end
+
+        get '/render_with_json_api' do
+          post = Models.model1
+          render post, meta: { page: 1, total_pages: 2 }, adapter: :json_api
+        end
+
+        get '/render_array_with_json_api' do
+          posts = Models.all
+          render posts, adapter: :json_api
+        end
+
+        get '/render_collection_with_json_api' do
+          posts = Models.collection
+          render posts, adapter: :json_api
+        end
+
+        get '/render_with_implicit_formatter' do
+          Models.model1
+        end
+
+        get '/render_array_with_implicit_formatter' do
+          Models.all
+        end
+
+        get '/render_collection_with_implicit_formatter' do
+          Models.collection
+        end
+      end
+    end
+
+    def app
+      Grape::Middleware::Globals.new(GrapeTest.new)
+    end
+
+    extend Minitest::Assertions
+    def self.run_one_method(*)
+      _, stderr = capture_io do
+        super
+      end
+      fail Minitest::Assertion, stderr if stderr !~ /grape/
+    end
+
+    def test_formatter_returns_json
+      get '/grape/render'
+
+      post = Models.model1
+      serializable_resource = serializable(post)
+
+      assert last_response.ok?
+      assert_equal serializable_resource.to_json, last_response.body
+    end
+
+    def test_render_helper_passes_through_options_correctly
+      get '/grape/render_with_json_api'
+
+      post = Models.model1
+      serializable_resource = serializable(post, serializer: ARModels::PostSerializer, adapter: :json_api, meta: { page: 1, total_pages: 2 })
+
+      assert last_response.ok?
+      assert_equal serializable_resource.to_json, last_response.body
+    end
+
+    def test_formatter_handles_arrays
+      get '/grape/render_array_with_json_api'
+
+      posts = Models.all
+      serializable_resource = serializable(posts, adapter: :json_api)
+
+      assert last_response.ok?
+      assert_equal serializable_resource.to_json, last_response.body
+    ensure
+      Models.reset_all
+    end
+
+    def test_formatter_handles_collections
+      get '/grape/render_collection_with_json_api'
+      assert last_response.ok?
+
+      representation = JSON.parse(last_response.body)
+      assert representation.include?('data')
+      assert representation['data'].count == Models.collection_per
+      assert representation.include?('links')
+      assert representation['links'].count > 0
+    end
+
+    def test_implicit_formatter
+      post = Models.model1
+      serializable_resource = serializable(post, adapter: :json_api)
+
+      with_adapter :json_api do
+        get '/grape/render_with_implicit_formatter'
+      end
+
+      assert last_response.ok?
+      assert_equal serializable_resource.to_json, last_response.body
+    end
+
+    def test_implicit_formatter_handles_arrays
+      posts = Models.all
+      serializable_resource = serializable(posts, adapter: :json_api)
+
+      with_adapter :json_api do
+        get '/grape/render_array_with_implicit_formatter'
+      end
+
+      assert last_response.ok?
+      assert_equal serializable_resource.to_json, last_response.body
+    ensure
+      Models.reset_all
+    end
+
+    def test_implicit_formatter_handles_collections
+      with_adapter :json_api do
+        get '/grape/render_collection_with_implicit_formatter'
+      end
+
+      representation = JSON.parse(last_response.body)
+      assert last_response.ok?
+      assert representation.include?('data')
+      assert representation['data'].count == Models.collection_per
+      assert representation.include?('links')
+      assert representation['links'].count > 0
+    end
+  end
+end

data/test/lint_test.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class LintTest < ActiveSupport::TestCase
+      include ActiveModel::Serializer::Lint::Tests
+
+      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 updated_at
+        end
+
+        def errors
+        end
+
+        def self.human_attribute_name(_, _ = {})
+        end
+
+        def self.lookup_ancestors
+        end
+
+        def self.model_name
+          @_model_name ||= ActiveModel::Name.new(self)
+        end
+      end
+
+      def setup
+        @resource = CompliantResource.new
+      end
+    end
+  end
+end

data/test/logger_test.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module ActiveModelSerializers
+  class LoggerTest < ActiveSupport::TestCase
+    def test_logger_is_set_to_action_controller_logger_when_initializer_runs
+      assert_equal $action_controller_logger, ActionController::Base.logger # rubocop:disable Style/GlobalVars
+    end
+
+    def test_logger_can_be_set
+      original_logger = ActiveModelSerializers.logger
+      logger = Logger.new(STDOUT)
+
+      ActiveModelSerializers.logger = logger
+
+      assert_equal ActiveModelSerializers.logger, logger
+    ensure
+      ActiveModelSerializers.logger = original_logger
+    end
+  end
+end

data/test/poro_test.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class PoroTest < ActiveSupport::TestCase
+  include ActiveModel::Serializer::Lint::Tests
+
+  def setup
+    @resource = Model.new
+  end
+end

data/test/serializable_resource_test.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module ActiveModelSerializers
+  class SerializableResourceTest < ActiveSupport::TestCase
+    def setup
+      @resource = Profile.new(name: 'Name 1', description: 'Description 1', comments: 'Comments 1')
+      @serializer = ProfileSerializer.new(@resource)
+      @adapter = ActiveModelSerializers::Adapter.create(@serializer)
+      @serializable_resource = SerializableResource.new(@resource)
+    end
+
+    def test_deprecation
+      assert_output(nil, /deprecated/) do
+        deprecated_serializable_resource = ActiveModel::SerializableResource.new(@resource)
+        assert_equal(@serializable_resource.as_json, deprecated_serializable_resource.as_json)
+      end
+    end
+
+    def test_serializable_resource_delegates_serializable_hash_to_the_adapter
+      options = nil
+      assert_equal @adapter.serializable_hash(options), @serializable_resource.serializable_hash(options)
+    end
+
+    def test_serializable_resource_delegates_to_json_to_the_adapter
+      options = nil
+      assert_equal @adapter.to_json(options), @serializable_resource.to_json(options)
+    end
+
+    def test_serializable_resource_delegates_as_json_to_the_adapter
+      options = nil
+      assert_equal @adapter.as_json(options), @serializable_resource.as_json(options)
+    end
+
+    def test_use_adapter_with_adapter_option
+      assert SerializableResource.new(@resource, adapter: 'json').use_adapter?
+    end
+
+    def test_use_adapter_with_adapter_option_as_false
+      refute SerializableResource.new(@resource, adapter: false).use_adapter?
+    end
+
+    class SerializableResourceErrorsTest < Minitest::Test
+      def test_serializable_resource_with_errors
+        options = nil
+        resource = ModelWithErrors.new
+        resource.errors.add(:name, 'must be awesome')
+        serializable_resource = ActiveModelSerializers::SerializableResource.new(
+          resource,             serializer: ActiveModel::Serializer::ErrorSerializer,
+                                adapter: :json_api
+        )
+        expected_response_document = {
+          errors: [
+            { source: { pointer: '/data/attributes/name' }, detail: 'must be awesome' }
+          ]
+        }
+        assert_equal serializable_resource.as_json(options), expected_response_document
+      end
+
+      def test_serializable_resource_with_collection_containing_errors
+        options = nil
+        resources = []
+        resources << resource = ModelWithErrors.new
+        resource.errors.add(:title, 'must be amazing')
+        resources << ModelWithErrors.new
+        serializable_resource = SerializableResource.new(
+          resources, serializer: ActiveModel::Serializer::ErrorsSerializer,
+                     each_serializer: ActiveModel::Serializer::ErrorSerializer,
+                     adapter: :json_api
+        )
+        expected_response_document = {
+          errors: [
+            { source: { pointer: '/data/attributes/title' }, detail: 'must be amazing' }
+          ]
+        }
+        assert_equal serializable_resource.as_json(options), expected_response_document
+      end
+    end
+  end
+end