adequate_serialization 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de42ee593fdcb4fafa1b10217deb4ca0668925680d9d7280e928a02e968a11c4
-  data.tar.gz: 71233f85c7cac26fd422f9e71f24b53fc063edae544284c9d07751c97f988c70
+  metadata.gz: 03131aa7cf99954e57efd860d550cf64fa3d796fa4a7c5b549dc160a75059e26
+  data.tar.gz: 34ad30c7accb106bd39e6682eaf0cd80f3cd4c7b22d8506aa25365ea1798886e
 SHA512:
-  metadata.gz: 3422db6a91f8474ccc00420458e4f0d62fac1611a78b62264e73fea5f1fdfdaac9017d247f8242a8e29f2917f933ddd189985e359f8bd6426b52807f544d0466
-  data.tar.gz: 528cf6375346a18ad6ed69684319f48027753d9d5ad742936e8759d83a04dcba21d2a2d8cc1710fdb40fd326d1a5f10ea8b269dc89fee5d0f20c3c07841ae9b9
+  metadata.gz: 4177f51b69b61fc4a0f0eab2b1bbf4e4492683205790720745cdce8473c9cef662d78b92b03201a107fb7d36e3328a882ad9c68f8d8c78056f83fca3b667e61e
+  data.tar.gz: fa4c554c06075a3a57af62e092169fdd669d57ee98d38f1699178ad341f2341886fa2dcb0af64fe45f09b48c79496f47da9bde86ec28e3b625b68d934297db58

data/.github/workflows/push.yml

@@ -0,0 +1,46 @@
+on: push
+name: Push
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: Install
+      uses: docker://culturehq/actions-bundler:latest
+      with:
+        args: install
+    - name: Test
+      uses: docker://culturehq/actions-bundler:latest
+      with:
+        args: exec rake test
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: Install
+      uses: docker://culturehq/actions-bundler:latest
+      with:
+        args: install
+    - name: Lint
+      uses: docker://culturehq/actions-bundler:latest
+      with:
+        args: exec rubocop --parallel
+  audit:
+    name: Audit
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: Install
+      uses: docker://culturehq/actions-bundler:latest
+      with:
+        args: install
+    - name: Update
+      uses: docker://culturehq/actions-bundler:latest
+      with:
+        args: exec bundle audit --update
+    - name: Audit
+      uses: docker://culturehq/actions-bundler:latest
+      with:
+        args: exec bundle audit

data/.mergify.yml

@@ -0,0 +1,12 @@
+pull_request_rules:
+  - name: Automatically merge dependencies
+    conditions:
+      - base=master
+      - label=dependencies
+      - status-success=Test
+      - status-success=Lint
+      - status-success=Audit
+    actions:
+      merge:
+        strict: true
+      delete_head_branch: {}

data/CHANGELOG.md

@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [1.0.1] - 2019-12-31
+### Changed
+- Fix up Ruby 2.7 warnings.
+
 ## [1.0.0] - 2019-03-25
 ### Added
 - The ability to define serializers inline in the object they're serializing.
@@ -20,6 +24,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 ### Changed
 - No longer trigger another query when the `ActiveRecord` relation being serialized isn't loaded.
 
-[Unreleased]: https://github.com/CultureHQ/adequate_serialization/compare/v1.0.0...HEAD
+[unreleased]: https://github.com/CultureHQ/adequate_serialization/compare/v1.0.1...HEAD
+[1.0.1]: https://github.com/CultureHQ/adequate_serialization/compare/v1.0.0...v1.0.1
 [1.0.0]: https://github.com/CultureHQ/adequate_serialization/compare/v0.1.1...v1.0.0
-[0.1.1]: https://github.com/CultureHQ/adequate_serialization/compare/v0.1.0...v0.1.1
+[0.1.1]: https://github.com/CultureHQ/adequate_serialization/compare/fcc7c7...v0.1.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at support@culturehq.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/Gemfile

@@ -4,5 +4,5 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'rails', '~> 5.2'
-gem 'sqlite3', '= 1.3.13' # can't be upgraded until next version of rails
+gem 'rails', '~> 6.0'
+gem 'sqlite3', '~> 1.4'

data/Gemfile.lock

@@ -1,69 +1,82 @@
 PATH
   remote: .
   specs:
-    adequate_serialization (1.0.0)
+    adequate_serialization (1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.2.2.1)
-      actionpack (= 5.2.2.1)
+    actioncable (6.0.2.1)
+      actionpack (= 6.0.2.1)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailer (5.2.2.1)
-      actionpack (= 5.2.2.1)
-      actionview (= 5.2.2.1)
-      activejob (= 5.2.2.1)
+    actionmailbox (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      activestorage (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      mail (>= 2.7.1)
+    actionmailer (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      actionview (= 6.0.2.1)
+      activejob (= 6.0.2.1)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.2.2.1)
-      actionview (= 5.2.2.1)
-      activesupport (= 5.2.2.1)
-      rack (~> 2.0)
+    actionpack (6.0.2.1)
+      actionview (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.2.1)
-      activesupport (= 5.2.2.1)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      activestorage (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.2.1)
+      activesupport (= 6.0.2.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.2.2.1)
-      activesupport (= 5.2.2.1)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.2.1)
+      activesupport (= 6.0.2.1)
       globalid (>= 0.3.6)
-    activemodel (5.2.2.1)
-      activesupport (= 5.2.2.1)
-    activerecord (5.2.2.1)
-      activemodel (= 5.2.2.1)
-      activesupport (= 5.2.2.1)
-      arel (>= 9.0)
-    activestorage (5.2.2.1)
-      actionpack (= 5.2.2.1)
-      activerecord (= 5.2.2.1)
+    activemodel (6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activerecord (6.0.2.1)
+      activemodel (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activestorage (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
       marcel (~> 0.3.1)
-    activesupport (5.2.2.1)
+    activesupport (6.0.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (9.0.0)
+      zeitwerk (~> 2.2)
     ast (2.4.0)
-    builder (3.2.3)
+    builder (3.2.4)
     bundler-audit (0.6.1)
       bundler (>= 1.2.0, < 3)
       thor (~> 0.18)
     concurrent-ruby (1.1.5)
-    crass (1.0.4)
-    docile (1.3.1)
-    erubi (1.8.0)
+    crass (1.0.5)
+    docile (1.3.2)
+    erubi (1.9.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    i18n (1.6.0)
+    i18n (1.7.0)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.2)
+    jaro_winkler (1.5.4)
     json (2.2.0)
-    loofah (2.2.3)
+    loofah (2.4.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -72,75 +85,76 @@ GEM
       mimemagic (~> 0.3.2)
     method_source (0.9.2)
     mimemagic (0.3.3)
-    mini_mime (1.0.1)
+    mini_mime (1.0.2)
     mini_portile2 (2.4.0)
-    minitest (5.11.3)
-    nio4r (2.3.1)
-    nokogiri (1.10.2)
+    minitest (5.13.0)
+    nio4r (2.5.2)
+    nokogiri (1.10.7)
       mini_portile2 (~> 2.4.0)
-    parallel (1.15.0)
-    parser (2.6.2.0)
+    parallel (1.19.1)
+    parser (2.6.5.0)
       ast (~> 2.4.0)
-    psych (3.1.0)
-    rack (2.0.6)
+    rack (2.0.8)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (5.2.2.1)
-      actioncable (= 5.2.2.1)
-      actionmailer (= 5.2.2.1)
-      actionpack (= 5.2.2.1)
-      actionview (= 5.2.2.1)
-      activejob (= 5.2.2.1)
-      activemodel (= 5.2.2.1)
-      activerecord (= 5.2.2.1)
-      activestorage (= 5.2.2.1)
-      activesupport (= 5.2.2.1)
+    rails (6.0.2.1)
+      actioncable (= 6.0.2.1)
+      actionmailbox (= 6.0.2.1)
+      actionmailer (= 6.0.2.1)
+      actionpack (= 6.0.2.1)
+      actiontext (= 6.0.2.1)
+      actionview (= 6.0.2.1)
+      activejob (= 6.0.2.1)
+      activemodel (= 6.0.2.1)
+      activerecord (= 6.0.2.1)
+      activestorage (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
       bundler (>= 1.3.0)
-      railties (= 5.2.2.1)
+      railties (= 6.0.2.1)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.2.1)
-      actionpack (= 5.2.2.1)
-      activesupport (= 5.2.2.1)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.19.0, < 2.0)
+      thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
-    rake (12.3.2)
-    rubocop (0.66.0)
+    rake (13.0.1)
+    rubocop (0.78.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      psych (>= 3.1.0)
+      parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.6)
-    ruby-progressbar (1.10.0)
-    simplecov (0.16.1)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    simplecov (0.17.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    sprockets (3.7.2)
+    sprockets (4.0.0)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
     sprockets-rails (3.2.1)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    sqlite3 (1.3.13)
+    sqlite3 (1.4.2)
     thor (0.20.3)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    unicode-display_width (1.5.0)
-    websocket-driver (0.7.0)
+    unicode-display_width (1.6.0)
+    websocket-driver (0.7.1)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.3)
+    websocket-extensions (0.1.4)
+    zeitwerk (2.2.2)
 
 PLATFORMS
   ruby
@@ -150,11 +164,12 @@ DEPENDENCIES
   bundler (~> 2)
   bundler-audit (~> 0.6)
   minitest (~> 5)
-  rails (~> 5.2)
-  rake (~> 12)
-  rubocop (~> 0.66)
+  rack-test (~> 1.1)
+  rails (~> 6.0)
+  rake (~> 13)
+  rubocop (~> 0.70)
   simplecov (~> 0.16)
-  sqlite3 (= 1.3.13)
+  sqlite3 (~> 1.4)
 
 BUNDLED WITH
-   2.0.1
+   2.1.2

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 CultureHQ
+Copyright (c) 2018-present CultureHQ
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,8 +1,24 @@
 # AdequateSerialization
 
+[![Build Status](https://github.com/CultureHQ/adequate_serialization/workflows/Push/badge.svg)](https://github.com/CultureHQ/adequate_serialization/actions)
 [![Gem Version](https://img.shields.io/gem/v/adequate_serialization.svg)](https://github.com/CultureHQ/adeqaute_serialization)
 
-Serializes objects adequately. `AdequateSerialization` allows you to define serializers that will convert your objects into simple hashes that are suitable for variable purposes such as caching or using in an HTTP response. It stems from the simple idea of giving slightly more control over the `as_json` method that gets called when objects are serialized using Rails' default controller serialization.
+`AdequateSerialization` allows you to define serializers that will convert your objects into simple hashes that are suitable for variable purposes such as caching or using in an HTTP response. It stems from the simple idea of giving slightly more control over the `as_json` method that gets called when objects are serialized using Rails' default controller serialization.
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Defining attributes](#defining-attributes)
+    - [:if](#if)
+    - [:unless](#unless)
+    - [:optional](#optional)
+  - [Attaching objects](#attaching-objects)
+  - [Usage with Rails](#usage-with-rails)
+    - [Cache busting](#cache-busting)
+    - [Caching plain objects](#caching-plain-objects)
+  - [Advanced](#advanced)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
 
 ## Installation
 
@@ -132,11 +148,31 @@ This relies on the objects to which you are attaching having an `id` attribute a
 
 ### Usage with Rails
 
-If `::Rails` is defined when `adequate_serialization` is required, it will hook into the serialization process for `ActiveRecord` objects in three ways:
+If `::Rails` is defined when `adequate_serialization` is required, it will hook into `ActiveRecord` in three ways:
 
-1. By introducing caching behavior so that when serializing objects they will by default be stored in the Rails cache.
-2. By including `AdequateSerializer::Serializable` in `ActiveRecord::Base` so that all of your models will be serializable.
-3. By overwriting `ActiveRecord::Relation`'s `as_json` method to use the `AdequateSerializer::Rails::RelationSerializer` object, which by default will use the `Rails.cache.fetch_multi` method in order to more efficiently serialize all of the records in the relation.
+1. By including `AdequateSerializer::Serializable` in `ActiveRecord::Base` so that all of your models will be serializable by overwriting `ActiveRecord::Base`'s `as_json` method, which by default will use `Rails.cache.fetch`.
+2. By overwriting `ActiveRecord::Relation`'s `as_json` method to use the `AdequateSerializer::Rails::RelationSerializer` object, which by default will use the `Rails.cache.fetch_multi` method in order to more efficiently serialize all of the records in the relation.
+3. By introducing cache busting behavior in the background using `ActiveJob` if you're serializing objects outside of a one-to-many relationship.
+
+#### Cache busting
+
+When using `adequate_serialization` with `rails`, each `attribute` call will check if you're serializing an association. If you are, then it will ensure you have appropriate caching behavior enabled:
+
+* If it's a `has_many` or `has_one` association, then it will make sure that the inverse has the `touch: true` option on the association.
+* If it's a `belongs_to` association, then it will add an `after_update_commit` hook to the inverse class that will loop through the associated objects and bust the association using an `ActiveJob` task.
+
+You can visualize this cache busting behavior with a prebaked Rack application that is shipped with this gem by adding the following to your `config/routes.rb` file:
+
+```ruby
+if Rails.env.development?
+  mount AdequateSerialization::Rails::CacheVisualization,
+        at: '/cache_visualization'
+end
+```
+
+This will allow you to view which caches will bust which others in development by navigating to your application's `/cache_visualization` path.
+
+#### Caching plain objects
 
 You can still use plain objects to be serialized, and if you want to take advantage of the caching behavior, you can define a `cache_key` method on the objects that you're serializing. This will cause `AdequateSerialization` to start putting them into the Rails cache.
 

data/adequate_serialization.gemspec

@@ -24,7 +24,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 2'
   spec.add_development_dependency 'bundler-audit', '~> 0.6'
   spec.add_development_dependency 'minitest', '~> 5'
-  spec.add_development_dependency 'rake', '~> 12'
-  spec.add_development_dependency 'rubocop', '~> 0.66'
+  spec.add_development_dependency 'rack-test', '~> 1.1'
+  spec.add_development_dependency 'rake', '~> 13'
+  spec.add_development_dependency 'rubocop', '~> 0.70'
   spec.add_development_dependency 'simplecov', '~> 0.16'
 end

data/lib/adequate_serialization.rb

@@ -1,5 +1,13 @@
 # frozen_string_literal: true
 
+module AdequateSerialization
+  class Error < StandardError
+    def initialize(message)
+      super(message.gsub("\n", ' '))
+    end
+  end
+end
+
 require 'adequate_serialization/attribute'
 require 'adequate_serialization/decorator'
 require 'adequate_serialization/inline_serializer'
@@ -12,8 +20,14 @@ require 'adequate_serialization/version'
 require 'adequate_serialization/steps/step'
 require 'adequate_serialization/steps/serialize_step'
 
-if defined?(::Rails)
+if defined?(Rails)
+  require 'adequate_serialization/rails/cache_busting'
   require 'adequate_serialization/rails/cache_step'
+  require 'adequate_serialization/rails/cache_visualization'
   require 'adequate_serialization/rails/relation_serializer'
-  ActiveRecord::Base.include(AdequateSerialization::Serializable)
+
+  module AdequateSerialization
+    Serializer.singleton_class.prepend(CacheBusting)
+    ActiveRecord::Base.include(Serializable)
+  end
 end

data/lib/adequate_serialization/attribute.rb

@@ -46,6 +46,10 @@ module AdequateSerialization
         @condition = condition
       end
 
+      def name
+        attribute.name
+      end
+
       def serialize_to(serializer, response, model, includes)
         return unless model.public_send(condition)
 
@@ -61,6 +65,10 @@ module AdequateSerialization
         @condition = condition
       end
 
+      def name
+        attribute.name
+      end
+
       def serialize_to(serializer, response, model, includes)
         return if model.public_send(condition)
 
@@ -75,6 +83,10 @@ module AdequateSerialization
         @attribute = attribute
       end
 
+      def name
+        attribute.name
+      end
+
       def serialize_to(serializer, response, model, includes)
         return unless includes.include?(attribute.name)
 

data/lib/adequate_serialization/inline_serializer.rb

@@ -37,9 +37,16 @@ module AdequateSerialization
     def included(base)
       base.include(Serializable)
 
+      serializer_class = Class.new(Serializer)
+
+      # In order to validate the attribute, we need to define the `serializes`
+      # method before we evaluate the block
+      serializer_class.define_singleton_method(:serializes) { base }
+      serializer_class.class_eval(&block)
+
       # No need to memoize within the method because the block will hold on to
       # local variables for us.
-      serializer = Class.new(Serializer, &block).new
+      serializer = serializer_class.new
       base.define_singleton_method(:serializer) { serializer }
     end
   end

data/lib/adequate_serialization/options.rb

@@ -13,7 +13,7 @@ module AdequateSerialization
     end
 
     def self.from(*opts)
-      Opts.new(opts[0] || {})
+      Opts.new(**(opts[0] || {}))
     end
 
     def self.null

data/lib/adequate_serialization/rails/cache_busting.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module AdequateSerialization
+  module CacheBusting
+    class InverseNotFoundError < StandardError
+      def initialize(record, association)
+        super(<<~MSG)
+          In order to be able to bust the associated cache for #{record}'s
+          `#{association}` association, that association must have an inverse.
+          Currently it doesn't, which means Rails was unable to determine the
+          name of the inverse association. You can fix this by adding the
+          inverse_of option to the association declaration.
+        MSG
+      end
+    end
+
+    class TouchNotFoundError < StandardError
+      def initialize(record, associated, inverse)
+        super(<<~MSG)
+          #{record} serializes all of the associated #{associated} records,
+          which means when #{associated} updates it needs to notify #{record} in
+          order to bust the cache. This can be accomplished by adding the
+          `touch: true` option to #{associated}'s #{inverse} association.
+        MSG
+      end
+    end
+
+    class ActiveJobNotFoundError < Error
+      def initialize(record, association)
+        super(<<~MSG)
+          In order to be able to bust the associated cache for #{record}'s
+          `#{association}` association, AdequateSerialization enqueues a
+          background job (since there are potentially multiple records on the
+          association). In order to use the background job, it must have access
+          to ActiveJob.
+        MSG
+      end
+    end
+
+    using(
+      Module.new do
+        refine ActiveRecord::Base.singleton_class do
+          def setup_serialize_association(association_name)
+            unless defined?(ActiveJob)
+              raise ActiveJobNotFoundError.new(name, association_name)
+            end
+
+            require 'adequate_serialization/rails/cache_refresh'
+            extend(CacheRefresh) unless respond_to?(:serialize_association)
+
+            serialize_association(association_name)
+          end
+        end
+
+        refine ActiveRecord::Reflection::AssociationReflection do
+          def setup
+            # If the association is polymorphic, we can't rely on the inverse
+            # to tell us information about cache busting because there are
+            # multiple inverse associations.
+            return if polymorphic?
+
+            unless inverse_of
+              raise InverseNotFoundError.new(active_record.name, name)
+            end
+
+            inverse_of.macro == :belongs_to ? setup_belongs_to : setup_has_some
+          end
+
+          private
+
+          # Ensures that the `belongs_to` association has the `touch` option
+          # enabled in order to bust the parent's cache
+          def setup_belongs_to
+            return if inverse_of.options[:touch]
+
+            record = active_record.name
+            raise TouchNotFoundError.new(record, klass.name, inverse_of.name)
+          end
+
+          # Hooks into the serialized class and adds cache busting behavior on
+          # commit that will loop through the associated records
+          def setup_has_some
+            active_record.setup_serialize_association(name)
+          end
+        end
+
+        refine ActiveRecord::Reflection::ThroughReflection do
+          def setup
+            unless inverse_of
+              raise InverseNotFoundError.new(active_record.name, name)
+            end
+
+            klass.setup_serialize_association(inverse_of.name)
+          end
+        end
+      end
+    )
+
+    # Used as a shim for the `setup` API in the case that an attribute on the
+    # serializer does not represent an association.
+    module NullAssociation
+      def self.setup; end
+    end
+
+    # Overrides the previous `attribute` declaration to add some addition
+    # validation in the case that we're serializing an ActiveRecord object.
+    def attribute(*names, &block)
+      record = serializes
+
+      if record < ActiveRecord::Base
+        (names.last.is_a?(Hash) ? names[0..-2] : names).each do |attribute|
+          (record.reflect_on_association(attribute) || NullAssociation).setup
+        end
+      end
+
+      super
+    end
+  end
+end

data/lib/adequate_serialization/rails/cache_refresh.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module AdequateSerialization
+  module CacheRefresh
+    class CacheRefreshJob < ActiveJob::Base
+      using(
+        Module.new do
+          # The association will return a relation if it's a `has_many` or a
+          # `has_many_through` regardless of how many associated records exist.
+          refine ActiveRecord::Relation do
+            def refresh
+              return unless any?
+
+              update_all(updated_at: Time.now)
+              find_each(&:as_json)
+            end
+          end
+
+          # The association will return a record if it's a `has_one` and it was
+          # previously created.
+          refine ActiveRecord::Base do
+            def refresh
+              touch
+              as_json
+            end
+          end
+
+          # The association will return a `nil` if it's a `has_one` and it was
+          # not yet created.
+          refine NilClass do
+            def refresh; end
+          end
+        end
+      )
+
+      queue_as :default
+      discard_on ActiveJob::DeserializationError
+
+      def perform(record)
+        record.class.serialized_associations.each do |association|
+          record.public_send(association).refresh
+        end
+      end
+    end
+
+    def self.extended(base)
+      base.after_update_commit { CacheRefreshJob.perform_later(self) }
+    end
+
+    def serialize_association(association)
+      serialized_associations << association
+    end
+
+    # The associations that serialize this object in their responses, so that we
+    # know to bust their cache when this object is updated.
+    def serialized_associations
+      @serialized_associations ||= []
+    end
+  end
+end

data/lib/adequate_serialization/rails/cache_visualization.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module AdequateSerialization
+  module Rails
+    class CacheVisualization
+      using(
+        Module.new do
+          refine ActiveRecord::Reflection::AbstractReflection do
+            def to_dot
+              "#{klass.name} -> #{active_record.name} [label=\"#{name}\"];"
+            end
+          end
+        end
+      )
+
+      STATIC = File.expand_path('static', __dir__)
+      FILES = %w[/favicon.ico].freeze
+
+      attr_reader :app, :server
+
+      def initialize
+        @server = Rack::File.new(STATIC)
+      end
+
+      def call(env)
+        if env[Rack::PATH_INFO] == '/'
+          render_index(env)
+        elsif FILES.include?(env[Rack::PATH_INFO])
+          server.call(env)
+        else
+          [404, { 'Content-Type' => 'text/plain' }, ['Not Found']]
+        end
+      end
+
+      def self.call(env)
+        (@app ||= new).call(env)
+      end
+
+      private
+
+      def to_dot
+        <<~EODOT
+          digraph attributes {
+            node [shape = circle];
+            #{reflections.map(&:to_dot).join("\n  ")}
+          }
+        EODOT
+      end
+
+      def to_svg
+        svg =
+          IO.popen('dot -Tsvg', 'w+') do |f|
+            f.write(to_dot)
+            f.close_write
+            f.readlines
+          end
+
+        3.times { svg.shift }
+        svg.join.gsub(/(height|width)="[^"]*"/, '')
+      end
+
+      def render_index(env)
+        content = File.read(File.join(STATIC, 'index.html.erb'))
+        locals = { svg: to_svg, script_name: env[Rack::SCRIPT_NAME] }
+
+        result = ERB.new(content).result_with_hash(locals)
+        [200, { 'Content-Type' => 'text/html' }, [result]]
+      end
+
+      def serializers
+        ::Rails.application.eager_load!
+        base = Serializer
+
+        ObjectSpace.each_object(base.singleton_class).select do |serializer|
+          serializer < base &&
+            serializer.name &&
+            serializer.serializes < ActiveRecord::Base
+        rescue AdequateSerialization::Serializer::ClassNotFoundError
+          false
+        end
+      end
+
+      def reflections
+        serializers.each_with_object([]) do |serializer, selected|
+          serializer.attributes.each do |attribute|
+            serializes = serializer.serializes
+            reflection = serializes.reflect_on_association(attribute.name)
+
+            next if !reflection || reflection.polymorphic?
+
+            selected << reflection
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adequate_serialization/rails/static/index.html.erb

@@ -0,0 +1,45 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="initial-scale=1, maximum-scale=5">
+    <title>AdequateSerialization</title>
+    <link rel="shortcut icon" href="favicon.ico">
+    <style type="text/css">
+html,
+body {
+  font-family: Verdana, Geneva, sans-serif;
+  line-height: 1.2em;
+  margin: 0;
+  padding: 0;
+}
+
+main {
+  padding: 0 1em 1em;
+}
+    </style>
+  </head>
+  <body data-script="<%= script_name %>">
+    <main>
+      <h1>AdequateSerialization</h1>
+      <p>
+        Below is a visualization of the associations that you are serializing.
+        The arrows represent which cache will get busted when you update an
+        object.
+      </p>
+      <p>
+        For instance, if you have an arrow pointing from
+        <code>Post</code> to <code>Comment</code>, it would mean that when
+        <code>Comment</code> objects are serialized they are serializing
+        <code>Post</code> objects as part of their response. In this case
+        <code>Post</code> objects need to bust the cache of their associated
+        <code>Comment</code> objects when they are updated.
+        <code>AdequateSerialization</code> takes care of this by enqueuing a
+        background job.
+      </p>
+      <div id="svg">
+        <%= svg %>
+      </div>
+    </main>
+  </body>
+</html>

data/lib/adequate_serialization/serializer.rb

@@ -2,6 +2,17 @@
 
 module AdequateSerialization
   class Serializer
+    class ClassNotFoundError < Error
+      def initialize(serializer, serializes)
+        super(<<~MSG)
+          AdequateSerialization was unable to find the associated class to
+          serialize for #{serializer}. It expected to find a class named
+          #{serializes}. This could mean that it was incorrectly named, or that
+          you have yet to create the class that it will serialize.
+        MSG
+      end
+    end
+
     class << self
       def attributes
         @attributes ||= []
@@ -20,6 +31,18 @@ module AdequateSerialization
 
         @attributes = attributes + additions
       end
+
+      def serializes
+        return @serializes if defined?(@serializes)
+
+        class_name = name.gsub(/Serializer\z/, '')
+
+        begin
+          @serializes = const_get(class_name)
+        rescue NameError
+          raise ClassNotFoundError.new(name, class_name)
+        end
+      end
     end
 
     def serialize(model, opts = Options.null)

data/lib/adequate_serialization/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AdequateSerialization
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adequate_serialization
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Kevin Deisz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-25 00:00:00.000000000 Z
+date: 2019-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,34 +52,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.66'
+        version: '0.70'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.66'
+        version: '0.70'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -101,10 +115,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/main.workflow"
+- ".github/workflows/push.yml"
 - ".gitignore"
+- ".mergify.yml"
 - ".rubocop.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -118,8 +134,13 @@ files:
 - lib/adequate_serialization/decorator.rb
 - lib/adequate_serialization/inline_serializer.rb
 - lib/adequate_serialization/options.rb
+- lib/adequate_serialization/rails/cache_busting.rb
+- lib/adequate_serialization/rails/cache_refresh.rb
 - lib/adequate_serialization/rails/cache_step.rb
+- lib/adequate_serialization/rails/cache_visualization.rb
 - lib/adequate_serialization/rails/relation_serializer.rb
+- lib/adequate_serialization/rails/static/favicon.ico
+- lib/adequate_serialization/rails/static/index.html.erb
 - lib/adequate_serialization/serializable.rb
 - lib/adequate_serialization/serializer.rb
 - lib/adequate_serialization/steps.rb
@@ -145,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Serializes objects adequately

data/.github/main.workflow

@@ -1,40 +0,0 @@
-workflow "Main" {
-  on = "push"
-  resolves = "Publish"
-}
-
-action "Install" {
-  uses = "docker://culturehq/actions-bundler:latest"
-  args = "install"
-}
-
-action "Audit" {
-  needs = "Install"
-  uses = "docker://culturehq/actions-bundler:latest"
-  args = "exec bundle audit"
-}
-
-action "Lint" {
-  needs = "Install"
-  uses = "docker://culturehq/actions-bundler:latest"
-  args = "exec rubocop --parallel"
-}
-
-action "Test" {
-  needs = "Install"
-  uses = "docker://culturehq/actions-bundler:latest"
-  args = "exec rake test"
-}
-
-action "Tag" {
-  needs = ["Audit", "Lint", "Test"]
-  uses = "actions/bin/filter@master"
-  args = "tag"
-}
-
-action "Publish" {
-  needs = "Tag"
-  uses = "docker://culturehq/actions-bundler:latest"
-  args = "build release:rubygem_push"
-  secrets = ["BUNDLE_GEM__PUSH_KEY"]
-}