cancando 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a52f50f7d79f1e3211409f3df36adde0c6deef7
+  data.tar.gz: 63884bf162be00902add65c10cd3c4c8999e0b7b
+SHA512:
+  metadata.gz: ab562bf17fccef7fbbc6c8ad3cacdc6e80722ba92ec03ba9af61cf17a002f90694b249705c7f9e94d6a948859484984de37bcb7afd6eb6aaa91ca7431b700979
+  data.tar.gz: 71c00b573218c6c9e996633b89d2af3342951ee93a4ccf15348a890c432d7e754ee9f507e3fc96aed6879839a10ac4b4697723028e063cbad41e3c1372c0a172

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cancando.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    cancando (1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    cancancan (2.0.0)
+    diff-lcs (1.3)
+    rake (12.3.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  cancancan (~> 2.0)
+  cancando!
+  rake (~> 12.3)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 viktormarkov
+
+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 @@
+# Cancando
+
+Helper for [Cancancan](https://github.com/CanCanCommunity/cancancan) gem.
+
+Increase `accessible_by` query performance via ability merging.
+
+If your app have more than one ability declaration for one resource
+```ruby
+can :index, User, id: [1, 2, 3]
+can :index, User, id: [4, 5, 6]
+```
+`User.accessible_by(ability, :index)` generates sql query like that:
+```sql
+SELECT users.* FROM users WHERE (users.id IN (4, 5, 6)) OR (users.id IN (1, 2, 3))
+```
+
+In case of big data that fact causes significant performance issue.
+
+Cancando helps to avoid that situation by merging conditions:
+```ruby
+can :index, User, id: [1, 2, 3, 4, 5, 6]
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cancando'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cancando
+
+## Usage
+
+Important. You have to install [Cancancan](https://github.com/CanCanCommunity/cancancan) gem first.
+
+1) Add `include Cancando`
+2) User `can_do` and `cannot_do` instead of `can` and `cannot` from cancancan
+3) Call `apply` for merge and save abilities
+
+Simple example:
+```ruby
+class Permission
+  include Cancando
+  
+  def grant_permission
+    can_do :index, User, company_id: available_company_ids
+    can_do :update, Company, id: current_user.company_id
+    apply
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/viktormarkov/cancando. This project is intended to be a safe, welcoming space for collaboration.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/cancando.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cancando/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cancando'
+  spec.version       = Cancando::VERSION
+  spec.authors       = ['Viktor Markov']
+  spec.email         = ['viktormarkov25@gmail.com']
+
+  spec.summary       = 'Increase accessible_by query performance via ability merging'
+  spec.description   = 'Helper for Cancancan. Increase accessible_by query performance via ability merging'
+  spec.homepage      = 'https://github.com/viktormarkov/cancando'
+  spec.license       = 'MIT'
+  spec.platform      = Gem::Platform::RUBY
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'cancancan', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/cancando.rb

@@ -0,0 +1,105 @@
+require 'cancan'
+
+module Cancando
+  include CanCan::Ability
+
+  def can_do(actions, resource, conditions = {})
+    add(abilities, actions, resource, conditions)
+  end
+
+  def cannot_do(actions, resource, conditions = {})
+    add(restrictions, actions, resource, conditions)
+  end
+
+  def abilities
+    @abilities ||= Hash.new { |hash, k| hash[k] = [] }
+  end
+
+  def restrictions
+    @restrictions ||= Hash.new { |hash, k| hash[k] = [] }
+  end
+
+  def apply
+    merge_and_grant(abilities, 'can') if abilities
+    merge_and_grant(restrictions, 'cannot') if restrictions
+  end
+
+  private
+
+  def add(target, actions, resource, conditions)
+    Array(actions).each do |action|
+      target[resource] << {action: action, conditions: conditions}
+    end
+  end
+
+  def merge_and_grant(abilities_to_merge, method)
+    abilities_to_merge.each do |resource, abilities|
+      merged_abilities = []
+      abilities.each do |ability|
+        merge_abilities(merged_abilities, ability)
+      end
+      grant_abilities(merged_abilities, resource, method)
+    end
+  end
+
+  def merge_abilities(abilities, ability_to_merge)
+    if abilities.empty?
+      abilities << ability_to_merge
+      return
+    end
+
+    merged = false
+    abilities.each do |ability|
+      if same_actions?(ability[:action], ability_to_merge[:action]) &&
+          same_single_condition_attr?(ability_to_merge[:conditions], ability[:conditions])
+
+        merge_conditions(ability, ability_to_merge)
+        merge_actions(ability, ability_to_merge)
+        merged = true
+        break
+      elsif equal_conditions?(ability_to_merge[:conditions], ability[:conditions])
+        merge_actions(ability, ability_to_merge)
+        merged = true
+        break
+      end
+    end
+
+    abilities << ability_to_merge unless merged
+  end
+
+  def same_actions?(actions1, actions2)
+    if actions1.is_a? Array
+      actions1.include? actions2
+    else
+      actions1 == actions2
+    end
+  end
+
+  def same_single_condition_attr?(conditions1, conditions2)
+    conditions1.length == 1 && conditions1.keys == conditions2.keys
+  end
+
+  def equal_conditions?(conditions1, conditions2)
+    conditions1.sort == conditions2.sort
+  end
+
+  def merge_conditions(ability1, ability2)
+    attr_value1 = ability1[:conditions].first[1]
+    attr_value2 = ability2[:conditions].first[1]
+    attr_name = ability2[:conditions].first[0]
+    merged_value = (Array(attr_value1) + Array(attr_value2)).uniq
+
+    ability1[:conditions][attr_name] = merged_value.length == 1 ? merged_value[0] : merged_value
+  end
+
+  def merge_actions(ability1, ability2)
+    ability1[:action] = (Array(ability1[:action]) + Array(ability2[:action])).uniq
+  end
+
+  # apply abilities by cancanan methods can or cannot
+  def grant_abilities(abilities, resource, method)
+    abilities.each do |ability|
+      send(method, ability[:action], resource, ability[:conditions])
+    end
+  end
+end

data/lib/cancando/version.rb

@@ -0,0 +1,3 @@
+module Cancando
+  VERSION = "1.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: cancando
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Viktor Markov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: cancancan
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Helper for Cancancan. Increase accessible_by query performance via ability
+  merging
+email:
+- viktormarkov25@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/cancando.iml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/workspace.xml"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- cancando.gemspec
+- lib/cancando.rb
+- lib/cancando/version.rb
+homepage: https://github.com/viktormarkov/cancando
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Increase accessible_by query performance via ability merging
+test_files: []