canard 0.5.0.pre → 0.6.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cc60d17173f92f98f6d45330a03a33fd1f7b1253
-  data.tar.gz: 4381d33e14aa4dde69a7433eb998b09a1fad5528
+SHA256:
+  metadata.gz: dd2cdacae06bfb7da04329a17572eb17173774faba3de5349aabfc004b34990b
+  data.tar.gz: 2b06876131a2befb4fe9dec8831c94ef08caa93269de8060623148040316b6fa
 SHA512:
-  metadata.gz: 476dac97c8a7588373a07f3812c4975b3330b3f815139ba96b530084d6ebd2a85c9e0cdee374bf6de6a961646bc3aa0144989f3aa22038aee6f75c6d7e0a3de5
-  data.tar.gz: 1f3d9f6111da01e36310b343948f5b0f2eddb979810237755653033a06edbf1a7aff3fa229d1fcbf045f4451f8b2e34c6625f9ffbd1c5ed8583a6bce362437ea
+  metadata.gz: 9d7d6198ab5b667c344845a77f75de282a865cfe4a4b2a514051d1c128d837972df46e4be58e6cc6e69ccc5a8f71a8f6e80f3f99da3f5a4b3a9cf688545202d0
+  data.tar.gz: 7974d7b761eab454523ef3c6e56ee0ce4a1387d3c1662257e31c2c011602d9979a7b7f0d403cca568177f20d1c7d9c8ea813aa314a1cee65879422e74da8b854

data/.hound.yml

@@ -0,0 +1,3 @@
+ruby:
+  config_file: .rubocop.yml
+

data/.rubocop.yml

@@ -0,0 +1,27 @@
+inherit_from: .rubocop_todo.yml
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+Style/MutableConstant:
+  Exclude:
+    - 'lib/seedbank/version.rb'
+Lint/ScriptPermission:
+  Exclude:
+    - 'test/dummy/Rakefile'
+Metrics/LineLength:
+  Exclude:
+    - 'test/**/*'
+  Max: 132
+Metrics/BlockLength:
+  Exclude:
+    - 'test/**/*'
+Naming/PredicateName:
+  NameWhitelist:
+    - 'has_roles_mask_accessors?'
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/generators/rspec/ability/ability_generator.rb'
+

data/.rubocop_todo.yml

@@ -0,0 +1,37 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-10-02 18:57:17 +0700 using RuboCop version 0.75.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 4
+Metrics/AbcSize:
+  Max: 24
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 11
+
+# Offense count: 4
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 13
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 12
+
+# Offense count: 1
+Style/ClassVars:
+  Exclude:
+    - 'lib/generators/ability_definition.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: line_count_dependent, lambda, literal
+Style/Lambda:
+  Exclude:
+    - 'lib/canard/adapters/mongoid.rb'

data/.travis.yml

@@ -5,7 +5,7 @@ rvm:
   - 2.2
   - 2.3.3
   - 2.4.0
-  - jruby-9.1.7.0
+  - jruby
 services:
   - mongodb
 

data/Gemfile

@@ -1,4 +1,6 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
 
 # Specify your gem's dependencies in canard.gemspec
 gemspec
@@ -9,16 +11,15 @@ end
 
 # for CRuby, Rubinius, including Windows and RubyInstaller
 group :development, :test do
-
-  gem 'bson', "~> 1.6.4"
+  gem 'bson', '~> 1.6.4'
+  gem 'rubocop'
 
   platform :ruby, :mswin, :mingw do
-    gem "sqlite3"
-    gem "bson_ext", "~> 1.6.4"
+    gem 'bson_ext', '~> 1.6.4'
+    gem 'sqlite3', '~> 1.3.5'
   end
 
   platform :jruby do
     gem 'activerecord-jdbcsqlite3-adapter'
   end
 end
-

data/README.md

@@ -2,10 +2,10 @@ 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
+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.
+top of the model's base abilities.
 A User model with :admin and :manager roles would be defined:
 
     class User < ActiveRecord::Base
@@ -14,32 +14,31 @@ A User model with :admin and :manager roles would be defined:
 
     end
 
-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.
+If a User has both the :manager and :admin roles, Canard looks first for user abilities. Then it will look for other roles in the order that they are defined:
 
     app/abilities/users.rb
     app/abilities/manager.rb
     app/abilities/admin.rb
 
-Therefore each the later abilities only need to build on their predecessors.
+Therefore each of the later abilities can build on its predecessor.
 
 Usage
 =====
-To generate some abilities for the User.
+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
     invoke  rspec
     create    spec/abilities/user_spec.rb
 
-Generates an ability folder in Rails root and an associated spec;
+This action generates an ability folder in Rails root and an associated spec:
 
     app.abilities/
       users.rb
     spec/abilities/
       users_spec.rb
 
-The resulting app/abilities/users.rb will look something like this;
+The resulting app/abilities/users.rb will look something like this:
 
     Canard::Abilities.for(:user) do
 
@@ -49,7 +48,7 @@ The resulting app/abilities/users.rb will look something like this;
 
     end
 
-And it's associated test spec/abilities/users_spec.rb;
+And its associated test spec/abilities/users_spec.rb will look something like this:
 
     require_relative '../spec_helper'
     require "cancan/matchers"
@@ -89,7 +88,7 @@ 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
+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
 
@@ -112,48 +111,52 @@ You can also re-use abilities defined for one role in another. This allows you t
 
     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.
+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.
+Now let's 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
 
-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.
+This generates 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 applying the abilities for each of the current user's roles.
 
 
-If there is no user (i.e. logged out) Canard creates a guest and looks for a guest ability to apply so:
+If there is no user (i.e. logged out), Canard creates a guest and looks for a guest ability to apply:
 
     $ rails g canard:ability guest can:create:user
 
-Would generate an ability for a not logged in user to signup.
+This would generate a signup ability for a user who was not logged in.
 
-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
+Obviously the generators are just a starting point and should be used only to get you going. I strongly
+suggest that you add each new model to the abilities because the specs are easy to write and CanCan
 definitions are very clear and simple.
 
 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;
+The :acts_as_user method will automatically define some named scopes for each role. For the User model
+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_managers:: return all the users without the manager role
+| Scope               | Returns                                 |
+| ------------------- | --------------------------------------- |
+| `User.admins`       | all the users with the admin role       |
+| `User.non_admins`   | all the users without the admin role    |
+| `User.managers`     | all the users with the manager role     |
+| `User.non_managers` | all the users without the manager role  |
 
-In addition to the role specific scopes it also adds some general scopes;
+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
+| Scope                        | Returns                                       |
+| -------------------          | --------------------------------------------- |
+| `User.with_any_role(roles)`  | all the users with any of the specified roles |
+| `User.with_all_roles(roles)` | only the users with all the specified roles   |
 
 Installation
 ============
 
 Rails 3.x, 4.x & 5.x
 --------------------
-Add the canard gem to your Gemfile. In Gemfile:
+Add the canard gem to your Gemfile:
 
     gem "canard"
 
@@ -167,20 +170,20 @@ That's it!
 Rails 2.x
 ---------
 
-Sorry you are out of luck with Rails 2.x Canard has only been written and tested with Rails 3 and above.
+Sorry, you are out of luck. Canard has only been written and tested with Rails 3 and above.
 
-Supported ORM's
+Supported ORMs
 ---------------
 
 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.
+New adapters can easily be added, but you'd need to check to see if CanCan can also support your adapter.
 
 Further reading
 ---------------
 
-Canard stands on the sholders of Ryan Bates' CanCan and Martin Rehfeld's RoleModel. You can read more
+Canard stands on the shoulders 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
-the Ability class for you so you don't need the boilerplate code from Ryan's example;
+the Ability class for you so you don't need the boilerplate code from Ryan's example:
 
     class Ability
       include CanCan::Ability
@@ -195,13 +198,13 @@ the Ability class for you so you don't need the boilerplate code from Ryan's exa
       end
     end
 
-The Canard equivalent for non admins would be;
+The Canard equivalent for non-admins would be:
 
     Canard::Abilities.for(:user) do
       can :read, :all
     end
 
-And for Admins;
+And for admins:
 
     Canard::Abilities.for(:admin) do
       can :manage, :all
@@ -217,8 +220,8 @@ Note on Patches/Pull Request
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it (when I have some). This is important so I don't break it in a future version unintentionally.
-* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but
-  bump version in a commit by itself I can ignore it when I pull)
+* Commit. Do not mess with rakefile, version, or history. (If you want to have your own version, that is fine but
+  bump version in a commit by itself so I can ignore it when I pull.)
 * Send me a pull request.  Bonus points for topic branches.
 
 Contributors

data/Rakefile

@@ -1,4 +1,6 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
 require 'rake'
 require 'rake/testtask'
 
@@ -6,6 +8,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'lib' << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = true
+  t.warning = false
 end
 
-task :default => ["test"]
+task default: ['test']

data/canard.gemspec

@@ -1,5 +1,6 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'canard/version'
 
 Gem::Specification.new do |s|
@@ -9,19 +10,19 @@ Gem::Specification.new do |s|
   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.summary     = 'Adds role based authorisation to Rails by combining RoleModel and CanCanCan.'
+  s.description = 'Wraps CanCanCan and RoleModel up to make role based authorisation really easy in Rails 4+.'
 
-  s.rubyforge_project = "canard"
+  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.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
 
   s.add_development_dependency 'minitest', '~> 2'
-  s.add_development_dependency 'rails', '~> 3.2.3', '>= 3.2.3'
   s.add_development_dependency 'mongoid', '~> 3.0'
+  s.add_development_dependency 'rails', '~> 3.2', '>= 3.2'
 
   s.requirements << "cancan's community supported Rails4+ compatible cancancan fork."
   s.add_runtime_dependency 'cancancan', '~> 1'

data/lib/ability.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Canard provides a CanCan Ability class for you. The Canard Ability class
 # looks for and applies abilities for the object passed when a new Ability
 # instance is initialized.
@@ -24,7 +26,6 @@
 # created and Canard will look for a guests.rb amongst the ability definitions
 # and give the guest those abilities.
 class Ability
-
   include CanCan::Ability
   extend Forwardable
 
@@ -32,12 +33,18 @@ class Ability
 
   def_delegators :Canard, :ability_definitions, :ability_key
 
-  def initialize(object=nil)
-
+  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
 
+    add_base_abilities
+    add_roles_abilities if @user.respond_to?(:roles)
+  end
+
+  protected
+
+  def add_base_abilities
     if @user
       # Add the base user abilities.
       user_class_name = String(@user.class.name)
@@ -47,24 +54,18 @@ class Ability
       @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
 
-  protected
+  def add_roles_abilities
+    @user.roles.each { |role| append_abilities(role) }
+  end
 
   def append_abilities(dirty_key)
     key = ability_key(dirty_key)
-    instance_eval(&ability_definitions[key]) if ability_definitions.has_key?(key)
+    instance_eval(&ability_definitions[key]) if ability_definitions.key?(key)
   end
 
   def includes_abilities_of(*other_roles)
     other_roles.each { |other_role| append_abilities(other_role) }
   end
-
 end

data/lib/canard.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 require 'cancan'
 require 'role_model'
 require 'canard/abilities'
 require 'canard/version'
 require 'canard/user_model'
-require "canard/find_abilities"
-require "ability"
+require 'canard/find_abilities'
+require 'ability'
 
 require 'canard/railtie' if defined?(Rails) && Rails::VERSION::MAJOR >= 3

data/lib/canard/abilities.rb

@@ -1,11 +1,11 @@
-module Canard
-  class Abilities
+# frozen_string_literal: true
 
-    @definitions      = {}
-    @default_path     = 'app/abilities'
+module Canard
+  class Abilities # :nodoc:
+    @definitions  = {}
+    @default_path = 'app/abilities'
 
     class << self
-
       extend Forwardable
 
       def_delegators :Canard, :ability_key
@@ -21,13 +21,11 @@ module Canard
       end
 
       def for(name, &block)
-        raise ArgumentError.new('No block of ability definitions given') unless block_given?
+        raise ArgumentError, 'No block of ability definitions given' unless block_given?
+
         key = ability_key(name)
         @definitions[key] = block
       end
-
     end
-
   end
-
 end