ar_lazy_preload 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fa14f78a46e62ec3f8cb5053ea2887bbb6a5b12b77bb714efed694c21c36432
-  data.tar.gz: f82efd9fef819d6c4c909e366161dfc9e39d679554ae0073af3519aaad0814e6
+  metadata.gz: 88bbf9af048997996a06aa5292f648fc9a5583a3335a4c088451bc7cb883f33f
+  data.tar.gz: 784ef74c3ab97149fb237c52ce663be4d0c7f5254e2181e1967b3f8b50e37949
 SHA512:
-  metadata.gz: 657987c4f3d36a53247aede5ffcd42cf362c732f286c87f7fada29e1ddcf775a49d39724a733c1281b0329c00f2bbab9ea74146e03b0a518756e91acaaa65820
-  data.tar.gz: de59065ed0ac071d39223f31f7028142d25d2fb7ac6e5af0149aff2211fdcf92ecf36aa5ba9a463883031e60d85b010df58dd55f7a9a3df228039f5de8fa0891
+  metadata.gz: 4bda01ddd3c35f9b1e4f03966566a8c14fcffe9c64b69a9b49227b6ff481bf73d348d0576aed8919e9363ab2914fa001a1ba3fd7da5569767ea714d38704d4cc
+  data.tar.gz: 15769ecfdd7a41f1860483aab2418c1c2f3167bcb2f67c491f120ac3d4cb00d5bb53b3540f0a3574a575f9062181f7a8c2b16fa50a4265f3e45bc032f9f63e47

data/README.md

@@ -1,3 +1,5 @@
+[![Cult Of Martians](http://cultofmartians.com/assets/badges/badge.svg)](https://cultofmartians.com/tasks/activerecord-lazy-preload.html)
+[![Gem Version](https://badge.fury.io/rb/ar_lazy_preload.svg)](https://rubygems.org/gems/ar_lazy_preload)
 [![Build Status](https://travis-ci.org/DmitryTsepelev/ar_lazy_preload.svg?branch=master)](https://travis-ci.org/DmitryTsepelev/ar_lazy_preload)
 [![Maintainability](https://api.codeclimate.com/v1/badges/00d04595661820dfba80/maintainability)](https://codeclimate.com/github/DmitryTsepelev/ar_lazy_preload/maintainability)
 [![Coverage Status](https://coveralls.io/repos/github/DmitryTsepelev/ar_lazy_preload/badge.svg?branch=master)](https://coveralls.io/github/DmitryTsepelev/ar_lazy_preload?branch=master)
@@ -8,13 +10,23 @@ Lazy loading associations for the ActiveRecord models. `#includes`, `#eager_load
 
 This gem allows to set up _lazy_ preloading for associations - it won't load anything until association is called for a first time, but when it happens - it loads all the associated records for all records from the initial relation in a single query.
 
-For example, if we define a following relation
+## Installation
+
+Add this line to your application's Gemfile, and you're all set:
+
+```ruby
+gem "ar_lazy_preload"
+```
+
+## Usage
+
+For example, if we define the following relation
 
 ```ruby
 users = User.lazy_preload(:posts).limit(10)
 ```
 
-and use it in a following way
+and use it in the following way
 
 ```ruby
 users.map(&:first_name)
@@ -26,7 +38,7 @@ there will be one query because we've never accessed posts:
 SELECT * FROM users LIMIT 10
 ```
 
-Hovever, when we try to load posts
+However, when we try to load posts
 
 ```ruby
 users.map(&:posts)
@@ -38,13 +50,15 @@ there will be one more request for posts:
 SELECT * FROM posts WHERE user_id in (...)
 ```
 
-## Installation
+## Auto preloading
 
-Add this line to your application's Gemfile, and you're all set:
+If you want the gem to be even more lazy - you can configure it to load all the associations lazily without specifying them explicitly. In order to do that you'll need to change the configuration in the following way:
 
 ```ruby
-gem "ar_lazy_preload"
+ArLazyPreload.config.auto_preload = true
 ```
 
+After that there is no need to call `lazy_preload` on the association, everything would be loaded lazily.
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/ar_lazy_preload/configuration.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ArLazyPreload
+  # ArLazyPreload configuration:
+  #
+  # - `auto_preload` - load all the associations lazily without
+  #    an explicit lazy_preload call
+  class Configuration
+    attr_accessor :auto_preload
+
+    def initialize
+      @auto_preload = false
+    end
+
+    alias auto_preload? auto_preload
+  end
+end

data/lib/ar_lazy_preload/context.rb

@@ -11,7 +11,8 @@ module ArLazyPreload
   class Context
     # Initiates lazy preload context for given records
     def self.register(records:, association_tree:)
-      return if records.empty? || association_tree.empty?
+      return if records.empty? || association_tree.empty? && !ArLazyPreload.config.auto_preload?
+
       ArLazyPreload::Context.new(records: records, association_tree: association_tree)
     end
 
@@ -30,6 +31,7 @@ module ArLazyPreload
     # objects in the context it if needed.
     def try_preload_lazily(association_name)
       return unless association_needs_preload?(association_name)
+
       preloader.preload(records, association_name)
       AssociatedContextBuilder.prepare(parent_context: self, association_name: association_name)
     end
@@ -37,6 +39,8 @@ module ArLazyPreload
     private
 
     def association_needs_preload?(association_name)
+      return true if ArLazyPreload.config.auto_preload?
+
       association_tree.any? do |node|
         if node.is_a?(Symbol)
           node == association_name

data/lib/ar_lazy_preload/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ArLazyPreload
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/ar_lazy_preload.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "ar_lazy_preload/configuration"
 require "ar_lazy_preload/ext/base"
 require "ar_lazy_preload/ext/relation"
 require "ar_lazy_preload/ext/association"
@@ -7,6 +8,12 @@ require "ar_lazy_preload/ext/merger"
 require "ar_lazy_preload/ext/association_relation"
 
 module ArLazyPreload
+  class << self
+    def config
+      @config ||= Configuration.new
+    end
+  end
+
   ActiveRecord::Base.include(ArLazyPreload::Base)
 
   ActiveRecord::Relation.prepend(ArLazyPreload::Relation)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_lazy_preload
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - DmitryTsepelev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-08 00:00:00.000000000 Z
+date: 2018-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -121,6 +121,7 @@ files:
 - lib/ar_lazy_preload.rb
 - lib/ar_lazy_preload/associated_context_builder.rb
 - lib/ar_lazy_preload/association_tree_builder.rb
+- lib/ar_lazy_preload/configuration.rb
 - lib/ar_lazy_preload/context.rb
 - lib/ar_lazy_preload/ext/association.rb
 - lib/ar_lazy_preload/ext/association_relation.rb