canard 0.4.3 → 0.5.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e544f830cff6f7f931128c3dc2742b678483d291
-  data.tar.gz: a972213e3379020ad58efa87c8273c66c1007740
+  metadata.gz: cc60d17173f92f98f6d45330a03a33fd1f7b1253
+  data.tar.gz: 4381d33e14aa4dde69a7433eb998b09a1fad5528
 SHA512:
-  metadata.gz: 652b6cb549fe75a54193a0516ef20a4de1249f5ac27cbaaa9e01d1ca19f52833755618d067efc580dad42e5951bd31fb6e42f18faa6190b23b7fc226947699f1
-  data.tar.gz: 8e4b03814ca265992850cb2e6e4574ba492cf44b00f1adbb92570df002f5f95be02549780bc6992f4ab9cfd09b9f0e5660daaa7fb76cd75c2bb75d6969d965ab
+  metadata.gz: 476dac97c8a7588373a07f3812c4975b3330b3f815139ba96b530084d6ebd2a85c9e0cdee374bf6de6a961646bc3aa0144989f3aa22038aee6f75c6d7e0a3de5
+  data.tar.gz: 1f3d9f6111da01e36310b343948f5b0f2eddb979810237755653033a06edbf1a7aff3fa229d1fcbf045f4451f8b2e34c6625f9ffbd1c5ed8583a6bce362437ea

data/.gitignore

@@ -8,4 +8,5 @@ pkg/*
 Gemfile.lock
 *.sqlite3
 *.log
-.tm_properties
+.tm_properties
+.byebug_history

data/.travis.yml

@@ -1,14 +1,11 @@
 language: ruby
 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
-  - rbx-19mode
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.3
+  - 2.4.0
+  - jruby-9.1.7.0
 services:
   - mongodb
 

data/{README.rdoc → README.md}

@@ -1,15 +1,16 @@
-= Canard
-== Overview
+Canard
+======
+[![Build Status](https://travis-ci.org/james2m/canard.svg?branch=master)](https://travis-ci.org/james2m/canard)
+
 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
 top of the models base abilities.
-
 A User model with :admin and :manager roles would be defined:
 
     class User < ActiveRecord::Base
 
-      acts_as_user :roles =>  :manager, :admin
+      acts_as_user :roles => [ :manager, :admin ]
 
     end
 
@@ -22,7 +23,8 @@ First it will look for a users abilities, then it will look for the roles in the
 
 Therefore each the later abilities only need to build on their predecessors.
 
-== Usage
+Usage
+=====
 To generate some abilities for the User.
 
     $ rails g canard:ability user can:[read,create]:[account,statement] cannot:destroy:account
@@ -131,8 +133,8 @@ Obviously the generators are just a starting point and should  be used only to g
 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
-
+Scopes
+======
 The :acts_as_user method with automatically define some named scopes for each role. For the example User model
 above it will define the following scopes;
 
@@ -146,10 +148,11 @@ In addition to the role specific scopes it also adds some general scopes;
 User.with_any_role(roles)::   return all the users with any of the specified roles
 User.with_all_roles(roles)::  return only the users with all the specified roles
 
-== Installation
-
-=== Rails 3.x & 4.x
+Installation
+============
 
+Rails 3.x, 4.x & 5.x
+--------------------
 Add the canard gem to your Gemfile. In Gemfile:
 
     gem "canard"
@@ -161,17 +164,19 @@ Add the `roles_mask` field to your user table:
 
 That's it!
 
-=== Rails 2.x
+Rails 2.x
+---------
 
-Sorry you are out of luck with Rails 2.x Canard has only been written and tested with Rails 3.x. I'll be happy
-to accept pull requests for tested Rails 2.x updates if anybody is game.
+Sorry you are out of luck with Rails 2.x Canard has only been written and tested with Rails 3 and above.
 
-== Supported ORM's
+Supported ORM's
+---------------
 
 Canard is ORM agnostic. ActiveRecord and Mongoid (thanks David Butler) adapters are currently implemented.
 New adapters can easily be added, but you'd need to check CanCan can also support your adapter.
 
-== Further reading
+Further reading
+---------------
 
 Canard stands on the sholders of Ryan Bates' CanCan and Martin Rehfeld's RoleModel. You can read more
 about defining abilities on the CanCan wiki (https://github.com/ryanb/cancan/wiki). Canard implements
@@ -206,7 +211,8 @@ Under the covers Canard uses RoleModel (https://github.com/martinrehfeld/role_mo
 is based on Ryan Bates' suggested approach to role based authorization which is documented in the CanCan
 wiki (https://github.com/ryanb/cancan/wiki/role-based-authorization).
 
-== Note on Patches/Pull Request
+Note on Patches/Pull Request
+----------------------------
 
 * Fork the project.
 * Make your feature addition or bug fix.
@@ -215,21 +221,33 @@ wiki (https://github.com/ryanb/cancan/wiki/role-based-authorization).
   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
+Contributors
+------------
 
     git log | grep Author | sort | uniq
 
+* Alessandro Dal Grande
+* David Butler
+* Dmitriy Molodtsov
+* Dmytro Salko
 * James McCarthy
+* Jesse McGinnis
 * Joey Geiger
+* Jon Kinney
+* Justin Buchanan
 * Morton Jonuschat
-* David Butler
+* Piotr Kuczynski
+* Thomas Hoen
+* Travis Berry
 
 If you feel like contributing there is a TODO list in the root with a few ideas and opportunities!
 
-== Credits
+Credits
+-------
 
 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
-Copyright (c) 2011 James McCarthy, released under the MIT license
+Copyright
+---------
+Copyright (c) 2011-2017 James McCarthy, released under the MIT license

data/TODO

@@ -7,4 +7,5 @@
 * Add install generator to allow overriding of the default tests.
 * Make the Ability user referece configureable in Ability.
 * Add DataMapper support.
-* Detect and use FactoryGirl syntax in generated spec.
+* Detect and use FactoryGirl syntax in generated spec.
+* Stop extending ActiveRecord, use composition instead.

data/canard.gemspec

@@ -1,34 +1,29 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "canard/version"
+require 'canard/version'
 
 Gem::Specification.new do |s|
-  s.name        = "canard"
+  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"
-  s.summary     = %q{Adds role based authorisation to Rails by combining RoleModel and CanCan.}
-  s.description = %q{Wraps CanCan and RoleModel up to make role based authorisation really easy in Rails 3.x.}
+  s.authors     = ['James McCarthy']
+  s.email       = ['james2mccarthy@gmail.com']
+  s.homepage    = 'https://github.com/james2m/canard'
+  s.summary     = %q{Adds role based authorisation to Rails by combining RoleModel and CanCanCan.}
+  s.description = %q{Wraps CanCanCan and RoleModel up to make role based authorisation really easy in Rails 4+.}
 
   s.rubyforge_project = "canard"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
 
-  s.add_development_dependency "minitest", "~> 2"
-  s.add_development_dependency "rails", "~> 3.2.3"
+  s.add_development_dependency 'minitest', '~> 2'
+  s.add_development_dependency 'rails', '~> 3.2.3', '>= 3.2.3'
+  s.add_development_dependency 'mongoid', '~> 3.0'
 
-  if RUBY_VERSION < '1.9'
-    s.add_development_dependency "mongoid", "~> 2.0"
-  else
-    s.add_development_dependency "mongoid", "~> 3.0"
-  end
-
-  s.requirements << 'cancan for Rails3 and earlier or the Rails4 compatible cancancan fork.'
-  s.add_runtime_dependency "cancancan"
-  s.add_runtime_dependency "role_model"
+  s.requirements << "cancan's community supported Rails4+ compatible cancancan fork."
+  s.add_runtime_dependency 'cancancan', '~> 1'
+  s.add_runtime_dependency 'role_model', '~> 0'
 end

data/lib/canard/adapters/active_record.rb

@@ -4,23 +4,24 @@ module Canard
 
       private
 
-      def add_role_scopes
+      def add_role_scopes(*args)
+        options = args.extract_options!
         # TODO change to check has_roles_attribute?
         if active_record_table?
           valid_roles.each do |role|
-            define_scopes_for_role role
+            define_scopes_for_role role, options[:prefix]
           end
 
           # TODO change hard coded :role_mask to roles_attribute_name
-          define_scope_method(:with_any_role) do |*roles|
+          define_singleton_method(:with_any_role) do |*roles|
             where("#{role_mask_column} & :role_mask > 0", { :role_mask => mask_for(*roles) })
           end
 
-          define_scope_method(:with_all_roles) do |*roles|
+          define_singleton_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|
+          define_singleton_method(:with_only_roles) do |*roles|
             where("#{role_mask_column} = :role_mask", { :role_mask => mask_for(*roles) })
           end
         end
@@ -35,29 +36,22 @@ module Canard
         active_record_table? && column_names.include?(roles_attribute_name.to_s) || super
       end
 
-      def define_scopes_for_role(role)
-        include_scope   = role.to_s.pluralize
-        exclude_scope   = "non_#{include_scope}"
+      def define_scopes_for_role(role, prefix=nil)
+        include_scope = [prefix, String(role).pluralize].compact.join('_')
+        exclude_scope = "non_#{include_scope}"
 
-        define_scope_method(include_scope) do
+        define_singleton_method(include_scope) do
           where("#{role_mask_column} & :role_mask > 0", { :role_mask => mask_for(role) })
         end
 
-        define_scope_method(exclude_scope) do
+        define_singleton_method(exclude_scope) do
           where("#{role_mask_column} & :role_mask = 0 or #{role_mask_column} is null", { :role_mask => mask_for(role) })
         end
       end
 
-      def define_scope_method(method, &block)
-        (class << self; self end).class_eval do
-          define_method(method, block)
-        end
-      end
-
       def role_mask_column
         "#{quoted_table_name}.#{connection.quote_column_name roles_attribute_name}"
       end
-
     end
   end
 end

data/lib/canard/adapters/mongoid.rb

@@ -4,9 +4,10 @@ module Canard
 
       private
 
-      def add_role_scopes
+      def add_role_scopes(*args)
+        options = args.extract_options!
         valid_roles.each do |role|
-          define_scopes_for_role role
+          define_scopes_for_role role, options[:prefix]
         end
 
         def with_any_role(*roles)
@@ -26,14 +27,13 @@ module Canard
        fields.include?(roles_attribute_name.to_s) || super
       end
 
-      def define_scopes_for_role(role)
-        include_scope   = role.to_s.pluralize
-        exclude_scope   = "non_#{include_scope}"
-        
-        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
+      def define_scopes_for_role(role, prefix=nil)
+        include_scope = [prefix, String(role).pluralize].compact.join('_')
+        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"}) }
+      end
     end
   end
 end

data/lib/canard/railtie.rb

@@ -25,21 +25,24 @@ module Canard
     end
 
     initializer "canard.mongoid" do |app|
-      if defined?(Mongoid)
-        require 'canard/adapters/mongoid'
-      end
+      require 'canard/adapters/mongoid' if defined?(Mongoid)
     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 }
-      else
-        ActionDispatch::Reloader.before { Canard.find_abilities }
+      reloader = rails5? ? ActiveSupport::Reloader : ActionDispatch::Reloader
+      if reloader.respond_to?(:to_prepare)
+        reloader.to_prepare { Canard.find_abilities }
       end
     end
 
     rake_tasks do
       load File.expand_path('../../tasks/canard.rake', __FILE__)
     end
+
+    private
+
+    def rails5?
+      ActionPack::VERSION::MAJOR == 5
+    end
   end
 end

data/lib/canard/user_model.rb

@@ -73,7 +73,7 @@ module Canard
 
       roles options[:roles] if options.has_key?(:roles) && has_roles_mask_accessors?
 
-      add_role_scopes if respond_to?(:add_role_scopes, true)
+      add_role_scopes(prefix: options[:prefix]) if respond_to?(:add_role_scopes, true)
     end
 
     private

data/lib/canard/version.rb

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

data/lib/generators/canard/ability/templates/abilities.rb.erb

@@ -1,5 +1,4 @@
 Canard::Abilities.for(<%= ":#{name}" -%>) do
-
 <% if ability_definitions.empty? -%>
   # Define abilities for the user role here. For example:
   #
@@ -19,14 +18,13 @@ Canard::Abilities.for(<%= ":#{name}" -%>) do
   # The third argument is an optional hash of conditions to further filter the objects.
   # For example, here the user can only update published articles.
   #
-  #   can :update, Article, :published => true
+  #   can :update, Article, published: true
   #
-  # See the wiki for details: https://github.com/ryanb/cancan/wiki/Defining-Abilities
+  # See the wiki for details: https://github.com/CanCanCommunity/cancancan/wiki/Defining-Abilities
 <% else -%>
 <% definitions do |model, definition| -%>
-  <%= "can".ljust(8, ' ') + "#{definition.cans.map(&:to_sym)}, #{model.classify}" unless definition.cans.empty? %>
-  <%= "cannot".ljust(8, ' ') + "#{definition.cannots.map(&:to_sym)}, #{model.classify}" unless definition.cannots.empty? %>
+  <%= "can #{definition.cans.map(&:to_sym)}, #{model.classify}" unless definition.cans.empty? %>
+  <%= "cannot #{definition.cannots.map(&:to_sym)}, #{model.classify}" unless definition.cannots.empty? %>
 <% end -%>
 <% end -%>
-
-end
+end

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

@@ -1,68 +1,51 @@
-require_relative '../spec_helper'
+require 'rails_helper'
+require 'cancan/matchers'
 
-require "cancan/matchers"
-
-describe Canard::Abilities, "for <%= plural_name %>" do
-
-  before do
+describe Canard::Abilities, '#<%= plural_name %>' do
 <% if Rails.configuration.generators.options[:rails][:fixture_replacement] == :factory_girl -%>
-    @user = Factory.create(:<%= name %>_user)
+  let(:acting_<%= name %>) { FactoryGirl.create(:user<%= name == 'user' ? '' : ", :#{name}" %>) }
 <% elsif Rails.configuration.generators.options[:rails][:fixture_replacement] == :machinist -%>
-    @user = User.make!(:<%= name %>)
+  let(:acting_<%= name %>) { User.make!(:<%= name %>) }
 <% else -%>
-  @user = User.create(:roles => %w(<%= name -%>))
+  let(:acting_<%= name %>) { User.create(roles: %w(<%= name -%>)) }
 <% end -%>
-  end
-  
-  subject { Ability.new(@user) }
-  
+  subject(:<%= name %>_ability) { Ability.new(acting_<%= name %>) }
+
 <% if ability_definitions.empty? -%>
-# Define your ability tests thus;
-#
-#  describe 'on Activity' do
-#
-#    before do
-#      @activity = Factory.create(:activity)
-#    end
+#   # Define your ability tests thus;
+#   describe 'on <%= name.camelize %>' do
+#     let(:<%= name %>) { FactoryGirl.create(<%= name %>) }
 #
-#    it { should be_able_to( :index,    Activity  ) }
-#    it { should be_able_to( :show,     @activity ) }
-#    it { should be_able_to( :read,     @activity ) }
-#    it { should be_able_to( :new,      @activity ) }
-#    it { should be_able_to( :create,   @activity ) }
-#    it { should be_able_to( :edit,     @activity ) }
-#    it { should be_able_to( :update,   @activity ) }
-#    it { should be_able_to( :destroy,  @activity ) }
-#
-#  end
-#  # on Activity
+#     it { is_expected.to be_able_to(:index,   <%= name.camelize %>) }
+#     it { is_expected.to be_able_to(:show,    <%= name %>) }
+#     it { is_expected.to be_able_to(:read,    <%= name %>) }
+#     it { is_expected.to be_able_to(:new,     <%= name %>) }
+#     it { is_expected.to be_able_to(:create,  <%= name %>) }
+#     it { is_expected.to be_able_to(:edit,    <%= name %>) }
+#     it { is_expected.to be_able_to(:update,  <%= name %>) }
+#     it { is_expected.to be_able_to(:destroy, <%= name %>) }
+#   end
+#   # on <%= name.camelize %>
 <% else -%>
 <% definitions do |model, definition| -%>
   <% model_name = model.camelize -%>
-  
-  describe 'on <%= model_name -%>' do
-
-    before do
+describe 'on <%= model_name -%>' do
 <% if Rails.configuration.generators.options[:rails][:fixture_replacement] == :factory_girl -%>
-      @<%= model -%> = Factory.create(:<%= model -%>)
+    let(:<%= model -%>) { FactoryGirl.create(:<%= model -%>) }
 <% elsif Rails.configuration.generators.options[:rails][:fixture_replacement] == :machinist -%>
-      @<%= model -%> = <%= model_name -%>.make!
+    let(:<%= model -%>) { <%= model_name -%>.make! }
 <% else -%>
-      @<%= model -%> = <%= model_name -%>.create
+    let(:<%= model -%>) { <%= model_name -%>.create }
 <% end -%>
-    end
-    
+
 <% definition.cans.each do |can| -%>
-    it { should be_able_to( <%= ":#{can},".ljust(12, ' ') + "@#{model}" -%> ) }
+    it { is_expected.to be_able_to(<%= ":#{can}, #{model}" -%>) }
 <% end -%>
 <%- definition.cannots.each do |cannot| -%>
-    it { should_not be_able_to( <%= ":#{cannot},".ljust(12, ' ') + "@#{model}" -%> ) }
+    it { is_expected.to_not be_able_to(<%= ":#{cannot}, #{model}" -%>) }
 <% end -%>
-
   end
   # on <%= model_name %>
-  <% end -%>
-  
-<% end -%>  
+<% end -%>
+<% end -%>
 end
-  

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canard
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0.pre
 platform: ruby
 authors:
 - James McCarthy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-24 00:00:00.000000000 Z
+date: 2017-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -31,6 +31,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,6 +41,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.3
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
@@ -56,32 +62,32 @@ dependencies:
   name: cancancan
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !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
-  easy in Rails 3.x.
+description: Wraps CanCanCan and RoleModel up to make role based authorisation really
+  easy in Rails 4+.
 email:
 - james2mccarthy@gmail.com
 executables: []
@@ -92,7 +98,7 @@ files:
 - ".travis.yml"
 - Gemfile
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - TODO
 - canard.gemspec
@@ -170,16 +176,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements:
-- cancan for Rails3 and earlier or the Rails4 compatible cancancan fork.
+- cancan's community supported Rails4+ compatible cancancan fork.
 rubyforge_project: canard
-rubygems_version: 2.4.3
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
-summary: Adds role based authorisation to Rails by combining RoleModel and CanCan.
+summary: Adds role based authorisation to Rails by combining RoleModel and CanCanCan.
 test_files:
 - test/abilities/administrators.rb
 - test/canard/abilities_test.rb