ams_lazy_relationships 0.1.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8f2d4206f5ac6fe534e19162405e4d6993e5a8ea
-  data.tar.gz: 78c94b7d3b54794b4ce8dd7f9b5645e694f2eff7
+SHA256:
+  metadata.gz: 3c8c81edbcbae5aed5aea521529d0bfbbe793739c9095a971c76799b976d9010
+  data.tar.gz: ad23f2121d43eb103bb770bc9b8ca2b9992839d7fe455e84f6cb5ebdedcf77f3
 SHA512:
-  metadata.gz: 80230d616e3b5007577ca2053080a1f11eda4d7b2978dd30ebb56d79819e5bd6555668add82b446cf381b00fc5684bf63bc13cb70085e2d818ba7d1d072ec228
-  data.tar.gz: c79403dd23812c678235b63a207e218c2c72eda850c7635fe0d962b536305a69c8188d85449e3f07a409702c22db9b573781f9ae6e6a172eaf2bed126fcaf101
+  metadata.gz: 0b94d1e5828e237ba98a12f9781ae81abf40acbb1c5438932f18a601ea87c96288c3ec8c29d220d3812c0ca90898a0a24707599ab088e5b9f02e6e4b3fa11f4b
+  data.tar.gz: a51c03a759b3b9d7062714d32c26af33e2c58ed6d28ad0e219b9d0a641c741f10abec39c9d6256efde46e8ef97e808bbb28df4e28c4efaf629554b363eab10d1

data/.travis.yml

@@ -6,20 +6,19 @@ env:
 language: ruby
 gemfile:
   - gemfiles/ams_0.10.0.rc4.gemfile
+  - gemfiles/ams_0.10.0.gemfile
   - gemfiles/ams_0.10.2.gemfile
+  - gemfiles/ams_0.10.3.gemfile
   - gemfiles/ams_0.10.8.gemfile
+  - gemfiles/ams_0.10.10.gemfile
 cache: bundler
 rvm:
-  - 2.3.4
-before_install:
-  - gem install bundler:1.17 undercover --no-doc
+  - 2.5.3
 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

@@ -2,10 +2,22 @@ appraise "ams-0.10.0.rc4" do
   gem "active_model_serializers", "0.10.0.rc4"
 end
 
+appraise "ams-0.10.0" do
+  gem "active_model_serializers", "0.10.0"
+end
+
 appraise "ams-0.10.2" do
   gem "active_model_serializers", "0.10.2"
 end
 
+appraise "ams-0.10.3" do
+  gem "active_model_serializers", "0.10.3"
+end
+
 appraise "ams-0.10.8" do
   gem "active_model_serializers", "0.10.8"
 end
+
+appraise "ams-0.10.10" do
+  gem "active_model_serializers", "0.10.10"
+end

data/CHANGELOG.md

@@ -1,5 +1,73 @@
 # Change Log
 
+## [v0.3.1](https://github.com/Bajena/ams_lazy_relationships/tree/v0.3.1) (2021-04-14)
+[Full Changelog](https://github.com/Bajena/ams_lazy_relationships/compare/v0.3.0...v0.3.1)
+
+**Closed issues:**
+
+- NameError: uninitialized constant ActiveModel::Serializer::Reflection [\#59](https://github.com/Bajena/ams_lazy_relationships/issues/59)
+
+**Merged pull requests:**
+
+- Lock minimum AMS version to 0.10.0.rc4 [\#60](https://github.com/Bajena/ams_lazy_relationships/pull/60) ([Bajena](https://github.com/Bajena))
+
+## [v0.3.0](https://github.com/Bajena/ams_lazy_relationships/tree/v0.3.0) (2020-01-16)
+[Full Changelog](https://github.com/Bajena/ams_lazy_relationships/compare/v0.2.0...v0.3.0)
+
+**Merged pull requests:**
+
+- Fix association duplicates after accepts\_nested\_attributes\_for assignation [\#50](https://github.com/Bajena/ams_lazy_relationships/pull/50) ([stokarenko](https://github.com/stokarenko))
+- Skip active\_support as redundant dependency [\#49](https://github.com/Bajena/ams_lazy_relationships/pull/49) ([stokarenko](https://github.com/stokarenko))
+- Test against AMS v0.10.0.rc4 [\#48](https://github.com/Bajena/ams_lazy_relationships/pull/48) ([stokarenko](https://github.com/stokarenko))
+- Skip redundant queries when include\_data is disabled [\#47](https://github.com/Bajena/ams_lazy_relationships/pull/47) ([stokarenko](https://github.com/stokarenko))
+- Adjust tested ams version [\#46](https://github.com/Bajena/ams_lazy_relationships/pull/46) ([stokarenko](https://github.com/stokarenko))
+- Fix documentation for blocked relationships [\#45](https://github.com/Bajena/ams_lazy_relationships/pull/45) ([stokarenko](https://github.com/stokarenko))
+
+## [v0.2.0](https://github.com/Bajena/ams_lazy_relationships/tree/v0.2.0) (2020-01-11)
+[Full Changelog](https://github.com/Bajena/ams_lazy_relationships/compare/v0.1.5...v0.2.0)
+
+**Merged pull requests:**
+
+- Lazy dig [\#44](https://github.com/Bajena/ams_lazy_relationships/pull/44) ([stokarenko](https://github.com/stokarenko))
+
+## [v0.1.5](https://github.com/Bajena/ams_lazy_relationships/tree/v0.1.5) (2020-01-08)
+[Full Changelog](https://github.com/Bajena/ams_lazy_relationships/compare/v0.1.4...v0.1.5)
+
+**Closed issues:**
+
+- Extract a base class for the loaders [\#39](https://github.com/Bajena/ams_lazy_relationships/issues/39)
+- "Association" loader loads unnecessary records on AR 5.2.3+ [\#37](https://github.com/Bajena/ams_lazy_relationships/issues/37)
+- undefined method `load\_all\_lazy\_relationships' for nil:NilClass [\#30](https://github.com/Bajena/ams_lazy_relationships/issues/30)
+- Convert loaders to use strings instead of records as main keys [\#24](https://github.com/Bajena/ams_lazy_relationships/issues/24)
+
+**Merged pull requests:**
+
+- Improve tests for nested serializer lookup [\#43](https://github.com/Bajena/ams_lazy_relationships/pull/43) ([stokarenko](https://github.com/stokarenko))
+- Extract a base class for lazy loaders [\#40](https://github.com/Bajena/ams_lazy_relationships/pull/40) ([Bajena](https://github.com/Bajena))
+- Filter out preloaded records in `Association` preloader [\#36](https://github.com/Bajena/ams_lazy_relationships/pull/36) ([Bajena](https://github.com/Bajena))
+- Synchronize lazy relationships [\#35](https://github.com/Bajena/ams_lazy_relationships/pull/35) ([stokarenko](https://github.com/stokarenko))
+- Fix nested serializer lookup [\#34](https://github.com/Bajena/ams_lazy_relationships/pull/34) ([stokarenko](https://github.com/stokarenko))
+- Fix batch loader dependency [\#33](https://github.com/Bajena/ams_lazy_relationships/pull/33) ([stokarenko](https://github.com/stokarenko))
+- Bump rack from 2.0.6 to 2.0.8 [\#32](https://github.com/Bajena/ams_lazy_relationships/pull/32) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump loofah from 2.2.3 to 2.3.1 [\#31](https://github.com/Bajena/ams_lazy_relationships/pull/31) ([dependabot[bot]](https://github.com/apps/dependabot))
+
+## [v0.1.4](https://github.com/Bajena/ams_lazy_relationships/tree/v0.1.4) (2019-06-02)
+[Full Changelog](https://github.com/Bajena/ams_lazy_relationships/compare/v0.1.3...v0.1.4)
+
+**Closed issues:**
+
+- Use replace\_methods: false by default in loaders [\#28](https://github.com/Bajena/ams_lazy_relationships/issues/28)
+- Require less restrictive batch-loader version [\#25](https://github.com/Bajena/ams_lazy_relationships/issues/25)
+- Profile time and memory usage [\#21](https://github.com/Bajena/ams_lazy_relationships/issues/21)
+- Loading circular relationships [\#20](https://github.com/Bajena/ams_lazy_relationships/issues/20)
+- Add railtie [\#19](https://github.com/Bajena/ams_lazy_relationships/issues/19)
+
+**Merged pull requests:**
+
+- Use replace\_methods: false in batch loaders [\#29](https://github.com/Bajena/ams_lazy_relationships/pull/29) ([Bajena](https://github.com/Bajena))
+- Add benchmark for speed & memory usage [\#27](https://github.com/Bajena/ams_lazy_relationships/pull/27) ([Bajena](https://github.com/Bajena))
+- Require less restrictive batch loader version [\#26](https://github.com/Bajena/ams_lazy_relationships/pull/26) ([Bajena](https://github.com/Bajena))
+
 ## [v0.1.3](https://github.com/Bajena/ams_lazy_relationships/tree/v0.1.3) (2019-05-19)
 [Full Changelog](https://github.com/Bajena/ams_lazy_relationships/compare/0.1.2...v0.1.3)
 
@@ -53,4 +121,4 @@
 
 
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    ams_lazy_relationships (0.1.3)
-      active_model_serializers
-      batch-loader (~> 1.2)
+    ams_lazy_relationships (0.3.1)
+      active_model_serializers (>= 0.10.0.rc4)
+      batch-loader (~> 1)
 
 GEM
   remote: https://rubygems.org/
@@ -21,9 +21,9 @@ GEM
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    active_model_serializers (0.10.9)
-      actionpack (>= 4.1, < 6)
-      activemodel (>= 4.1, < 6)
+    active_model_serializers (0.10.12)
+      actionpack (>= 4.1, < 6.2)
+      activemodel (>= 4.1, < 6.2)
       case_transform (>= 0.2)
       jsonapi-renderer (>= 0.1.1.beta1, < 0.3)
     activemodel (5.2.2)
@@ -45,13 +45,15 @@ GEM
       thor (>= 0.14.0)
     arel (9.0.0)
     ast (2.4.0)
-    batch-loader (1.3.0)
+    batch-loader (1.5.0)
+    benchmark-memory (0.1.2)
+      memory_profiler (~> 0.9)
     builder (3.2.3)
     case_transform (0.2)
       activesupport
     coderay (1.1.2)
     concurrent-ruby (1.1.4)
-    crass (1.0.4)
+    crass (1.0.5)
     db-query-matchers (0.9.0)
       activesupport (>= 4.0, <= 6.0)
       rspec (~> 3.0)
@@ -76,16 +78,17 @@ GEM
       parser (>= 2.5, != 2.5.1.1)
     jaro_winkler (1.5.2)
     json (2.1.0)
-    jsonapi-renderer (0.2.0)
-    loofah (2.2.3)
+    jsonapi-renderer (0.2.2)
+    loofah (2.3.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
+    memory_profiler (0.9.13)
     method_source (0.8.2)
     mini_portile2 (2.4.0)
     minitest (5.11.3)
     multi_json (1.13.1)
     multipart-post (2.0.0)
-    nokogiri (1.10.0)
+    nokogiri (1.10.5)
       mini_portile2 (~> 2.4.0)
     octokit (4.13.0)
       sawyer (~> 0.8.0, >= 0.5.3)
@@ -100,7 +103,7 @@ GEM
     pry-nav (0.2.4)
       pry (>= 0.9.10, < 0.11.0)
     public_suffix (3.0.3)
-    rack (2.0.6)
+    rack (2.0.8)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
@@ -181,7 +184,7 @@ DEPENDENCIES
   activerecord
   ams_lazy_relationships!
   appraisal
-  bundler (~> 1.17)
+  benchmark-memory (~> 0.1)
   db-query-matchers
   github_changelog_generator
   pry
@@ -193,9 +196,10 @@ DEPENDENCIES
   rubocop-rspec (= 1.20.1)
   simplecov
   simplecov-lcov
-  sqlite3 (~> 1.3.6)
+  sqlite3
+  thread_safe
   undercover
   with_model (~> 2.0)
 
 BUNDLED WITH
-   1.17.1
+   2.2.15

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/Bajena/ams_lazy_relationships.svg?branch=master)](https://travis-ci.org/Bajena/ams_lazy_relationships)
+[![Build Status](https://travis-ci.com/Bajena/ams_lazy_relationships.svg?branch=master)](https://travis-ci.com/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)
 
@@ -63,8 +63,10 @@ class UserSerializer < BaseSerializer
   
   # 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
+  has_many :blog_posts, serializer: BlogPostSerializer do |serializer|
+    # non-proc custom finder will work as well, but it can produce redundant sql
+    # queries, please see [Example 2: Modifying the relationship before rendering](#example-2-modifying-the-relationship-before-rendering)
+    -> { serializer.lazy_blog_posts }
   end
    
   lazy_has_one :poro_model, loader: AmsLazyRelationships::Loaders::Direct.new(:poro_model) { |object| PoroModel.new(object) }
@@ -116,10 +118,43 @@ end
 #### Example 2: Modifying the relationship before rendering
 Sometimes it may happen that you need to process the relationship before rendering, e.g. decorate the records. In this case the gem provides a special method (in our case `lazy_comments`) for each defined relationship. Check out the example - we'll decorate every comment before serializing:
 
+```ruby
+class BlogPostSerializer < BaseSerializer
+  lazy_has_many :comments do |serializer|
+    -> { serializer.lazy_comments.map(&:decorate) }
+   end
+end
+```
+
+Despite the fact that non-block custom finder such as
+
+```ruby
+class BlogPostSerializer < BaseSerializer
+  lazy_has_many :comments do |serializer|
+    serializer.lazy_comments.map(&:decorate)
+   end
+end
+```
+
+will work still, it's better to implement it in a form of lambda, in order to avoid redundant SQL queries when `include_data` AMS setting appears to be `false`:
+
+```ruby
+class BlogPostSerializer < BaseSerializer
+  lazy_has_many :comments do |serializer|
+    include_data :if_sideloaded
+    -> { serializer.lazy_comments.map(&:decorate) }
+   end
+end
+```
+
+Feel free to skip custom lazy finder for association if your goal is just to define `include_data` setting and/or to specify some links and metas:
+
 ```ruby
 class BlogPostSerializer < BaseSerializer
   lazy_has_many :comments do
-    lazy_comments.map(&:decorate)
+    include_data :if_sideloaded
+    link :self, 'a link'
+    meta name: 'Dan Brown'
    end
 end
 ```
@@ -163,6 +198,54 @@ class BlogPostSerializer < BaseSerializer
 end
 ```
 
+#### Example 6: Lazy dig through relationships
+In additional to previous example you may want to make use of nested lazy relationship without rendering of any nested record.
+There is an `lazy_dig` method to be used for that:
+
+```ruby
+class AuthorSerializer < BaseSerializer
+  lazy_relationship :address
+end
+
+class BlogPostSerializer < BaseSerializer
+  lazy_relationship :author
+
+  attribute :author_address do
+    lazy_dig(:author, :address)&.full_address
+  end
+end
+```
+
+## Performance comparison with vanilla AMS
+
+In general the bigger and more complex your serialized records hierarchy is and the more latency you have in your DB the more you'll benefit from using this gem. 
+Example results for average size records tree (10 blog posts -> 10 comments each -> 1 user per comment, performed on local in-memory SQLite DB) are:
+
+### Time:
+
+```bash
+# With lazy relationships:    0.860000   0.010000   0.870000 (  0.870297)
+# Vanilla AMS:                1.050000   0.000000   1.050000 (  1.059801)
+```
+
+This means your serializers should get **~13%** speed boost by introducing lazy relationships.
+
+### Memory:
+
+```bash
+# With lazy relationships:
+#                         46.283M memsize (     0.000  retained)
+#                        506.696k objects (     0.000  retained)
+#                         50.000  strings (     0.000  retained)
+# Vanilla AMS:            42.738M memsize (     0.000  retained)
+#                        545.266k objects (     0.000  retained)
+#                         50.000  strings (     0.000  retained)
+```
+
+This means that serialization may consume **~5%** more memory.
+
+Detailed benchmark script & results can be found [here](/spec/benchmark_spec.rb).
+
 ## 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.

data/RELEASE.md

@@ -0,0 +1,13 @@
+# Release steps
+1. Bump VERSION constant
+2. Generate changelog and update
+```shell
+CHANGELOG_GITHUB_TOKEN=<token> bundle exec rake changelog
+```
+3. Run `bundle` to regenerate Gemfile.lock
+4. Commit & push a new tag
+5. Build and push to rubygems
+```shell
+gem build ams_lazy_relationships
+gem push ams_lazy_relationships-x.y.z.gem
+```

data/Rakefile

@@ -3,6 +3,7 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "github_changelog_generator/task"
+require "ams_lazy_relationships/version"
 
 RSpec::Core::RakeTask.new(:spec)
 
@@ -11,5 +12,5 @@ task default: :spec
 GitHubChangelogGenerator::RakeTask.new :changelog do |config|
   config.user = "Bajena"
   config.project = "ams_lazy_relationships"
-  config.future_release = "0.1.2"
+  config.future_release = "v#{AmsLazyRelationships::VERSION}"
 end

data/ams_lazy_relationships.gemspec

@@ -33,13 +33,12 @@ Gem::Specification.new do |spec|
   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"
+  spec.add_dependency "active_model_serializers", ">= 0.10.0.rc4"
+  spec.add_dependency "batch-loader", "~> 1"
 
   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"
@@ -52,9 +51,14 @@ Gem::Specification.new do |spec|
   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.6"
+  spec.add_development_dependency "sqlite3"
   # 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"
+
+  # Implicit dependency of AMS - used to be a part of Rails
+  spec.add_development_dependency "thread_safe"
+
+  spec.add_development_dependency "benchmark-memory", "~> 0.1"
 end

data/gemfiles/ams_0.10.0.gemfile

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

data/gemfiles/ams_0.10.10.gemfile

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

data/gemfiles/ams_0.10.3.gemfile

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

data/lib/ams_lazy_relationships.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
+require "batch-loader"
+require "active_model_serializers"
+
 require "ams_lazy_relationships/version"
+require "ams_lazy_relationships/extensions"
 require "ams_lazy_relationships/loaders"
 require "ams_lazy_relationships/core"