Serializer#attributes => Serializer#serialized

`attributes` sort of implies that it is a collection of things, when in
truth serialized should be able to return a String or `true` or `nil` as
the primitive type for a serialized entity (even though *most* of the
time the return value of Serializer#serialized will be a Hash)

Author: foca

README.md

@@ -11,7 +11,7 @@ gets out of your way. You just write plain ruby.
 
 ``` ruby
 class PersonSerializer < Granola::Serializer
-  def attributes
+  def serialized
     {
       "name" => object.name,
       "email" => object.email,
@@ -99,7 +99,7 @@ generating the JSON response altogether. For example, using Cuba:
 
 ``` ruby
 class UserSerializer < Granola::Serializer
-  def attributes
+  def serialized
     { "id" => object.id, "name" => object.name, "email" => object.email }
   end
 

lib/granola.rb

@@ -47,11 +47,13 @@ def initialize(object)
       @object = object
     end
 
-    # Public: Returns the Hash of attributes that should be serialized into
-    # JSON.
+    # Public: Returns a primitive Object that can be serialized into JSON,
+    # meaning one of `nil`, `true`, `false`, a String, a Numeric, an Array of
+    # primitive objects, or a Hash with String keys and primitive objects as
+    # values.
     #
     # Raises NotImplementedError unless you override in subclasses.
-    def attributes
+    def serialized
       fail NotImplementedError
     end
 
@@ -61,7 +63,7 @@ def attributes
     #
     # Returns a String.
     def to_json(**options)
-      Granola.json.(attributes, options)
+      Granola.json.(serialized, options)
     end
 
     # Public: Returns the MIME type generated by this serializer. By default
@@ -102,8 +104,8 @@ def initialize(list, *args, with: serializer)
     end
 
     # Public: Returns an Array of Hashes that can be serialized into JSON.
-    def attributes
-      @list.map(&:attributes)
+    def serialized
+      @list.map(&:serialized)
     end
   end
 end

lib/granola/helper.rb

@@ -41,7 +41,7 @@ def self.serializer_class_for(object)
   # Internal: Null serializer that transparently handles rendering `nil` in case
   # it's passed.
   class NilClassSerializer < Granola::Serializer
-    def attributes
+    def serialized
       {}
     end
   end

lib/granola/schema.rb

@@ -26,7 +26,7 @@ def schema
       def valid?
         validation_errors.clear
         validation_errors.concat(
-          JSON::Validator.fully_validate(self.class.schema, attributes)
+          JSON::Validator.fully_validate(self.class.schema, serialized)
         )
         validation_errors.empty?
       end
@@ -52,7 +52,7 @@ def validation_errors
   #   serializer = SchemaSerializer.new(PersonSerializer.schema)
   #   serializer.to_json
   class SchemaSerializer < Serializer
-    def attributes
+    def serialized
       {
         "$schema".freeze => "http://json-schema.org/schema#".freeze,
         "type".freeze => "object".freeze

test/helper.rb

@@ -4,7 +4,7 @@
 Person = Struct.new(:name, :age, :updated_at)
 
 class PersonSerializer < Granola::Serializer
-  def attributes
+  def serialized
     { "name" => object.name, "age" => object.age }
   end
 

test/helper_test.rb

@@ -3,7 +3,7 @@
 include Granola::Helper
 
 class CustomSerializer < Granola::Serializer
-  def attributes
+  def serialized
     { "name" => object.name }
   end
 end

test/schema_test.rb

@@ -30,13 +30,13 @@ def self.schema
 
   assert_equal \
     "http://json-schema.org/schema#",
-    serializer.attributes["$schema"]
+    serializer.serialized["$schema"]
 
-  assert_equal "object", serializer.attributes["type"]
-  assert_equal ["name"], serializer.attributes["required"]
+  assert_equal "object", serializer.serialized["type"]
+  assert_equal ["name"], serializer.serialized["required"]
   assert_equal(
     { "type" => "integer" },
-    serializer.attributes["properties"]["age"]
+    serializer.serialized["properties"]["age"]
   )
 end
 

test/serialize_test.rb

@@ -1,7 +1,7 @@
 require "ostruct"
 
 class OpenStructSerializer < Granola::Serializer
-  def attributes
+  def serialized
     object.send(:table).each.with_object({}) do |(key, val), hash|
       hash[key.to_s] = val
     end
@@ -21,7 +21,7 @@ def mime_type
 
   test "serializes the properties" do |object|
     serializer = OpenStructSerializer.new(object)
-    assert_equal({ "a" => 1, "b" => 2, "c" => 3 }, serializer.attributes)
+    assert_equal({ "a" => 1, "b" => 2, "c" => 3 }, serializer.serialized)
   end
 
   test "converts to json" do |object|
@@ -71,7 +71,7 @@ def initialize(object, another)
       @another = another
     end
 
-    def attributes
+    def serialized
       { "foo" => object.foo, "bar" => another.bar }
     end
   end