canard 0.3.7 → 0.4.0.pre

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - ree
+  - 1.8.7
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode

data/Gemfile

@@ -6,3 +6,9 @@ gemspec
 group :test do
   gem 'rake'
 end
+
+# for CRuby, Rubinius, including Windows and RubyInstaller
+gem "sqlite3", :platform => [:ruby, :mswin, :mingw], :group => [:development, :test]
+
+# for JRuby
+gem 'activerecord-jdbcsqlite3-adapter', :platform => [:jruby], :group => [:development, :test]

data/TODO

@@ -1,10 +1,6 @@
 0.4.0
-* 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.

data/canard.gemspec

@@ -5,6 +5,7 @@ require "canard/version"
 Gem::Specification.new do |s|
   s.name        = "canard"
   s.version     = Canard::VERSION
+  s.date        = `git log -1 --format="%cd" --date=short lib/canard/version.rb`
   s.authors     = ["James McCarthy"]
   s.email       = ["james2mccarthy@gmail.com"]
   s.homepage    = "https://github.com/james2m/canard"
@@ -19,9 +20,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "minitest", "~> 2"
-  s.add_development_dependency "sqlite3"
   s.add_development_dependency "rails", "~> 3.2.3"
-  s.add_runtime_dependency 'activesupport'
   s.add_runtime_dependency "cancan"
   s.add_runtime_dependency "role_model"
 end

data/lib/ability.rb

@@ -30,34 +30,40 @@ class Ability
   attr_reader :user
 
   def initialize(object=nil)
-    
+
     # If object has a user attribute set the user from it otherwise assume
     # this is the user.
     @user = object.respond_to?(:user) ? object.user : object
-    
+
     if @user
       # Add the base user abilities.
-      user_class_name = @user.class.name.to_s
-      append_abilities user_class_name.underscore.to_sym unless user_class_name.length == 0
+      user_class_name = String(@user.class.name)
+      append_abilities ability_key(user_class_name) unless user_class_name.empty?
     else
       # If user not set then lets create a guest
       @user = Object.new
       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| append_abilities(role) }
     end
-  
+
   end
-  
+
   private
-  
-  def append_abilities(role)
+
+  def append_abilities(key)
     ability_definitions = Canard.ability_definitions
-    instance_eval(&ability_definitions[role]) if ability_definitions.has_key?(role)
+    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
   end
 
 end

data/lib/canard/find_abilities.rb

@@ -1,40 +1,16 @@
 module Canard
 
   class << self
-    # A string specifying the location that should be searched for ability
-    # definitions. By default, Canard will attempt to load abilities from
-    # Rails.root + /abilities/.
-    attr_writer :abilities_path
-    
-    def abilities_path 
-      @abilities_path ||= 'abilities'
-    end
-    
     def ability_definitions
       Abilities.definitions
     end
-    
-    def abilities_for(role, &block)
-      ::ActiveSupport::Deprecation.warn("abilities_for is deprecated and will be removed from Canard 0.4.0. Use Canard::Abilities.for and move the definitions to app/abilities.")
-      ability_definitions[role] = block
-    end
-
   end
 
   def self.load_paths
     Abilities.definition_paths.map { |path| File.expand_path(path) }
   end
 
-  # TODO remove at version 0.4.0
   def self.find_abilities #:nodoc:
-    absolute_abilities_path = File.expand_path(abilities_path)
-
-    if File.directory? absolute_abilities_path
-      Dir[File.join(absolute_abilities_path, '**', '*.rb')].sort.each do |file|
-        self.class_eval File.read(file)
-      end
-    end
-    
     load_paths.each do |path|
       Dir[File.join(path, '**', '*.rb')].sort.each do |file|
         load file
@@ -42,5 +18,5 @@ module Canard
     end
 
   end
-  
+
 end

data/lib/canard/railtie.rb

@@ -3,7 +3,7 @@ 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
@@ -19,7 +19,7 @@ module Canard
         Canard.find_abilities
       end
     end
-    
+
     initializer "canard.abilities_reloading", :after => "action_dispatch.configure" do |app|
       if ActionDispatch::Reloader.respond_to?(:to_prepare)
         ActionDispatch::Reloader.to_prepare { Canard.find_abilities }
@@ -27,6 +27,9 @@ module Canard
         ActionDispatch::Reloader.before { Canard.find_abilities }
       end
     end
-    
+
+    rake_tasks do
+      load File.expand_path('../../tasks/canard.rake', __FILE__)
+    end
   end
 end

data/lib/canard/version.rb

@@ -1,3 +1,3 @@
 module Canard
-  VERSION = "0.3.7"
+  VERSION = "0.4.0.pre"
 end

data/lib/tasks/canard.rake

@@ -0,0 +1,23 @@
+namespace :canard do
+  desc 'Upgrades deprecated ability definition syntax and moves the files from abilities to app/abilities'
+  task :upgrade => :environment do
+    require 'rake/clean'
+    source_path = 'abilities'
+    destination_path = Canard::Abilities.definition_paths.first
+
+    Dir.mkdir(destination_path) unless Dir.exists?(destination_path)
+
+    if Dir.exists?(source_path)
+      Dir[File.join(source_path, '*.rb')].each do |input_file|
+        input = File.read(input_file)
+        output = input.gsub(/abilities_for/, 'Canard::Abilities.for')
+        output_file = File.expand_path(File.basename(input_file), destination_path)
+        File.write(output_file, output)
+        File.delete(input_file)
+      end
+      Dir.delete(source_path)
+    else
+    end
+
+  end
+end

data/test/abilities/administrators.rb

@@ -0,0 +1,5 @@
+Canard::Abilities.for(:administrator) do
+
+  can :manage, [Activity, User]
+
+end

data/test/canard/ability_test.rb

@@ -1,46 +1,46 @@
 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
-    
+
   describe "new" do
-    
+
     describe "with a user" do
-      
+
       let(:user) { User.new }
       subject { Ability.new(user) }
-      
+
       it "assign the user to Ability#user" do
         subject.user.must_equal user
       end
 
     end
-    
+
     describe "with a model that references a user" do
-      
+
       let(:user) { User.create }
       let(:member) { Member.new(:user => user) }
-      
+
       subject { Ability.new(member) }
-      
+
       it "assign the user to Ability#user" do
         subject.user.must_equal user
       end
 
     end
-    
+
     describe "with a user that has author role" do
-      
+
       let(:user) { User.create(:roles => [:author]) }
       let(:member) { Member.create(:user => user) }
       let(:other_member) { Member.new(:user => User.create) }
       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
@@ -48,7 +48,7 @@ describe Ability do
         subject.can?(:edit, other_member).wont_equal true
         subject.can?(:update, other_member).wont_equal true
       end
-      
+
       it "has all the abilities of an author" do
         subject.can?(:new, Post).must_equal true
         subject.can?(:create, Post).must_equal true
@@ -57,21 +57,21 @@ describe Ability do
         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
 
     describe "with a user that has admin and author roles" do
-      
+
       let(:user) { User.create(:roles => [:author, :admin]) }
       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
@@ -79,39 +79,39 @@ describe Ability do
         subject.cannot?(:edit, other_member).must_equal true
         subject.cannot?(:update, other_member).must_equal true
       end
-      
+
       it "has all the abilities of an author" do
         subject.can?(:new, Post).must_equal true
       end
-      
+
       it "has the abilities of an admin" do
         subject.can?(:manage, Post).must_equal true
         subject.can?(:manage, other_user).must_equal true
         subject.can?(:destroy, other_user).must_equal true
         subject.cannot?(:destroy, user).must_equal true
       end
-      
+
     end
-    
+
     describe "with no user" do
-      
+
       subject { Ability.new }
-      
+
       it "applies the guest abilities" do
         subject.can?(:index, Post)
         subject.can?(:show, Post)
-        
+
         subject.cannot?(:create, Post)
         subject.cannot?(:update, Post)
         subject.cannot?(:destroy, Post)
-        
+
         subject.cannot?(:show, User)
         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
@@ -123,16 +123,16 @@ describe Ability do
       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
@@ -141,13 +141,29 @@ describe Ability do
           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
+
+  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/canard_test.rb

@@ -2,26 +2,17 @@ require 'test_helper'
 require 'canard'
 
 describe Canard do
-    
-  describe "abilities_path" do
-    
-    it "should be mutable" do
-      Canard.abilities_path = 'app/abilities'
-      Canard.abilities_path.must_equal 'app/abilities'
-    end
 
-  end
-  
   describe "ability_definitions" do
-    
+
     it "should be an accessor" do
       Canard.must_respond_to(:ability_definitions)
     end
-    
+
     it "should be a hash" do
       Canard.ability_definitions.must_be_instance_of Hash
     end
-    
-  end  
-    
+
+  end
+
 end

data/test/canard/find_abilities_test.rb

@@ -1,50 +1,43 @@
 require 'test_helper'
-require 'active_support/testing/deprecation'
 
 describe Canard do
-  
-  include ActiveSupport::Testing::Deprecation
-  
-  before 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
-  
+
   describe "find_abilities" do
-    
+
+    before do
+      Canard::Abilities.default_path = File.expand_path('../../dummy/app/abilities', __FILE__)
+    end
+
     it "loads the abilities into ability_definitions" do
       Canard.find_abilities
 
       Canard.ability_definitions.keys.must_include :admin
     end
-    
-    it "finds the abilities with the new syntax" do
+
+    it "finds abilities in the default path" do
+      Canard.find_abilities
+
+      Canard.ability_definitions.keys.must_include :author
+      Canard.ability_definitions.keys.wont_include :administrator
+    end
+
+    it "finds abilities in additional paths" do
+      Canard::Abilities.definition_paths << File.expand_path('../../abilities', __FILE__)
       Canard.find_abilities
-      
+
       Canard.ability_definitions.keys.must_include :author
+      Canard.ability_definitions.keys.must_include :administrator
     end
-    
+
     it "reloads existing abilities" do
       Canard.find_abilities
       Canard::Abilities.send(:instance_variable_set, '@definitions', {})
       Canard.find_abilities
-      
+
       Canard.ability_definitions.keys.must_include :author
       Canard.ability_definitions.keys.must_include :admin
     end
-    
-  end
-  
-  describe "abilities_for" do
-    
-    it "raises a deprecation warning" do
-      assert_deprecated do
-        Canard.abilities_for(:this) { return 'that' }
-      end
-    end
-    
+
   end
+
 end

metadata

@@ -1,119 +1,90 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: canard
-version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 7
-  version: 0.3.7
+version: !ruby/object:Gem::Version
+  version: 0.4.0.pre
+  prerelease: 6
 platform: ruby
-authors: 
+authors:
 - James McCarthy
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-06-23 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: minitest
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !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: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
   name: rails
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: !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: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+- !ruby/object:Gem::Dependency
   name: cancan
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: !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: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: role_model
+  requirement: !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: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+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
+- .travis.yml
 - Gemfile
 - MIT-LICENSE
 - README.rdoc
@@ -134,7 +105,8 @@ files:
 - lib/generators/canard/ability/templates/abilities.rb.erb
 - lib/generators/rspec/ability/ability_generator.rb
 - lib/generators/rspec/ability/templates/abilities_spec.rb.erb
-- test/abilities/admins.rb
+- lib/tasks/canard.rake
+- test/abilities/administrators.rb
 - test/canard/abilities_test.rb
 - test/canard/ability_test.rb
 - test/canard/adapters/active_record_test.rb
@@ -175,39 +147,30 @@ 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 
-      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: 1.3.1
 requirements: []
-
 rubyforge_project: canard
 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/abilities/admins.rb
+test_files:
+- test/abilities/administrators.rb
 - test/canard/abilities_test.rb
 - test/canard/ability_test.rb
 - test/canard/adapters/active_record_test.rb

data/test/abilities/admins.rb

@@ -1,5 +0,0 @@
-abilities_for(:admin) do
-
-  can :manage, [Activity, User]
-
-end