canard 0.2.3 → 0.2.4

data/README.rdoc

@@ -1,5 +1,5 @@
 = Canard
-
+== Overview
 Canard brings CanCan and RoleModel together to make role based authorization in Rails easy. Your ability 
 definitions gain their own folder and a little structure. The easiest way to get started is with the 
 Canard generator. Canard progressively enhances the abilities of the model by applying role abilities on
@@ -9,11 +9,21 @@ A User model with :admin and :manger roles would be defined:
 
     class User < ActiveRecord::Base
     
-      acts_as_user :roles => :admin, :manager
+      acts_as_user :roles =>  :manager, :admin
       
     end
     
-Lets generate some abilities for the User.
+If a User has both the :manager and :admin roles Canard will apply the abilities in the following order.
+First it will look for a users abilities, then it will look for the roles in the order they are defined e.g.
+
+    app/abilities/users.rb
+    app/abilities/manager.rb
+    app/abilities/admin.rb
+    
+Therefore each the later abilities only need to build on their predecessors. 
+
+== Usage 
+To generate some abilities for the User.
 
     $ rails g canard:ability user can:[read,create]:[account,statement] cannot:destroy:account
     create  app/abilities/users.rb
@@ -29,7 +39,7 @@ Generates an ability folder in Rails root and an associated spec;
 
 The resulting app/abilities/users.rb will look something like this;
 
-    abilities_for(:user) do
+    Canard::Abilities.for(:user) do
     
       can     [:read, :create], Account
       cannot  [:destroy], Account
@@ -82,18 +92,19 @@ Now lets generate some abilities for the manager and admin.
     $ rails g canard:ability admin can:manage:[account,statement]
     $ rails g canard:ability manager can:edit:statement
 
-Will give us two new sets of abilities in the abilities folder. Canard will apply these abilities by first
+Gives us two new sets of abilities in the abilities folder. Canard will apply these abilities by first
 loading the ability for the User model and then apply the abilities for each role the current user has.
 
-Canard also creates a guest ability by default so:
+
+If there is no user (i.e. logged out) Canard creates a guest and looks for a guest ability to apply so:
 
     $ rails g canard:ability guest can:create:user
     
 Would generate an ability for a not logged in user to signup.
 
-Obviously the generators are just a starting point and should not be used only to get you going. I strongly 
-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.
+Obviously the generators are just a starting point and should  be used only to get you going. I strongly 
+suggest that every new model you create you add to the abilities as the specs are easy to write and CanCan
+definitions are very clear and simple.
 
 == Scopes
 
@@ -103,7 +114,7 @@ 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
+User.non_managers:: return all the users without the manager role
 
 In addition to the role specific scopes it also adds some general scopes;
 
@@ -134,6 +145,11 @@ to accept pull requests for tested Rails 2.x updates if anybody is game.
   bump version in a commit by itself I can ignore it when I pull)
 * Send me a pull request.  Bonus points for topic branches.
 
+== Contributors
+
+* James McCarthy
+* Joey Geiger
+
 == Credits
 
 Thanks to Ryan Bates for creating the awesome CanCan (http://wiki.github.com/ryanb/cancan/role-based-authorization) 

data/TODO

@@ -1,7 +1,7 @@
-* create ability generator for a new model e.g. rails g canard:abilitiy user:manage
 * Test the ability class.
 * Test the generators.
 * Test the railtie
 * Expand the tests to produce all the standard abilities: index,show,read,new,create,edit,update,destroy.
-* Take the Factory references out of the generated tests.
+* Add test unit generator.
+* Add install generator to allow overriding of the default tests.
 * Add some rdocs.

data/lib/ability.rb

@@ -9,17 +9,17 @@ class Ability
     
     if @user
       # Add the base user abilities.
-      load_abilities @user.class.name.underscore.to_sym
+      append_abilities @user.class.name.underscore.to_sym
     else
       # If user not set then lets create a guest
       @user = Object.new
-      load_abilities :guest
+      append_abilities :guest
     end
     
     # If user has roles get those abilities
     if @user.respond_to?(:roles)
       # Add roles on top of the base user abilities
-      @user.roles.each { |role| load_abilities(role) }
+      @user.roles.each { |role| append_abilities(role) }
     end
   
   end
@@ -34,7 +34,7 @@ class Ability
     Canard::Abilities.definitions
   end
   
-  def load_abilities(role)
+  def append_abilities(role)
     instance_eval(&ability_definitions[role]) if ability_definitions.has_key?(role)
   end
 

data/lib/canard/version.rb

@@ -1,3 +1,3 @@
 module Canard
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/lib/generators/rspec/ability/templates/abilities_spec.rb.erb

@@ -2,13 +2,19 @@ require_relative '../spec_helper'
 
 require "cancan/matchers"
 
-describe Ability, "for :<%= name %>" do
+describe Canard::Abilities, "for <%= plural_name %>" do
 
   before do
-    @<%= name %> = Factory.create(:<%= name %>_user)
+<% if Rails.configuration.generators.options[:rails][:fixture_replacement] == :factory_girl -%>
+    @user = Factory.create(:<%= name %>_user)
+<% elsif Rails.configuration.generators.options[:rails][:fixture_replacement] == :machinist -%>
+    @user = User.make!(:<%= name %>)
+<% else -%>
+  @user = User.create(:roles => %w(<%= name -%>))
+<% end -%>
   end
   
-  subject { Ability.new(@<%= name -%>) }
+  subject { Ability.new(@user) }
   
 <% if ability_definitions.empty? -%>
 # Define your ability tests thus;
@@ -32,22 +38,29 @@ describe Ability, "for :<%= name %>" do
 #  # on Activity
 <% else -%>
 <% definitions do |model, definition| -%>
+  <% model_name = model.camelize -%>
   
-  describe 'on <%= model.camelize -%>' do
+  describe 'on <%= model_name -%>' do
 
     before do
+<% if Rails.configuration.generators.options[:rails][:fixture_replacement] == :factory_girl -%>
       @<%= model -%> = Factory.create(:<%= model -%>)
+<% elsif Rails.configuration.generators.options[:rails][:fixture_replacement] == :machinist -%>
+      @<%= model -%> = <%= model_name -%>.make!
+<% else -%>
+      @<%= model -%> = <%= model_name -%>.create
+<% end -%>
     end
     
 <% definition.cans.each do |can| -%>
-    it { should be_able_to( <%= ":#{can},".ljust(12, ' ') + (can == 'index' ? model.camelize : "@#{model}") -%> ) }
+    it { should be_able_to( <%= ":#{can},".ljust(12, ' ') + "@#{model}" -%> ) }
 <% end -%>
 <%- definition.cannots.each do |cannot| -%>
-    it { should_not be_able_to( <%= ":#{cannot},".ljust(12, ' ') + (cannot == 'index' ? model.camelize : "@#{model}") -%> ) }
+    it { should_not be_able_to( <%= ":#{cannot},".ljust(12, ' ') + "@#{model}" -%> ) }
 <% end -%>
 
   end
-  # on <%= model.camelize %>
+  # on <%= model_name %>
   <% end -%>
   
 <% end -%>  

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: canard
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-12 00:00:00.000000000Z
+date: 2012-03-26 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2157009700 !ruby/object:Gem::Requirement
+  requirement: &2156040520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2'
   type: :development
   prerelease: false
-  version_requirements: *2157009700
+  version_requirements: *2156040520
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2157009160 !ruby/object:Gem::Requirement
+  requirement: &2156040060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157009160
+  version_requirements: *2156040060
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2157008240 !ruby/object:Gem::Requirement
+  requirement: &2156039580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157008240
+  version_requirements: *2156039580
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2157007780 !ruby/object:Gem::Requirement
+  requirement: &2156038960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157007780
+  version_requirements: *2156038960
 - !ruby/object:Gem::Dependency
   name: cancan
-  requirement: &2157007360 !ruby/object:Gem::Requirement
+  requirement: &2156038380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157007360
+  version_requirements: *2156038380
 - !ruby/object:Gem::Dependency
   name: role_model
-  requirement: &2156992120 !ruby/object:Gem::Requirement
+  requirement: &2156037880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156992120
+  version_requirements: *2156037880
 description: Wraps CanCan and RoleModel up to make role based authorisation really
   easy in Rails 3.x.
 email: