rolify 4.1.1 → 6.0.0

data/Rakefile

@@ -1,6 +1,7 @@
 require 'bundler'
 require 'rspec/core/rake_task'
 require 'coveralls/rake/task'
+require 'appraisal'
 
 Bundler::GemHelper.install_tasks
 
@@ -14,7 +15,11 @@ RSpec::Core::RakeTask.new(:rolify) do |task|
   task.pattern = 'spec/rolify/**/*_spec.rb'
 end
 
-task :default => [ :spec, 'coveralls:push' ]
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["CI"]
+  task :default => :appraisal
+else
+  task :default => [ :spec, 'coveralls:push' ]
+end
 
 desc 'Run all specs'
 task 'spec' do

data/gemfiles/activerecord_4.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.3.6"
+gem "activerecord", "~> 4.2.11", require: "active_record"
+gem "bigdecimal", "1.4.2"
+
+group :test do
+  gem "codeclimate-test-reporter", require: nil
+  gem "coveralls", require: false
+  gem "database_cleaner", "~> 1.6.2"
+  gem "its"
+  gem "test-unit"
+  gem "byebug"
+  gem "pry"
+  gem "pry-byebug"
+end
+
+gemspec path: "../"

data/gemfiles/activerecord_5.gemfile

@@ -0,0 +1,22 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.3.6"
+gem "activerecord", "~> 5.2.4", require: "active_record"
+gem "actionpack", "~> 5.2.4"
+gem "activemodel", "~> 5.2.4"
+gem "railties", "~> 5.2.4"
+
+group :test do
+  gem "codeclimate-test-reporter", require: nil
+  gem "coveralls", require: false
+  gem "database_cleaner", "~> 1.6.2"
+  gem "its"
+  gem "test-unit"
+  gem "byebug"
+  gem "pry"
+  gem "pry-byebug"
+end
+
+gemspec path: "../"

data/gemfiles/activerecord_6.gemfile

@@ -0,0 +1,22 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.4", platform: "ruby"
+gem "activerecord", ">= 6.0.0", require: "active_record"
+gem "actionpack", ">= 6.0.0"
+gem "activemodel", ">= 6.0.0"
+gem "railties", ">= 6.0.0"
+
+group :test do
+  gem "codeclimate-test-reporter", require: nil
+  gem "coveralls", require: false
+  gem "database_cleaner", "~> 1.6.2"
+  gem "its"
+  gem "test-unit"
+  gem "byebug"
+  gem "pry"
+  gem "pry-byebug"
+end
+
+gemspec path: "../"

data/gemfiles/mongoid_5.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mongoid", "~> 5"
+gem "bson_ext", "1.5.1"
+gem "bigdecimal", "1.4.2"
+
+group :test do
+  gem "codeclimate-test-reporter", require: nil
+  gem "coveralls", require: false
+  gem "database_cleaner", "~> 1.6.2"
+  gem "its"
+  gem "test-unit"
+  gem "byebug"
+  gem "pry"
+  gem "pry-byebug"
+end
+
+gemspec path: "../"

data/gemfiles/mongoid_6.gemfile

@@ -0,0 +1,19 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mongoid", "~> 6"
+gem "bson_ext", "1.5.1"
+
+group :test do
+  gem "codeclimate-test-reporter", require: nil
+  gem "coveralls", require: false
+  gem "database_cleaner", "~> 1.6.2"
+  gem "its"
+  gem "test-unit"
+  gem "byebug"
+  gem "pry"
+  gem "pry-byebug"
+end
+
+gemspec path: "../"

data/gemfiles/mongoid_7.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mongoid", "~> 7"
+gem "bson_ext", "1.5.1"
+gem "railties", "5.2.4.1"
+
+group :test do
+  gem "codeclimate-test-reporter", require: nil
+  gem "coveralls", require: false
+  gem "database_cleaner", "~> 1.6.2"
+  gem "its"
+  gem "test-unit"
+  gem "byebug"
+  gem "pry"
+  gem "pry-byebug"
+end
+
+gemspec path: "../"

data/lib/generators/active_record/rolify_generator.rb

@@ -1,5 +1,6 @@
 require 'rails/generators/active_record'
 require 'active_support/core_ext'
+require 'erb'
 
 module ActiveRecord
   module Generators
@@ -8,6 +9,13 @@ module ActiveRecord
 
       argument :user_cname, :type => :string, :default => "User", :banner => "User"
 
+      def ensure_user_class_defined
+        unless user_class_defined?
+          prompt_missing_user
+          abort
+        end
+      end
+
       def generate_model
         invoke "active_record:model", [ name ], :migration => false
       end
@@ -22,15 +30,18 @@ module ActiveRecord
             require "#{ENGINE_ROOT}/app/models/#{user_cname.downcase}.rb"
           end
         end
+
         inject_into_class(model_path, class_name, model_content)
       end
 
       def copy_rolify_migration
-        migration_template "migration.rb", "db/migrate/rolify_create_#{table_name}.rb"
+        migration_template "migration.rb", "db/migrate/rolify_create_#{table_name}.rb", migration_version: migration_version
       end
 
+      private
+
       def join_table
-        user_cname.constantize.table_name + "_" + table_name
+        user_class.table_name + "_" + table_name
       end
 
       def user_reference
@@ -46,18 +57,41 @@ module ActiveRecord
       end
 
       def model_content
-        content = <<RUBY
-  has_and_belongs_to_many :%{user_cname}, :join_table => :%{join_table}
-  belongs_to :resource, :polymorphic => true
+        ERB.new(File.read(File.join(__dir__, 'templates/model.rb'))).result(binding)
+      end
+
+      def user_class
+        user_cname.constantize
+      end
 
-  validates :resource_type,
-            :inclusion => { :in => Rolify.resource_types },
-            :allow_nil => true
+      def user_class_defined?
+        user_class
+        true
+      rescue NameError => ex
+        if ex.missing_name == user_cname
+          false
+        else
+          raise ex
+        end
+      end
+
+      def prompt_missing_user
+        puts <<MSG
+Rolify expected a model named #{user_cname} to be defined but could not find one.
+Please ensure that this model exists and is not mis-spelled and re-run the generator.
+MSG
+      end
 
-  scopify
-RUBY
-        content % { :user_cname => user_cname.constantize.table_name, :join_table => "#{user_cname.constantize.table_name}_#{table_name}"}
+      def versioned_migrations?
+        Rails::VERSION::MAJOR >= 5
       end
+
+      def migration_version
+        if versioned_migrations?
+          "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        end
+      end
+
     end
   end
 end

data/lib/generators/active_record/templates/migration.rb

@@ -1,4 +1,4 @@
-class RolifyCreate<%= table_name.camelize %> < ActiveRecord::Migration
+class RolifyCreate<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table(:<%= table_name %>) do |t|
       t.string :name
@@ -11,8 +11,7 @@ class RolifyCreate<%= table_name.camelize %> < ActiveRecord::Migration
       t.references :<%= user_reference %>
       t.references :<%= role_reference %>
     end
-
-    add_index(:<%= table_name %>, :name)
+    <% if ActiveRecord::Base.connection.class.to_s.demodulize != 'PostgreSQLAdapter' %><%= "\n    " %>add_index(:<%= table_name %>, :name)<% end %>
     add_index(:<%= table_name %>, [ :name, :resource_type, :resource_id ])
     add_index(:<%= join_table %>, [ :<%= user_reference %>_id, :<%= role_reference %>_id ])
   end

data/lib/generators/active_record/templates/model.rb

@@ -0,0 +1,15 @@
+  has_and_belongs_to_many :<%= user_class.table_name %>, :join_table => :<%= join_table %>
+  <% if Rails::VERSION::MAJOR < 5 %>
+  belongs_to :resource,
+             :polymorphic => true
+  <% else %>
+  belongs_to :resource,
+             :polymorphic => true,
+             :optional => true
+  <% end %>
+
+  validates :resource_type,
+            :inclusion => { :in => Rolify.resource_types },
+            :allow_nil => true
+
+  scopify

data/lib/generators/rolify/templates/initializer.rb

@@ -4,4 +4,7 @@ Rolify.configure<%= "(\"#{class_name.camelize.to_s}\")" if class_name != "Role"
 
   # Dynamic shortcuts for User class (user.is_admin? like methods). Default is: false
   # config.use_dynamic_shortcuts
-end
+  
+  # Configuration to remove roles from database once the last resource is removed. Default is: true
+  # config.remove_role_if_empty = false
+end

data/lib/rolify.rb

@@ -25,12 +25,11 @@ module Rolify
 
     rolify_options = { :class_name => options[:role_cname].camelize }
     rolify_options.merge!({ :join_table => self.role_join_table_name }) if Rolify.orm == "active_record"
-    rolify_options.merge!(options.reject{ |k,v| ![ :before_add, :after_add, :before_remove, :after_remove ].include? k.to_sym })
+    rolify_options.merge!(options.reject{ |k,v| ![ :before_add, :after_add, :before_remove, :after_remove, :inverse_of ].include? k.to_sym })
 
-    has_and_belongs_to_many :roles, rolify_options
+    has_and_belongs_to_many :roles, **rolify_options
 
     self.adapter = Rolify::Adapter::Base.create("role_adapter", self.role_cname, self.name)
-    load_dynamic_methods if Rolify.dynamic_shortcuts
 
     #use strict roles
     self.strict_rolify = true if options[:strict]
@@ -49,7 +48,7 @@ module Rolify
     self.role_cname = options[:role_cname]
     self.role_table_name = self.role_cname.tableize.gsub(/\//, "_")
 
-    has_many association_name, resourcify_options
+    has_many association_name, **resourcify_options
 
     self.resource_adapter = Rolify::Adapter::Base.create("resource_adapter", self.role_cname, self.name)
     @@resource_types << self.name

data/lib/rolify/adapters/active_record/resource_adapter.rb

@@ -17,16 +17,17 @@ module Rolify
           str << ', ' unless klass == klasses.last
           str
         end
-        resources = relation.joins("INNER JOIN #{quote(roles_table)} ON #{quote(roles_table)}.resource_type IN (#{relations}) AND
-                                    (#{quote(roles_table)}.resource_id IS NULL OR #{quote(roles_table)}.resource_id = #{quote(relation.table_name)}.#{relation.primary_key})")
-        resources = resources.where("#{quote(roles_table)}.name IN (?) AND #{quote(roles_table)}.resource_type IN (?)", Array(role_name), klasses)
-        resources = resources.select("#{quote(relation.table_name)}.*")
+
+        resources = relation.joins("INNER JOIN #{quote_table(roles_table)} ON #{quote_table(roles_table)}.resource_type IN (#{relations}) AND
+                                    (#{quote_table(roles_table)}.resource_id IS NULL OR #{quote_table(roles_table)}.resource_id = #{quote_table(relation.table_name)}.#{quote_column(relation.primary_key)})")
+        resources = resources.where("#{quote_table(roles_table)}.name IN (?) AND #{quote_table(roles_table)}.resource_type IN (?)", Array(role_name), klasses)
+        resources = resources.select("#{quote_table(relation.table_name)}.*")
         resources
       end
 
       def in(relation, user, role_names)
-        roles = user.roles.where(:name => role_names).select("#{quote(role_class.table_name)}.#{role_class.primary_key}")
-        relation.where("#{quote(role_class.table_name)}.#{role_class.primary_key} IN (?) AND ((resource_id = #{quote(relation.table_name)}.#{relation.primary_key}) OR (resource_id IS NULL))", roles)
+        roles = user.roles.where(:name => role_names).select("#{quote_table(role_class.table_name)}.#{quote_column(role_class.primary_key)}")
+        relation.where("#{quote_table(role_class.table_name)}.#{quote_column(role_class.primary_key)} IN (?) AND ((#{quote_table(role_class.table_name)}.resource_id = #{quote_table(relation.table_name)}.#{quote_column(relation.primary_key)}) OR (#{quote_table(role_class.table_name)}.resource_id IS NULL))", roles)
       end
 
       def applied_roles(relation, children)
@@ -39,14 +40,19 @@ module Rolify
 
       def all_except(resource, excluded_obj)
         prime_key = resource.primary_key.to_sym
-        resource.where(prime_key => (resource.all - excluded_obj).map(&prime_key))
+        resource.where.not(prime_key => excluded_obj.pluck(prime_key))
       end
 
       private
 
-      def quote(column)
+      def quote_column(column)
         ActiveRecord::Base.connection.quote_column_name column
       end
+
+      def quote_table(table)
+        ActiveRecord::Base.connection.quote_table_name table
+      end
+
     end
   end
 end

data/lib/rolify/adapters/active_record/role_adapter.rb

@@ -9,13 +9,42 @@ module Rolify
       end
 
       def where_strict(relation, args)
-        resource = if args[:resource].is_a?(Class)
-                     {class: args[:resource].to_s, id: nil}
-                   else
-                     {class: args[:resource].class.name, id: args[:resource].id}
-                   end
+        wrap_conditions = relation.name != role_class.name
 
-        relation.where(:name => args[:name], :resource_type => resource[:class], :resource_id => resource[:id])
+        conditions = if args[:resource].is_a?(Class)
+                       {:resource_type => args[:resource].to_s, :resource_id => nil }
+                     elsif args[:resource].present?
+                       {:resource_type => args[:resource].class.name, :resource_id => args[:resource].id}
+                     else
+                       {}
+                     end
+
+        conditions.merge!(:name => args[:name])
+        conditions = wrap_conditions ? { role_table => conditions } : conditions
+
+        relation.where(conditions)
+      end
+
+      def find_cached(relation, args)
+        resource_id = (args[:resource].nil? || args[:resource].is_a?(Class) || args[:resource] == :any) ? nil : args[:resource].id
+        resource_type = args[:resource].is_a?(Class) ? args[:resource].to_s : args[:resource].class.name
+
+        return relation.find_all { |role| role.name == args[:name].to_s } if args[:resource] == :any
+
+        relation.find_all do |role|
+          (role.name == args[:name].to_s && role.resource_type == nil && role.resource_id == nil) ||
+          (role.name == args[:name].to_s && role.resource_type == resource_type && role.resource_id == nil) ||
+          (role.name == args[:name].to_s && role.resource_type == resource_type && role.resource_id == resource_id)
+        end
+      end
+
+      def find_cached_strict(relation, args)
+        resource_id = (args[:resource].nil? || args[:resource].is_a?(Class)) ? nil : args[:resource].id
+        resource_type = args[:resource].is_a?(Class) ? args[:resource].to_s : args[:resource].class.name
+
+        relation.find_all do |role|
+          role.resource_id == resource_id && role.resource_type == resource_type && role.name == args[:name].to_s
+        end
       end
 
       def find_or_create_by(role_name, resource_type = nil, resource_id = nil)
@@ -23,7 +52,7 @@ module Rolify
       end
 
       def add(relation, role)
-        relation.role_ids |= [role.id]
+        relation.roles << role unless relation.roles.include?(role)
       end
 
       def remove(relation, role_name, resource = nil)
@@ -44,20 +73,14 @@ module Rolify
         relation.where("#{column} IS NOT NULL")
       end
 
-      def scope(relation, conditions)
-        if Rails.version < "4.0"
-          query = relation.scoped
-        else
-          query = relation.all
-        end
-        query = query.joins(:roles)
-        query = where(query, conditions)
+      def scope(relation, conditions, strict)
+        query = relation.joins(:roles)
+        query = strict ? where_strict(query, conditions) : where(query, conditions)
         query
       end
 
       def all_except(user, excluded_obj)
-        prime_key = user.primary_key.to_sym
-        user.where(prime_key => (user.all - excluded_obj).map(&prime_key))
+        user.where.not(user.primary_key => excluded_obj)
       end
 
       private

data/lib/rolify/adapters/mongoid/role_adapter.rb

@@ -9,13 +9,42 @@ module Rolify
       end
 
       def where_strict(relation, args)
-        resource = if args[:resource].is_a?(Class)
-                     {class: args[:resource].to_s, id: nil}
-                   else
-                     {class: args[:resource].class.name, id: args[:resource].id}
-                   end
+        wrap_conditions = relation.name != role_class.name
 
-          relation.where(:name => args[:name], :resource_type => resource[:class], :resource_id => resource[:id])
+        conditions = if args[:resource].is_a?(Class)
+                       {:resource_type => args[:resource].to_s, :resource_id => nil }
+                     elsif args[:resource].present?
+                       {:resource_type => args[:resource].class.name, :resource_id => args[:resource].id}
+                     else
+                       {}
+                     end
+
+        conditions.merge!(:name => args[:name])
+        conditions = wrap_conditions ? { role_table => conditions } : conditions
+
+        relation.where(conditions)
+      end
+
+      def find_cached(relation, args)
+        resource_id = (args[:resource].nil? || args[:resource].is_a?(Class) || args[:resource] == :any) ? nil : args[:resource].id
+        resource_type = args[:resource].is_a?(Class) ? args[:resource].to_s : args[:resource].class.name
+
+        return relation.find_all { |role| role.name == args[:name].to_s } if args[:resource] == :any
+
+        relation.find_all do |role|
+          (role.name == args[:name].to_s && role.resource_type == nil && role.resource_id == nil) ||
+          (role.name == args[:name].to_s && role.resource_type == resource_type && role.resource_id == nil) ||
+          (role.name == args[:name].to_s && role.resource_type == resource_type && role.resource_id == resource_id)
+        end
+      end
+
+      def find_cached_strict(relation, args)
+        resource_id = (args[:resource].nil? || args[:resource].is_a?(Class)) ? nil : args[:resource].id
+        resource_type = args[:resource].is_a?(Class) ? args[:resource].to_s : args[:resource].class.name
+
+        relation.find_all do |role|
+          role.resource_id == resource_id && role.resource_type == resource_type && role.name == args[:name].to_s
+        end
       end
 
       def find_or_create_by(role_name, resource_type = nil, resource_id = nil)
@@ -61,8 +90,9 @@ module Rolify
         relation.where(column.to_sym.ne => nil)
       end
 
-      def scope(relation, conditions)
-        roles = where(role_class, conditions).map { |role| role.id }
+      def scope(relation, conditions, strict)
+        query = strict ? where_strict(role_class, conditions) : where(role_class, conditions)
+        roles = query.map { |role| role.id }
         return [] if roles.size.zero?
         query = relation.any_in(:role_ids => roles)
         query