Integrate with Active Record's .serialize

Define `ActiveResource::Base.dump` and `ActiveResource::Base.load` to
support passing classes directly to [serialize][] as the `:coder`
option:

Writing to String columns
---

Encodes Active Resource instances into a string to be stored in the
database. Decodes strings read from the database into Active Resource
instances.

```ruby
class User < ActiveRecord::Base
  serialize :person, coder: Person
end

class Person < ActiveResource::Base
  schema do
    attribute :name, :string
  end
end

user = User.new
user.person = Person.new name: "Matz"
user.person_before_type_cast # => "{\"name\":\"Matz\"}"
```

Writing string values incorporates the Base.format:

```ruby
Person.format = :xml

user.person = Person.new name: "Matz"
user.person_before_type_cast # => "<?xml version=\"1.0\" encoding=\"UTF-8\"?><person><name>Matz</name></person>"
```

Instances are loaded as persisted when decoded from data containing a
primary key value, and new records when missing a primary key value:

```ruby
user.person = Person.new
user.person.persisted? # => false

user.person = Person.find(1)
user.person.persisted? # => true
```

Writing to JSON and JSONB columns
---

```ruby
class User < ActiveRecord::Base
  serialize :person, coder: ActiveResource::Coder.new(Person, :serializable_hash)
end

class Person < ActiveResource::Base
  schema do
    attribute :name, :string
  end
end

user = User.new
user.person = Person.new name: "Matz"
user.person_before_type_cast # => {"name"=>"Matz"}

user.person.name # => "Matz"
```

The `ActiveResource::Coder` class
===

By default, `#dump` serializes the instance to a string value by
calling `ActiveResource::Base#encode`:

```ruby
user.person_before_type_cast # => "{\"name\":\"Matz\"}"
```

To customize serialization, pass the method name or a block as the second
argument:

```ruby
person = Person.new name: "Matz"

coder = ActiveResource::Coder.new(Person, :serializable_hash)
coder.dump(person) # => {"name"=>"Matz"}

coder = ActiveResource::Coder.new(Person) { |person| person.serializable_hash }
coder.dump(person) # => {"name"=>"Matz"}
```

[serialize]: https://api.rubyonrails.org/classes/ActiveRecord/AttributeMethods/Serialization/ClassMethods.html#method-i-serialize

Author: seanpdoyle

lib/active_resource.rb

@@ -37,12 +37,14 @@ module ActiveResource
 
   autoload :Base
   autoload :Callbacks
+  autoload :Coder
   autoload :Connection
   autoload :CustomMethods
   autoload :Formats
   autoload :HttpMock
   autoload :Rescuable
   autoload :Schema
+  autoload :Serialization
   autoload :Singleton
   autoload :InheritingHash
   autoload :Validations

lib/active_resource/base.rb

@@ -1751,7 +1751,7 @@ class Base
     extend ActiveModel::Naming
     extend ActiveResource::Associations
 
-    include Callbacks, CustomMethods, Validations
+    include Callbacks, CustomMethods, Validations, Serialization
     include ActiveModel::Conversion
     include ActiveModel::ForbiddenAttributesProtection
     include ActiveModel::Serializers::JSON

lib/active_resource/coder.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module ActiveResource
+  # Integrates with Active Record's
+  # {serialize}[link:https://api.rubyonrails.org/classes/ActiveRecord/AttributeMethods/Serialization/ClassMethods.html#method-i-serialize]
+  # method as the <tt>:coder</tt> option.
+  #
+  # Encodes Active Resource instances into a value to be stored in the
+  # database. Decodes values read from the database into Active Resource
+  # instances.
+  #
+  #   class User < ActiveRecord::Base
+  #     serialize :person, coder: ActiveResource::Coder.new(Person)
+  #   end
+  #
+  #   class Person < ActiveResource::Base
+  #     schema do
+  #       attribute :name, :string
+  #     end
+  #   end
+  #
+  #   user = User.new
+  #   user.person = Person.new name: "Matz"
+  #   user.person.name # => "Matz"
+  #
+  # Values are loaded as persisted when decoded from data containing a
+  # primary key value, and new records when missing a primary key value:
+  #
+  #   user.person = Person.new
+  #   user.person.persisted? # => true
+  #
+  #   user.person = Person.find(1)
+  #   user.person.persisted? # => true
+  #
+  # By default, <tt>#dump</tt> serializes the instance to a string value by
+  # calling Base#encode:
+  #
+  #   user.person_before_type_cast # => "{\"name\":\"Matz\"}"
+  #
+  # To customize serialization, pass the method name or a block as the second
+  # argument:
+  #
+  #   person = Person.new name: "Matz"
+  #
+  #   coder = ActiveResource::Coder.new(Person, :serializable_hash)
+  #   coder.dump(person) # => { "name" => "Matz" }
+  #
+  #   coder = ActiveResource::Coder.new(Person) { |person| person.serializable_hash }
+  #   coder.dump(person) # => { "name" => "Matz" }
+  class Coder
+    attr_accessor :resource_class, :encoder
+
+    def initialize(resource_class, encoder_method = :encode, &block)
+      @resource_class = resource_class
+      @encoder = block || encoder_method
+    end
+
+    # Serializes a resource value to a value that will be stored in the database.
+    # Returns nil when passed nil
+    def dump(value)
+      return if value.nil?
+      raise ArgumentError.new("expected value to be #{resource_class}, but was #{value.class}") unless value.is_a?(resource_class)
+
+      value.yield_self(&encoder)
+    end
+
+    # Deserializes a value from the database to a resource instance.
+    # Returns nil when passed nil
+    def load(value)
+      return if value.nil?
+      value = resource_class.format.decode(value) if value.is_a?(String)
+      raise ArgumentError.new("expected value to be Hash, but was #{value.class}") unless value.is_a?(Hash)
+      resource_class.new(value, value[resource_class.primary_key])
+    end
+  end
+end

lib/active_resource/serialization.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module ActiveResource
+  # Compatibilitiy with Active Record's
+  # {serialize}[link:https://api.rubyonrails.org/classes/ActiveRecord/AttributeMethods/Serialization/ClassMethods.html#method-i-serialize]
+  # method as the <tt>:coder</tt> option.
+  #
+  # === Writing to String columns
+  #
+  # Encodes Active Resource instances into a string to be stored in the
+  # database. Decodes strings read from the database into Active Resource
+  # instances.
+  #
+  #   class User < ActiveRecord::Base
+  #     serialize :person, coder: Person
+  #   end
+  #
+  #   class Person < ActiveResource::Base
+  #     schema do
+  #       attribute :name, :string
+  #     end
+  #   end
+  #
+  #   user = User.new
+  #   user.person = Person.new name: "Matz"
+  #
+  # Writing string values incorporates the Base.format:
+  #
+  #   Person.format = :json
+  #
+  #   user.person = Person.new name: "Matz"
+  #   user.person_before_type_cast # => "{\"name\":\"Matz\"}"
+  #
+  #   Person.format = :xml
+  #
+  #   user.person = Person.new name: "Matz"
+  #   user.person_before_type_cast # => "<?xml version=\"1.0\" encoding=\"UTF-8\"?><person><name>Matz</name></person>"
+  #
+  # Instances are loaded as persisted when decoded from data containing a
+  # primary key value, and new records when missing a primary key value:
+  #
+  #   user.person = Person.new
+  #   user.person.persisted? # => false
+  #
+  #   user.person = Person.find(1)
+  #   user.person.persisted? # => true
+  #
+  # === Writing to JSON and JSONB columns
+  #
+  #   class User < ActiveRecord::Base
+  #     serialize :person, coder: ActiveResource::Coder.new(Person, :serializable_hash)
+  #   end
+  #
+  #   class Person < ActiveResource::Base
+  #     schema do
+  #       attribute :name, :string
+  #     end
+  #   end
+  #
+  #   user = User.new
+  #   user.person = Person.new name: "Matz"
+  #   user.person.name # => "Matz"
+  #
+  #   user.person_before_type_cast # => {"name"=>"Matz"}
+  module Serialization
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :coder, instance_accessor: false, instance_predicate: false
+    end
+
+    module ClassMethods
+      delegate :dump, :load, to: :coder
+
+      def inherited(subclass) # :nodoc:
+        super
+        subclass.coder = Coder.new(subclass)
+      end
+    end
+  end
+end

test/cases/base/serialization_test.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+require "abstract_unit"
+require "fixtures/person"
+
+class SerializationTest < ActiveSupport::TestCase
+  test ".load delegates to the .coder" do
+    resource = Person.new(id: 1, name: "Matz")
+
+    encoded = Person.load(resource.encode)
+
+    assert_equal resource.id, encoded.id
+    assert_equal resource.name, encoded.name
+    assert_equal resource.attributes, encoded.attributes
+  end
+
+  test ".load decodes JSON" do
+    previous_value, Person.format = Person.format, :json
+
+    resource = Person.new(id: 1, name: "Matz")
+    json = resource.to_json
+
+    assert_equal resource, Person.load(json)
+  ensure
+    Person.format = previous_value
+  end
+
+  test ".load decodes XML" do
+    previous_value, Person.format = Person.format, :xml
+
+    resource = Person.new(id: 1, name: "Matz")
+    xml = resource.to_xml
+
+    assert_equal resource, Person.load(xml)
+  ensure
+    Person.format = previous_value
+  end
+
+  test ".dump delegates to the default .coder" do
+    resource = Person.new(id: 1, name: "Matz")
+
+    encoded = Person.dump(resource)
+
+    assert_equal resource.encode, encoded
+    assert_equal({ person: { id: 1, name: "Matz" } }.to_json, encoded)
+  end
+
+  test ".dump delegates to a configured .coder method name" do
+    previous_value, Person.coder = Person.coder, ActiveResource::Coder.new(Person, :serializable_hash)
+
+    resource = Person.new(id: 1, name: "Matz")
+
+    assert_equal resource.serializable_hash, Person.dump(resource)
+  ensure
+    Person.coder = previous_value
+  end
+
+  test ".dump delegates to a configured .coder callable" do
+    previous_value, Person.coder = Person.coder, ActiveResource::Coder.new(Person) { |value| value.serializable_hash }
+
+    resource = Person.new(id: 1, name: "Matz")
+
+    assert_equal resource.serializable_hash, Person.dump(resource)
+  ensure
+    Person.coder = previous_value
+  end
+
+  test ".dump encodes JSON" do
+    previous_value, Person.format = Person.format, :json
+
+    resource = Person.new(id: 1, name: "Matz")
+
+    assert_equal resource.to_json, Person.dump(resource)
+  ensure
+    Person.format = previous_value
+  end
+
+  test ".dump encodes XML" do
+    previous_value, Person.format = Person.format, :xml
+
+    resource = Person.new(id: 1, name: "Matz")
+
+    assert_equal resource.to_xml, Person.dump(resource)
+  ensure
+    Person.format = previous_value
+  end
+
+  test "#load returns nil when the encoded value is nil" do
+    assert_nil Person.coder.load(nil)
+  end
+
+  test "#load decodes a String into an instance" do
+    resource = Person.new(id: 1, name: "Matz")
+
+    decoded = Person.coder.load(resource.encode)
+
+    assert_equal resource, decoded
+  end
+
+  test "#load decodes a Hash into an instance" do
+    resource = Person.new(id: 1, name: "Matz")
+
+    decoded = Person.coder.load(resource.serializable_hash)
+
+    assert_equal resource.id, decoded.id
+    assert_equal resource.name, decoded.name
+    assert_equal resource.attributes, decoded.attributes
+  end
+
+  test "#load builds the instance as persisted when the default primary key is present" do
+    resource = Person.new(id: 1, name: "Matz")
+
+    decoded = Person.coder.load(resource.encode)
+
+    assert_predicate decoded, :persisted?
+    assert_not_predicate decoded, :new_record?
+  end
+
+  test "#load builds the instance as persisted when the configured primary key is present" do
+    previous_value, Person.primary_key = Person.primary_key, "pk"
+    resource = Person.new(pk: 1, name: "Matz")
+
+    decoded = Person.coder.load(resource.encode)
+
+    assert_equal 1, decoded.id
+    assert_predicate decoded, :persisted?
+    assert_not_predicate decoded, :new_record?
+  ensure
+    Person.primary_key = previous_value
+  end
+
+  test "#load builds the instance as a new record when the default primary key is absent" do
+    resource = Person.new(name: "Matz")
+
+    decoded = Person.coder.load(resource.encode)
+
+    assert_nil decoded.id
+    assert_not_predicate decoded, :persisted?
+    assert_predicate decoded, :new_record?
+  end
+
+  test "#load builds the instance as a new record when the configured primary key is absent" do
+    previous_value, Person.primary_key = Person.primary_key, "pk"
+
+    resource = Person.new(name: "Matz")
+
+    decoded = Person.coder.load(resource.encode)
+
+    assert_nil decoded.id
+    assert_not_predicate decoded, :persisted?
+    assert_predicate decoded, :new_record?
+  ensure
+    Person.primary_key = previous_value
+  end
+
+  test "#load raises an ArgumentError when passed anything but a String or Hash" do
+    resource = Person.new(name: "Matz")
+    string_value = resource.encode
+    hash_value = resource.attributes
+
+    assert_equal resource, Person.coder.load(string_value)
+    assert_equal resource, Person.coder.load(hash_value)
+    assert_raises(ArgumentError, match: "expected value to be Hash, but was Integer") { Person.coder.load(1) }
+  end
+
+  test "#dump encodes resources" do
+    resource = Person.new(id: 1, name: "Matz")
+
+    encoded = Person.coder.dump(resource)
+
+    assert_equal resource.encode, encoded
+    assert_equal({ person: { id: 1, name: "Matz" } }.to_json, encoded)
+  end
+
+  test "#dump raises an ArgumentError is passed anything but an ActiveResource::Base" do
+    assert_raises ArgumentError, match: "expected value to be Person, but was Integer" do
+      Person.coder.dump(1)
+    end
+  end
+
+  test "#dump returns nil when the resource is nil" do
+    assert_nil Person.coder.dump(nil)
+  end
+
+  test "#dump with an encoder method name returns nil when the resource is nil" do
+    coder = ActiveResource::Coder.new(Person, :serializable_hash)
+
+    assert_nil coder.dump(nil)
+  end
+
+  test "#dump with an encoder method name encodes resources" do
+    coder = ActiveResource::Coder.new(Person, :serializable_hash)
+    resource = Person.new(id: 1, name: "Matz")
+
+    encoded = coder.dump(resource)
+
+    assert_equal resource.serializable_hash, encoded
+  end
+
+  test "#dump with an encoder block encodes resources" do
+    coder = ActiveResource::Coder.new(Person) { |value| value.serializable_hash }
+    resource = Person.new(id: 1, name: "Matz")
+
+    encoded = coder.dump(resource)
+
+    assert_equal resource.serializable_hash, encoded
+  end
+end