tiny_serializer 2.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3f2930aab86eaf43af0326633d4698fdd4f1e51
+  data.tar.gz: 297b7d9fb72d0075853448ec056e7ea596c2e4fd
+SHA512:
+  metadata.gz: 6c3ab366f4a4e5bcabc111d78ad10eae27ce23c23f54d2f009963b09005adae9dfcbb534755352ba7750923db7e099cdf297f6f1e8c9177df98ffc9cc4ae86bf
+  data.tar.gz: 959b2a9e76f0303615dab63a52cb52a76b3861362832530139e196e583b91bdc9c1110bd90b1fc9e76c99c18da0fb6dc182296b3059d865dc7d6c44cfcfebbda

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+.idea
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/html/
+
+.DS_Store
+Thumbs.db
+._*
+~*
+*~
+*.swp
+.vscode

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,23 @@
+---
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Exclude:
+    - "**/*_spec.rb"
+
+# We might want to make this work on an old Ruby sometime.
+Style/SafeNavigation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "**/*_spec.rb"
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: false
+
+Layout/EmptyLines:
+  Exclude:
+    - "**/*_spec.rb"

data/.ruby-version

@@ -0,0 +1 @@
+2.4.5

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.5
+  - 2.5.3
+before_install: gem install bundler -v 1.17.1
+bundler_args:
+script:
+  - bundle exec rake spec
+  - bundle exec rake build

data/CHANGELOG.md

@@ -0,0 +1,73 @@
+# SimpleSerializer Change Log
+
+## 2.0.2
+
+* Fix major incorrect require statement.
+
+## 2.0.1
+
+* Bump version so I can publish under the correct rubygems account.
+
+## 2.0.0
+
+* Rename to "tiny_serializer" and push to rubygems.org.
+* Update .travis.yml ruby versions to 2.4.5 and 2.5.3
+* Minor rubocop config tweaks and add frozen\_string_literal to specs.
+
+## 1.0.0
+
+* Remove netflix/fast_jsonapi NOOP compatibily methods.
+* Rubocop style improvements.
+
+## 0.5.3
+
+* Raise ArgumentError if serialize_each called without a collection.
+  (Helps find unexpected values earlier in testing.)
+
+## 0.5.2
+
+* Fix place I forgot to create a new serializer instance.
+
+## 0.5.1
+
+* Fix `key` arguments not being passed around correctly.
+* Minor code clarity improvements.
+
+## 0.5.0
+
+* Pass options to has_many definition block.
+* Use a new serializer instance to serialize each item in a collection.
+
+## 0.4.0
+
+* Implement options parameter (from AMS).
+* Raises ArgumentError if a specified serializer is not actually a
+  SimpleSerializer subclass.
+* Add note to README.md about attribute inheritance.
+
+## 0.3.1
+
+* Fix bug where collections would be checked for existence before serialization,
+  causing unnecessary database queries.
+
+## 0.3.0
+
+* Fix blocks not being passed on to the #sub_record method.
+* Major documentation improvements.
+* Code cleanup and simplification.
+* Travis CI config improvements.
+* Allow #as_json and #to_json to take arguments.
+
+## 0.2.1
+
+* Remove lack of inheritance as a downside!
+
+## 0.2.0
+
+* Implement serialized attribute inheritance.
+* README improvements.
+* Add this CHANGELOG.
+
+## 0.1.0
+
+* Initial post to Reddit.

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in simple_serializer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    tiny_serializer (2.0.2)
+      activesupport (>= 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  rake (~> 10.0)
+  rspec (~> 3.5)
+  tiny_serializer!
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 William Makley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,239 @@
+# TinySerializer
+
+Simple DSL for converting objects to Hashes, which is mostly API-compatible with
+[ActiveModel::Serializers](https://github.com/rails-api/active_model_serializers).
+Not quite a drop-in replacement, but facilitates migrating away from it.
+The resulting Hashes can be rendered as JSON by Rails using the ActiveSupport::JSON
+module.
+
+Unlike AMS, it does **not** integrate with Rails for automatic usage with the `render` function,
+which has proven to be one of the biggest sources of confusion and complexity for me.
+`render json: @object` will continue to work exactly as it does in a base Rails setup.
+
+Use if you have heavily invested in [active_model_serializers](https://github.com/rails-api/active_model_serializers), but have started experiencing the same frustrations I had with it and can't transition to [jsonapi-rb](http://jsonapi-rb.org/) or [fast_jsonapi](https://github.com/Netflix/fast_jsonapi).
+
+![Travis CI Build Status](https://travis-ci.org/wmakley/tiny_serializer.svg?branch=master)
+
+**Benefits:**
+
+* Extremely simple and deterministic behavior; no adapter classes and other complications. Just turns Objects into Hashes.
+* Easy to understand; uses `#as_json` to serialize attributes.
+* Simple and explicit invocation.
+* Does not leak memory in development.
+* ~200 lines of code, give or take.
+* Seems pretty darn fast, at least as fast as `public_send`, `Hash#[]=`, and `Hash#to_json` can be.
+
+**Downsides:**
+
+* Uses `#as_json` to serialize attributes (maybe unintended consequences, especially with complex objects).
+* Requires ActiveSupport.
+
+## Usage
+
+### Serializer definition:
+
+```ruby
+MyObject = Struct.new(:id, :first_name, :last_name, :date) do
+  def parent; nil; end
+  def sub_record; nil; end
+  def related_items; []; end
+end
+
+class MyObjectSerializer < TinySerializer
+  attributes :id,
+             :first_name,
+             :last_name,
+             :date
+
+  belongs_to :parent, serializer: ParentSerializer
+  has_one :sub_record # serializer will be inferred to be SubRecordSerializer
+  has_many :related_items, serializer: RelatedItemSerializer
+
+  attribute :full_name do |object|
+    "#{object.first_name} #{object.last_name}"
+  end
+end
+```
+
+**Notes on blocks:**
+
+The `object` parameter for blocks is optional, as blocks are executed
+in the context of the serializer instance. It just makes it easier
+to use the [fast_jsonapi](https://github.com/Netflix/fast_jsonapi) gem later if you want.
+
+### Usage:
+
+```ruby
+object = MyObject.new(...)
+# Several ways to invoke the serializer are available:
+MyObjectSerializer.new(object).serialize
+MyObjectSerializer.serialize(object)
+```
+
+Produces:
+
+```json
+{
+  "id": 1,
+  "first_name": "Fred",
+  "last_name": "Flintstone",
+  "date": "2000-01-01",
+  "full_name": "Fred Flintstone",
+  "parent": null,
+  "sub_record": null,
+  "related_items": []
+}
+```
+
+### Usage in Rails:
+
+In Rails, calling `.serialize` is optional because **TinySerializer** implements all the 'magic' methods (`as_json`, `to_json`, and `serializable_hash`), although I'm not the biggest fan (it loses some explicitness):
+
+```ruby
+@model = MyObject.new(1, "Fred", "Flintstone", Date.new(2000, 1, 1))
+render json: MyObjectSerializer.new(@model)
+```
+
+### Under the Hood
+
+Takes every attribute you define, and uses it to call `#public_send` on the object to serialize,
+then uses `#as_json` to serialize the resulting value. If you define the attribute with a block, it will call the block to get the value instead.
+
+### Usage with Collections:
+
+Collections are handled automatically:
+
+```ruby
+class MyObjectSerializer < TinySerializer
+  attributes :id, :first_name
+end
+
+items = [
+  MyObject.new(1, "Fred"),
+  MyObject.new(2, "Wilma")
+]
+MyObjectSerializer.new(items).serialize
+```
+
+Produces:
+
+```json
+[
+  {"id": 1, "name": "Fred"},
+  {"id": 2, "name": "Wilma"}
+]
+```
+
+### Defining Associations and Serializing Sub-Objects
+
+The DSL methods `belongs_to`, `has_one`, and `has_many` are all synonyms for "use this serializer to serialize this property". They are basically syntax sugar for:
+
+```ruby
+class MySerializer < TinySerializer
+  attribute :parent do |object|
+    ParentSerializer.new(object.parent).serialize
+  end
+end
+```
+
+These methods all optionally take a block, which you can use to customize the
+object or collection. For example, to avoid loading every single item in a
+`has_many` relation:
+
+```ruby
+class MySerializer < TinySerializer
+  has_many :items, serializer: ItemSerializer do |object|
+    object.items.limit(100)
+  end
+end
+```
+
+### Links and URL's
+
+When used with Rails, serializer instances have the `#url_helpers`
+method available.
+
+
+```ruby
+class ItemSerializer < TinySerializer
+  attribute :link do
+    url_helpers.item_path(object)
+  end
+end
+```
+
+### Notes on ID's.
+
+If you don't want ID's to be serialized as numeric types,
+you can have them automatically detected and coerced to Strings.
+
+```ruby
+class MyObjectSerializer < TinySerializer
+  self.coerce_ids_to_string = true
+end
+```
+
+To enable globally, but opt out for a specific attribute:
+
+```ruby
+class MyObjectSerializer < TinySerializer
+  self.coerce_ids_to_string = true
+
+  attribute :id, is_id: false
+end
+
+### Notes on Options
+
+If you want to pass in options to the serializer you can access via the second argument of the block
+
+
+class MyObjectSerializer < TinySerializer
+  attribute :id do |object, options|
+    options[:prefix] + object.id
+  end
+end
+```
+MyObjectSerializer.new(object, { prefix: "prefix_" }).serialize
+
+Produces:
+
+{
+  id: "prefix_id"
+}
+
+### Attribute Inheritance
+
+Attributes are inherited from parent classes, but can be extended.
+This example works as you would expect from [active_model_serializers](https://github.com/rails-api/active_model_serializers)
+(the `name` attribute will only appear if you use `MyObjectSerializer::WithName.serialize(my_object)`):
+
+```ruby
+class MyObjectSerializer < TinySerializer
+  attribute :id
+
+  class WithName < MyObjectSerializer
+    attribute :name
+  end
+end
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tiny_serializer', '~> 2.0.0'
+```
+
+And then execute:
+
+    $ bundle
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wmakley/tiny_serializer.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+begin
+  require "rdoc/task"
+  RDoc::Task.new do |rdoc|
+    rdoc.main = "README.md"
+    rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
+  end
+rescue LoadError
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tiny_serializer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tiny_serializer/dsl.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/string/inflections"
+
+class TinySerializer
+  # The TinySerializer class macros.
+  module DSL
+    # Get all the sub-record attribute definitions (created by #belongs_to,
+    # #has_one, etc.)
+    def sub_records
+      @sub_records ||=
+        if superclass.respond_to?(:sub_records)
+          superclass.sub_records.dup
+        else
+          []
+        end
+    end
+
+    # Get only the names of the sub-record attribute definitions (created by
+    # #belongs_to, #has_one, etc.)
+    def sub_record_names
+      sub_records.map(&:first)
+    end
+
+    # Get all the collection definitions (created by #has_many).
+    def collections
+      @collections ||=
+        if superclass.respond_to?(:collections)
+          superclass.collections.dup
+        else
+          []
+        end
+    end
+
+    # Get only the names of the collections definitions (created by #has_many).
+    def collection_names
+      collections.map(&:first)
+    end
+
+    # Definite a new attribute to serialize. The value to serialize is retrieved
+    # in one of two ways:
+    #
+    # 1. *Default:* Calls #public_send(name) on TinySerializer#object.
+    # 2. *Block:* The return value of the block is used.
+    #
+    # name::
+    #   The name of the attribute
+    # key::
+    #   Optional. Defaults to *name*. The Hash key to assign the attribute's
+    #   value to.
+    # is_id::
+    #   Optional. Whether the attribute is a database ID. Guessed from its name
+    #   by default.
+    #
+    def attribute(name, key: name, is_id: _is_id?(name), &block)
+      _initialize_attributes
+      name = name.to_sym
+      attribute = [name, key, is_id, block]
+      @attributes << attribute
+      return attribute
+    end
+
+    # Define multiple attributes at once, using the defaults.
+    def attributes(*names)
+      if names && !names.empty?
+        names.each do |name|
+          attribute(name)
+        end
+      else
+        _initialize_attributes
+      end
+      return @attributes
+    end
+
+    # Get the names of all attributes defined using #attribute.
+    def attribute_names
+      attributes.map(&:first)
+    end
+
+    # Alias of #sub_record
+    def has_one(association_name, key: association_name, serializer: nil, &block)
+      sub_record(association_name, key: key, serializer: serializer, &block)
+    end
+
+    # Alias of #sub_record
+    def belongs_to(association_name, key: association_name, serializer: nil, &block)
+      sub_record(association_name, key: key, serializer: serializer, &block)
+    end
+
+    # Define a serializer to use for a sub-object of TinySerializer#object.
+    # <b>If given a block:</b> Will use the block to retrieve the
+    # object, instead of public_send(name).
+    #
+    # name::
+    #   The method name of the sub-object.
+    # serializer::
+    #   Optional. The serializer class to use. Inferred from name if blank.
+    #   Must be a subclass of TinySerializer.
+    # key::
+    #   Optional. Defaults to *name*. The Hash key to assign the sub-record's
+    #   JSON to.
+    #
+    def sub_record(name, key: name, serializer: nil, &block)
+      if serializer.nil?
+        serializer = "#{name.to_s.camelize}Serializer".constantize
+      elsif !_is_serializer?(serializer)
+        raise ArgumentError, "#{serializer} does not appear to be a TinySerializer"
+      end
+
+      sub_records << [name, key, serializer, block]
+    end
+
+    # Alias of #collection
+    def has_many(name, key: name, serializer: nil, &block)
+      collection(name, key: key, serializer: serializer, &block)
+    end
+
+    # Define a serializer to use to serialize a collection of objects
+    # as an Array. Will call #public_send(name) on TinySerializer#object
+    # to get the items in the collection, or use the return value of
+    # the block.
+    #
+    # name::
+    #   The name of the collection.
+    # key::
+    #   Optional. Defaults to *name*. The Hash key to assign the serialized
+    #   Array to.
+    # serializer::
+    #   Optional, inferred from *collection_name*. The serializer class to use
+    #   to serialize each item in the collection. Must be a subclass of
+    #   TinySerializer.
+    #
+    def collection(name, key: name, serializer: nil, &block)
+      if serializer.nil?
+        serializer = "#{name.to_s.singularize.camelize}Serializer".constantize
+      elsif !_is_serializer?(serializer)
+        raise ArgumentError, "#{serializer} does not appear to be a TinySerializer"
+      end
+      collections << [name, key, serializer, block]
+    end
+
+    # Private method to initialize inherited attributes.
+    def _initialize_attributes # :nodoc:
+      @attributes ||=
+        if superclass.respond_to?(:attributes)
+          superclass.attributes.dup
+        else
+          []
+        end
+    end
+
+    # Private method to check if an attribute name is an ID.
+    def _is_id?(name) # :nodoc:
+      name == :id || name.to_s.end_with?("_id")
+    end
+
+    # Private method to check if a class is a TinySerializer subclass
+    def _is_serializer?(klass)
+      klass <= TinySerializer
+    end
+  end
+end

data/lib/tiny_serializer/rails_extensions.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class TinySerializer
+  # Small convenience improvements to TinySerializer
+  # that are automatically included as serializer instance methods
+  # when used in a Rails app.
+  module RailsExtensions
+    # Alias of +Rails.application.routes.url_helpers+.
+    def url_helpers
+      Rails.application.routes.url_helpers
+    end
+
+    # Return +Rails.logger+ if TinySerializer#logger is not set.
+    def logger
+      super || Rails.logger
+    end
+  end
+end

data/lib/tiny_serializer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class TinySerializer
+  VERSION = "2.0.2"
+end

data/lib/tiny_serializer.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+require "tiny_serializer/version"
+require "tiny_serializer/dsl"
+require "active_support/json"
+require "active_support/core_ext/class/attribute"
+
+# Simple DSL for converting objects to Hashes, which is mostly API-compatible
+# with ActiveModel::Serializer. The Hashes can be rendered as JSON by Rails.
+#
+# I have also added some fast_jsonapi[https://github.com/Netflix/fast_jsonapi]
+# API parameters that do nothing, to ease later transition to that library.
+#
+# == Usage
+#
+#   # my_object.rb
+#   MyObject = Struct.new(:id, :first_name, :last_name, :date) do
+#     def parent; nil; end
+#     def sub_record; nil; end
+#     def related_items; []; end
+#   end
+#
+#   # my_object_serializer.rb
+#   class MyObjectSerializer < TinySerializer
+#     attributes :id,
+#                :first_name,
+#                :last_name,
+#                :date
+#
+#     belongs_to :parent, serializer: ParentSerializer
+#     has_one :sub_record # serializer will be inferred to be SubRecordSerializer
+#     has_many :related_items, serializer: RelatedItemSerializer
+#
+#     attribute :full_name do
+#       "#{object.first_name} #{object.last_name}"
+#     end
+#   end
+#
+#   # my_objects_controller.rb
+#   def show
+#     @my_object = MyObject.new(1, "Fred", "Flintstone", Date.new(2000, 1, 1))
+#     render json: MyObjectSerializer.new(@my_object).serialize
+#   end
+#
+# == RailsExtensions
+#
+# The RailsExtensions module is automatically prepended when TinySerializer
+# is used in a Rails app. It defines some small convenience instance methods.
+#
+class TinySerializer
+  extend DSL
+
+  if defined?(Rails)
+    require "tiny_serializer/rails_extensions"
+    prepend RailsExtensions
+  end
+
+  # Whether to automatically convert "\*_id" properties to String.
+  # *default:* _false_
+  class_attribute :coerce_ids_to_string, default: false
+
+  # The object to serialize as a Hash
+  attr_accessor :object
+
+  # Hash of data to be passed to blocks
+  attr_accessor :options
+
+  # Optional logger object. Defaults to Rails.logger in a Rails app.
+  attr_accessor :logger
+
+  # Create a new serializer instance.
+  #
+  # object::
+  #   The object to serialize. Can be a single object or a collection of
+  #   objects.
+  def initialize(object, options = {})
+    @object = object
+    @options = options
+  end
+
+  # Serialize #object as a Hash with Symbol keys.
+  # Returns nil if #object is nil.
+  def serializable_hash(_ = nil)
+    return serialize_single_object_to_hash unless collection?
+
+    json = []
+    @object.each do |object|
+      json << self.class.new(object, @options).serializable_hash
+    end
+    json
+  end
+
+  alias to_hash serializable_hash
+  alias serialize serializable_hash
+
+  # Serialize #object as a Hash, then call #as_json on the Hash,
+  # which will convert keys to Strings.
+  #
+  # <b>There shouldn't be a need to call this, but we implement it to fully
+  # support ActiveSupport's magic JSON protocols.</b>
+  def as_json(_ = nil)
+    serializable_hash.as_json
+  end
+
+  # Serialize #object to a JSON String.
+  #
+  # Calls #serializable_hash, then call #to_json on the resulting Hash,
+  # converting it to a String using the automatic facilities for doing so
+  # from ActiveSupport.
+  def to_json(_ = nil)
+    serializable_hash.to_json
+  end
+
+  # Return true if #object is a collection.
+  def collection?
+    self.class.is_collection?(@object)
+  end
+
+  # = Class Methods
+  class << self
+    # The same as:
+    #
+    #   TinySerializer.new(object).serializable_hash
+    def serialize(object)
+      new(object).serializable_hash
+    end
+
+    # Same as #serialize, but raises ArgumentError if `collection`
+    # doesn't appear to be a collection.
+    def serialize_each(collection)
+      raise ArgumentError, "collection does not appear to be a collection" unless is_collection?(collection)
+      new(collection).serializable_hash
+    end
+
+    # Check if #object is a collection.
+    def is_collection?(object)
+      object.respond_to?(:each) && !object.respond_to?(:each_pair)
+    end
+  end
+
+  private
+
+  # Private serialization implementation for a single object.
+  # @object must be a single object.
+  def serialize_single_object_to_hash
+    return nil if @object.nil?
+
+    hash = {}
+    serialize_attributes(hash)
+    serialize_sub_records(hash)
+    serialize_collections(hash)
+    hash
+  end
+
+  def serialize_attributes(hash)
+    self.class.attributes.each do |name, key, is_id, block|
+      raw_value = get_attribute(name, block)
+      hash[key] = serialize_attribute(raw_value, is_id)
+    end
+  end
+
+  def get_attribute(name, block)
+    if block
+      instance_exec(@object, @options, &block)
+    else
+      @object.public_send(name)
+    end
+  end
+
+  # Internal algorithm to convert any object to a valid JSON string, scalar,
+  # object, array, etc. All objects are passed through this function after they
+  # are retrieved from #object. Currently just calls #as_json.
+  def serialize_attribute(raw_value, is_id = false)
+    if is_id && coerce_ids_to_string?
+      serialize_id(raw_value)
+    else
+      raw_value.as_json
+    end
+  end
+
+  def serialize_id(id)
+    id && id.to_s
+  end
+
+  def serialize_sub_records(hash)
+    self.class.sub_records.each do |name, key, serializer, block|
+      record = get_attribute(name, block)
+      hash[key] = serializer.new(record, @options).serializable_hash
+    end
+  end
+
+  def serialize_collections(hash)
+    self.class.collections.each do |collection_name, key, serializer, block|
+      collection = get_collection(collection_name, block)
+
+      json_array = []
+      collection.each do |object|
+        json_array << serializer.new(object, @options).serializable_hash
+      end
+
+      hash[key] = json_array
+    end
+  end
+
+  # Get the collection from #object or block, or [] if nil.
+  def get_collection(name, block)
+    if block
+      instance_exec(@object, @options, &block)
+    else
+      @object.public_send(name)
+    end || []
+  end
+end

data/tiny_serializer.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tiny_serializer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tiny_serializer"
+  spec.version       = TinySerializer::VERSION
+  spec.authors       = ["William Makley"]
+  spec.email         = ["william@pioneerstreet.com"]
+
+  spec.summary       = %q{Tiny Ruby JSON Serialization DSL}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/wmakley/simple_serializer.git"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 4.2"
+
+  spec.add_development_dependency "bundler", "~> 1.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: tiny_serializer
+version: !ruby/object:Gem::Version
+  version: 2.0.2
+platform: ruby
+authors:
+- William Makley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: 
+email:
+- william@pioneerstreet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/vcs.xml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tiny_serializer.rb
+- lib/tiny_serializer/dsl.rb
+- lib/tiny_serializer/rails_extensions.rb
+- lib/tiny_serializer/version.rb
+- tiny_serializer.gemspec
+homepage: https://github.com/wmakley/simple_serializer.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.3
+signing_key: 
+specification_version: 4
+summary: Tiny Ruby JSON Serialization DSL
+test_files: []