canard 0.1.2 → 0.2.0

data/.gitignore

@@ -1,4 +1,5 @@
 *.gem
 .bundle
 pkg/*
-.rvmrc
+.rvmrc
+Gemfile.lock

data/README.rdoc

@@ -95,6 +95,21 @@ Obviously the generators are just a starting point and should not be used only t
 suggest that every new model you create you add to the abilities as the specs are so easy to write and CanCan
 definitions are so clear and simple.
 
+== Scopes
+
+The :acts_as_user method with automatically define some named scopes for each role. For the example User model
+above it will define the following scopes;
+
+User.admins::       return all the users with the admin role
+User.non_admins::   return all the users without the admin role
+User.managers::     return all the users with the manager role
+User.non_namagers:: return all the users without the manager role
+
+In addition to the role specific scopes it also adds some general scopes;
+
+User.with_any_role(roles)::   return all the users with any of the specified roles
+User.with_all_roles(roles)::  return only the users with all the specified roles
+
 == Installation
 
 === Rails 3.x

data/TODO

@@ -2,5 +2,4 @@
 * Test the ability class.
 * Test the generators.
 * Test the railtie
-* Add scopes by default and :scopes => false to acts_as_user
 * Expand the tests to produce all the standard abilities: index,show,read,new,create,edit,update,destroy.

data/lib/canard/user_model.rb

@@ -8,6 +8,43 @@ module Canard
       options = args.extract_options!.symbolize_keys
 
       roles options[:roles] if options.has_key?(:roles) && column_names.include?(roles_attribute_name.to_s)
+              
+      valid_roles.each do |role|
+        define_scopes_for_role role
+      end
+    
+      define_scope_method(:with_any_role) do |*roles|
+        where("#{role_mask_column} & :role_mask > 0", { :role_mask => mask_for(*roles) })
+      end
+    
+      define_scope_method(:with_all_roles) do |*roles|
+        where("#{role_mask_column} & :role_mask = :role_mask", { :role_mask => mask_for(*roles) })
+      end
+    end
+    
+    private
+    
+    def define_scopes_for_role(role)
+      include_scope   = role.to_s.pluralize
+      exclude_scope   = "non_#{include_scope}"
+
+      define_scope_method(include_scope) do
+        where("#{role_mask_column} & :role_mask > 0", { :role_mask => mask_for(role) })
+      end
+
+      define_scope_method(exclude_scope) do
+        where("#{role_mask_column} & :role_mask = 0 or #{role_mask_column} is null", { :role_mask => mask_for(role) })
+      end
+    end
+    
+    def define_scope_method(method, &block)
+      (class << self; self end).class_eval do
+        define_method(method, block)
+      end
+    end
+    
+    def role_mask_column
+      %{"#{table_name}"."#{roles_attribute_name}"}
     end
 
   end

data/lib/canard/version.rb

@@ -1,3 +1,3 @@
 module Canard
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/test/user_model_test.rb

@@ -55,4 +55,379 @@ describe Canard::UserModel do
     
   end
 
-end
+  describe "scopes" do
+    
+    before do
+      @no_role             = User.create
+      @admin_author_viewer = User.create(:roles => [:admin, :author, :viewer])
+      @author_viewer       = User.create(:roles => [:author, :viewer])
+      @viewer              = User.create(:roles => [:viewer])
+      @admin_only          = User.create(:roles => [:admin])
+      @author_only         = User.create(:roles => [:author])
+    end
+    
+    after do
+      User.delete_all
+    end
+    
+    describe "on models with roles" do
+      
+      subject { User }
+      
+      it "should add a scope to return instances with each role" do
+        subject.must_respond_to :admins
+        subject.must_respond_to :authors
+        subject.must_respond_to :viewers
+      end
+      
+      it "should add a scope to return instances without each role" do
+        subject.must_respond_to :non_admins
+        subject.must_respond_to :non_authors
+        subject.must_respond_to :non_viewers
+      end
+      
+      describe "finding instances with a role" do
+        
+        describe "admins scope" do
+
+          subject { User.admins.sort_by(&:id) }
+
+          it "should return only admins" do
+            subject.must_equal [@admin_author_viewer, @admin_only].sort_by(&:id)
+          end
+
+          it "should not return non admins" do
+            subject.wont_include @no_role
+            subject.wont_include @author_viewer
+            subject.wont_include @author_only
+            subject.wont_include @viewer
+          end
+
+        end
+
+        describe "authors scope" do
+
+          subject { User.authors.sort_by(&:id) }
+
+          it "should return only authors" do
+            subject.must_equal [@admin_author_viewer, @author_viewer, @author_only].sort_by(&:id)
+          end
+
+          it "should not return non authors" do
+            subject.wont_include @no_role
+            subject.wont_include @admin_only
+            subject.wont_include @viewer
+          end
+
+        end
+
+        describe "viewers scope" do
+
+          subject { User.viewers.sort_by(&:id) }
+
+          it "should return only viewers" do
+            subject.must_equal [@admin_author_viewer, @author_viewer, @viewer].sort_by(&:id)
+          end
+
+          it "should not return non authors" do
+            subject.wont_include @no_role
+            subject.wont_include @admin_only
+            subject.wont_include @author_only
+          end
+
+        end
+
+      end
+      
+      describe "finding instances without a role" do
+        
+        describe "non_admins scope" do
+
+          subject { User.non_admins.sort_by(&:id) }
+
+          it "should return only non_admins" do
+            subject.must_equal [@no_role, @author_viewer, @viewer, @author_only].sort_by(&:id)
+          end
+
+          it "should not return admins" do
+            subject.wont_include @admin_author_viewer
+            subject.wont_include @admin_only
+          end
+
+        end
+
+        describe "non_authors scope" do
+
+          subject { User.non_authors.sort_by(&:id) }
+
+          it "should return only non_authors" do
+            subject.must_equal [@no_role, @viewer, @admin_only].sort_by(&:id)
+          end
+
+          it "should not return authors" do
+            subject.wont_include @admin_author_viewer
+            subject.wont_include @author_viewer
+            subject.wont_include @author_only
+          end
+
+        end
+
+        describe "non_viewers scope" do
+
+          subject { User.non_viewers.sort_by(&:id) }
+
+          it "should return only non_viewers" do
+            subject.must_equal [@no_role, @admin_only, @author_only].sort_by(&:id)
+          end
+
+          it "should not return viewers" do
+            subject.wont_include @admin_author_viewer
+            subject.wont_include @author_viewer
+            subject.wont_include @viewer
+          end
+
+        end
+
+      end
+      
+      describe "with_any_role" do
+        
+        describe "specifying admin only" do
+
+          subject { User.with_any_role(:admin).sort_by(&:id) }
+
+          it "should return only admins" do
+            subject.must_equal [@admin_author_viewer, @admin_only].sort_by(&:id)
+          end
+
+          it "should not return non admins" do
+            subject.wont_include @no_role
+            subject.wont_include @author_viewer
+            subject.wont_include @author_only
+            subject.wont_include @viewer
+          end
+
+        end
+
+        describe "specifying author only" do
+
+          subject { User.with_any_role(:author).sort_by(&:id) }
+
+          it "should return only authors" do
+            subject.must_equal [@admin_author_viewer, @author_viewer, @author_only].sort_by(&:id)
+          end
+
+          it "should not return non authors" do
+            subject.wont_include @no_role
+            subject.wont_include @admin_only
+            subject.wont_include @viewer
+          end
+
+        end
+
+        describe "specifying viewer only" do
+
+          subject { User.with_any_role(:viewer).sort_by(&:id) }
+
+          it "should return only viewers" do
+            subject.must_equal [@admin_author_viewer, @author_viewer, @viewer].sort_by(&:id)
+          end
+
+          it "should not return non authors" do
+            subject.wont_include @no_role
+            subject.wont_include @admin_only
+            subject.wont_include @author_only
+          end
+
+        end
+
+        describe "specifying admin and author" do
+
+          subject { User.with_any_role(:admin, :author).sort_by(&:id) }
+
+          it "should return only admins and authors" do
+            subject.must_equal [@admin_author_viewer, @author_viewer, @admin_only, @author_only].sort_by(&:id)
+          end
+
+          it "should not return non admins or authors" do
+            subject.wont_include @no_role
+            subject.wont_include @viewer
+          end
+
+        end
+
+        describe "specifying admin and viewer" do
+
+          subject { User.with_any_role(:admin, :viewer).sort_by(&:id) }
+
+          it "should return only admins and viewers" do
+            subject.must_equal [@admin_author_viewer, @author_viewer, @admin_only, @viewer].sort_by(&:id)
+          end
+
+          it "should not return non admins or viewers" do
+            subject.wont_include @no_role
+            subject.wont_include @author_only
+          end
+
+        end
+
+        describe "specifying author and viewer" do
+
+          subject { User.with_any_role(:author, :viewer).sort_by(&:id) }
+
+          it "should return only authors and viewers" do
+            subject.must_equal [@admin_author_viewer, @author_viewer, @author_only, @viewer].sort_by(&:id)
+          end
+
+          it "should not return non authors or viewers" do
+            subject.wont_include @no_role
+            subject.wont_include @admin_only
+          end
+
+        end
+
+        describe "specifying admin, author and viewer" do
+
+          subject { User.with_any_role(:admin, :author, :viewer).sort_by(&:id) }
+
+          it "should return only admins, authors and viewers" do
+            subject.must_equal [@admin_author_viewer, @author_viewer, @admin_only, @author_only, @viewer].sort_by(&:id)
+          end
+
+          it "should not return non admins, authors or viewers" do
+            subject.wont_include @no_role
+          end
+
+        end
+
+      end
+      
+      describe "with_all_roles" do
+        
+        describe "specifying admin only" do
+
+          subject { User.with_all_roles(:admin).sort_by(&:id) }
+
+          it "should return only admins" do
+            subject.must_equal [@admin_author_viewer, @admin_only].sort_by(&:id)
+          end
+
+          it "should not return non admins" do
+            subject.wont_include @no_role
+            subject.wont_include @author_viewer
+            subject.wont_include @author_only
+            subject.wont_include @viewer
+          end
+
+        end
+
+        describe "specifying author only" do
+
+          subject { User.with_all_roles(:author).sort_by(&:id) }
+
+          it "should return only authors" do
+            subject.must_equal [@admin_author_viewer, @author_viewer, @author_only].sort_by(&:id)
+          end
+
+          it "should not return non authors" do
+            subject.wont_include @no_role
+            subject.wont_include @admin_only
+            subject.wont_include @viewer
+          end
+
+        end
+
+        describe "specifying viewer only" do
+
+          subject { User.with_all_roles(:viewer).sort_by(&:id) }
+
+          it "should return only viewers" do
+            subject.must_equal [@admin_author_viewer, @author_viewer, @viewer].sort_by(&:id)
+          end
+
+          it "should not return non authors" do
+            subject.wont_include @no_role
+            subject.wont_include @admin_only
+            subject.wont_include @author_only
+          end
+
+        end
+
+        describe "specifying admin and author" do
+
+          subject { User.with_all_roles(:admin, :author).sort_by(&:id) }
+
+          it "should return only admins and authors" do
+            subject.must_equal [@admin_author_viewer].sort_by(&:id)
+          end
+
+          it "should not return non admin and authors" do
+            subject.wont_include @no_role
+            subject.wont_include @author_viewer
+            subject.wont_include @author_only
+            subject.wont_include @admin_only
+            subject.wont_include @viewer
+          end
+
+        end
+
+        describe "specifying admin and viewer" do
+
+          subject { User.with_all_roles(:admin, :viewer).sort_by(&:id) }
+
+          it "should return only admins and viewers" do
+            subject.must_equal [@admin_author_viewer].sort_by(&:id)
+          end
+
+          it "should not return non admins or viewers" do
+            subject.wont_include @no_role
+            subject.wont_include @author_viewer
+            subject.wont_include @author_only
+            subject.wont_include @admin_only
+            subject.wont_include @viewer
+          end
+
+        end
+
+        describe "specifying author and viewer" do
+
+          subject { User.with_all_roles(:author, :viewer).sort_by(&:id) }
+
+          it "should return only authors and viewers" do
+            subject.must_equal [@admin_author_viewer, @author_viewer].sort_by(&:id)
+          end
+
+          it "should not return non authors or viewers" do
+            subject.wont_include @no_role
+            subject.wont_include @admin_only
+            subject.wont_include @author_only
+            subject.wont_include @viewer
+          end
+
+        end
+
+        describe "specifying admin, author and viewer" do
+
+          subject { User.with_all_roles(:admin, :author, :viewer).sort_by(&:id) }
+
+          it "should return only admins, authors and viewers" do
+            subject.must_equal [@admin_author_viewer].sort_by(&:id)
+          end
+
+          it "should not return non admins, authors or viewers" do
+            subject.wont_include @no_role
+            subject.wont_include @author_viewer
+            subject.wont_include @author_only
+            subject.wont_include @admin_only
+            subject.wont_include @viewer
+          end
+
+        end
+
+      end
+      
+    end
+
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: canard
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-10 00:00:00.000000000Z
+date: 2011-12-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2153302940 !ruby/object:Gem::Requirement
+  requirement: &2160840240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2'
   type: :development
   prerelease: false
-  version_requirements: *2153302940
+  version_requirements: *2160840240
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2153302520 !ruby/object:Gem::Requirement
+  requirement: &2160839820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153302520
+  version_requirements: *2160839820
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2153302060 !ruby/object:Gem::Requirement
+  requirement: &2160839360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153302060
+  version_requirements: *2160839360
 - !ruby/object:Gem::Dependency
   name: cancan
-  requirement: &2153301640 !ruby/object:Gem::Requirement
+  requirement: &2160838940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153301640
+  version_requirements: *2160838940
 - !ruby/object:Gem::Dependency
   name: role_model
-  requirement: &2153301220 !ruby/object:Gem::Requirement
+  requirement: &2160838520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153301220
+  version_requirements: *2160838520
 description: Wraps CanCan and RoleModel up with a generator and makes role based authorisation
   really easy in Rails 3.x.
 email:
@@ -76,7 +76,6 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- Gemfile.lock
 - MIT-LICENSE
 - README.rdoc
 - Rakefile

data/Gemfile.lock

@@ -1,41 +0,0 @@
-PATH
-  remote: .
-  specs:
-    canard (0.0.1)
-      cancan
-      role_model
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activemodel (3.1.0)
-      activesupport (= 3.1.0)
-      bcrypt-ruby (~> 3.0.0)
-      builder (~> 3.0.0)
-      i18n (~> 0.6)
-    activerecord (3.1.0)
-      activemodel (= 3.1.0)
-      activesupport (= 3.1.0)
-      arel (~> 2.2.1)
-      tzinfo (~> 0.3.29)
-    activesupport (3.1.0)
-      multi_json (~> 1.0)
-    arel (2.2.1)
-    bcrypt-ruby (3.0.0)
-    builder (3.0.0)
-    cancan (1.6.5)
-    i18n (0.6.0)
-    minitest (2.5.1)
-    multi_json (1.0.3)
-    role_model (0.7.0)
-    sqlite3 (1.3.4)
-    tzinfo (0.3.29)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord
-  canard!
-  minitest (~> 2)
-  sqlite3