canard 0.3.5 → 0.3.6

data/.gitignore

@@ -5,4 +5,5 @@ pkg/*
 .rvmrc
 Gemfile.lock
 *.sqlite3
-*.log
+*.log
+.tm_properties

data/TODO

@@ -1,5 +1,4 @@
 0.4.0
-* Make the roles_attribute_name configureable in UserModel.
 * Make the Ability user referece configureable in Ability.
 * Test the generators.
 * Test the railtie (currently implicity tested in dummy app).
@@ -7,7 +6,6 @@
 * Remove old definition syntax and therefore deprecations.
 * Remove ActiveSupport runtime dependency (which is just used for deprecation warnings).
 0.5.0
-* Abstract out the ActiveRecord extensions into a model adapter to become framework independent.
 * Expand the generated tests to produce all the standard abilities: index,show,read,new,create,edit,update,destroy.
 * Add test unit generator.
 * Add install generator to allow overriding of the default tests.

data/lib/canard.rb

@@ -7,4 +7,5 @@ require "canard/find_abilities"
 require "ability"
 
 require 'canard/railtie' if defined?(Rails) && Rails::VERSION::MAJOR >= 3
+require 'canard/adapters/active_record' if defined?(ActiveRecord)
 

data/lib/canard/adapters/active_record.rb

@@ -0,0 +1,56 @@
+module Canard
+  module Adapters
+    module ActiveRecord
+
+      private
+
+      def add_role_scopes
+        if active_record_table?
+          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
+      end
+
+      def active_record_table?
+        respond_to?(:table_exists?) && table_exists?
+      end
+
+      def has_roles_mask_accessors?
+        active_record_table? && column_names.include?(roles_attribute_name.to_s) || super
+      end
+
+      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
+        "#{quoted_table_name}.#{connection.quote_column_name roles_attribute_name}"
+      end
+
+    end
+  end
+end

data/lib/canard/find_abilities.rb

@@ -7,7 +7,7 @@ module Canard
     attr_writer :abilities_path
     
     def abilities_path 
-      @abilities_path ||= File.expand_path('abilities', Rails.root)
+      @abilities_path ||= 'abilities'
     end
     
     def ability_definitions
@@ -22,7 +22,7 @@ module Canard
   end
 
   def self.load_paths
-    Abilities.definition_paths.map { |path| File.join(Rails.root, path) }
+    Abilities.definition_paths.map { |path| File.expand_path(path) }
   end
 
   # TODO remove at version 0.4.0

data/lib/canard/railtie.rb

@@ -14,6 +14,7 @@ module Canard
 
     initializer "canard.active_record" do |app|
       ActiveSupport.on_load :active_record do
+        Canard::Abilities.default_path = File.expand_path('app/abilities', Rails.root)
         extend Canard::UserModel
         Canard.find_abilities
       end

data/lib/canard/user_model.rb

@@ -1,5 +1,4 @@
 module Canard
-
   module UserModel
 
     # Canard applies roles to a model using the acts_as_user class method. The following User model
@@ -7,7 +6,7 @@ module Canard
     #
     #   class User < ActiveRecord::Base
     #
-    #     acts_as_user :roles =>  :manager, :admin
+    #     acts_as_user :roles => [:manager, :admin]
     #
     #   end
     #
@@ -20,14 +19,19 @@ module Canard
     #
     #     attr_accessor :roles_mask
     #
-    #     acts_as_user :roles =>  :manager, :admin
+    #     acts_as_user :roles => [:manager, :admin]
     #
     #   end
     #
+    # You can choose the attribute used for the roles_mask by specifying :roles_mask. If no
+    # roles_mask is specified it uses RoleModel's default of 'roles_mask'
+    #
+    #    acts_as_user :roles_mask => :my_roles_mask, :roles => [:manager, :admin]
+    #
     # == Scopes
     #
-    # Beyond applying the roles to model acts_as_user also creates some useful scopes on the User
-    # model for ActiveRecord models;
+    # Beyond applying the roles to the model, acts_as_user also creates some useful scopes for
+    # ActiveRecord models;
     #
     #   User.with_any_role(:manager, :admin)
     #
@@ -54,66 +58,26 @@ module Canard
     # returns all the users who don't have the manager role.
     def acts_as_user(*args)
       include RoleModel
+      extend Adapters::ActiveRecord if defined?(ActiveRecord) && self < ActiveRecord::Base
 
-      options = args.extract_options!.symbolize_keys
+      options = args.last.is_a?(Hash) ? args.pop : {}
 
-      roles options[:roles] if options.has_key?(:roles) && has_roles_mask_attribute? || has_roles_mask_accessors?
+      roles_attribute options[:roles_mask] if options.has_key?(:roles_mask)
+      
+      roles options[:roles] if options.has_key?(:roles) && has_roles_mask_accessors?
 
-      if active_record_table?
-        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
+      add_role_scopes if respond_to?(:add_role_scopes, true)
     end
 
     private
 
-    def active_record_table?
-      respond_to?(:table_exists?) && table_exists?
-    end
-
+    # This is overridden by the ActiveRecord adapter as the attribute accessors
+    # don't show up in instance_methods.
     def has_roles_mask_accessors?
       instance_method_names = instance_methods.map { |method_name| method_name.to_s }
       [roles_attribute_name.to_s, "#{roles_attribute_name}="].all? do |accessor| 
         instance_method_names.include?(accessor)
       end
     end
-
-    def has_roles_mask_attribute?
-      active_record_table? && column_names.include?(roles_attribute_name.to_s)
-    end
-
-    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
-
 end

data/lib/canard/version.rb

@@ -1,3 +1,3 @@
 module Canard
-  VERSION = "0.3.5"
+  VERSION = "0.3.6"
 end

data/test/{ability_test.rb → canard/ability_test.rb}

@@ -3,6 +3,7 @@ require 'test_helper'
 describe Ability do
   
   before do
+    Canard::Abilities.default_path = File.expand_path('../../dummy/app/abilities', __FILE__)
     # reload abilities because the reloader will have removed them after the railtie ran
     Canard.find_abilities
   end

data/test/{user_model_test.rb → canard/adapters/active_record_test.rb}

@@ -1,92 +1,68 @@
 require 'test_helper'
-require 'canard'
 
-describe Canard::UserModel do
-
-  before do
-    Canard.abilities_path = 'abilities'
-  end
-
-  # Sanity test
-  it "must be an user" do
-    user = User.new
-    user.must_be_instance_of User
-    user = UserWithoutRole.new
-    user.must_be_instance_of UserWithoutRole
-    user = UserWithoutRoleMask.new
-    user.must_be_instance_of UserWithoutRoleMask
-  end
+describe Canard::Adapters::ActiveRecord do
 
   describe 'acts_as_user' do
 
-    it 'adds role_model to the class' do
-      User.included_modules.must_include RoleModel
-      User.must_respond_to :roles
-    end
-
-    describe "on an ActiveRecord model" do
+    describe 'with a role_mask' do
 
-      describe 'with a role_mask' do
+      describe 'and :roles => [] specified' do
+        
+        it 'sets the valid_roles for the class' do
+          User.valid_roles.must_equal [:viewer, :author, :admin]
+        end
 
-        describe 'and :roles => [] specified' do
+      end
 
-          it 'sets the valid_roles for the class' do
-            User.valid_roles.must_equal [:viewer, :author, :admin]
-          end
+      describe 'and no :roles => [] specified' do
 
+        it 'sets no roles' do
+          UserWithoutRole.valid_roles.must_equal []
         end
+      end
 
-        describe 'and no :roles => [] specified' do
+    end
 
-          it 'sets no roles' do
-            UserWithoutRole.valid_roles.must_equal []
-          end
-        end
+    describe 'with no roles_mask' do
 
+      before do
+        UserWithoutRoleMask.acts_as_user :roles => [:viewer, :admin]
       end
 
-      describe 'with no roles_mask' do
-
-        it 'sets no roles' do
-          UserWithoutRole.valid_roles.must_equal []
-        end
+      it 'sets no roles' do
+        UserWithoutRoleMask.valid_roles.must_equal []
       end
+    end
 
-      describe "with no table" do
+    describe "with no table" do
         
-        subject { Class.new(ActiveRecord::Base) }
+      subject { Class.new(ActiveRecord::Base) }
 
-        it "sets no roles" do
-          subject.class_eval { acts_as_user :roles => [:admin] }
-          subject.valid_roles.must_equal []
-        end
+      it "sets no roles" do
+        subject.class_eval { acts_as_user :roles => [:admin] }
+        subject.valid_roles.must_equal []
+      end
         
-        it "does not raise any errors" do
-          proc { subject.class_eval { acts_as_user :roles => [:admin] } }.must_be_silent
-        end
+      it "does not raise any errors" do
+        proc { subject.class_eval { acts_as_user :roles => [:admin] } }.must_be_silent
+      end
         
-        it "returns nil" do
-          subject.class_eval { acts_as_user :roles => [:admin] }.must_be_nil
-        end
+      it "returns nil" do
+        subject.class_eval { acts_as_user :roles => [:admin] }.must_be_nil
       end
     end
     
-    describe "on a regular Ruby class" do
-
-      describe "with a roles_mask" do
+    describe 'with an alternative roles_mask specified' do
 
-        it "assigns the roles" do
-          PlainRubyUser.valid_roles.must_equal [:viewer, :author, :admin]
-        end
+      before do
+        UserWithoutRoleMask.acts_as_user :roles_mask => :my_roles_mask, :roles => [:viewer, :admin]
       end
 
-      describe "with no roles_mask" do
-
-        it "sets no roles" do
-          PlainRubyNonUser.valid_roles.must_equal []
-        end
+      it 'sets no roles' do
+        UserWithoutRoleMask.valid_roles.must_equal [:viewer, :admin]
       end
     end
+
   end
 
   describe "scopes" do
@@ -461,24 +437,6 @@ describe Canard::UserModel do
       end
 
     end
-
-    describe "on a plain Ruby class" do
-
-      subject { PlainRubyUser }
-
-      it "creates no scope methods" do
-        subject.wont_respond_to :admins
-        subject.wont_respond_to :authors
-        subject.wont_respond_to :viewers
-        subject.wont_respond_to :non_admins
-        subject.wont_respond_to :non_authors
-        subject.wont_respond_to :non_viewers
-        subject.wont_respond_to :with_any_role
-        subject.wont_respond_to :with_all_roles
-      end
-
-    end
-
   end
 
 end

data/test/{find_abilities_test.rb → canard/find_abilities_test.rb}

@@ -9,6 +9,7 @@ describe Canard do
     # Stop the deprecation warnings coming to stderr for these tests.
     ActiveSupport::Deprecation.behavior = :notify
     
+    Canard::Abilities.default_path = File.expand_path('../../dummy/app/abilities', __FILE__)
     Canard.abilities_path = File.expand_path('../abilities', __FILE__)
   end
   

data/test/canard/user_model_test.rb

@@ -0,0 +1,91 @@
+require 'test_helper'
+
+describe Canard::UserModel do
+
+  describe 'acts_as_user' do
+
+    describe "integrating RoleModel" do
+
+      before do
+        PlainRubyUser.acts_as_user
+      end
+
+      it 'adds role_model to the class' do
+        PlainRubyUser.included_modules.must_include RoleModel
+        PlainRubyUser.must_respond_to :roles
+      end
+    end
+
+    describe "with a roles_mask" do
+
+      describe 'and :roles => [] specified' do
+
+        before do
+          PlainRubyUser.acts_as_user :roles => [:viewer, :author, :admin]
+        end
+
+        it 'sets the valid_roles for the class' do
+          PlainRubyUser.valid_roles.must_equal [:viewer, :author, :admin]
+        end
+      end
+
+      describe 'and no :roles => [] specified' do
+
+        before do
+          PlainRubyUser.acts_as_user
+        end
+
+        it 'sets no roles' do
+          PlainRubyUser.valid_roles.must_equal []
+        end
+      end
+    end
+
+    describe "with no roles_mask" do
+      
+      before do
+        PlainRubyNonUser.acts_as_user :roles => [:viewer, :author, :admin]
+      end
+
+      it "sets no roles" do
+        PlainRubyNonUser.valid_roles.must_equal []
+      end
+    end
+    
+    describe "setting the role_mask" do
+      
+      before do
+        PlainRubyNonUser.send :attr_accessor, :my_roles
+        PlainRubyNonUser.acts_as_user :roles => [:viewer, :author], :roles_mask => :my_roles
+      end
+
+      it 'sets the valid_roles for the class' do
+        PlainRubyNonUser.valid_roles.must_equal [:viewer, :author]
+      end
+    end
+  end
+
+  describe "scopes" do
+
+    before do
+      PlainRubyUser.acts_as_user :roles => [:viewer, :author, :admin]
+    end
+
+    describe "on a plain Ruby class" do
+
+      subject { PlainRubyUser }
+
+      it "creates no scope methods" do
+        subject.wont_respond_to :admins
+        subject.wont_respond_to :authors
+        subject.wont_respond_to :viewers
+        subject.wont_respond_to :non_admins
+        subject.wont_respond_to :non_authors
+        subject.wont_respond_to :non_viewers
+        subject.wont_respond_to :with_any_role
+        subject.wont_respond_to :with_all_roles
+      end
+    end
+  end
+
+end

data/test/dummy/app/models/plain_ruby_non_user.rb

@@ -2,6 +2,4 @@ class PlainRubyNonUser
   
   extend Canard::UserModel
   
-  acts_as_user :roles => [:viewer, :author, :admin]
-  
 end

data/test/dummy/app/models/plain_ruby_user.rb

@@ -4,6 +4,4 @@ class PlainRubyUser
   
   attr_accessor :roles_mask
   
-  acts_as_user :roles => [:viewer, :author, :admin]
-  
 end

data/test/dummy/app/models/user_without_role_mask.rb

@@ -1,6 +1,5 @@
 class UserWithoutRoleMask < ActiveRecord::Base
 
-  acts_as_user 
-
   attr_accessible :roles
+
 end

data/test/dummy/db/migrate/20120430083231_initialize_db.rb

@@ -8,6 +8,7 @@ class InitializeDb < ActiveRecord::Migration
       t.integer     :roles_mask
     end
     create_table :user_without_role_masks, :force => true do |t|
+      t.integer     :my_roles_mask
     end
   
     create_table :members, :force => true do |t|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: canard
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-25 00:00:00.000000000Z
+date: 2012-06-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2152467160 !ruby/object:Gem::Requirement
+  requirement: &2152663460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2'
   type: :development
   prerelease: false
-  version_requirements: *2152467160
+  version_requirements: *2152663460
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2152466380 !ruby/object:Gem::Requirement
+  requirement: &2152663000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152466380
+  version_requirements: *2152663000
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2152464940 !ruby/object:Gem::Requirement
+  requirement: &2152662380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 3.2.3
   type: :development
   prerelease: false
-  version_requirements: *2152464940
+  version_requirements: *2152662380
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2152463940 !ruby/object:Gem::Requirement
+  requirement: &2152661900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152463940
+  version_requirements: *2152661900
 - !ruby/object:Gem::Dependency
   name: cancan
-  requirement: &2152463060 !ruby/object:Gem::Requirement
+  requirement: &2152661320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152463060
+  version_requirements: *2152661320
 - !ruby/object:Gem::Dependency
   name: role_model
-  requirement: &2152462240 !ruby/object:Gem::Requirement
+  requirement: &2152660780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152462240
+  version_requirements: *2152660780
 description: Wraps CanCan and RoleModel up to make role based authorisation really
   easy in Rails 3.x.
 email:
@@ -95,6 +95,7 @@ files:
 - lib/ability.rb
 - lib/canard.rb
 - lib/canard/abilities.rb
+- lib/canard/adapters/active_record.rb
 - lib/canard/find_abilities.rb
 - lib/canard/railtie.rb
 - lib/canard/user_model.rb
@@ -106,9 +107,12 @@ files:
 - lib/generators/rspec/ability/ability_generator.rb
 - lib/generators/rspec/ability/templates/abilities_spec.rb.erb
 - test/abilities/admins.rb
-- test/abilities_test.rb
-- test/ability_test.rb
-- test/canard_test.rb
+- test/canard/abilities_test.rb
+- test/canard/ability_test.rb
+- test/canard/adapters/active_record_test.rb
+- test/canard/canard_test.rb
+- test/canard/find_abilities_test.rb
+- test/canard/user_model_test.rb
 - test/dummy/Rakefile
 - test/dummy/app/abilities/admins.rb
 - test/dummy/app/abilities/authors.rb
@@ -139,10 +143,8 @@ files:
 - test/dummy/db/schema.rb
 - test/dummy/log/.gitkeep
 - test/dummy/script/rails
-- test/find_abilities_test.rb
 - test/support/reloadable.rb
 - test/test_helper.rb
-- test/user_model_test.rb
 homepage: https://github.com/james2m/canard
 licenses: []
 post_install_message: 
@@ -169,9 +171,12 @@ specification_version: 3
 summary: Adds role based authorisation to Rails by combining RoleModel and CanCan.
 test_files:
 - test/abilities/admins.rb
-- test/abilities_test.rb
-- test/ability_test.rb
-- test/canard_test.rb
+- test/canard/abilities_test.rb
+- test/canard/ability_test.rb
+- test/canard/adapters/active_record_test.rb
+- test/canard/canard_test.rb
+- test/canard/find_abilities_test.rb
+- test/canard/user_model_test.rb
 - test/dummy/Rakefile
 - test/dummy/app/abilities/admins.rb
 - test/dummy/app/abilities/authors.rb
@@ -202,7 +207,5 @@ test_files:
 - test/dummy/db/schema.rb
 - test/dummy/log/.gitkeep
 - test/dummy/script/rails
-- test/find_abilities_test.rb
 - test/support/reloadable.rb
 - test/test_helper.rb
-- test/user_model_test.rb