ams_lazy_relationships 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f2d4206f5ac6fe534e19162405e4d6993e5a8ea
-  data.tar.gz: 78c94b7d3b54794b4ce8dd7f9b5645e694f2eff7
+  metadata.gz: dbafe51edd7b544ae1aa9f0338cb50d22a54d9f1
+  data.tar.gz: d60d837607389b59a521deb7a3486d3ec9c951b5
 SHA512:
-  metadata.gz: 80230d616e3b5007577ca2053080a1f11eda4d7b2978dd30ebb56d79819e5bd6555668add82b446cf381b00fc5684bf63bc13cb70085e2d818ba7d1d072ec228
-  data.tar.gz: c79403dd23812c678235b63a207e218c2c72eda850c7635fe0d962b536305a69c8188d85449e3f07a409702c22db9b573781f9ae6e6a172eaf2bed126fcaf101
+  metadata.gz: bee54b4366b2ddb41a43c4ca79db09162d7a2910e2570e046d57c79fb5bfee4031d2c2674af2dd04e5c276c93b0d8805a8a7871239bcbb60386310ac7e0cbc3b
+  data.tar.gz: 1de8a52d3743bcbeb955bbda27f8974c9d34dd6b3a3c1350c75fa2b646b9af955e53276cedd6b52b052516e781fe6bfc79f8c1f29ce20fe7cb6f612301121525

data/.travis.yml

@@ -11,15 +11,11 @@ gemfile:
 cache: bundler
 rvm:
   - 2.3.4
-before_install:
-  - gem install bundler:1.17 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/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Change Log
 
+## [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 +70,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)
+    ams_lazy_relationships (0.1.4)
       active_model_serializers
-      batch-loader (~> 1.2)
+      batch-loader (~> 1)
 
 GEM
   remote: https://rubygems.org/
@@ -45,7 +45,9 @@ GEM
       thor (>= 0.14.0)
     arel (9.0.0)
     ast (2.4.0)
-    batch-loader (1.3.0)
+    batch-loader (1.4.1)
+    benchmark-memory (0.1.2)
+      memory_profiler (~> 0.9)
     builder (3.2.3)
     case_transform (0.2)
       activesupport
@@ -80,6 +82,7 @@ GEM
     loofah (2.2.3)
       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)
@@ -181,6 +184,7 @@ DEPENDENCIES
   activerecord
   ams_lazy_relationships!
   appraisal
+  benchmark-memory (~> 0.1)
   bundler (~> 1.17)
   db-query-matchers
   github_changelog_generator

data/README.md

@@ -163,6 +163,36 @@ class BlogPostSerializer < BaseSerializer
 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,12 @@
+# 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. Build and push to rubygems
+```shell
+gem build ams_lazy_relationships
+gem push ams_lazy_relationships-x.y.z.gem
+```

data/Rakefile

@@ -11,5 +11,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 = "v0.1.4"
 end

data/ams_lazy_relationships.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "active_model_serializers"
-  spec.add_dependency "batch-loader", "~> 1.2"
+  spec.add_dependency "batch-loader", "~> 1"
 
   spec.add_development_dependency "activerecord"
   # A Ruby library for testing against different versions of dependencies
@@ -57,4 +57,6 @@ Gem::Specification.new do |spec|
   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"
+
+  spec.add_development_dependency "benchmark-memory", "~> 0.1"
 end

data/lib/ams_lazy_relationships/loaders/association.rb

@@ -20,7 +20,7 @@ module AmsLazyRelationships
       # @param block [Proc] a block to execute when data is evaluated.
       #  Loaded data is yielded as a block argument.
       def load(record, &block)
-        BatchLoader.for(record).batch(key: batch_key) do |records, loader|
+        BatchLoader.for(record).batch(key: batch_key, replace_methods: false) do |records, loader|
           data = load_data(records, loader)
 
           block&.call(data)

data/lib/ams_lazy_relationships/loaders/direct.rb

@@ -19,7 +19,7 @@ module AmsLazyRelationships
       # @param block [Proc] a block to execute when data is evaluated.
       #  Loaded data is yielded as a block argument.
       def load(record, &block)
-        BatchLoader.for(record).batch(key: cache_key(record)) do |records, loader|
+        BatchLoader.for(record).batch(key: cache_key(record), replace_methods: false) do |records, loader|
           data = []
           records.each do |r|
             value = calculate_value(r)

data/lib/ams_lazy_relationships/loaders/simple_belongs_to.rb

@@ -23,7 +23,7 @@ module AmsLazyRelationships
       # @param block [Proc] a block to execute when data is evaluated
       #  Loaded data is yielded as a block argument.
       def load(record, &block)
-        BatchLoader.for(record).batch(key: cache_key(record)) do |records, loader|
+        BatchLoader.for(record).batch(key: cache_key(record), replace_methods: false) do |records, loader|
           data = load_data(records)
 
           block&.call(data)

data/lib/ams_lazy_relationships/loaders/simple_has_many.rb

@@ -20,7 +20,7 @@ module AmsLazyRelationships
       #  Loaded data is yielded as a block argument.
       def load(record, &block)
         key = "#{record.class}/#{association_class_name}"
-        BatchLoader.for(record).batch(key: key) do |records, loader|
+        BatchLoader.for(record).batch(key: key, replace_methods: false) do |records, loader|
           data = load_data(records)
 
           block&.call(data)

data/lib/ams_lazy_relationships/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AmsLazyRelationships
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ams_lazy_relationships
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Jan Bajena
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-19 00:00:00.000000000 Z
+date: 2019-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -276,6 +276,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-memory
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 description: 
 email: 
 executables: []
@@ -294,6 +308,7 @@ files:
 - LICENSE
 - LICENSE.txt
 - README.md
+- RELEASE.md
 - Rakefile
 - ams_lazy_relationships.gemspec
 - bin/console