rolify 4.1.1 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1e51b0a50895b89514d5f41266e0eb5373d47158
-  data.tar.gz: d99233b97fd7e18a79b0958ef9d359d8266b58b3
+SHA256:
+  metadata.gz: 39183b0e66a9dfdbe636059ec28145106f14347129676c334598ff4f330edfc0
+  data.tar.gz: 686c5b98efcc79e84b104cca586053b920032cbc0bf7978baa0b1caa04e021bb
 SHA512:
-  metadata.gz: 0846e497eac805c2bcbd8227ae96efe949e337c4872f9b6295c1df4c32df2699702ebcd957f516204d7c28948aca8557391b2b17da9d9db4da1079d130d8f144
-  data.tar.gz: 5ca314c4b2c63b9897f60e948c28310dcd9ebb5623614831fb1b5368a290090987829e31bc388d297a7665ee753cd2dd6e045c2c28d6eda4910f902ab79e7740
+  metadata.gz: a24f0ef337c8c5d1b9381e30020ba18c790193f4b00085cbd2581f25d6322d5ffeee099a22a43b4b4c86de66a2774364f799426ae71ed331027d5e565a06be72
+  data.tar.gz: b1d55761a7a5df75a9c1f462ca04232c44e81adcc180ece7232386f0c6f4dff0441cc463e674075c5906fc3c3ddcc71922dd20cf2129eecff099fa604db56b94

data/.github/workflows/activerecord.yml

@@ -0,0 +1,27 @@
+name: activerecord
+on: [push]
+jobs:
+  ubuntu:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    strategy:
+      matrix:
+        gemfile: [activerecord_4, activerecord_5, activerecord_6]
+        ruby: [2.5.7, 2.6.5, 2.7.2]
+    env:
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+      ADAPTER: active_record
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: sudo apt-get install -y libsqlite3-dev
+      - run: gem update --system
+      - run: gem install bundler
+      - run: gem --version
+      - run: bundle install
+      - name: Run Tests
+        run: |
+          bundle exec rake

data/.github/workflows/mongoid.yml

@@ -0,0 +1,32 @@
+name: mongoid
+on: [push]
+jobs:
+  ubuntu:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    services:
+      mongodb:
+        image: mongo:3.4.23
+        ports:
+          - 27017:27017
+    strategy:
+      matrix:
+        gemfile: [mongoid_5]
+        ruby: [2.5.7, 2.6.5, 2.7.2]
+    env:
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+      ADAPTER: mongoid
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: sudo apt-get install -y libsqlite3-dev
+      - run: gem update --system
+      - run: gem install bundler
+      - run: gem --version
+      - run: bundle install
+      - name: Run Tests
+        run: |
+          bundle exec rake

data/.hakiri.yml

@@ -0,0 +1 @@
+dependency_source: gemspec_file

data/Appraisals

@@ -0,0 +1,42 @@
+appraise 'mongoid-5' do
+  gem "mongoid", "~> 5"
+  gem "bson_ext", "1.5.1"
+  gem 'bigdecimal', '1.4.2'
+end
+
+appraise 'mongoid-6' do
+  gem "mongoid", "~> 6"
+  gem "bson_ext", "1.5.1"
+end
+
+appraise 'mongoid-7' do
+  gem "mongoid", "~> 7"
+  gem "bson_ext", "1.5.1"
+  gem "railties", "5.2.4.1"
+end
+
+appraise 'activerecord-4' do
+  gem "sqlite3", "~> 1.3.6"
+  gem "activerecord", "~> 4.2.11", :require => "active_record"
+  gem 'bigdecimal', '1.4.2'
+end
+
+appraise 'activerecord-5' do
+  gem "sqlite3", "~> 1.3.6"
+  gem "activerecord", "~> 5.2.4", :require => "active_record"
+
+  # Ammeter dependencies:
+  gem "actionpack", "~> 5.2.4"
+  gem "activemodel", "~> 5.2.4"
+  gem "railties", "~> 5.2.4"
+end
+
+appraise 'activerecord-6' do
+  gem "sqlite3", "~> 1.4", :platform => "ruby"
+  gem "activerecord", ">= 6.0.0", :require => "active_record"
+
+  # Ammeter dependencies:
+  gem "actionpack", ">= 6.0.0"
+  gem "activemodel", ">= 6.0.0"
+  gem "railties", ">= 6.0.0"
+end

data/CHANGELOG.rdoc

@@ -1,3 +1,47 @@
+= 6.0.0 (April 2, 2021)
+
+Breaking changes:
+
+* Support strict <tt>with_role</tt> queries. Note this changes behaviour of with_role when running in strict mode to behave as previously documented. #543 describes the behaviour change.
+* Dropped support for Ruby 2.3 and 2.4
+
+Improvements:
+
+* Updated ActiveRecord adapters implementation of <tt>in</tt> to utilise a subquery instead of two queries
+
+= 5.3.0 (June 1, 2020)
+
+5.3.0 will be the last version to support Ruby < 2.5 and Rails < 5.2. Support for these will be dropped in the next major release.
+
+* Fix deprecation warning in Ruby 2.7
+* Add Rails 6 support to migration generator
+* Significant ActiveRecord performance improvements to <tt>add_role</tt> and <tt>without_role</tt>
+* Mongoid fix and performance improvement and to <tt>roles_name</tt>
+* Make it safe to call <tt>Thing.with_role(:admin, user)</tt> with new record
+
+= 5.2.0 (Dec 14, 2017)
+* Fix regression in generator around belongs_to options compatibility
+* Update version of database_cleaner
+* Update initializer.rb to include the remove_role_if_empty option and description
+* Allow inverse_of option on rolify method
+* Fix the code-climate-reporter issue that's causing travis to fail
+* Remove a separate index for the name column
+* Fix migration generator for AR 5.x
+* Fixed ambiguous column error
+
+= 5.1.0 (Mar 19, 2016)
+* Rails 5 Support (thanks @lorefnon)
+* Fix user handling in generator (thanks @lorefnon)
+* Fix quoting issues (thanks @lorefnon)
+* Improvements to dynamic module loading (thanks to @DmitryKK)
+
+= 5.0.0 (Nov 17, 2015)
+* Fix migration warning showing when it shouldn't
+* Add role lazy-loading
+* Add has_cached_role and has_cached_strict_role to project.
+  See: https://github.com/RolifyCommunity/rolify#cached-roles-to-avoid-n1-issue
+* Update specs to pass with all Mongoid version.
+
 = 4.1.1 (Aug 06, 2015)
 * Fix a regression in the dynamic method loader.
 
@@ -103,7 +147,7 @@
 * fixed a backward incompatible change introduced in Rails 3.2 release (<tt>find_or_create_by_* generated methods</tt>)
 
 = 2.2 (Jan 18, 2012)
-* fixed a bug in the initializer file regarding dynamic shortcuts 
+* fixed a bug in the initializer file regarding dynamic shortcuts
 
 = 2.1 (Nov 30, 2011)
 * added syntactic sugar: <tt>grant</tt> and <tt>revoke</tt> are aliases for <tt>has_role</tt> and <tt>has_no_role</tt>
@@ -144,8 +188,8 @@
 
 = 1.0 (Aug 25, 2011)
 * added a new parameter to disable dynamic shortcut methods due to potential incompatibility with other gems using method_missing with the same pattern
-  * add <tt>Rolify.dynamic_shortcuts = false</tt> in the initializer file or 
-  * use the generator command with a third parameter: 
+  * add <tt>Rolify.dynamic_shortcuts = false</tt> in the initializer file or
+  * use the generator command with a third parameter:
     * <tt>rails g rolify:role Role User false</tt>
 * removed the railtie as it created more problems than it solved
 * code refactoring to do some speed improvements and code clean up
@@ -154,16 +198,16 @@
 * rolify is now on travis-ci to monitor build status
 
 = 0.7 (June 20, 2011)
-* added a method_missing to catch newly created role outside the current ruby process (i.e. dynamic shortcut methods are not defined within this process) 
-  * dynamic shortcut is created on the fly in the method_missing to avoid extra method_missing for the same dynamic shortcut 
-  * check if the role actually exists in the database before defining the new method 
+* added a method_missing to catch newly created role outside the current ruby process (i.e. dynamic shortcut methods are not defined within this process)
+  * dynamic shortcut is created on the fly in the method_missing to avoid extra method_missing for the same dynamic shortcut
+  * check if the role actually exists in the database before defining the new method
   * first call is slower due to method_missing but next calls are fast
   * avoid strange bugs when spawning many ruby processes as the dynamic shortcut methods were only defined in the process that used the <tt>has_role</tt> command
 
 = 0.6 (June 19, 2011)
 * custom User and Role class names support
   * can now use other class names for Role and User classes
-  * fixed generators and templates 
+  * fixed generators and templates
   * join table is explicitly set to avoid alphabetical order issue
 * created a new railtie to load the dynamic shortcuts at startup
 
@@ -185,7 +229,7 @@
   * Trying to remove a role scoped to a resource whereas the user has a global role won't remove it
 
 = v0.3 (June 06, 2011)
-* multiple roles check: 
+* multiple roles check:
   * <tt>has_all_roles?</tt> returns true if the user has ALL the roles in arguments
   * <tt>has_any_role?</tt> returns true if the user has ANY the roles in arguments
 

data/CONTRIBUTORS

@@ -4,3 +4,14 @@ Joel Azemar (@joel)
 Alex Klim (@AlexKlim)
 Mauro George (@MauroGeorge)
 Cheri Allen(@cherimarie)
+Gaurab Paul (@lorefnon)
+Dmitry Krakosevich (@DmitryKK)
+Michael Watts (@mikwat)
+Derek Ethier (@ethier)
+Michael (@mibamur)
+Undo1 (@Undo1)
+Hitabis Engineering (@Hitabis)
+Sergey Alekseev (@sergey-alekseev)
+Sankalp Kulshreshtha (@sankalpk)
+Kirill Sevastyanenko (@kirillseva)
+Denis Shevchenko (@SimplySorc)

data/Gemfile

@@ -1,23 +1,15 @@
 source "https://rubygems.org"
 
 group :test do
-  case ENV["ADAPTER"]
-  when nil, "active_record"
-    gem "activerecord-jdbcsqlite3-adapter", ">= 1.3.0.rc", :platform => "jruby"
-    gem "sqlite3", :platform => "ruby"
-    gem "activerecord", ">= 3.2.0", :require => "active_record"
-  when "mongoid"
-    gem "mongoid", ">= 3.1"
-    gem "bson_ext", :platform => "ruby"
-  else
-    raise "Unknown model adapter: #{ENV["ADAPTER"]}"
-  end
-
-  gem 'coveralls', :require => false
+  gem 'codeclimate-test-reporter', require: nil
+  gem 'coveralls', require: false
+  gem 'database_cleaner', '~> 1.6.2'
   gem 'its'
+  gem 'test-unit' # Implicitly loaded by ammeter
+
   gem 'byebug'
+  gem 'pry'
   gem 'pry-byebug'
-  gem 'codeclimate-test-reporter', :require => nil
 end
 
 gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Florent Monbillard
+Copyright (c) 2017 Florent Monbillard
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,28 +1,28 @@
-# rolify [![Gem Version](https://badge.fury.io/rb/rolify.svg)](http://badge.fury.io/rb/rolify) [![build status](https://secure.travis-ci.org/RolifyCommunity/rolify.png)](http://travis-ci.org/RolifyCommunity/rolify) [![Dependency Status](https://gemnasium.com/RolifyCommunity/rolify.svg)](https://gemnasium.com/RolifyCommunity/rolify) [![Code Climate](https://codeclimate.com/github/RolifyCommunity/rolify.png)](https://codeclimate.com/github/RolifyCommunity/rolify) [![Coverage Status](https://img.shields.io/coveralls/RolifyCommunity/rolify.svg)](https://coveralls.io/r/RolifyCommunity/rolify?branch=master)
+# rolify [![Gem Version](https://badge.fury.io/rb/rolify.svg)](http://badge.fury.io/rb/rolify) [![build status](https://travis-ci.org/RolifyCommunity/rolify.svg)](http://travis-ci.org/RolifyCommunity/rolify) [![Code Climate](https://codeclimate.com/github/RolifyCommunity/rolify.svg)](https://codeclimate.com/github/RolifyCommunity/rolify) [![Coverage Status](https://coveralls.io/repos/RolifyCommunity/rolify/badge.svg?branch=master&service=github)](https://coveralls.io/github/RolifyCommunity/rolify?branch=master)
 
 Very simple Roles library without any authorization enforcement supporting scope on resource object.
 
 Let's see an example:
 
 ```ruby
-user.has_role?(:moderator, Forum.first)
+user.has_role?(:moderator, @forum)
 => false # if user is moderator of another Forum
 ```
 
-This library can be easily integrated with any authentication gem ([devise](https://github.com/plataformatec/devise), [Authlogic](https://github.com/binarylogic/authlogic), [Clearance](https://github.com/thoughtbot/clearance)) and authorization gem<span style="color: red"><strong>*</strong></span> ([CanCanCan](https://github.com/CanCanCommunity/cancancan), [authority](https://github.com/nathanl/authority))
+This library can be easily integrated with any authentication gem ([devise](https://github.com/plataformatec/devise), [Authlogic](https://github.com/binarylogic/authlogic), [Clearance](https://github.com/thoughtbot/clearance)) and authorization gem<span style="color: red"><strong>*</strong></span> ([CanCanCan](https://github.com/CanCanCommunity/cancancan), [authority](https://github.com/nathanl/authority), [Pundit](https://github.com/elabs/pundit))
 
 <span style="color: red"><strong>*</strong></span>: authorization gem that doesn't provide a role class
 
 ## Requirements
 
-* Rails >= 3.2
-* ActiveRecord >= 3.2 <b>or</b> Mongoid >= 3.1
-* supports ruby 2.0/1.9.3, JRuby 1.6.0+ (in 1.9 mode) and Rubinius 2.0.0dev (in 1.9 mode)
+* Rails >= 4.2
+* ActiveRecord >= 4.2 <b>or</b> Mongoid >= 4.0
+* supports ruby 2.2+, JRuby 1.6.0+ (in 1.9 mode) and Rubinius 2.0.0dev (in 1.9 mode)
 * support of ruby 1.8 has been dropped due to Mongoid >=3.0 that only supports 1.9 new hash syntax
 
 ## Installation
 
-Add this to your Gemfile and run the +bundle+ command.
+Add this to your Gemfile and run the `bundle` command.
 
 ```ruby
 gem "rolify"
@@ -32,7 +32,9 @@ gem "rolify"
 
 ### 1. Generate Role Model
 
-First, create your Role model and migration file using this generator:
+First, use the generator to setup Rolify. Role and User class are the default names. However, you can specify any class name you want. For the User class name, you would probably use the one provided by your authentication solution.
+
+If you want to use Mongoid instead of ActiveRecord, just add `--orm=mongoid` argument, and skip to step #3.
 
 ```
 rails g rolify Role User
@@ -44,14 +46,11 @@ rails g rolify Role User
 rails g rolify:role Role User
 ```
 
-Role and User classes are the default. You can specify any Role class name you want. This is completly a new file so any name can do the job.
-For the User class name, you would probably use the one provided by your authentication solution. rolify just adds some class methods in an existing User class.
-
-If you want to use Mongoid instead of ActiveRecord, just add `--orm=mongoid` argument, and skip to step #3
+The generator will create your Role model, add a migration file, and update your User class with new class methods.
 
 ### 2. Run the migration (only required when using ActiveRecord)
 
-Let's migrate !
+Let's migrate!
 
 ```
 rake db:migrate
@@ -80,6 +79,8 @@ The `rolify` method accepts the following callback options:
 
 Mongoid callbacks are also supported and works the same way.
 
+The `rolify` method also accepts the `inverse_of` option if you need to disambiguate the relationship.
+
 ### 3.2 Configure your resource models
 
 In the resource models you want to apply roles on, just add ``resourcify`` method.
@@ -91,6 +92,18 @@ class Forum < ActiveRecord::Base
 end
 ```
 
+### 3.3 Assign default role
+
+```ruby
+class User < ActiveRecord::Base
+  after_create :assign_default_role
+
+  def assign_default_role
+    self.add_role(:newuser) if self.roles.blank?
+  end
+end
+```
+
 ### 4. Add a role to a user
 
 To define a global role:
@@ -100,21 +113,27 @@ user = User.find(1)
 user.add_role :admin
 ```
 
-To define a role scoped to a resource instance
+To define a role scoped to a resource instance:
 
 ```ruby
 user = User.find(2)
 user.add_role :moderator, Forum.first
 ```
 
-To define a role scoped to a resource class
+To define a role scoped to a resource class:
 
 ```ruby
 user = User.find(3)
 user.add_role :moderator, Forum
 ```
 
-That's it !
+Remove role:
+```ruby
+user = User.find(3)
+user.remove_role :moderator
+```
+
+That's it!
 
 ### 5. Role queries
 
@@ -162,6 +181,17 @@ user.has_role? :moderator, Forum.last
 => true
 ```
 
+To check if a user has the exact role scoped to a resource class:
+
+```ruby
+user = User.find(5)
+user.add_role :moderator # sets a global role
+user.has_role? :moderator, Forum.first
+=> true
+user.has_strict_role? :moderator, Forum.last
+=> false
+```
+
 ### 6. Resource roles querying
 
 Starting from rolify 3.0, you can search roles on instance level or class level resources.
@@ -171,36 +201,38 @@ Starting from rolify 3.0, you can search roles on instance level or class level
 ```ruby
 forum = Forum.first
 forum.roles
-# => [ list of roles that are only binded to forum instance ]
+# => [ list of roles that are only bound to forum instance ]
 forum.applied_roles
-# => [ list of roles binded to forum instance and to the Forum class ]
+# => [ list of roles bound to forum instance and to the Forum class ]
 ```
 
 #### Class level
 
 ```ruby
 Forum.with_role(:admin)
-# => [ list of Forum instances that has role "admin" binded to it ]
+# => [ list of Forum instances that have role "admin" bound to them ]
+Forum.without_role(:admin)
+# => [ list of Forum instances that do NOT have role "admin" bound to them ]
 Forum.with_role(:admin, current_user)
-# => [ list of Forum instances that has role "admin" binded to it and belongs to current_user roles ]
+# => [ list of Forum instances that have role "admin" bound to them and belong to current_user roles ]
 Forum.with_roles([:admin, :user], current_user)
-# => [ list of Forum instances that has role "admin" or "user" binded to it and belongs to current_user roles ]
+# => [ list of Forum instances that have role "admin" or "user" bound to them and belong to current_user roles ]
 
 User.with_any_role(:user, :admin)
-# => [ list of User instances that has role "admin" or "user" binded to it ]
+# => [ list of User instances that have role "admin" or "user" bound to them ]
 User.with_role(:site_admin, current_site)
 # => [ list of User instances that have a scoped role of "site_admin" to a site instance ]
 User.with_role(:site_admin, :any)
 # => [ list of User instances that have a scoped role of "site_admin" for any site instances ]
 User.with_all_roles(:site_admin, :admin)
-# => [ list of User instances that have a role of "site_admin" and a role of "admin" binded to it ]
+# => [ list of User instances that have a role of "site_admin" and a role of "admin" bound to it ]
 
 Forum.find_roles
-# => [ list of roles that binded to any Forum instance or to the Forum class ]
+# => [ list of roles that are bound to any Forum instance or to the Forum class ]
 Forum.find_roles(:admin)
-# => [ list of roles that binded to any Forum instance or to the Forum class with "admin" as a role name ]
+# => [ list of roles that are bound to any Forum instance or to the Forum class, with "admin" as a role name ]
 Forum.find_roles(:admin, current_user)
-# => [ list of roles that binded to any Forum instance or to the Forum class with "admin" as a role name and belongs to current_user roles ]
+# => [ list of roles that are bound to any Forum instance, or to the Forum class with "admin" as a role name, and belongs to current_user ]
 ```
 
 ### Strict Mode
@@ -221,6 +253,20 @@ end
 ```
 I.e. you get true only on a role that you manually add.
 
+### Cached Roles (to avoid N+1 issue)
+
+```ruby
+@user.add_role :admin, Forum
+@user.add_role :member, Forum
+
+users = User.with_role(:admin, Forum).preload(:roles)
+users.each do |user|
+  user.has_cached_role?(:member, Forum) # no extra queries
+end
+```
+
+This method should be used with caution. If you don't preload the roles, the `has_cached_role?` might return `false`. In the above example, it would return `false` for `@user.has_cached_role?(:member, Forum)`, because `User.with_role(:admin, Forum)` will load only the `:admin` roles.
+
 ## Resources
 
 * [Wiki](https://github.com/RolifyCommunity/rolify/wiki)