canard 0.4.2.pre → 0.4.3

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    Y2MxZDQwMmE0ZmI0NDE0YzZjNTA0MWNiZWQ4YzRhZmRiNDc1YzMwMA==
-  data.tar.gz: !binary |-
-    Yzk2MTg0YzZiZWQyMTcwNmQ3OTBkN2UyZTVlMjQzMGVhY2Q2MDQwMA==
+SHA1:
+  metadata.gz: e544f830cff6f7f931128c3dc2742b678483d291
+  data.tar.gz: a972213e3379020ad58efa87c8273c66c1007740
 SHA512:
-  metadata.gz: !binary |-
-    N2ZjYzkxZDk1NzFiNmVhN2I2Mzg5YTgwOGFkMjE1MjU1ZWFjOTUxODg0OTQx
-    ZGNiZDcwZjBhMTQ5ZjVmNzk1NWQ0NjFjZWYyZjE4NjhhM2NkYjI4NTM1MjRl
-    N2YwYzMzZTk3MDQ2YmZiMjFjZjg3NzlmY2ViNzBlODkyZDhhN2Y=
-  data.tar.gz: !binary |-
-    MzFhZjVjMGUxNjVhNTRkMjg4YjkxYTEwNzFhMjI1MDEyYTYxOWM2YzI1NWFh
-    MTc1ZjYyMTRiY2I5ODAxMWQ4NDE3NWZiNmRkYzgwNjUwNzE2MzAwYjgyMzgy
-    ZmQ3Yzk4OTlkMDJkOGE0ZjAyZTBkOGY1MjlkNmY5ZmI5ODgzNDE=
+  metadata.gz: 652b6cb549fe75a54193a0516ef20a4de1249f5ac27cbaaa9e01d1ca19f52833755618d067efc580dad42e5951bd31fb6e42f18faa6190b23b7fc226947699f1
+  data.tar.gz: 8e4b03814ca265992850cb2e6e4574ba492cf44b00f1adbb92570df002f5f95be02549780bc6992f4ab9cfd09b9f0e5660daaa7fb76cd75c2bb75d6969d965ab

data/.travis.yml

@@ -3,6 +3,8 @@ rvm:
   - ree
   - 1.8.7
   - 1.9.3
+  - 2.0.0
+  - 2.1.0
   - jruby-18mode # JRuby in 1.8 mode
   - jruby-19mode # JRuby in 1.9 mode
   - rbx-18mode

data/README.rdoc

@@ -87,6 +87,31 @@ And it's associated test spec/abilities/users_spec.rb;
 
     end
 
+You can also re-use abilities defined for one role in another. This allows you to 'inherit' abilities without having to assign all of the roles to the user. To do this, pass a list of role names to the includes_abilities_of method
+
+    Canard::Abilities.for(:writer) do
+
+      can     [:create], Post
+      can     [:read], Post, user_id: user.id
+
+    end
+
+    Canard::Abilities.for(:reviewer) do
+
+      can     [:read, :update], Post
+
+    end
+
+    Canard::Abilities.for(:admin) do
+
+      includes_abilities_of :writer, :reviewer
+
+      can     [:delete], Post
+
+    end
+
+A user assigned the :admin role will have all of the abilities of the :writer and :reviewer, along with their own abilities without having to have those individual roles assigned to them.
+
 Now lets generate some abilities for the manager and admin.
 
     $ rails g canard:ability admin can:manage:[account,statement]
@@ -123,7 +148,7 @@ User.with_all_roles(roles)::  return only the users with all the specified roles
 
 == Installation
 
-=== Rails 3.x
+=== Rails 3.x & 4.x
 
 Add the canard gem to your Gemfile. In Gemfile:
 

data/canard.gemspec

@@ -1,7 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 require "canard/version"
-require 'rails'
 
 Gem::Specification.new do |s|
   s.name        = "canard"
@@ -30,10 +29,6 @@ Gem::Specification.new do |s|
   end
 
   s.requirements << 'cancan for Rails3 and earlier or the Rails4 compatible cancancan fork.'
-  if Rails.version > '3'
-    s.add_runtime_dependency "cancancan"
-  else
-    s.add_runtime_dependency "cancan"
-  end
+  s.add_runtime_dependency "cancancan"
   s.add_runtime_dependency "role_model"
 end

data/lib/ability.rb

@@ -26,9 +26,12 @@
 class Ability
 
   include CanCan::Ability
+  extend Forwardable
 
   attr_reader :user
 
+  def_delegators :Canard, :ability_definitions, :ability_key
+
   def initialize(object=nil)
 
     # If object has a user attribute set the user from it otherwise assume
@@ -38,7 +41,7 @@ class Ability
     if @user
       # Add the base user abilities.
       user_class_name = String(@user.class.name)
-      append_abilities ability_key(user_class_name) unless user_class_name.empty?
+      append_abilities user_class_name unless user_class_name.empty?
     else
       # If user not set then lets create a guest
       @user = Object.new
@@ -53,17 +56,15 @@ class Ability
 
   end
 
-  private
+  protected
 
-  def append_abilities(key)
-    ability_definitions = Canard.ability_definitions
+  def append_abilities(dirty_key)
+    key = ability_key(dirty_key)
     instance_eval(&ability_definitions[key]) if ability_definitions.has_key?(key)
   end
 
-  def ability_key(class_name)
-    class_name.gsub!('::', '')
-    class_name.gsub!(/(.)([A-Z])/,'\1_\2')
-    class_name.downcase!.to_sym
+  def includes_abilities_of(*other_roles)
+    other_roles.each { |other_role| append_abilities(other_role) }
   end
 
 end

data/lib/canard.rb

@@ -1,3 +1,4 @@
+require 'forwardable'
 require 'cancan'
 require 'role_model'
 require 'canard/abilities'

data/lib/canard/abilities.rb

@@ -1,28 +1,33 @@
 module Canard
   class Abilities
-  
+
     @definitions      = {}
     @default_path     = 'app/abilities'
 
     class << self
 
+      extend Forwardable
+
+      def_delegators :Canard, :ability_key
+
       attr_accessor :default_path
-      
+
       attr_writer :definition_paths
-      
+
       attr_reader :definitions
-      
+
       def definition_paths
         @definition_paths ||= [@default_path]
       end
-      
+
       def for(name, &block)
         raise ArgumentError.new('No block of ability definitions given') unless block_given?
-        @definitions[name.to_sym] = block
+        key = ability_key(name)
+        @definitions[key] = block
       end
-      
+
     end
-    
+
   end
-  
+
 end

data/lib/canard/adapters/mongoid.rb

@@ -30,8 +30,8 @@ module Canard
         include_scope   = role.to_s.pluralize
         exclude_scope   = "non_#{include_scope}"
         
-        scope include_scope, where("(this.#{roles_attribute_name} & #{mask_for(role)}) > 0")
-        scope exclude_scope, any_of({roles_attribute_name  => { "$exists" => false }}, {roles_attribute_name => nil}, {"$where" => "(this.#{roles_attribute_name} & #{mask_for(role)}) === 0"})
+        scope include_scope, lambda { where("(this.#{roles_attribute_name} & #{mask_for(role)}) > 0") }
+        scope exclude_scope, lambda { any_of({roles_attribute_name  => { "$exists" => false }}, {roles_attribute_name => nil}, {"$where" => "(this.#{roles_attribute_name} & #{mask_for(role)}) === 0"}) }
       end
 
     end

data/lib/canard/find_abilities.rb

@@ -1,9 +1,15 @@
 module Canard
 
-  class << self
-    def ability_definitions
-      Abilities.definitions
-    end
+  def self.ability_definitions
+    Abilities.definitions
+  end
+
+  def self.ability_key(class_name)
+    klass_name = String(class_name)
+    klass_name.gsub!('::', '')
+    klass_name.gsub!(/(.)([A-Z])/,'\1_\2')
+    klass_name.downcase!
+    klass_name.to_sym
   end
 
   def self.load_paths

data/lib/canard/version.rb

@@ -1,3 +1,3 @@
 module Canard
-  VERSION = "0.4.2.pre"
+  VERSION = "0.4.3"
 end

data/test/canard/abilities_test.rb

@@ -4,13 +4,13 @@ require 'canard'
 describe 'Canard::Abilities' do
 
   subject { Canard::Abilities }
-   
+
   describe "ability_paths" do
-     
+
     it "defaults to app/abilities" do
       subject.definition_paths.must_include 'app/abilities'
     end
-     
+
     it "appends paths" do
       subject.definition_paths << 'other_abilities'
       subject.definition_paths.must_include 'other_abilities'
@@ -18,47 +18,53 @@ describe 'Canard::Abilities' do
 
     it "can be overwritten" do
       subject.definition_paths = ['other_abilities']
-      
+
       subject.definition_paths.must_equal ['other_abilities']
     end
 
   end
-  
+
   describe "default_path" do
-    
+
     it "defaults to app/abilities" do
       subject.default_path.must_equal 'app/abilities'
     end
 
     it "can be changhed" do
       subject.default_path = 'other_abilities'
-      
+
       subject.default_path.must_equal 'other_abilities'
     end
 
-    
+
   end
-  
+
   describe "for" do
-    
+
     it "adds the block to the definitions" do
       block = lambda { puts 'some block' }
-      
+
       subject.for(:definition, &block)
 
       assert_equal block, subject.definitions[:definition]
     end
-    
+
     it "normalises the key to a symbol" do
       subject.for('definition') { puts 'a block' }
-      
+
       subject.definitions.keys.must_include :definition
     end
-    
+
     it "rasises ArgumentError if no block is provided" do
       proc { subject.for(:definition) }.must_raise ArgumentError
     end
-    
+
+    it 'creates a lowercaae key' do
+      subject.for('NotCamelCase') { puts 'a block' }
+
+      subject.definitions.keys.must_include :not_camel_case
+    end
+
   end
-      
+
 end

data/test/canard/ability_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 describe Ability do
 
   before do
-    Canard::Abilities.default_path = File.expand_path('../../dummy/app/abilities', __FILE__)
+    Canard::Abilities.definition_paths = [File.expand_path('../../dummy/app/abilities', __FILE__)]
     # reload abilities because the reloader will have removed them after the railtie ran
     Canard.find_abilities
   end
@@ -93,6 +93,29 @@ describe Ability do
 
     end
 
+    describe "a user with editor role" do
+      let(:user) { User.create(:roles => [:editor]) }
+      let(:member) { Member.create(:user => user) }
+      let(:other_user) { User.create }
+      let(:other_member) { Member.new(:user => other_user) }
+      subject { Ability.new(user) }
+
+      it "has all the abilities of the base class" do
+        subject.can?(:edit, member).must_equal true
+        subject.can?(:update, member).must_equal true
+
+        subject.cannot?(:edit, other_member).must_equal true
+        subject.cannot?(:update, other_member).must_equal true
+      end
+
+      it "has most of the abilities of authors, except it can't create Posts" do
+        subject.can?(:update, Post).must_equal true
+        subject.can?(:read, Post).must_equal true
+        subject.cannot?(:create, Post).must_equal true
+      end
+
+    end
+
     describe "with no user" do
 
       subject { Ability.new }
@@ -149,21 +172,4 @@ describe Ability do
 
     end
   end
-
-  describe "ability_key" do
-
-    it "returns a snake case version of the string" do
-      class_name = 'CamelCaseString'
-      key = :camel_case_string
-
-      Ability.new.send(:ability_key, class_name).must_equal key
-    end
-
-    it "prepends namespaces to the class name" do
-      class_name = 'Namespace::CamelCaseString'
-      key = :namespace_camel_case_string
-
-      Ability.new.send(:ability_key, class_name).must_equal key
-    end
-  end
 end

data/test/canard/adapters/active_record_test.rb

@@ -7,9 +7,9 @@ describe Canard::Adapters::ActiveRecord 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]
+          User.valid_roles.must_equal [:viewer, :author, :admin, :editor]
         end
 
       end
@@ -35,23 +35,23 @@ describe Canard::Adapters::ActiveRecord do
     end
 
     describe "with no table" do
-        
+
       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 "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
-    
+
     describe 'with an alternative roles_mask specified' do
 
       before do

data/test/canard/canard_test.rb

@@ -15,4 +15,20 @@ describe Canard do
 
   end
 
+  describe "ability_key" do
+
+    it "returns a snake case version of the string" do
+      class_name = 'CamelCaseString'
+      key = :camel_case_string
+
+      Canard.ability_key(class_name).must_equal key
+    end
+
+    it "prepends namespaces to the class name" do
+      class_name = 'Namespace::CamelCaseString'
+      key = :namespace_camel_case_string
+
+      Canard.ability_key(class_name).must_equal key
+    end
+  end
 end

data/test/canard/find_abilities_test.rb

@@ -5,7 +5,7 @@ describe Canard do
   describe "find_abilities" do
 
     before do
-      Canard::Abilities.default_path = File.expand_path('../../dummy/app/abilities', __FILE__)
+      Canard::Abilities.definition_paths = [File.expand_path('../../dummy/app/abilities', __FILE__)]
     end
 
     it "loads the abilities into ability_definitions" do

data/test/canard/user_model_test.rb

@@ -12,7 +12,7 @@ describe Canard::UserModel do
 
       it 'adds role_model to the class' do
         PlainRubyUser.included_modules.must_include RoleModel
-        PlainRubyUser.must_respond_to :roles
+        PlainRubyUser.new.must_respond_to :roles
       end
     end
 
@@ -42,7 +42,7 @@ describe Canard::UserModel do
     end
 
     describe "with no roles_mask" do
-      
+
       before do
         PlainRubyNonUser.acts_as_user :roles => [:viewer, :author, :admin]
       end
@@ -51,9 +51,9 @@ describe Canard::UserModel 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
@@ -117,7 +117,7 @@ describe Canard::UserModel::InstanceMethods do
       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

data/test/dummy/app/abilities/editors.rb

@@ -0,0 +1,7 @@
+Canard::Abilities.for(:editor) do
+
+  includes_abilities_of :author
+
+  cannot :create, Post
+
+end

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

@@ -1,6 +1,6 @@
 class User < ActiveRecord::Base
-  
-  acts_as_user :roles => [:viewer, :author, :admin]
-  
+
+  acts_as_user :roles => [:viewer, :author, :admin, :editor]
+
   attr_accessible :roles
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: canard
 version: !ruby/object:Gem::Version
-  version: 0.4.2.pre
+  version: 0.4.3
 platform: ruby
 authors:
 - James McCarthy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-23 00:00:00.000000000 Z
+date: 2015-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.3
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: cancancan
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: role_model
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Wraps CanCan and RoleModel up to make role based authorisation really
@@ -88,8 +88,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - MIT-LICENSE
 - README.rdoc
@@ -123,6 +123,7 @@ files:
 - test/dummy/Rakefile
 - test/dummy/app/abilities/admins.rb
 - test/dummy/app/abilities/authors.rb
+- test/dummy/app/abilities/editors.rb
 - test/dummy/app/abilities/guests.rb
 - test/dummy/app/abilities/users.rb
 - test/dummy/app/controllers/application_controller.rb
@@ -164,18 +165,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>'
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements:
 - cancan for Rails3 and earlier or the Rails4 compatible cancancan fork.
 rubyforge_project: canard
-rubygems_version: 2.1.11
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Adds role based authorisation to Rails by combining RoleModel and CanCan.
@@ -191,6 +192,7 @@ test_files:
 - test/dummy/Rakefile
 - test/dummy/app/abilities/admins.rb
 - test/dummy/app/abilities/authors.rb
+- test/dummy/app/abilities/editors.rb
 - test/dummy/app/abilities/guests.rb
 - test/dummy/app/abilities/users.rb
 - test/dummy/app/controllers/application_controller.rb