cancan-eager_load 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98f72f292a710c3b3958d0fd629b2bc2ffcda253fe6172cde28a8dff9fbd3b86
-  data.tar.gz: b41449ab6f5e8331ebca578c2af3ff185cf06210171e743b88a40ca115c31bd7
+  metadata.gz: 322e66e24a6cb570205bb168d8678822c171677c3707555cbd7804b88c4a06f4
+  data.tar.gz: 505b51f3e13703169b9c69f106a4cab4e1b9eb9fb07a933ed12b5a5fc0460510
 SHA512:
-  metadata.gz: b788482de305ac567374660605d5cfde58df752af33fb429e76a466061657f738c803fceb779a969f825bcd5c80e58c5cc7fb742249dfead8bd67c1c3b9867d2
-  data.tar.gz: ebe0d97aac384045bccc166f5d6b952be7b7fd96e58662c32af4378c332b5359d0588f3a3e2b552e5802267639ced7e76a1feb4448502709ac4ca845b315d760
+  metadata.gz: 16b01225d9c173864492e7ac92b177b67ab9b996ff8432fdc5fa05664c49f3c2fdaca73f0eeab1e5e3354eb9f7f9ec2ff0c5dec1a948883ba59b3c4506df059d
+  data.tar.gz: 7fc9343396b863f0df453e989ca2788f71310339574444ebdbf9398ec88bd2ec25b8a3601938d6c498e6441d7eda43f2633bc2cb465e3e33f838cd5e064cff47

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,46 @@
+Eager load associations to check hash conditions.
+
+## Why is this needed?
+
+When checking a user has the ability to perform an action on an instance using a deeply nested hash, it's possible to encounter expensive N+1 queries, which slow your application down.
+
+```ruby
+# ability.rb
+def initialize(user)
+  return unless user.present?
+  
+  # User can see Posts before they're published, of the authors they're mentoring
+  can :show, Post, status: :preview, authors: { mentors: { id: user.id } }
+end    
+        
+# Controllers
+def show
+  @post = Post.find(params[:id])
+                         
+  # Causes an N+1 problem - a separate SQL query is made to find the mentors of each author
+  authorize! :show, @post
+end
+```  
+
+It's possible to audit your code and manually eager load the associtions needed for each permission check, but that's slow, error prone and likely to get out of sync if you redefine your abilities.
+
+Or you could use `cancan-eager_load` to automatically do it for you.  
+ 
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cancan-eager_load'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cancan-eager_load
+
+## Usage
+
+Just use CanCanCan's helper methods as normal: `authorize!`, `can?` and `cannot?`
+

data/cancan-eager_loading.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'cancan/eager_load/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cancan-eager_load'
+  spec.version       = CanCan::EagerLoad::VERSION
+  spec.authors       = ['Aleck Greenham']
+  spec.email         = ['greenhama13@gmail.com']
+  spec.summary       = 'Eager load associations to check hash conditions.'
+  spec.description   = 'Complex CanCan rule hash conditions can generate a lot of queries when passed an ' \
+                        'ActiveRecord instance as a subject. cancan-eager_load parses the hash and adapts it ' \
+                        'to eager load the data needed in a single query.'
+  spec.homepage      = 'https://github.com/greena13/cancan-eager_load'
+  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-instance_includes', '>= 0.0.1'
+  spec.add_dependency 'cancancan', '>= 2.1.4'
+end

data/lib/cancan-eager_load.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'cancan/eager_load/rule_extensions'
+
+module CanCan
+  class Rule
+    include CanCan::RuleExtensions
+  end
+end

data/lib/cancan/eager_load/rule_extensions.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'cancancan'
+
+module CanCan
+  module RuleExtensions
+    def matches_non_block_conditions(subject)
+      if @conditions.is_a?(Hash)
+        return nested_subject_matches_conditions?(subject) if subject.class == Hash
+
+        unless subject_class?(subject)
+          subject.includes(conditions_to_includes(@conditions))
+
+          return matches_conditions_hash?(subject)
+        end
+      end
+
+      # Don't stop at "cannot" definitions when there are conditions.
+      conditions_empty? ? true : @base_behavior
+    end
+
+    private
+
+    def conditions_to_includes(target)
+      return unless target.is_a?(Hash)
+
+      target.each_with_object({}) do |key_and_value, memo|
+        key = key_and_value[0]
+        value = key_and_value[1]
+
+        memo[key] = conditions_to_includes(value) || {} if value.is_a?(Hash)
+
+        memo
+      end
+    end
+  end
+end

data/lib/cancan/eager_load/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module CanCan
+  module EagerLoad
+    VERSION = '0.0.2'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cancan-eager_load
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Aleck Greenham
@@ -46,7 +46,16 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- cancan-eager_loading.gemspec
+- lib/cancan-eager_load.rb
+- lib/cancan/eager_load/rule_extensions.rb
+- lib/cancan/eager_load/version.rb
 homepage: https://github.com/greena13/cancan-eager_load
 licenses:
 - MIT