cancancan 1.11.0 → 2.3.0

data/lib/cancan/model_adapters/conditions_extractor.rb

@@ -0,0 +1,75 @@
+# this class is responsible of converting the hash of conditions
+# in "where conditions" to generate the sql query
+# it consists of a names_cache that helps calculating the next name given to the association
+# it tries to reflect the bahavior of ActiveRecord when generating aliases for tables.
+module CanCan
+  module ModelAdapters
+    class ConditionsExtractor
+      def initialize(model_class)
+        @names_cache = { model_class.table_name => [] }.with_indifferent_access
+        @root_model_class = model_class
+      end
+
+      def tableize_conditions(conditions, model_class = @root_model_class, path_to_key = 0)
+        return conditions unless conditions.is_a? Hash
+        conditions.each_with_object({}) do |(key, value), result_hash|
+          if value.is_a? Hash
+            result_hash.merge!(calculate_result_hash(key, model_class, path_to_key, result_hash, value))
+          else
+            result_hash[key] = value
+          end
+          result_hash
+        end
+      end
+
+      private
+
+      def calculate_result_hash(key, model_class, path_to_key, result_hash, value)
+        reflection = model_class.reflect_on_association(key)
+        unless reflection
+          raise WrongAssociationName, "association #{key} not defined in model #{model_class.name}"
+        end
+        nested_resulted = calculate_nested(model_class, result_hash, key, value.dup, path_to_key)
+        association_class = reflection.klass.name.constantize
+        tableize_conditions(nested_resulted, association_class, "#{path_to_key}_#{key}")
+      end
+
+      def calculate_nested(model_class, result_hash, relation_name, value, path_to_key)
+        value.each_with_object({}) do |(k, v), nested|
+          if v.is_a? Hash
+            value.delete(k)
+            nested[k] = v
+          else
+            table_alias = generate_table_alias(model_class, relation_name, path_to_key)
+            result_hash[table_alias] = value
+          end
+          nested
+        end
+      end
+
+      def generate_table_alias(model_class, relation_name, path_to_key)
+        table_alias = model_class.reflect_on_association(relation_name).table_name.to_sym
+
+        if alredy_used?(table_alias, relation_name, path_to_key)
+          table_alias = "#{relation_name.to_s.pluralize}_#{model_class.table_name}".to_sym
+
+          index = 1
+          while alredy_used?(table_alias, relation_name, path_to_key)
+            table_alias = "#{table_alias}_#{index += 1}".to_sym
+          end
+        end
+        add_to_cache(table_alias, relation_name, path_to_key)
+      end
+
+      def alredy_used?(table_alias, relation_name, path_to_key)
+        @names_cache[table_alias].try(:exclude?, "#{path_to_key}_#{relation_name}")
+      end
+
+      def add_to_cache(table_alias, relation_name, path_to_key)
+        @names_cache[table_alias] ||= []
+        @names_cache[table_alias] << "#{path_to_key}_#{relation_name}"
+        table_alias
+      end
+    end
+  end
+end

data/lib/cancan/model_additions.rb

@@ -1,5 +1,4 @@
 module CanCan
-
   # This module adds the accessible_by class method to a model. It is included in the model adapters.
   module ModelAdditions
     module ClassMethods

data/lib/cancan/rule.rb

@@ -1,8 +1,10 @@
+require_relative 'conditions_matcher.rb'
 module CanCan
   # This class is used internally and should only be called through Ability.
   # it holds the information about a "can" call made on Ability and provides
   # helpful methods to determine permission checking and conditions hash generation.
   class Rule # :nodoc:
+    include ConditionsMatcher
     attr_reader :base_behavior, :subjects, :actions, :conditions
     attr_writer :expanded_actions
 
@@ -11,77 +13,70 @@ module CanCan
     # and subject respectively (such as :read, @project). The third argument is a hash
     # of conditions and the last one is the block passed to the "can" call.
     def initialize(base_behavior, action, subject, conditions, block)
-      raise Error, "You are not able to supply a block with a hash of conditions in #{action} #{subject} ability. Use either one." if conditions.kind_of?(Hash) && !block.nil?
+      both_block_and_hash_error = 'You are not able to supply a block with a hash of conditions in '\
+                                  "#{action} #{subject} ability. Use either one."
+      raise Error, both_block_and_hash_error if conditions.is_a?(Hash) && block
       @match_all = action.nil? && subject.nil?
       @base_behavior = base_behavior
-      @actions = [action].flatten
-      @subjects = [subject].flatten
+      @actions = Array(action)
+      @subjects = Array(subject)
       @conditions = conditions || {}
       @block = block
     end
 
+    def can_rule?
+      base_behavior
+    end
+
+    def cannot_catch_all?
+      !can_rule? && catch_all?
+    end
+
+    def catch_all?
+      [nil, false, [], {}, '', ' '].include? @conditions
+    end
+
     # Matches both the subject and action, not necessarily the conditions
     def relevant?(action, subject)
       subject = subject.values.first if subject.class == Hash
       @match_all || (matches_action?(action) && matches_subject?(subject))
     end
 
-    # Matches the block or conditions hash
-    def matches_conditions?(action, subject, extra_args)
-      if @match_all
-        call_block_with_all(action, subject, extra_args)
-      elsif @block && !subject_class?(subject)
-        @block.call(subject, *extra_args)
-      elsif @conditions.kind_of?(Hash) && subject.class == Hash
-        nested_subject_matches_conditions?(subject)
-      elsif @conditions.kind_of?(Hash) && !subject_class?(subject)
-        matches_conditions_hash?(subject)
-      else
-        # Don't stop at "cannot" definitions when there are conditions.
-        conditions_empty? ? true : @base_behavior
-      end
-    end
-
     def only_block?
-      conditions_empty? && !@block.nil?
+      conditions_empty? && @block
     end
 
     def only_raw_sql?
-      @block.nil? && !conditions_empty? && !@conditions.kind_of?(Hash)
-    end
-
-    def conditions_empty?
-      @conditions == {} || @conditions.nil?
+      @block.nil? && !conditions_empty? && !@conditions.is_a?(Hash)
     end
 
     def unmergeable?
       @conditions.respond_to?(:keys) && @conditions.present? &&
-        (!@conditions.keys.first.kind_of? Symbol)
+        (!@conditions.keys.first.is_a? Symbol)
     end
 
     def associations_hash(conditions = @conditions)
       hash = {}
-      conditions.map do |name, value|
-        hash[name] = associations_hash(value) if value.kind_of? Hash
-      end if conditions.kind_of? Hash
+      if conditions.is_a? Hash
+        conditions.map do |name, value|
+          hash[name] = associations_hash(value) if value.is_a? Hash
+        end
+      end
       hash
     end
 
     def attributes_from_conditions
       attributes = {}
-      @conditions.each do |key, value|
-        attributes[key] = value unless [Array, Range, Hash].include? value.class
-      end if @conditions.kind_of? Hash
+      if @conditions.is_a? Hash
+        @conditions.each do |key, value|
+          attributes[key] = value unless [Array, Range, Hash].include? value.class
+        end
+      end
       attributes
     end
 
     private
 
-    def subject_class?(subject)
-      klass = (subject.kind_of?(Hash) ? subject.values.first : subject).class
-      klass == Class || klass == Module
-    end
-
     def matches_action?(action)
       @expanded_actions.include?(:manage) || @expanded_actions.include?(action)
     end
@@ -91,61 +86,10 @@ module CanCan
     end
 
     def matches_subject_class?(subject)
-      @subjects.any? { |sub| sub.kind_of?(Module) && (subject.kind_of?(sub) || subject.class.to_s == sub.to_s || subject.kind_of?(Module) && subject.ancestors.include?(sub)) }
-    end
-
-    # Checks if the given subject matches the given conditions hash.
-    # This behavior can be overriden by a model adapter by defining two class methods:
-    # override_matching_for_conditions?(subject, conditions) and
-    # matches_conditions_hash?(subject, conditions)
-    def matches_conditions_hash?(subject, conditions = @conditions)
-      return true if conditions.empty?
-      adapter = model_adapter(subject)
-
-      if adapter.override_conditions_hash_matching?(subject, conditions)
-        return adapter.matches_conditions_hash?(subject, conditions)
-      end
-
-      conditions.all? do |name, value|
-        if adapter.override_condition_matching?(subject, name, value)
-          return adapter.matches_condition?(subject, name, value)
-        end
-
-        condition_match?(subject.send(name), value)
-      end
-    end
-
-    def nested_subject_matches_conditions?(subject_hash)
-      parent, child = subject_hash.first
-      matches_conditions_hash?(parent, @conditions[parent.class.name.downcase.to_sym] || {})
-    end
-
-    def call_block_with_all(action, subject, extra_args)
-      if subject.class == Class
-        @block.call(action, subject, nil, *extra_args)
-      else
-        @block.call(action, subject.class, subject, *extra_args)
-      end
-    end
-
-    def model_adapter(subject)
-      CanCan::ModelAdapters::AbstractAdapter.adapter_class(subject_class?(subject) ? subject : subject.class)
-    end
-
-    def condition_match?(attribute, value)
-      case value
-      when Hash       then hash_condition_match?(attribute, value)
-      when String     then attribute == value
-      when Enumerable then value.include?(attribute)
-      else attribute == value
-      end
-    end
-
-    def hash_condition_match?(attribute, value)
-      if attribute.kind_of?(Array) || (defined?(ActiveRecord) && attribute.kind_of?(ActiveRecord::Relation))
-        attribute.any? { |element| matches_conditions_hash?(element, value) }
-      else
-        !attribute.nil? && matches_conditions_hash?(attribute, value)
+      @subjects.any? do |sub|
+        sub.is_a?(Module) && (subject.is_a?(sub) ||
+          subject.class.to_s == sub.to_s ||
+          (subject.is_a?(Module) && subject.ancestors.include?(sub)))
       end
     end
   end

data/lib/cancan/rules_compressor.rb

@@ -0,0 +1,20 @@
+require_relative 'conditions_matcher.rb'
+module CanCan
+  class RulesCompressor
+    attr_reader :initial_rules, :rules_collapsed
+
+    def initialize(rules)
+      @initial_rules = rules
+      @rules_collapsed = compress(@initial_rules)
+    end
+
+    def compress(array)
+      idx = array.rindex(&:catch_all?)
+      return array unless idx
+      value = array[idx]
+      array[idx..-1]
+        .drop_while { |n| n.base_behavior == value.base_behavior }
+        .tap { |a| a.unshift(value) unless value.cannot_catch_all? }
+    end
+  end
+end

data/lib/cancan/version.rb

@@ -1,3 +1,3 @@
 module CanCan
-  VERSION = "1.11.0"
+  VERSION = '2.3.0'.freeze
 end

data/lib/cancan.rb

@@ -1,25 +1,18 @@
-require "cancan/version"
+require 'cancan/version'
 require 'cancan/ability'
 require 'cancan/rule'
 require 'cancan/controller_resource'
 require 'cancan/controller_additions'
 require 'cancan/model_additions'
 require 'cancan/exceptions'
-require 'cancan/inherited_resource'
 
 require 'cancan/model_adapters/abstract_adapter'
 require 'cancan/model_adapters/default_adapter'
+require 'cancan/rules_compressor'
 
 if defined? ActiveRecord
+  require 'cancan/model_adapters/conditions_extractor'
   require 'cancan/model_adapters/active_record_adapter'
-  if ActiveRecord.respond_to?(:version) &&
-      ActiveRecord.version >= Gem::Version.new("4")
-    require 'cancan/model_adapters/active_record_4_adapter'
-  else
-    require 'cancan/model_adapters/active_record_3_adapter'
-  end
+  require 'cancan/model_adapters/active_record_4_adapter'
+  require 'cancan/model_adapters/active_record_5_adapter'
 end
-
-require 'cancan/model_adapters/data_mapper_adapter' if defined? DataMapper
-require 'cancan/model_adapters/mongoid_adapter' if defined?(Mongoid) && defined?(Mongoid::Document)
-require 'cancan/model_adapters/sequel_adapter' if defined? Sequel

data/lib/generators/cancan/ability/ability_generator.rb

@@ -4,7 +4,7 @@ module Cancan
       source_root File.expand_path('../templates', __FILE__)
 
       def generate_ability
-        copy_file "ability.rb", "app/models/ability.rb"
+        copy_file 'ability.rb', 'app/models/ability.rb'
       end
     end
   end

metadata

@@ -1,15 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: cancancan
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 2.3.0
 platform: ruby
 authors:
+- Alessandro Rodi (Renuo AG)
 - Bryan Rite
 - Ryan Bates
+- Richard Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-16 00:00:00.000000000 Z
+date: 2018-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -26,129 +28,117 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.1.1
+        version: 0.48.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.1.1
+        version: 0.48.1
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '10.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '10.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.1.1
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
-description: Continuation of the simple authorization solution for Rails which is
-  decoupled from user roles. All permissions are stored in a single location.
-email: bryan@bryanrite.com
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Simple authorization solution for Rails. All permissions are stored in
+  a single location.
+email: alessandro.rodi@renuo.ch
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Appraisals
-- CHANGELOG.rdoc
-- CONTRIBUTING.md
-- Gemfile
-- LICENSE
-- README.md
-- Rakefile
 - cancancan.gemspec
-- gemfiles/activerecord_3.0.gemfile
-- gemfiles/activerecord_3.1.gemfile
-- gemfiles/activerecord_3.2.gemfile
-- gemfiles/activerecord_4.0.gemfile
-- gemfiles/activerecord_4.1.gemfile
-- gemfiles/activerecord_4.2.gemfile
-- gemfiles/datamapper_1.x.gemfile
-- gemfiles/mongoid_2.x.gemfile
-- gemfiles/sequel_3.x.gemfile
 - init.rb
 - lib/cancan.rb
 - lib/cancan/ability.rb
+- lib/cancan/ability/actions.rb
+- lib/cancan/ability/rules.rb
+- lib/cancan/conditions_matcher.rb
 - lib/cancan/controller_additions.rb
 - lib/cancan/controller_resource.rb
+- lib/cancan/controller_resource_builder.rb
+- lib/cancan/controller_resource_finder.rb
+- lib/cancan/controller_resource_loader.rb
+- lib/cancan/controller_resource_name_finder.rb
+- lib/cancan/controller_resource_sanitizer.rb
 - lib/cancan/exceptions.rb
-- lib/cancan/inherited_resource.rb
 - lib/cancan/matchers.rb
 - lib/cancan/model_adapters/abstract_adapter.rb
-- lib/cancan/model_adapters/active_record_3_adapter.rb
 - lib/cancan/model_adapters/active_record_4_adapter.rb
+- lib/cancan/model_adapters/active_record_5_adapter.rb
 - lib/cancan/model_adapters/active_record_adapter.rb
-- lib/cancan/model_adapters/data_mapper_adapter.rb
+- lib/cancan/model_adapters/can_can/model_adapters/active_record_adapter/joins.rb
+- lib/cancan/model_adapters/conditions_extractor.rb
 - lib/cancan/model_adapters/default_adapter.rb
-- lib/cancan/model_adapters/mongoid_adapter.rb
-- lib/cancan/model_adapters/sequel_adapter.rb
 - lib/cancan/model_additions.rb
 - lib/cancan/rule.rb
+- lib/cancan/rules_compressor.rb
 - lib/cancan/version.rb
 - lib/cancancan.rb
 - lib/generators/cancan/ability/USAGE
 - lib/generators/cancan/ability/ability_generator.rb
 - lib/generators/cancan/ability/templates/ability.rb
-- spec/README.rdoc
-- spec/cancan/ability_spec.rb
-- spec/cancan/controller_additions_spec.rb
-- spec/cancan/controller_resource_spec.rb
-- spec/cancan/exceptions_spec.rb
-- spec/cancan/inherited_resource_spec.rb
-- spec/cancan/matchers_spec.rb
-- spec/cancan/model_adapters/active_record_4_adapter_spec.rb
-- spec/cancan/model_adapters/active_record_adapter_spec.rb
-- spec/cancan/model_adapters/data_mapper_adapter_spec.rb
-- spec/cancan/model_adapters/default_adapter_spec.rb
-- spec/cancan/model_adapters/mongoid_adapter_spec.rb
-- spec/cancan/model_adapters/sequel_adapter_spec.rb
-- spec/cancan/rule_spec.rb
-- spec/matchers.rb
-- spec/spec.opts
-- spec/spec_helper.rb
-- spec/support/ability.rb
 homepage: https://github.com/CanCanCommunity/cancancan
 licenses:
 - MIT
@@ -161,17 +151,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.4
+      version: '0'
 requirements: []
-rubyforge_project: cancancan
-rubygems_version: 2.4.5
+rubyforge_project: 
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Simple authorization solution for Rails.
-test_files:
-- Appraisals
+test_files: []

data/.gitignore

@@ -1,15 +0,0 @@
-.DS_Store
-.idea/*
-*.swp
-**/*.swp
-*.gem
-.bundle
-
-gemfiles/*.lock
-Gemfile.lock
-
-.rvmrc
-.rbenv-version
-.ruby-version
-.ruby-gemset
-/tmp

data/.rspec

@@ -1 +0,0 @@
---color

data/.travis.yml

@@ -1,55 +0,0 @@
-rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.2.0
-  - ree
-  - jruby
-  - rbx
-gemfile:
-  - gemfiles/activerecord_3.0.gemfile
-  - gemfiles/activerecord_3.1.gemfile
-  - gemfiles/activerecord_3.2.gemfile
-  - gemfiles/activerecord_4.0.gemfile
-  - gemfiles/activerecord_4.1.gemfile
-  - gemfiles/activerecord_4.2.gemfile
-  - gemfiles/datamapper_1.x.gemfile
-  - gemfiles/mongoid_2.x.gemfile
-  - gemfiles/sequel_3.x.gemfile
-services:
-  - mongodb
-matrix:
-  allow_failures:
-    - rvm: rbx
-    - rvm: jruby
-      gemfile: gemfiles/datamapper_1.x.gemfile
-  exclude:
-    - rvm: 1.8.7
-      gemfile: gemfiles/activerecord_4.0.gemfile
-    - rvm: 1.8.7
-      gemfile: gemfiles/activerecord_4.1.gemfile
-    - rvm: 1.8.7
-      gemfile: gemfiles/activerecord_4.2.gemfile
-    - rvm: 1.9.2
-      gemfile: gemfiles/activerecord_4.0.gemfile
-    - rvm: 1.9.2
-      gemfile: gemfiles/activerecord_4.1.gemfile
-    - rvm: 1.9.2
-      gemfile: gemfiles/activerecord_4.2.gemfile
-    - rvm: 2.2.0
-      gemfile: gemfiles/activerecord_3.0.gemfile
-    - rvm: 2.2.0
-      gemfile: gemfiles/activerecord_3.1.gemfile
-    - rvm: 2.2.0
-      gemfile: gemfiles/activerecord_3.2.gemfile
-    - rvm: ree
-      gemfile: gemfiles/activerecord_4.0.gemfile
-    - rvm: ree
-      gemfile: gemfiles/activerecord_4.1.gemfile
-    - rvm: ree
-      gemfile: gemfiles/activerecord_4.2.gemfile
-notifications:
-  recipients:
-    - bryan@bryanrite.com