canard 0.3.6 → 0.3.7

data/TODO

@@ -1,11 +1,13 @@
 0.4.0
-* Make the Ability user referece configureable in Ability.
-* Test the generators.
+* Make framework agnostic.
+* Split the test suite so Rails is only required for Rails integration. http://blog.railsware.com/2012/01/07/testing-gem-integration-with-multiple-ruby-frameworks/
 * 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
 * Expand the generated tests to produce all the standard abilities: index,show,read,new,create,edit,update,destroy.
+* Test the generators.
 * Add test unit generator.
 * Add install generator to allow overriding of the default tests.
+* Make the Ability user referece configureable in Ability.

data/lib/ability.rb

@@ -37,7 +37,8 @@ class Ability
     
     if @user
       # Add the base user abilities.
-      append_abilities @user.class.name.underscore.to_sym
+      user_class_name = @user.class.name.to_s
+      append_abilities user_class_name.underscore.to_sym unless user_class_name.length == 0
     else
       # If user not set then lets create a guest
       @user = Object.new

data/lib/canard/adapters/active_record.rb

@@ -17,6 +17,10 @@ module Canard
           define_scope_method(:with_all_roles) do |*roles|
             where("#{role_mask_column} & :role_mask = :role_mask", { :role_mask => mask_for(*roles) })
           end
+
+          define_scope_method(:with_only_roles) do |*roles|
+            where("#{role_mask_column} = :role_mask", { :role_mask => mask_for(*roles) })
+          end
         end
       end
 

data/lib/canard/user_model.rb

@@ -58,12 +58,13 @@ module Canard
     # returns all the users who don't have the manager role.
     def acts_as_user(*args)
       include RoleModel
+      include InstanceMethods
       extend Adapters::ActiveRecord if defined?(ActiveRecord) && self < ActiveRecord::Base
 
       options = args.last.is_a?(Hash) ? args.pop : {}
 
       roles_attribute options[:roles_mask] if options.has_key?(:roles_mask)
-      
+
       roles options[:roles] if options.has_key?(:roles) && has_roles_mask_accessors?
 
       add_role_scopes if respond_to?(:add_role_scopes, true)
@@ -79,5 +80,13 @@ module Canard
         instance_method_names.include?(accessor)
       end
     end
+
+    module InstanceMethods
+
+      def ability
+        @ability ||= Ability.new(self)
+      end
+
+    end
   end
 end

data/lib/canard/version.rb

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

data/test/canard/ability_test.rb

@@ -34,7 +34,7 @@ describe Ability do
 
     end
     
-    describe "for a user with author role" do
+    describe "with a user that has author role" do
       
       let(:user) { User.create(:roles => [:author]) }
       let(:member) { Member.create(:user => user) }
@@ -64,7 +64,7 @@ describe Ability do
       
     end
 
-    describe "for a user with admin and author role" do
+    describe "with a user that has admin and author roles" do
       
       let(:user) { User.create(:roles => [:author, :admin]) }
       let(:member) { Member.create(:user => user) }
@@ -93,7 +93,7 @@ describe Ability do
       
     end
     
-    describe "for a guest" do
+    describe "with no user" do
       
       subject { Ability.new }
       
@@ -109,6 +109,45 @@ describe Ability do
         subject.cannot?(:show, Member)
       end
     end
+    
+    describe "with an instance of an anonymous class that has author role" do
+      
+      let(:klass) do
+        Class.new do
+          extend Canard::UserModel
+          attr_accessor :roles_mask
+          acts_as_user :roles => [:author, :admin]
+          def initialize(*roles); self.roles = roles; end
+        end
+      end
+      let(:instance) { klass.new(:author) }
+
+      describe "for base class abilities" do
+        
+        it "does nothing" do
+          proc { Ability.new(instance) }.must_be_silent
+        end
+      end
+      
+      describe "for assigned roles" do
+        
+        subject { Ability.new(instance) }
+        
+        it "has all the abilities of an author" do
+          subject.can?(:new, Post).must_equal true
+          subject.can?(:create, Post).must_equal true
+          subject.can?(:edit, Post).must_equal true
+          subject.can?(:update, Post).must_equal true
+          subject.can?(:show, Post).must_equal true
+          subject.can?(:index, Post).must_equal true
+        end
+      
+        it "has no admin abilities" do
+          subject.cannot?(:destroy, Post).must_equal true
+        end
+      end
+      
+    end
   end
   
 end

data/test/canard/adapters/active_record_test.rb

@@ -436,6 +436,43 @@ describe Canard::Adapters::ActiveRecord do
 
       end
 
+      describe "with_only_roles" do
+
+        describe "specifying one role" do
+
+          subject { User.with_only_roles(:admin).sort_by(&:id) }
+
+          it "returns users with just that role" do
+            subject.must_equal [@admin_only].sort_by(&:id)
+          end
+
+          it "doesn't return any other users" do
+            subject.wont_include @no_role
+            subject.wont_include @admin_author_viewer
+            subject.wont_include @author_viewer
+            subject.wont_include @author_only
+            subject.wont_include @viewer
+          end
+
+        end
+
+        describe "specifying multiple roles" do
+
+          subject { User.with_only_roles(:author, :viewer).sort_by(&:id) }
+
+          it "returns only users with no more or less roles" do
+            subject.must_equal [@author_viewer].sort_by(&:id)
+          end
+
+          it "doesn't return any other users" do
+            subject.wont_include @no_role
+            subject.wont_include @admin_author_viewer
+            subject.wont_include @admin_only
+            subject.wont_include @author_only
+            subject.wont_include @viewer
+          end
+        end
+      end
     end
   end
 

data/test/canard/user_model_test.rb

@@ -87,5 +87,39 @@ describe Canard::UserModel do
       end
     end
   end
+end
+
+describe Canard::UserModel::InstanceMethods 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
+
+  describe "ability" do
+
+    before do
+      PlainRubyUser.acts_as_user :roles => [:admin, :author]
+    end
 
+    subject { PlainRubyUser.new(:author).ability }
+
+    it "returns an ability for this instance" do
+      subject.must_be_instance_of Ability
+    end
+
+    it "has the users abilities" do
+      subject.can?(:new, Post).must_equal true
+      subject.can?(:create, Post).must_equal true
+      subject.can?(:edit, Post).must_equal true
+      subject.can?(:update, Post).must_equal true
+      subject.can?(:show, Post).must_equal true
+      subject.can?(:index, Post).must_equal true
+    end
+      
+    it "has no other abilities" do
+      subject.cannot?(:destroy, Post).must_equal true
+    end
+  end
 end

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

@@ -1,7 +1,11 @@
 class PlainRubyUser
-  
+
   extend Canard::UserModel
-  
+
   attr_accessor :roles_mask
-  
+
+  def initialize(*roles)
+    self.roles = roles
+  end
+
 end

metadata

@@ -1,90 +1,118 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: canard
-version: !ruby/object:Gem::Version
-  version: 0.3.6
+version: !ruby/object:Gem::Version 
+  hash: 29
   prerelease: 
+  segments: 
+  - 0
+  - 3
+  - 7
+  version: 0.3.7
 platform: ruby
-authors:
+authors: 
 - James McCarthy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-06 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-06-23 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: minitest
-  requirement: &2152663460 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2'
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        version: "2"
   type: :development
-  prerelease: false
-  version_requirements: *2152663460
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: sqlite3
-  requirement: &2152663000 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *2152663000
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: rails
-  requirement: &2152662380 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 3
+        - 2
+        - 3
         version: 3.2.3
   type: :development
-  prerelease: false
-  version_requirements: *2152662380
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: activesupport
-  requirement: &2152661900 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *2152661900
-- !ruby/object:Gem::Dependency
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: cancan
-  requirement: &2152661320 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *2152661320
-- !ruby/object:Gem::Dependency
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: role_model
-  requirement: &2152660780 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *2152660780
-description: Wraps CanCan and RoleModel up to make role based authorisation really
-  easy in Rails 3.x.
-email:
+  version_requirements: *id006
+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
@@ -147,29 +175,38 @@ files:
 - test/test_helper.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
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: canard
-rubygems_version: 1.8.12
+rubygems_version: 1.8.24
 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/canard/abilities_test.rb
 - test/canard/ability_test.rb