activerecord-instance_includes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8522d7e3d7c607a0921784a5002886eab1deaaf3cee31aa28ef8c3d78ad85da
+  data.tar.gz: 5a9cfb7da57a9ba25f089e5177bdf0a3f6b253b3129b06a3922da639bc9c696e
+SHA512:
+  metadata.gz: 4b3cdf4c73e714fa95f59ffc9ed0fe044f0a3bb13b796ccb74bfe63bfb84a3d03fcad170564f8bab2617a3e51bcb7f4a46f33902163044f63051ff3841241858
+  data.tar.gz: 20a315d1bf52298f7e197736de8ef0ebc76f64c27272b7379f6ac87df9d88e6800636a097190f54eef5e6b64bf76cc70b43097516a789e2192058b692c445d15

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+spec/tmp
+spec/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2020 Aleck Greenham
+
+MIT License
+
+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,67 @@
+Adds includes method to ActiveRecord instances
+
+## Why is this needed?
+
+Sometimes you don't have access to the code that instantiates a particular `ActiveRecord` instance, so you can't call `includes` on the class or `ActiveRecord::Relation` instance to eager load associations.
+
+For example:
+
+```ruby
+# Defines the @post instance variable for us
+load_and_authorize_resource
+
+def show
+  render @post 
+end
+```
+
+Normally this isn't a problem, because if you have a single instance, it's not possible to encounter a N+1 query while working with that instance or any of its direct associations. 
+
+```haml
+%h1= @post.title  
+
+%ul
+  - @post.authors.each do |author|
+    %li= author.name
+```
+
+The problem occurs with more complex (deeply nested) processing, and you have to crawl over the data of nested has_many associations. 
+
+```haml
+%ul
+  - @post.authors.each do |author|
+    -# Causes a N+1 query problem:
+    %li= "#{author.name} (#{author.nicknames.pluck(:value).join(',')})
+```
+
+That's when you need `activerecord-instance_includes`:
+
+```ruby
+@post.includes(authors: [:nicknames])
+```
+ 
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-instance_includes'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-instance_includes
+
+## Usage
+
+Just call `includes` on ActiveRecord instances in the same way you would normally do so for the ActiveRecord class or `ActiveRecord::Relation` instance.
+
+The `#includes` method returns the ActiveRecord instance itself so you can chain method calls:
+
+```ruby
+%ul
+  - @post.includes(authors: [:nicknames]).authors.each do |author|
+    %li= "#{author.name} (#{author.nicknames.pluck(:value).join(',')})
+```

data/activerecord-instance_includes.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'activerecord/instance_includes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'activerecord-instance_includes'
+  spec.version       = ActiveRecordInstanceIncludes::VERSION
+  spec.authors       = ['Aleck Greenham']
+  spec.email         = ['greenhama13@gmail.com']
+  spec.summary       = 'Adds includes method to ActiveRecord instances.'
+  spec.description   = 'Provides an #includes method to eager load associations of ActiveRecord instances, ' \
+                        'for when you don\'t have access to the class object or ActiveRecord::Relation instance.'
+  spec.homepage      = 'https://github.com/greena13/activerecord-instance_includes'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 1.8.7'
+  spec.add_dependency 'activerecord', '>= 3.0.0'
+end

data/lib/activerecord-instance_includes.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module InstanceIncludes
+    autoload :Rails3Extensions, 'activerecord/instance_includes/rails3_extensions'
+    autoload :Rails4Extensions, 'activerecord/instance_includes/rails4_extensions'
+  end
+end
+
+require 'activerecord/instance_includes/active_record'

data/lib/activerecord/instance_includes/active_record.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/lazy_load_hooks'
+
+ActiveSupport.on_load(:active_record) do
+  if ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR >= 1
+    include ActiveRecord::InstanceIncludes::Rails3Extensions
+  elsif ActiveRecord::VERSION::MAJOR >= 4
+    include ActiveRecord::InstanceIncludes::Rails4Extensions
+  end
+end

data/lib/activerecord/instance_includes/rails3_extensions.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module InstanceIncludes
+    module Rails3Extensions
+      def includes(*eager_loads)
+        ActiveRecord::Associations::Preloader.new(self, eager_loads).run
+        self
+      end
+    end
+  end
+end

data/lib/activerecord/instance_includes/rails4_extensions.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module InstanceIncludes
+    module Rails4Extensions
+      def includes(*eager_loads)
+        ActiveRecord::Associations::Preloader.new.preload(self, eager_loads)
+        self
+      end
+    end
+  end
+end

data/lib/activerecord/instance_includes/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveRecordInstanceIncludes
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-instance_includes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aleck Greenham
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: 'Provides an #includes method to eager load associations of ActiveRecord
+  instances, for when you don''t have access to the class object or ActiveRecord::Relation
+  instance.'
+email:
+- greenhama13@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- activerecord-instance_includes.gemspec
+- lib/activerecord-instance_includes.rb
+- lib/activerecord/instance_includes/active_record.rb
+- lib/activerecord/instance_includes/rails3_extensions.rb
+- lib/activerecord/instance_includes/rails4_extensions.rb
+- lib/activerecord/instance_includes/version.rb
+homepage: https://github.com/greena13/activerecord-instance_includes
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Adds includes method to ActiveRecord instances.
+test_files: []