cancan 1.4.1 → 1.5.0.beta1

data/spec/cancan/model_adapters/default_adapter_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe CanCan::ModelAdapters::DefaultAdapter do
+  it "should be default for generic classes" do
+    CanCan::ModelAdapters::AbstractAdapter.adapter_class(Object).should == CanCan::ModelAdapters::DefaultAdapter
+  end
+end

data/spec/cancan/model_adapters/mongoid_adapter_spec.rb

@@ -0,0 +1,168 @@
+if ENV["MODEL_ADAPTER"] == "mongoid"
+  require "spec_helper"
+
+  class MongoidCategory
+    include Mongoid::Document
+
+    references_many :mongoid_projects
+  end
+
+  class MongoidProject
+    include Mongoid::Document
+
+    referenced_in :mongoid_category
+  end
+
+  Mongoid.configure do |config|
+    config.master = Mongo::Connection.new('127.0.0.1', 27017).db("cancan_mongoid_spec")
+  end
+
+  describe CanCan::ModelAdapters::MongoidAdapter do
+    context "Mongoid defined" do
+      before(:each) do
+        @ability = Object.new
+        @ability.extend(CanCan::Ability)
+      end
+
+      after(:each) do
+        Mongoid.master.collections.select do |collection|
+          collection.name !~ /system/
+        end.each(&:drop)
+      end
+
+      it "should be for only Mongoid classes" do
+        CanCan::ModelAdapters::MongoidAdapter.should_not be_for_class(Object)
+        CanCan::ModelAdapters::MongoidAdapter.should be_for_class(MongoidProject)
+        CanCan::ModelAdapters::AbstractAdapter.adapter_class(MongoidProject).should == CanCan::ModelAdapters::MongoidAdapter
+      end
+
+      it "should compare properties on mongoid documents with the conditions hash" do
+        model = MongoidProject.new
+        @ability.can :read, MongoidProject, :id => model.id
+        @ability.should be_able_to(:read, model)
+      end
+
+      it "should return [] when no ability is defined so no records are found" do
+        MongoidProject.create(:title => 'Sir')
+        MongoidProject.create(:title => 'Lord')
+        MongoidProject.create(:title => 'Dude')
+
+        MongoidProject.accessible_by(@ability, :read).entries.should == []
+      end
+
+      it "should return the correct records based on the defined ability" do
+        @ability.can :read, MongoidProject, :title => "Sir"
+        sir   = MongoidProject.create(:title => 'Sir')
+        lord  = MongoidProject.create(:title => 'Lord')
+        dude  = MongoidProject.create(:title => 'Dude')
+
+        MongoidProject.accessible_by(@ability, :read).should == [sir]
+      end
+
+      it "should return everything when the defined ability is manage all" do
+        @ability.can :manage, :all
+        sir   = MongoidProject.create(:title => 'Sir')
+        lord  = MongoidProject.create(:title => 'Lord')
+        dude  = MongoidProject.create(:title => 'Dude')
+
+        MongoidProject.accessible_by(@ability, :read).entries.should == [sir, lord, dude]
+      end
+
+
+      describe "Mongoid::Criteria where clause Symbol extensions using MongoDB expressions" do
+        it "should handle :field.in" do
+          obj = MongoidProject.create(:title => 'Sir')
+          @ability.can :read, MongoidProject, :title.in => ["Sir", "Madam"]
+          @ability.can?(:read, obj).should == true
+          MongoidProject.accessible_by(@ability, :read).should == [obj]
+
+          obj2 = MongoidProject.create(:title => 'Lord')
+          @ability.can?(:read, obj2).should == false
+        end
+
+        describe "activates only when there are Criteria in the hash" do
+          it "Calls where on the model class when there are criteria" do
+            obj = MongoidProject.create(:title => 'Bird')
+            @conditions = {:title.nin => ["Fork", "Spoon"]}
+
+            @ability.can :read, MongoidProject, @conditions
+            @ability.should be_able_to(:read, obj)
+          end
+          it "Calls the base version if there are no mongoid criteria" do
+            obj = MongoidProject.new(:title => 'Bird')
+            @conditions = {:id => obj.id}
+            @ability.can :read, MongoidProject, @conditions
+            @ability.should be_able_to(:read, obj)
+          end
+        end
+
+        it "should handle :field.nin" do
+          obj = MongoidProject.create(:title => 'Sir')
+          @ability.can :read, MongoidProject, :title.nin => ["Lord", "Madam"]
+          @ability.can?(:read, obj).should == true
+          MongoidProject.accessible_by(@ability, :read).should == [obj]
+
+          obj2 = MongoidProject.create(:title => 'Lord')
+          @ability.can?(:read, obj2).should == false
+        end
+
+        it "should handle :field.size" do
+          obj = MongoidProject.create(:titles => ['Palatin', 'Margrave'])
+          @ability.can :read, MongoidProject, :titles.size => 2
+          @ability.can?(:read, obj).should == true
+          MongoidProject.accessible_by(@ability, :read).should == [obj]
+
+          obj2 = MongoidProject.create(:titles => ['Palatin', 'Margrave', 'Marquis'])
+          @ability.can?(:read, obj2).should == false
+        end
+
+        it "should handle :field.exists" do
+          obj = MongoidProject.create(:titles => ['Palatin', 'Margrave'])
+          @ability.can :read, MongoidProject, :titles.exists => true
+          @ability.can?(:read, obj).should == true
+          MongoidProject.accessible_by(@ability, :read).should == [obj]
+
+          obj2 = MongoidProject.create
+          @ability.can?(:read, obj2).should == false
+        end
+
+        it "should handle :field.gt" do
+          obj = MongoidProject.create(:age => 50)
+          @ability.can :read, MongoidProject, :age.gt => 45
+          @ability.can?(:read, obj).should == true
+          MongoidProject.accessible_by(@ability, :read).should == [obj]
+
+          obj2 = MongoidProject.create(:age => 40)
+          @ability.can?(:read, obj2).should == false
+        end
+
+        it "should handle instance not saved to database" do
+          obj = MongoidProject.new(:title => 'Sir')
+          @ability.can :read, MongoidProject, :title.in => ["Sir", "Madam"]
+          @ability.can?(:read, obj).should == true
+
+          # accessible_by only returns saved records
+          MongoidProject.accessible_by(@ability, :read).entries.should == []
+
+          obj2 = MongoidProject.new(:title => 'Lord')
+          @ability.can?(:read, obj2).should == false
+        end
+      end
+
+      it "should call where with matching ability conditions" do
+        obj = MongoidProject.create(:foo => {:bar => 1})
+        @ability.can :read, MongoidProject, :foo => {:bar => 1}
+        MongoidProject.accessible_by(@ability, :read).entries.first.should == obj
+      end
+
+      it "should not allow to fetch records when ability with just block present" do
+        @ability.can :read, MongoidProject do
+          false
+        end
+        lambda {
+          MongoidProject.accessible_by(@ability)
+        }.should raise_error(CanCan::Error)
+      end
+    end
+  end
+end

data/spec/cancan/rule_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+# Most of Rule functionality is tested in Ability specs
+describe CanCan::Rule do
+  before(:each) do
+    @conditions = {}
+    @rule = CanCan::Rule.new(true, :read, Integer, @conditions, nil)
+  end
+
+  it "should return no association joins if none exist" do
+    @rule.associations_hash.should == {}
+  end
+
+  it "should return no association for joins if just attributes" do
+    @conditions[:foo] = :bar
+    @rule.associations_hash.should == {}
+  end
+
+  it "should return single association for joins" do
+    @conditions[:foo] = {:bar => 1}
+    @rule.associations_hash.should == {:foo => {}}
+  end
+
+  it "should return multiple associations for joins" do
+    @conditions[:foo] = {:bar => 1}
+    @conditions[:test] = {1 => 2}
+    @rule.associations_hash.should == {:foo => {}, :test => {}}
+  end
+
+  it "should return nested associations for joins" do
+    @conditions[:foo] = {:bar => {1 => 2}}
+    @rule.associations_hash.should == {:foo => {:bar => {}}}
+  end
+
+  it "should return no association joins if conditions is nil" do
+    rule = CanCan::Rule.new(true, :read, Integer, nil, nil)
+    rule.associations_hash.should == {}
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 require 'rubygems'
 require 'bundler/setup'
+
 Bundler.require(:default)
+
 require 'supermodel' # shouldn't Bundler do this already?
 require 'active_support/all'
 require 'matchers'
@@ -27,28 +29,4 @@ end
 
 class Project < SuperModel::Base
   belongs_to :category
-
-  class << self
-    protected
-
-    def sanitize_sql(hash_cond)
-      case hash_cond
-      when Hash
-        sanitize_hash(hash_cond).join(' AND ')
-      when Array
-        hash_cond.shift.gsub('?'){"#{hash_cond.shift.inspect}"}
-      when String then hash_cond
-      end
-    end
-
-    def sanitize_hash(hash)
-      hash.map do |name, value|
-        if Hash === value
-          sanitize_hash(value).map{|cond| "#{name}.#{cond}"}
-        else
-          "#{name}=#{value}"
-        end
-      end.flatten
-    end
-  end
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: cancan
 version: !ruby/object:Gem::Version 
-  hash: 5
-  prerelease: false
+  hash: -1848230027
+  prerelease: true
   segments: 
   - 1
-  - 4
-  - 1
-  version: 1.4.1
+  - 5
+  - 0
+  - beta1
+  version: 1.5.0.beta1
 platform: ruby
 authors: 
 - Ryan Bates
@@ -15,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-12 00:00:00 -08:00
+date: 2011-01-08 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,14 +27,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 62196431
+        hash: 11
         segments: 
         - 2
+        - 1
         - 0
-        - 0
-        - beta
-        - 22
-        version: 2.0.0.beta.22
+        version: 2.1.0
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -94,25 +93,35 @@ extra_rdoc_files: []
 
 files: 
 - lib/cancan/ability.rb
-- lib/cancan/active_record_additions.rb
-- lib/cancan/can_definition.rb
 - lib/cancan/controller_additions.rb
 - lib/cancan/controller_resource.rb
 - lib/cancan/exceptions.rb
 - lib/cancan/inherited_resource.rb
 - lib/cancan/matchers.rb
-- lib/cancan/query.rb
+- lib/cancan/model_adapters/abstract_adapter.rb
+- lib/cancan/model_adapters/active_record_adapter.rb
+- lib/cancan/model_adapters/data_mapper_adapter.rb
+- lib/cancan/model_adapters/default_adapter.rb
+- lib/cancan/model_adapters/mongoid_adapter.rb
+- lib/cancan/model_additions.rb
+- lib/cancan/rule.rb
 - lib/cancan.rb
+- lib/generators/cancan/ability/ability_generator.rb
+- lib/generators/cancan/ability/templates/ability.rb
+- lib/generators/cancan/ability/USAGE
 - spec/cancan/ability_spec.rb
-- spec/cancan/active_record_additions_spec.rb
-- spec/cancan/can_definition_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/query_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/rule_spec.rb
 - spec/matchers.rb
+- spec/README.rdoc
 - spec/spec.opts
 - spec/spec_helper.rb
 - CHANGELOG.rdoc

data/lib/cancan/query.rb

@@ -1,97 +0,0 @@
-module CanCan
-
-  # Generates the sql conditions and association joins for use in ActiveRecord queries.
-  # Normally you will not use this class directly, but instead through ActiveRecordAdditions#accessible_by.
-  class Query
-    def initialize(sanitizer, can_definitions)
-      @sanitizer = sanitizer
-      @can_definitions = can_definitions
-    end
-
-    # Returns conditions intended to be used inside a database query. Normally you will not call this
-    # method directly, but instead go through ActiveRecordAdditions#accessible_by.
-    #
-    # If there is only one "can" definition, a hash of conditions will be returned matching the one defined.
-    #
-    #   can :manage, User, :id => 1
-    #   query(:manage, User).conditions # => { :id => 1 }
-    #
-    # If there are multiple "can" definitions, a SQL string will be returned to handle complex cases.
-    #
-    #   can :manage, User, :id => 1
-    #   can :manage, User, :manager_id => 1
-    #   cannot :manage, User, :self_managed => true
-    #   query(:manage, User).conditions # => "not (self_managed = 't') AND ((manager_id = 1) OR (id = 1))"
-    #
-    def conditions
-      if @can_definitions.size == 1 && @can_definitions.first.base_behavior
-        # Return the conditions directly if there's just one definition
-        @can_definitions.first.tableized_conditions
-      else
-        @can_definitions.reverse.inject(false_sql) do |sql, can_definition|
-          merge_conditions(sql, can_definition.tableized_conditions, can_definition.base_behavior)
-        end
-      end
-    end
-
-    # Returns the associations used in conditions for the :joins option of a search.
-    # See ActiveRecordAdditions#accessible_by for use in Active Record.
-    def joins
-      joins_hash = {}
-      @can_definitions.each do |can_definition|
-        merge_joins(joins_hash, can_definition.associations_hash)
-      end
-      clean_joins(joins_hash) unless joins_hash.empty?
-    end
-
-    private
-
-    def merge_conditions(sql, conditions_hash, behavior)
-      if conditions_hash.blank?
-        behavior ? true_sql : false_sql
-      else
-        conditions = sanitize_sql(conditions_hash)
-        case sql
-        when true_sql
-          behavior ? true_sql : "not (#{conditions})"
-        when false_sql
-          behavior ? conditions : false_sql
-        else
-          behavior ? "(#{conditions}) OR (#{sql})" : "not (#{conditions}) AND (#{sql})"
-        end
-      end
-    end
-
-    def false_sql
-      sanitize_sql(['?=?', true, false])
-    end
-
-    def true_sql
-      sanitize_sql(['?=?', true, true])
-    end
-
-    def sanitize_sql(conditions)
-      @sanitizer.send(:sanitize_sql, conditions)
-    end
-
-    # Takes two hashes and does a deep merge.
-    def merge_joins(base, add)
-      add.each do |name, nested|
-        if base[name].is_a?(Hash) && !nested.empty?
-          merge_joins(base[name], nested)
-        else
-          base[name] = nested
-        end
-      end
-    end
-
-    # Removes empty hashes and moves everything into arrays.
-    def clean_joins(joins_hash)
-      joins = []
-      joins_hash.each do |name, nested|
-        joins << (nested.empty? ? name : {name => clean_joins(nested)})
-      end
-      joins
-    end
-  end
-end

data/spec/cancan/active_record_additions_spec.rb

@@ -1,75 +0,0 @@
-require "spec_helper"
-
-describe CanCan::ActiveRecordAdditions do
-  before(:each) do
-    @model_class = Class.new(Project)
-    stub(@model_class).scoped { :scoped_stub }
-    @model_class.send(:include, CanCan::ActiveRecordAdditions)
-    @ability = Object.new
-    @ability.extend(CanCan::Ability)
-  end
-
-  it "should call where('true=false') when no ability is defined so no records are found" do
-    stub(@model_class).joins { true } # just so it responds to .joins as well
-    stub(@model_class).where('true=false').stub!.joins(nil) { :no_match }
-    @model_class.accessible_by(@ability, :read).should == :no_match
-  end
-
-  it "should call where with matching ability conditions" do
-    @ability.can :read, @model_class, :foo => {:bar => 1}
-    stub(@model_class).joins { true } # just so it responds to .joins as well
-    stub(@model_class).where(:foos => { :bar => 1 }).stub!.joins([:foo]) { :found_records }
-    @model_class.accessible_by(@ability, :read).should == :found_records
-  end
-
-  it "should default to :read ability and use scoped when where isn't available" do
-    @ability.can :read, @model_class, :foo => {:bar => 1}
-    stub(@model_class).scoped(:conditions => {:foos => {:bar => 1}}, :joins => [:foo]) { :found_records }
-    @model_class.accessible_by(@ability).should == :found_records
-  end
-
-  it "should merge association joins and sanitize conditions" do
-    @ability.can :read, @model_class, :foo => {:bar => 1}
-    @ability.can :read, @model_class, :too => {:car => 1, :far => {:bar => 1}}
-
-    condition_variants = [
-        '(toos.fars.bar=1 AND toos.car=1) OR (foos.bar=1)', # faked sql sanitizer is stupid ;-)
-        '(toos.car=1 AND toos.fars.bar=1) OR (foos.bar=1)'
-    ]
-    joins_variants = [
-        [:foo, {:too => [:far]}],
-        [{:too => [:far]}, :foo]
-    ]
-
-    condition_variants.each do |condition|
-      joins_variants.each do |joins|
-        stub(@model_class).scoped( :conditions => condition, :joins => joins ) { :found_records }
-      end
-    end
-    # @ability.conditions(:read, @model_class).should == '(too.car=1 AND too.far.bar=1) OR (foo.bar=1)'
-    # @ability.associations_hash(:read, @model_class).should == [{:too => [:far]}, :foo]
-    @model_class.accessible_by(@ability).should == :found_records
-  end
-
-  it "should allow to define sql conditions by not hash" do
-    @ability.can :read, @model_class, :foo => 1
-    @ability.can :read, @model_class, ['bar = ?', 1]
-    stub(@model_class).scoped( :conditions => '(bar = 1) OR (foo=1)', :joins => nil ) { :found_records }
-    stub(@model_class).scoped{|*args| args.inspect}
-    @model_class.accessible_by(@ability).should == :found_records
-  end
-
-  it "should not allow to fetch records when ability with just block present" do
-    @ability.can :read, @model_class do false end
-    lambda {
-      @model_class.accessible_by(@ability)
-    }.should raise_error(CanCan::Error)
-  end
-
-  it "should not allow to check ability on object when nonhash sql ability definition without block present" do
-    @ability.can :read, @model_class, ['bar = ?', 1]
-    lambda {
-      @ability.can? :read, @model_class.new
-    }.should raise_error(CanCan::Error)
-  end
-end