More cleanup

Author: bf4

lib/active_model_serializers.rb

@@ -38,6 +38,14 @@ def self.default_include_directive
     @default_include_directive ||= JSONAPI::IncludeDirective.new(config.default_includes, allow_wildcard: true)
   end
 
+  def self.silence_warnings
+    original_verbose = $VERBOSE
+    $VERBOSE = nil
+    yield
+  ensure
+    $VERBOSE = original_verbose
+  end
+
   require 'active_model/serializer/version'
   require 'active_model/serializer'
   require 'active_model/serializable_resource'

lib/active_model_serializers/model.rb

@@ -7,47 +7,56 @@ class Model
     include ActiveModel::Model
 
     class_attribute :attribute_names
+    # Initialize +attribute_names+ for all subclasses.  The array is usually
+    # mutated in the +attributes+ method, but can be set directly, as well.
     self.attribute_names = []
 
     def self.attributes(*names)
-      attr_accessor(*names)
-      self.attribute_names = attribute_names | names.map(&:to_sym)
+      self.attribute_names |= names.map(&:to_sym)
+      # Silence redefinition of methods warnings
+      ActiveModelSerializers.silence_warnings do
+        attr_accessor(*names)
+      end
     end
 
-    attributes :id
-    attr_writer :updated_at
-
     attr_reader :errors
+    # NOTE that +updated_at+ isn't included in +attribute_names+,
+    # which means it won't show up in +attributes+ unless a subclass has
+    # either <tt>attributes :updated_at</tt> which will redefine the methods
+    # or <tt>attribute_names << :updated_at</tt>.
+    attr_writer :updated_at
+    # NOTE that +id+ will always be in +attributes+.
+    attributes :id
 
     def initialize(attributes = {})
       @errors = ActiveModel::Errors.new(self)
       super
     end
 
-    # Defaults to the downcased model name.
-    def id
-      @id ||= self.class.name && self.class.name.downcase
+    # The the fields in +attribute_names+ determines the returned hash.
+    # +attributes+ are returned frozen to prevent any expectations that mutation affects
+    # the actual values in the model.
+    def attributes
+      attribute_names.each_with_object({}) do |attribute_name, result|
+        result[attribute_name] = public_send(attribute_name).freeze
+      end.with_indifferent_access.freeze
     end
 
-    # Defaults to the downcased model name and updated_at
+    # To customize model behavior, this method must be redefined. However,
+    # there are other ways of setting the +cache_key+ a serializer uses.
     def cache_key
       ActiveSupport::Cache.expand_cache_key([
-        self.class.name && self.class.name.downcase,
+        self.class.model_name.name.downcase,
         "#{id}-#{updated_at.strftime('%Y%m%d%H%M%S%9N')}"
       ].compact)
     end
 
-    # Defaults to the time the serializer file was modified.
+    # When no set, defaults to the time the file was modified.
+    # See NOTE by attr_writer :updated_at
     def updated_at
       defined?(@updated_at) ? @updated_at : File.mtime(__FILE__)
     end
 
-    def attributes
-      attribute_names.each_with_object({}) do |attribute_name, result|
-        result[attribute_name] = public_send(attribute_name).freeze
-      end.with_indifferent_access.freeze
-    end
-
     # The following methods are needed to be minimally implemented for ActiveModel::Errors
     # :nocov:
     def self.human_attribute_name(attr, _options = {})

test/collection_serializer_test.rb

@@ -3,10 +3,10 @@
 module ActiveModel
   class Serializer
     class CollectionSerializerTest < ActiveSupport::TestCase
-      SingularModel = poro_without_caching_support
+      class SingularModel < ::Model; end
       class SingularModelSerializer < ActiveModel::Serializer
       end
-      HasManyModel = poro_without_caching_support(::Model) do
+      class HasManyModel < ::Model
         associations :singular_models
       end
       class HasManyModelSerializer < ActiveModel::Serializer

test/fixtures/poro.rb

@@ -3,6 +3,11 @@
 class Model < ActiveModelSerializers::Model
   FILE_DIGEST = Digest::MD5.hexdigest(File.open(__FILE__).read)
 
+  # Defaults to the downcased model name.
+  def id
+    @id ||= self.class.model_name.name.downcase
+  end
+
   # At this time, just for organization of intent
   class_attribute :association_names
   self.association_names = []

test/serializers/options_test.rb

@@ -3,7 +3,7 @@
 module ActiveModel
   class Serializer
     class OptionsTest < ActiveSupport::TestCase
-      ModelWithOptions = poro_without_caching_support do
+      class ModelWithOptions < ActiveModelSerializers::Model
         attributes :name, :description
       end
       class ModelWithOptionsSerializer < ActiveModel::Serializer