ams_lazy_relationships 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 250cb8632ee5305b7f64e9c405d234f4314efd44
+  data.tar.gz: 13a9171c97c9404bf6bf999d089f65bafcc0240d
+SHA512:
+  metadata.gz: c43418b6e95a06f7e5e1ca453004792b2b42f10a02a97f4f07b48304c02b0792ee706b14a548a4d97c95c32ff459e4884ebda4fec5dc3cb842f6cff05e565862
+  data.tar.gz: 1b574d51889e7ba67bce43b433e94d9da706f47d38008bbe81f804844380a8fd2f3231a467edb8705dc534215ce42439abcedc20b983887226122c26f40f2d8f

data/.codeclimate.yml

@@ -0,0 +1,31 @@
+# This is a sample .codeclimate.yml configured for Plugin analysis on Code
+# Climate Platform. For an overview of the Code Climate Platform, see here:
+# https://codeclimate.com/blog/code-climate-platform/
+
+# Under the plugins key, you can configure which plugins will analyze your repo.
+# Each key is a plugin name. For each value, you need to specify enabled: true
+# to enable the plugin as well as any other plugins-specific configuration.
+
+# For more details, see here:
+# http://docs.codeclimate.com/article/289-configuring-your-repository-via-codeclimate-yml#platform
+
+version: "2"
+
+# For a list of all available plugins, see here:
+# https://docs.codeclimate.com/docs/list-of-engines
+
+plugins:
+# to turn on a plugin, add it here and set enabled to `true`
+# to turn off a plugin, set enabled to `false` or remove it
+  rubocop:
+    enabled: true
+    channel: rubocop-0-51
+    checks:
+      Rubocop/Metrics/LineLength:
+        enabled: false
+  bundler-audit:
+    enabled: true
+  duplication:
+    enabled: true
+    exclude_patterns:
+      - spec

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+gemfiles/*.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,37 @@
+require: rubocop-rspec
+
+AllCops:
+  Exclude:
+    - db/schema.rb
+    - Gemfile
+  TargetRubyVersion: 2.3
+  TargetRailsVersion: 4.2
+
+Metrics/ClassLength:
+  Max: 300
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Layout/AccessModifierIndentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Layout/DotPosition:
+  Enabled: true
+  EnforcedStyle: trailing
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -0,0 +1,25 @@
+---
+sudo: false
+env:
+  global:
+    - CC_TEST_REPORTER_ID=1da1af59767d8c64ae960d5a0ac69089a0fa90e013aedb09e76843f104bec709
+language: ruby
+gemfile:
+  - gemfiles/ams_0.10.0.rc4.gemfile
+  - gemfiles/ams_0.10.2.gemfile
+  - gemfiles/ams_0.10.8.gemfile
+cache: bundler
+rvm:
+  - 2.3.4
+before_install:
+  - gem install bundler undercover --no-doc
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rake
+  - git pull origin master:master
+  - undercover --compare master
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Appraisals

@@ -0,0 +1,11 @@
+appraise "ams-0.10.0.rc4" do
+  gem "active_model_serializers", "0.10.0.rc4"
+end
+
+appraise "ams-0.10.2" do
+  gem "active_model_serializers", "0.10.2"
+end
+
+appraise "ams-0.10.8" do
+  gem "active_model_serializers", "0.10.8"
+end

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Change Log
+
+## [0.1.0](https://github.com/Bajena/ams_lazy_relationships/tree/0.1.0) (2018-12-30)
+**Closed issues:**
+
+- Add changelog [\#10](https://github.com/Bajena/ams_lazy_relationships/issues/10)
+- Prepare initial version + test suite [\#2](https://github.com/Bajena/ams_lazy_relationships/issues/2)
+- Test multiple AMS versions [\#1](https://github.com/Bajena/ams_lazy_relationships/issues/1)
+
+**Merged pull requests:**
+
+- Add undercover back [\#12](https://github.com/Bajena/ams_lazy_relationships/pull/12) ([Bajena](https://github.com/Bajena))
+- Add changelog [\#11](https://github.com/Bajena/ams_lazy_relationships/pull/11) ([Bajena](https://github.com/Bajena))
+- Split methods logically, add yard comments and hide unnecessary public methods [\#9](https://github.com/Bajena/ams_lazy_relationships/pull/9) ([Bajena](https://github.com/Bajena))
+- Code cleanup [\#8](https://github.com/Bajena/ams_lazy_relationships/pull/8) ([Bajena](https://github.com/Bajena))
+- Add tests for JSON adapter and improve backwards compatibility [\#7](https://github.com/Bajena/ams_lazy_relationships/pull/7) ([Bajena](https://github.com/Bajena))
+- Use Appraisal to test different versions of AMS [\#6](https://github.com/Bajena/ams_lazy_relationships/pull/6) ([Bajena](https://github.com/Bajena))
+- Add core module [\#5](https://github.com/Bajena/ams_lazy_relationships/pull/5) ([Bajena](https://github.com/Bajena))
+- Add Loader classes [\#4](https://github.com/Bajena/ams_lazy_relationships/pull/4) ([Bajena](https://github.com/Bajena))
+- Initial setup [\#3](https://github.com/Bajena/ams_lazy_relationships/pull/3) ([Bajena](https://github.com/Bajena))
+
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

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 ams_lazy_relationships.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jan Bajena
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jan Bajena
+
+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,108 @@
+[![Build Status](https://travis-ci.org/Bajena/ams_lazy_relationships.svg?branch=master)](https://travis-ci.org/Bajena/ams_lazy_relationships)
+[![Maintainability](https://api.codeclimate.com/v1/badges/c21b988e09db63396309/maintainability)](https://codeclimate.com/github/Bajena/ams_lazy_relationships/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/c21b988e09db63396309/test_coverage)](https://codeclimate.com/github/Bajena/ams_lazy_relationships/test_coverage)
+
+# AmsLazyRelationships
+
+#### What does the gem do?
+Eliminates N+1 queries problem in [Active Model Serializers gem](https://github.com/rails-api/active_model_serializers) thanks to batch loading provided by a great [BatchLoader gem](https://github.com/exAspArk/batch-loader).
+
+The gem provides a module which defines a set of methods useful for eliminating N+1 query problem
+during the serialization. Serializers will first prepare a tree of "promises"
+for every nested lazy relationship. The relationship promises will be
+evaluated only when they're requested.
+E.g. when including `blog_posts.user`: instead of loading a user for each blog post separately it'll gather the blog posts and load all their users at once when including the users in the response.
+
+#### How is it better than Rails' includes/joins methods?
+In many cases it's fine to use [`includes`](https://apidock.com/rails/ActiveRecord/QueryMethods/includes) method provided by Rails. 
+There are a few problems with `includes` approach though:
+- It loads all the records provided in the arguments hash. Often you may not need all the nested records to serialize the data you want. `AmsLazyRelationships` will load only the data you need thanks to lazy evaluation.
+- When the app gets bigger and bigger you'd need to update all the `includes` statements across your app to prevent the N+1 queries problem which quickly becomes impossible.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "ams_lazy_relationships"
+```
+
+And then execute:
+
+    $ bundle
+
+## Installation
+
+Include `AmsLazyRelationships::Core` module in your base serializer
+
+```ruby
+class BaseSerializer < ActiveModel::Serializer
+  include AmsLazyRelationships::Core
+end
+```
+
+**Important:** 
+This gem uses `BatchLoader` heavily. I highly recommend to clear the batch loader's cache between HTTP requests.
+To do so add a following middleware:
+`use BatchLoader::Middleware`
+
+For more info about the middleware check out BatchLoader gem docs: https://github.com/exAspArk/batch-loader#caching
+
+### Usage
+Adding the `AmsLazyRelationships::Core` module lets you define lazy relationships in your serializers:
+```ruby
+
+class UserSerializer < BaseSerializer
+  # Short version - preloads a specified ActiveRecord relationships by default
+  lazy_has_many :blog_posts
+  
+  # Works same as the previous one, but the loader option is specified explicitly
+  lazy_has_many :blog_posts,
+                serializer: BlogPostSerializer,
+                loader: AmsLazyRelationships::Loaders::Association.new("User", :blog_posts)
+  
+  # The previous one is a shorthand for the following lines:
+  lazy_relationship :blog_posts, loader: AmsLazyRelationships::Loaders::Association.new("User", :blog_posts)
+  has_many :blog_posts, serializer: BlogPostSerializer do
+    lazy_blog_posts
+  end
+   
+  lazy_has_one :poro_model, loader: AmsLazyRelationships::Loaders::Direct.new(:poro_model) { |object| PoroModel.new(object) }
+  
+  lazy_belongs_to :account, loader: AmsLazyRelationships::Loaders::SimpleBelongsTo.new("Account")
+  
+  lazy_has_many :comment, loader: AmsLazyRelationships::Loaders::SimpleHasMany.new("Comment", foreign_key: :user_id)
+
+```
+
+As you may have already noticed the gem makes use of various loader classes. 
+
+I've implemented the following ones for you:
+- `AmsLazyRelationships::Loaders::Association` - Batch loads a ActiveRecord association (has_one/has_many/has_many-through/belongs_to). This is a deafult loader in case you don't specify a `loader` option in your serializer's lazy relationship.
+E.g. in order to lazy load user's blog posts use a following loader: `AmsLazyRelationships::Loaders::Association.new("User", :blog_posts)`.
+
+- `AmsLazyRelationships::Loaders::SimpleBelongsTo` - Batch loads ActiveRecord models using a foreign key method called on a serialized object. E.g. `AmsLazyRelationships::Loaders::SimpleBelongsTo.new("Account")` called on users will gather their `account_id`s and fire one query to get all accounts at once instead of loading an account per user separately. 
+This loader can be useful e.g. when the serialized object is not an ActiveRecord model.
+
+- `AmsLazyRelationships::Loaders::SimpleHasMany` - Batch loads ActiveRecord records belonging to given record by foreign key. E.g. `AmsLazyRelationships::Loaders::SimpleHasMany.new("BlogPosts", foreign_key: :user_id)` called on users will  and fire one query to gather all blog posts for the users at once instead of loading an the blog posts per user separately.
+This loader can be useful e.g. when the serialized object is not an ActiveRecord model.
+
+- `AmsLazyRelationships::Loaders::Direct` - Lazy loads data in a "dumb" way - just executes the provided block when needed. Useful e.g. when the relationship is just a PORO which then in its own serializer needs to lazy load some relationships.
+You can use it like this: `AmsLazyRelationships::Loaders::Direct.new(:poro_model) { |object| PoroModel.new(object)`.
+
+The abovementioned loaders are mostly useful when using ActiveRecord, but there should be no problem building a new loader for different frameworks.
+If you're missing a loader you can create an issue or create your own loader taking the existing ones as an example. 
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Bajena/ams_lazy_relationships.
+
+## 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 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "github_changelog_generator/task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.user = "Bajena"
+  config.project = "ams_lazy_relationships"
+  config.future_release = "0.1.0"
+end

data/ams_lazy_relationships.gemspec

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ams_lazy_relationships/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ams_lazy_relationships"
+  spec.version       = AmsLazyRelationships::VERSION
+  spec.authors       = ["Jan Bajena"]
+
+  spec.summary       = "ActiveModel Serializers addon for eliminating N+1 queries problem from the serializers."
+  spec.homepage      = "https://github.com/Bajena/ams_lazy_relationships"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/Bajena/ams_lazy_relationships"
+    spec.metadata["changelog_uri"] = "https://github.com/Bajena/ams_lazy_relationships/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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 "active_model_serializers"
+  spec.add_dependency "batch-loader", "=1.2.2"
+
+  spec.add_development_dependency "activerecord"
+  # A Ruby library for testing against different versions of dependencies
+  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "bundler", "~> 1.17"
+  # Rspec matchers for SQL query counts
+  spec.add_development_dependency "db-query-matchers"
+  spec.add_development_dependency "github_changelog_generator"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-rails", "~> 3.5"
+  spec.add_development_dependency "rubocop", "= 0.61.0"
+  spec.add_development_dependency "rubocop-rspec", "= 1.20.1"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "simplecov-lcov"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+  # Detect untested code blocks in recent changes
+  spec.add_development_dependency "undercover"
+  # Dynamically build an Active Record model (with table) within a test context
+  spec.add_development_dependency "with_model", "~> 2.0"
+end

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "ams_lazy_relationships"
+
+# 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/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/ams_0.10.0.rc4.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "active_model_serializers", "0.10.0.rc4"
+
+gemspec path: "../"

data/gemfiles/ams_0.10.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "active_model_serializers", "0.10.2"
+
+gemspec path: "../"