cheap_ams 0.10.0.rc2

data/test/capture_warnings.rb

@@ -0,0 +1,57 @@
+# https://raw.githubusercontent.com/metric_fu/metric_fu/master/spec/capture_warnings.rb
+require "tempfile"
+require "fileutils"
+
+class CaptureWarnings
+  def initialize(fail_on_warnings = true)
+    @fail_on_warnings = fail_on_warnings
+    @stderr_file = Tempfile.new("app.stderr")
+    @app_root ||= Dir.pwd
+    @output_dir = File.join(app_root, "tmp")
+    FileUtils.mkdir_p(output_dir)
+    @bundle_dir = File.join(app_root, "bundle")
+  end
+
+  def before_tests
+    $stderr.reopen(stderr_file.path)
+    $VERBOSE = true
+    at_exit { $stderr.reopen(STDERR) }
+  end
+
+  def after_tests
+    stderr_file.rewind
+    lines = stderr_file.read.split("\n")
+    stderr_file.close!
+
+    $stderr.reopen(STDERR)
+
+    app_warnings, other_warnings = lines.partition { |line|
+      line.include?(app_root) && !line.include?(bundle_dir)
+    }
+
+    if app_warnings.any?
+      puts <<-WARNINGS
+#{'-' * 30} app warnings: #{'-' * 30}
+
+#{app_warnings.join("\n")}
+
+#{'-' * 75}
+      WARNINGS
+    end
+
+    if other_warnings.any?
+      File.write(File.join(output_dir, "warnings.txt"), other_warnings.join("\n") << "\n")
+      puts
+      puts "Non-app warnings written to tmp/warnings.txt"
+      puts
+    end
+
+    # fail the build...
+    if fail_on_warnings && app_warnings.any?
+      abort "Failing build due to app warnings: #{app_warnings.inspect}"
+    end
+  end
+
+  private
+  attr_reader :stderr_file, :app_root, :output_dir, :bundle_dir, :fail_on_warnings
+end

data/test/fixtures/active_record.rb

@@ -0,0 +1,57 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+ActiveRecord::Schema.define do
+  create_table :posts, force: true do |t|
+    t.string :title
+    t.text :body
+    t.references :author
+    t.timestamps null: false
+  end
+  create_table :authors, force: true do |t|
+    t.string :name
+    t.timestamps null: false
+  end
+  create_table :comments, force: true do |t|
+    t.text :contents
+    t.references :author
+    t.references :post
+    t.timestamp null: false
+  end
+end
+
+module ARModels
+  class Post < ActiveRecord::Base
+    has_many :comments
+    belongs_to :author
+  end
+
+  class Comment < ActiveRecord::Base
+    belongs_to :post
+    belongs_to :author
+  end
+
+  class Author < ActiveRecord::Base
+    has_many :posts
+  end
+
+  class PostSerializer < ActiveModel::Serializer
+    attributes :id, :title, :body
+
+    has_many :comments
+    belongs_to :author
+    url :comments
+  end
+
+  class CommentSerializer < ActiveModel::Serializer
+    attributes :id, :contents
+
+    belongs_to :author
+  end
+
+  class AuthorSerializer < ActiveModel::Serializer
+    attributes :id, :name
+
+    has_many :posts
+  end
+end

data/test/fixtures/poro.rb

@@ -0,0 +1,266 @@
+verbose = $VERBOSE
+$VERBOSE = nil
+class Model
+  FILE_DIGEST = Digest::MD5.hexdigest(File.open(__FILE__).read)
+
+  def self.model_name
+    @_model_name ||= ActiveModel::Name.new(self)
+  end
+
+  def initialize(hash={})
+    @attributes = hash
+  end
+
+  def cache_key
+    "#{self.class.name.downcase}/#{self.id}-#{self.updated_at.strftime("%Y%m%d%H%M%S%9N")}"
+  end
+
+  def serializable_hash(options = nil)
+    @attributes
+  end
+
+  def read_attribute_for_serialization(name)
+    if name == :id || name == 'id'
+      id
+    else
+      @attributes[name]
+    end
+  end
+
+  def id
+    @attributes[:id] || @attributes['id'] || object_id
+  end
+
+  ### Helper methods, not required to be serializable
+  #
+  # Convenience for adding @attributes readers and writers
+  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
+
+  def cache_key_with_digest
+    "#{cache_key}/#{FILE_DIGEST}"
+  end
+
+  def updated_at
+    @attributes[:updated_at] ||= DateTime.now.to_time
+  end
+end
+
+class Profile < Model
+end
+
+class ProfileSerializer < ActiveModel::Serializer
+  attributes :name, :description
+
+  urls :posts, :comments
+
+  def arguments_passed_in?
+    options[:my_options] == :accessible
+  end
+end
+
+class ProfilePreviewSerializer < ActiveModel::Serializer
+  attributes :name
+
+  urls :posts, :comments
+end
+
+Post     = Class.new(Model)
+Like     = Class.new(Model)
+Author   = Class.new(Model)
+Bio      = Class.new(Model)
+Blog     = Class.new(Model)
+Role     = Class.new(Model)
+User     = Class.new(Model)
+Location = Class.new(Model)
+Place    = Class.new(Model)
+Tag      = Class.new(Model)
+VirtualValue = Class.new(Model)
+Comment  = Class.new(Model) do
+  # Uses a custom non-time-based cache key
+  def cache_key
+    "#{self.class.name.downcase}/#{self.id}"
+  end
+end
+
+module Spam; end
+Spam::UnrelatedLink = Class.new(Model)
+
+PostSerializer = Class.new(ActiveModel::Serializer) do
+  cache key:'post', expires_in: 0.1, skip_digest: true
+  attributes :id, :title, :body
+
+  has_many :comments
+  belongs_to :blog
+  belongs_to :author
+  url :comments
+
+  def blog
+    Blog.new(id: 999, name: "Custom blog")
+  end
+
+  def custom_options
+    options
+  end
+end
+
+SpammyPostSerializer = Class.new(ActiveModel::Serializer) do
+  attributes :id
+  has_many :related
+
+  def self.root_name
+    'posts'
+  end
+end
+
+CommentSerializer = Class.new(ActiveModel::Serializer) do
+  cache expires_in: 1.day, skip_digest: true
+  attributes :id, :body
+
+  belongs_to :post
+  belongs_to :author
+
+  def custom_options
+    options
+  end
+end
+
+AuthorSerializer = Class.new(ActiveModel::Serializer) do
+  cache key:'writer', skip_digest: true
+  attribute :id
+  attribute :name
+
+  has_many :posts
+  has_many :roles
+  has_one :bio
+end
+
+RoleSerializer = Class.new(ActiveModel::Serializer) do
+  cache only: [:name], skip_digest: true
+  attributes :id, :name, :description, :slug
+
+  def slug
+    "#{name}-#{id}"
+  end
+
+  belongs_to :author
+end
+
+LikeSerializer = Class.new(ActiveModel::Serializer) do
+  attributes :id, :time
+
+  belongs_to :likeable
+end
+
+LocationSerializer = Class.new(ActiveModel::Serializer) do
+  cache only: [:place], skip_digest: true
+  attributes :id, :lat, :lng
+
+  belongs_to :place
+
+  def place
+    'Nowhere'
+  end
+end
+
+PlaceSerializer = Class.new(ActiveModel::Serializer) do
+  attributes :id, :name
+
+  has_many :locations
+end
+
+BioSerializer = Class.new(ActiveModel::Serializer) do
+  cache except: [:content], skip_digest: true
+  attributes :id, :content, :rating
+
+  belongs_to :author
+end
+
+BlogSerializer = Class.new(ActiveModel::Serializer) do
+  cache key: 'blog'
+  attributes :id, :name
+
+  belongs_to :writer
+  has_many :articles
+end
+
+PaginatedSerializer = Class.new(ActiveModel::Serializer::ArraySerializer) do
+  def json_key
+    'paginated'
+  end
+end
+
+AlternateBlogSerializer = Class.new(ActiveModel::Serializer) do
+  attribute :id
+  attribute :name, key: :title
+end
+
+CustomBlogSerializer = Class.new(ActiveModel::Serializer) do
+  attribute :id
+  attribute :special_attribute
+
+  has_many :articles
+end
+
+CommentPreviewSerializer = Class.new(ActiveModel::Serializer) do
+  attributes :id
+
+  belongs_to :post
+end
+
+AuthorPreviewSerializer = Class.new(ActiveModel::Serializer) do
+  attributes :id
+
+  has_many :posts
+end
+
+PostPreviewSerializer = Class.new(ActiveModel::Serializer) do
+  def self.root_name
+    'posts'
+  end
+
+  attributes :title, :body, :id
+
+  has_many :comments, serializer: CommentPreviewSerializer
+  belongs_to :author, serializer: AuthorPreviewSerializer
+end
+
+PostWithTagsSerializer = Class.new(ActiveModel::Serializer) do
+  attributes :id
+
+  has_many :tags
+end
+
+PostWithCustomKeysSerializer = Class.new(ActiveModel::Serializer) do
+  attributes :id
+
+  has_many :comments, key: :reviews
+  belongs_to :author, key: :writer
+  has_one :blog, key: :site
+end
+
+VirtualValueSerializer = Class.new(ActiveModel::Serializer) do
+  attributes :id
+
+  has_many :reviews, virtual_value: [{id: 1}, {id: 2}]
+  has_one :maker, virtual_value: {id: 1}
+
+  def reviews
+  end
+
+  def maker
+  end
+end
+
+Spam::UnrelatedLinkSerializer = Class.new(ActiveModel::Serializer) do
+  cache only: [:id]
+  attributes :id
+end
+$VERBOSE = verbose

data/test/generators/scaffold_controller_generator_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+# require 'active_model/serializer/railtie'
+
+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,56 @@
+require 'test_helper'
+require 'generators/serializer/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
+    Object.const_set(:ApplicationSerializer, Class.new)
+    run_generator
+    assert_file "app/serializers/account_serializer.rb", /class AccountSerializer < ApplicationSerializer/
+  ensure
+    Object.send :remove_const, :ApplicationSerializer
+  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
+end

data/test/lint_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class LintTest < Minitest::Test
+      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 self.model_name
+          @_model_name ||= ActiveModel::Name.new(self)
+        end
+      end
+
+      def setup
+        @resource = CompliantResource.new
+      end
+
+    end
+  end
+end

data/test/poro_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class PoroTest < Minitest::Test
+  include ActiveModel::Serializer::Lint::Tests
+
+  def setup
+    @resource = Model.new
+  end
+end

data/test/serializable_resource_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+module ActiveModel
+  class SerializableResourceTest < Minitest::Test
+    def setup
+      @resource = Profile.new({ name: 'Name 1', description: 'Description 1', comments: 'Comments 1' })
+      @serializer = ProfileSerializer.new(@resource)
+      @adapter = ActiveModel::Serializer::Adapter.create(@serializer)
+      @serializable_resource = ActiveModel::SerializableResource.new(@resource)
+    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
+  end
+end

data/test/serializers/adapter_for_test.rb

@@ -0,0 +1,50 @@
+module ActiveModel
+  class Serializer
+    class AdapterForTest < Minitest::Test
+      def setup
+        @previous_adapter = ActiveModel::Serializer.config.adapter
+      end
+
+      def teardown
+        ActiveModel::Serializer.config.adapter = @previous_adapter
+      end
+
+      def test_returns_default_adapter
+        adapter = ActiveModel::Serializer.adapter
+        assert_equal ActiveModel::Serializer::Adapter::FlattenJson, adapter
+      end
+
+      def test_overwrite_adapter_with_symbol
+        ActiveModel::Serializer.config.adapter = :null
+
+        adapter = ActiveModel::Serializer.adapter
+        assert_equal ActiveModel::Serializer::Adapter::Null, adapter
+      ensure
+
+      end
+
+      def test_overwrite_adapter_with_class
+        ActiveModel::Serializer.config.adapter = ActiveModel::Serializer::Adapter::Null
+
+        adapter = ActiveModel::Serializer.adapter
+        assert_equal ActiveModel::Serializer::Adapter::Null, adapter
+      end
+
+      def test_raises_exception_if_invalid_symbol_given
+        ActiveModel::Serializer.config.adapter = :unknown
+
+        assert_raises ArgumentError do
+          ActiveModel::Serializer.adapter
+        end
+      end
+
+      def test_raises_exception_if_it_does_not_know_hot_to_infer_adapter
+        ActiveModel::Serializer.config.adapter = 42
+
+        assert_raises ArgumentError do
+          ActiveModel::Serializer.adapter
+        end
+      end
+    end
+  end
+end

data/test/serializers/association_macros_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+module ActiveModel
+  class Serializer
+    class AssociationMacrosTest < Minitest::Test
+      AuthorSummarySerializer = Class.new
+      class AssociationsTestSerializer < Serializer
+        belongs_to :author, serializer: AuthorSummarySerializer
+        has_many :comments
+        has_one :category
+      end
+
+      def before_setup
+        @reflections = AssociationsTestSerializer._reflections
+      end
+
+      def test_has_one_defines_reflection
+        has_one_reflection = HasOneReflection.new(:category, {})
+
+        assert_includes(@reflections, has_one_reflection)
+      end
+
+      def test_has_many_defines_reflection
+        has_many_reflection = HasManyReflection.new(:comments, {})
+
+        assert_includes(@reflections, has_many_reflection)
+      end
+
+      def test_belongs_to_defines_reflection
+        belongs_to_reflection = BelongsToReflection.new(:author, serializer: AuthorSummarySerializer)
+
+        assert_includes(@reflections, belongs_to_reflection)
+      end
+    end
+  end
+end