canard 0.3.4 → 0.3.5

data/README.rdoc

@@ -147,12 +147,15 @@ to accept pull requests for tested Rails 2.x updates if anybody is game.
 
 == Contributors
 
+    git log | grep Author | sort | uniq
+
 * James McCarthy
 * Joey Geiger
+* Morton Jonuschat
 
 == Credits
 
-Thanks to Ryan Bates for creating the awesome CanCan (http://wiki.github.com/ryanb/cancan/role-based-authorization) 
+Thanks to Ryan Bates for creating the awesome CanCan (http://wiki.github.com/ryanb/cancan) 
 and Martin Rehfeld for implementing Role Based Authorization in the form of RoleModel (http://github.com/martinrehfeld/role_model).
 
 == Copyright

data/TODO

@@ -1,9 +1,13 @@
+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
-* Expand the tests to produce all the standard abilities: index,show,read,new,create,edit,update,destroy.
+* Test the railtie (currently implicity tested in dummy app).
+* Add upgrade generator to move the now deprecated definitions to the new syntax.
+* 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.
-* Make the Ability user referece configureable in Ability.
-* Abstract out the ActiveRecord extensions into a model adapter.
-* Make the roles_attribute_name configureable in UserModel.
-* Remove ActiveSupport runtime dependency.

data/lib/ability.rb

@@ -54,11 +54,8 @@ class Ability
   
   private
   
-  def ability_definitions
-    Canard.ability_definitions
-  end
-  
   def append_abilities(role)
+    ability_definitions = Canard.ability_definitions
     instance_eval(&ability_definitions[role]) if ability_definitions.has_key?(role)
   end
 

data/lib/canard/find_abilities.rb

@@ -21,6 +21,11 @@ module Canard
 
   end
 
+  def self.load_paths
+    Abilities.definition_paths.map { |path| File.join(Rails.root, path) }
+  end
+
+  # TODO remove at version 0.4.0
   def self.find_abilities #:nodoc:
     absolute_abilities_path = File.expand_path(abilities_path)
 
@@ -30,13 +35,12 @@ module Canard
       end
     end
     
-    Abilities.definition_paths.each do |path|
-      Dir[File.join(Rails.root, path, '**', '*.rb')].sort.each do |file|
+    load_paths.each do |path|
+      Dir[File.join(path, '**', '*.rb')].sort.each do |file|
         load file
       end
     end
 
   end
   
-  
 end

data/lib/canard/railtie.rb

@@ -4,6 +4,14 @@ require 'rails'
 module Canard
   class Railtie < Rails::Railtie
     
+    initializer "carard.no_eager_loading", :before => 'before_eager_loading' do |app|
+      ActiveSupport::Dependencies.autoload_paths.reject!{ |path| Canard.load_paths.include?(path) }
+      # Don't eagerload our configs, we'll deal with them ourselves
+      app.config.eager_load_paths = app.config.eager_load_paths.reject do |path|
+        Canard.load_paths.include?(path)
+      end
+    end
+
     initializer "canard.active_record" do |app|
       ActiveSupport.on_load :active_record do
         extend Canard::UserModel

data/lib/canard/user_model.rb

@@ -59,7 +59,7 @@ module Canard
 
       roles options[:roles] if options.has_key?(:roles) && has_roles_mask_attribute? || has_roles_mask_accessors?
 
-      if respond_to?(:table_exists?) && table_exists?
+      if active_record_table?
         valid_roles.each do |role|
           define_scopes_for_role role
         end
@@ -76,6 +76,10 @@ module Canard
 
     private
 
+    def active_record_table?
+      respond_to?(:table_exists?) && table_exists?
+    end
+
     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| 
@@ -84,7 +88,7 @@ module Canard
     end
 
     def has_roles_mask_attribute?
-      respond_to?(:column_names) && column_names.include?(roles_attribute_name.to_s)
+      active_record_table? && column_names.include?(roles_attribute_name.to_s)
     end
 
     def define_scopes_for_role(role)

data/lib/canard/version.rb

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

data/test/user_model_test.rb

@@ -19,40 +19,61 @@ describe Canard::UserModel do
 
   describe 'acts_as_user' do
 
-    it 'should add role_model to this model' do
+    it 'adds role_model to the class' do
       User.included_modules.must_include RoleModel
       User.must_respond_to :roles
     end
 
-    describe 'on a model with a role mask' do
+    describe "on an ActiveRecord model" do
 
-      describe 'and :roles => [] specified' do
+      describe 'with a role_mask' do
 
-        it 'sets the valid_roles for the class' do
-          User.valid_roles.must_equal [:viewer, :author, :admin]
+        describe 'and :roles => [] specified' do
+
+          it 'sets the valid_roles for the class' do
+            User.valid_roles.must_equal [:viewer, :author, :admin]
+          end
+
+        end
+
+        describe 'and no :roles => [] specified' do
+
+          it 'sets no roles' do
+            UserWithoutRole.valid_roles.must_equal []
+          end
         end
 
       end
 
-      describe 'with no :roles => [] specified' do
+      describe 'with no roles_mask' do
 
         it 'sets no roles' do
           UserWithoutRole.valid_roles.must_equal []
         end
       end
 
-    end
+      describe "with no table" do
+        
+        subject { Class.new(ActiveRecord::Base) }
 
-    describe 'on a model with no roles_mask' do
-
-      it 'sets no roles' do
-        UserWithoutRole.valid_roles.must_equal []
+        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 "returns nil" do
+          subject.class_eval { acts_as_user :roles => [:admin] }.must_be_nil
+        end
       end
     end
+    
+    describe "on a regular Ruby class" do
 
-    describe "on a non ActiveRecord User class" do
-
-      describe "with a roles_mask attribute" do
+      describe "with a roles_mask" do
 
         it "assigns the roles" do
           PlainRubyUser.valid_roles.must_equal [:viewer, :author, :admin]
@@ -65,26 +86,25 @@ describe Canard::UserModel do
           PlainRubyNonUser.valid_roles.must_equal []
         end
       end
-
     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
+    describe "on an ActiveRecord model with roles" do
 
-    after do
-      User.delete_all
-    end
+      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
 
-    describe "on models with roles" do
+      after do
+        User.delete_all
+      end
 
       subject { User }
 
@@ -442,7 +462,7 @@ describe Canard::UserModel do
 
     end
 
-    describe "on a non ActiveRecord class" do
+    describe "on a plain Ruby class" do
 
       subject { PlainRubyUser }
 

metadata

@@ -1,118 +1,90 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: canard
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.3.5
   prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 4
-  version: 0.3.4
 platform: ruby
-authors: 
+authors:
 - James McCarthy
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-05-12 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-05-25 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: minitest
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2152467160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 2
-        version: "2"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2152467160
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2152466380 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rails
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2152466380
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2152464940 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 3
-        - 2
-        - 3
+      - !ruby/object:Gem::Version
         version: 3.2.3
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2152464940
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2152463940 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: cancan
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2152463940
+- !ruby/object:Gem::Dependency
+  name: cancan
+  requirement: &2152463060 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: role_model
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *2152463060
+- !ruby/object:Gem::Dependency
+  name: role_model
+  requirement: &2152462240 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id006
-description: Wraps CanCan and RoleModel up to make role based authorisation really easy in Rails 3.x.
-email: 
+  prerelease: false
+  version_requirements: *2152462240
+description: Wraps CanCan and RoleModel up to make role based authorisation really
+  easy in Rails 3.x.
+email:
 - james2mccarthy@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - MIT-LICENSE
@@ -173,38 +145,29 @@ files:
 - test/user_model_test.rb
 homepage: https://github.com/james2m/canard
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: canard
-rubygems_version: 1.8.21
+rubygems_version: 1.8.12
 signing_key: 
 specification_version: 3
 summary: Adds role based authorisation to Rails by combining RoleModel and CanCan.
-test_files: 
+test_files:
 - test/abilities/admins.rb
 - test/abilities_test.rb
 - test/ability_test.rb