cancancan-squeel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e54134fb57f78cfd282b96b03b2bc49cf164468
+  data.tar.gz: 1c5b7a4a8f1aeea3cca907c7755a8a3fc9f4d13c
+SHA512:
+  metadata.gz: 0b03fa5bfafc638b66de73e42856e3047de0450898f2f6b31b0b4c2f514b4ffbeec719b6b6a35e8d03c09f129351a21c97729d41ecdb1c414e64891ff9901fbb
+  data.tar.gz: 9b2cee5e00ea453850b5065b826ae5917ebfbd9dd0017bd5870f7770f5802797ece8169f8652af4a33b11bcb219af4af1af4fd925b78dd9175ab52160bdf7c9d

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# Ignore generated code coverage information
+/spec/coverage/*
+/coverage/*
+
+# Ignore RSpec state
+/spec/examples.txt

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.idea/cancancan-squeel.iml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/.bundle" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

data/.rspec

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

data/.rubocop.unhound.yml

@@ -0,0 +1,109 @@
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    reduce:
+    inject: 'reduce'
+    find:
+    detect: 'find'
+
+Style/FileName:
+  Enabled: true
+
+Style/GuardClause:
+  Enabled: true
+
+Style/IfUnlessModifier:
+  Enabled: true
+
+Style/PercentLiteralDelimiters:
+  Enabled: true
+
+Style/SignalException:
+  Enabled: true
+
+Style/SingleLineBlockParams:
+  Enabled: true
+
+Style/SingleLineMethods:
+  Enabled: true
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+
+Style/TrailingCommaInLiteral:
+  Enabled: true
+
+Metrics/AbcSize:
+  Enabled: true
+
+Metrics/ClassLength:
+  Enabled: true
+
+Metrics/ModuleLength:
+  Enabled: true
+
+Metrics/CyclomaticComplexity:
+  Enabled: true
+
+Metrics/MethodLength:
+  Enabled: true
+
+Metrics/ParameterLists:
+  Enabled: true
+
+Metrics/PerceivedComplexity:
+  Enabled: true
+
+Lint/AssignmentInCondition:
+  Enabled: true
+
+Style/AccessorMethodName:
+  Enabled: true
+
+Style/Alias:
+  Enabled: true
+  EnforcedStyle: prefer_alias_method
+
+Style/Documentation:
+  Enabled: true
+
+Style/DoubleNegation:
+  Enabled: true
+
+Style/EachWithObject:
+  Enabled: true
+
+Style/EmptyLiteral:
+  Enabled: true
+
+Style/ModuleFunction:
+  Enabled: true
+
+Style/OneLineConditional:
+  Enabled: true
+
+Style/PerlBackrefs:
+  Enabled: true
+
+Style/SpecialGlobalVars:
+  Enabled: true
+
+Style/VariableInterpolation:
+  Enabled: true
+
+Style/WhenThen:
+  Enabled: true
+
+Lint/EachWithObjectArgument:
+  Enabled: true
+
+Lint/HandleExceptions:
+  Enabled: true
+
+Lint/LiteralInCondition:
+  Description: Checks of literals used in conditions.
+  Enabled: true
+
+Lint/LiteralInInterpolation:
+  Description: Checks for literals used in interpolation.
+  Enabled: true

data/.rubocop.yml

@@ -0,0 +1,46 @@
+inherit_from:
+  - .rubocop.unhound.yml
+
+AllCops:
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+  Exclude:
+   - 'vendor/bundle/**/*'
+  TargetRubyVersion: 2.1
+
+Metrics/LineLength:
+  Max: 100
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/Documentation:
+  Enabled: false
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/IfUnlessModifier:
+  MaxLineLength: 100
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/WhileUntilModifier:
+  MaxLineLength: 100
+
+Style/WordArray:
+  Enabled: false
+
+Style/RegexpLiteral:
+  AllowInnerSlashes: true
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 2.1.7
+  - 2.2.3
+  - 2.3.0
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+bundler_args: "--jobs=3 --retry=3"
+cache: bundler
+
+before_install:
+  - gem update bundler

data/Gemfile

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

data/README.md

@@ -0,0 +1,13 @@
+# CanCanCan-Squeel [![Build Status](https://travis-ci.org/lowjoel/cancancan-squeel.svg?branch=master)](https://travis-ci.org/lowjoel/cancancan-squeel)
+[![Code Climate](https://codeclimate.com/github/lowjoel/cancancan-squeel/badges/gpa.svg)] (https://codeclimate.com/github/lowjoel/cancancan-squeel) [![Coverage Status](https://coveralls.io/repos/github/lowjoel/cancancan-squeel/badge.svg?branch=master)](https://coveralls.io/github/lowjoel/cancancan-squeel?branch=master) [![security](https://hakiri.io/github/lowjoel/cancancan-squeel/master.svg)](https://hakiri.io/github/lowjoel/cancancan-squeel/master) [![Inline docs](http://inch-ci.org/github/lowjoel/cancancan-squeel.svg?branch=master)](http://inch-ci.org/github/lowjoel/cancancan-squeel)
+
+This is an adapter for the [CanCanCan](https://github.com/CanCanCommunity/cancancan) authorisation
+library to automatically generate SQL queries from ability rules.
+
+This differs from the default ActiveRecord implementation in that it uses
+[squeel](https://github.com/activerecord-hackery/squeel) to generate SQL queries. This no longer
+uses
+ - `includes` (which incurs eager loading overhead)
+ - `WHERE` fragments, joined lexically using `OR` or `AND` or `NOT`.
+
+As a side effect of using `squeel`, this allows self-joins in rule definitions.

data/Rakefile

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

data/cancancan-squeel.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cancancan/squeel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cancancan-squeel'
+  spec.version       = CanCanCan::Squeel::VERSION
+  spec.authors       = ['Joel Low']
+  spec.email         = ['joel@joelsplace.sg']
+
+  spec.summary       = 'Squeel database adapter for CanCanCan.'
+  spec.description   = "Implements CanCanCan's rule-based record fetching using Squeel."
+  spec.homepage      = 'https://github.com/lowjoel/cancancan-squeel'
+
+  spec.files         = `git ls-files -z`.split("\x0").
+                       reject { |f| f.match(/^(test|spec|features)\//) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+
+  spec.add_development_dependency 'sqlite3'
+
+  spec.add_dependency 'activerecord', '>= 4.1'
+  spec.add_dependency 'cancancan', '~> 1.10'
+  spec.add_dependency 'squeel', '~> 1.2'
+end

data/lib/cancancan/squeel.rb

@@ -0,0 +1,8 @@
+require 'active_record'
+require 'cancancan'
+require 'squeel'
+
+require 'cancancan/squeel/version'
+require 'cancancan/squeel/active_record_disabler'
+require 'cancancan/squeel/squeel_adapter'
+

data/lib/cancancan/squeel/active_record_disabler.rb

@@ -0,0 +1,7 @@
+class CanCanCan::Squeel::ActiveRecordDisabler
+  ::CanCan::ModelAdapters::ActiveRecord4Adapter.class_eval do
+    def self.for_class?(_)
+      false
+    end
+  end
+end

data/lib/cancancan/squeel/squeel_adapter.rb

@@ -0,0 +1,195 @@
+class CanCanCan::Squeel::SqueelAdapter < CanCan::ModelAdapters::AbstractAdapter
+  def self.for_class?(model_class)
+    model_class <= ActiveRecord::Base
+  end
+
+  def self.override_condition_matching?(subject, name, _)
+    return false unless subject.class.respond_to?(:defined_enums)
+
+    subject.class.defined_enums.include?(name.to_s)
+  end
+
+  def self.matches_condition?(subject, name, value)
+    # Get the mapping from enum strings to values.
+    enum = subject.class.public_send(name.to_s.pluralize)
+
+    # Get the value of the attribute as an integer.
+    attribute = enum[subject.public_send(name)]
+
+    # Check to see if the value matches the condition.
+    value.is_a?(Enumerable) ? value.include?(attribute) : attribute == value
+  end
+
+  def database_records
+    # TODO: Handle overridden scopes.
+    relation.distinct
+  end
+
+  private
+
+  # Builds a relation that expresses the set of provided rules.
+  #
+  # This first joins all the tables specified in the rules, then builds the corresponding Squeel
+  # expression for the conditions.
+  def relation
+    join_scope = @rules.reduce(@model_class.where(nil)) do |scope, rule|
+      add_joins_to_scope(scope, build_join_list(rule.conditions))
+    end
+
+    add_conditions_to_scope(join_scope)
+  end
+
+  # Builds an array of joins for the given conditions hash.
+  #
+  # For example:
+  #
+  # a: { b: { c: 3 }, d: { e: 4 }} => [[:a, :b], [:a, :d]]
+  #
+  # @param [Hash] conditions The conditions to build the joins.
+  # @return [Array<Array<Symbol>>] The joins needed to satisfy the given conditions
+  def build_join_list(conditions)
+    conditions.flat_map do |key, value|
+      if value.is_a?(Hash)
+        [[key]].concat(build_join_list(value).map { |join| Array(join).unshift(key) })
+      else
+        []
+      end
+    end
+  end
+
+  # Builds a relation, outer joined on the provided associations.
+  #
+  # @param [ActiveRecord::Relation] scope The current scope to add the joins to.
+  # @param [Array<Array<Symbol>>] joins The set of associations to outer join with.
+  # @return [ActiveRecord::Relation] The built relation.
+  def add_joins_to_scope(scope, joins)
+    joins.reduce(scope) do |result, join|
+      result.joins do
+        join.reduce(self) do |relation, association|
+          relation.__send__(association).outer
+        end
+      end
+    end
+  end
+
+  # Adds the rule conditions to the scope.
+  #
+  # This builds Squeel expression for each rule, and combines the expression with those to the left
+  # using a fold-left.
+  #
+  # @param [ActiveRecord::Relation] scope The scope to add the rule conditions to.
+  def add_conditions_to_scope(scope)
+    adapter = self
+    rules = @rules
+
+    # default n
+    scope.where do
+      rules.reduce(nil) do |left_expression, rule|
+        combined_rule = adapter.send(:combine_expression_with_rule, self, left_expression, rule)
+        break if combined_rule.nil?
+
+        combined_rule
+      end
+    end
+  end
+
+  # Combines the given expression with the new rule.
+  #
+  # @param squeel The Squeel scope.
+  # @param left_expression The Squeel expression for all preceding rules.
+  # @param [CanCan::Rule] rule The rule being added.
+  # @return [Squeel::Nodes::Node] If the rule has an expression.
+  # @return [NilClass] If the rule is unconditional.
+  def combine_expression_with_rule(squeel, left_expression, rule)
+    right_expression = build_expression_from_rule(squeel, rule)
+    return right_expression if right_expression.nil? || !left_expression
+
+    if rule.base_behavior
+      left_expression | right_expression
+    else
+      left_expression & right_expression
+    end
+  end
+
+  # Builds a Squeel expression representing the rule's conditions.
+  #
+  # @param squeel The Squeel scope.
+  # @param [CanCan::Rule] rule The rule being built.
+  def build_expression_from_rule(squeel, rule)
+    comparator = rule.base_behavior ? :== : :!=
+    build_expression_node(squeel, @model_class, comparator, rule.conditions, true)
+  end
+
+  # Builds a new Squeel expression node.
+  #
+  # @param node The parent node context.
+  # @param [Class] model_class The model class which the conditions reference.
+  # @param [Symbol] comparator The comparator to use when generating the comparison.
+  # @param [Hash] conditions The values to compare the given node's attributes against.
+  # @param [Boolean] root True if the node being built is from the root. The root node is special
+  #   because it does not mutate itself; all other nodes do.
+  def build_expression_node(node, model_class, comparator, conditions, root = false)
+    conditions.reduce(nil) do |left_expression, (key, value)|
+      comparison_node = build_comparison_node(root ? node : node.dup, model_class, key,
+                                              comparator, value)
+      if left_expression
+        left_expression & comparison_node
+      else
+        comparison_node
+      end
+    end
+  end
+
+  # Builds a comparison node for the given key and value.
+  #
+  # @param node The node context to build the comparison.
+  # @param [Class] model_class The model class which the conditions reference.
+  # @param [Symbol] key The column to compare against.
+  # @param [Symbol] comparator The comparator to compare the column against the value.
+  # @param value The value to compare the column against.
+  def build_comparison_node(node, model_class, key, comparator, value)
+    if value.is_a?(Hash)
+      reflection = model_class.reflect_on_association(key)
+      build_expression_node(node.__send__(key), reflection.klass, comparator, value)
+    else
+      key, comparator, value = squeel_comparison_for(model_class, key, comparator, value)
+      node.__send__(key).public_send(comparator, value)
+    end
+  end
+
+  # Picks the appropriate column, comparator, and value to use in the Squeel expression.
+  #
+  # This checks for association references: this will use the appropriate column name.
+  #
+  # Array values are interpreted as alternative choices allowed or disallowed.
+  #
+  # @param [Class] model_class The model class which the key references.
+  # @param [Symbol] key The column being compared.
+  # @param [Symbol] comparator The comparator to get the appropriate Squeel comparator for.
+  # @param value The value to be comparing against.
+  # @return [Array<(Symbol, Symbol, Object)>] A triple containing the column to compare with, the
+  #   comparator to use, and the value to compare with.
+  def squeel_comparison_for(model_class, key, comparator, value)
+    if (association = model_class.reflect_on_association(key))
+      key = association.foreign_key
+    end
+
+    comparator = squeel_comparator_for(comparator, value)
+    [key, comparator, value]
+  end
+
+  # Maps the given comparator to a comparator appropriate for the given value.
+  #
+  # Array values are interpreted as alternative choices allowed or disallowed.
+  #
+  # @param [Symbol] comparator The comparator to get the appropriate Squeel comparator for.
+  # @param value The value to be comparing against.
+  # @return [Symbol] The comparator for the desired effect, suitable for the given type.
+  def squeel_comparator_for(comparator, value)
+    case [comparator, value]
+    when :==, Array then :>>
+    when :!=, Array then :<<
+    else comparator
+    end
+  end
+end

data/lib/cancancan/squeel/version.rb

@@ -0,0 +1,4 @@
+module CanCanCan; end
+module CanCanCan::Squeel
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification
+name: cancancan-squeel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joel Low
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: cancancan
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: squeel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Implements CanCanCan's rule-based record fetching using Squeel.
+email:
+- joel@joelsplace.sg
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".idea/cancancan-squeel.iml"
+- ".rspec"
+- ".rubocop.unhound.yml"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- cancancan-squeel.gemspec
+- lib/cancancan/squeel.rb
+- lib/cancancan/squeel/active_record_disabler.rb
+- lib/cancancan/squeel/squeel_adapter.rb
+- lib/cancancan/squeel/version.rb
+homepage: https://github.com/lowjoel/cancancan-squeel
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Squeel database adapter for CanCanCan.
+test_files: []