bullet_train-roles 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f03a796a2c17954ad4c25e313caea68ba0b60b7e8901e7c1acf83d869e100592
-  data.tar.gz: 131e6518cefb00c6ea280d4ac4bf492961cb6f45b6d0ef3d695b66de9366d906
+  metadata.gz: 51bbbee558714e45bdff2dadf3735cf8a2fce88d7e7e3a8144880c245bb8e384
+  data.tar.gz: 419402bc1f7560bc932c202275091456e4a68ddd271ddf7382df57b7f4b21b1f
 SHA512:
-  metadata.gz: 7df53d71fb2d393e84a30a5efb1fa9f351781653b40e1cc31e5cf565d4432228b3a78b6924d021908c5d463695dfdeb0dff834a0f1c63a26438774e8159f4438
-  data.tar.gz: 56a0c8b76f5105959d828db3f619c863cc917fd3caf1e8dc838151268da68da1bce455ebd3378f68dfa7bf78d804d673df311f6351cfd0a47a2b4f43a6c68c07
+  metadata.gz: 30bfee959c7c45e7dda23c7d4f71fa44a1efc9499e3bd5244e48e55895ff88e21fc26ade42def3591661c0aef1796762edae9a05625b1145822c5eb3a71cfc43
+  data.tar.gz: 6da43045a530531c8910f4c456f7c5b7211ac90f9cce69d05fc7a7456fedb664d099a951d0c5fdd131f4daa8f0784ac36add7837bfcc7760ff5193c22191c21c

data/lib/bullet_train/roles/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Roles
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/models/role.rb

@@ -21,17 +21,12 @@ class Role < ActiveYaml::Base
 
   def self.includes(role_or_key)
     role_key = role_or_key.is_a?(Role) ? role_or_key.key : role_or_key
-
     role = Role.find_by_key(role_key)
-
     return Role.all.select(&:assignable?) if role.default?
-
     result = []
-
     all.each do |role|
       result << role if role.includes.include?(role_key)
     end
-
     result
   end
 
@@ -49,6 +44,10 @@ class Role < ActiveYaml::Base
     key
   end
 
+  def to_s
+    key
+  end
+
   def included_by
     Role.includes(self)
   end
@@ -69,20 +68,15 @@ class Role < ActiveYaml::Base
 
   def included_roles
     default_roles = []
-
     default_roles << Role.default unless default?
-
     (default_roles + includes.map { |included_key| Role.find_by_key(included_key) }).uniq.compact
   end
 
   def manageable_by?(role_or_roles)
     return true if default?
-
     roles = role_or_roles.is_a?(Array) ? role_or_roles : [role_or_roles]
-
     roles.each do |role|
       return true if role.manageable_roles.include?(key)
-
       role.included_roles.each do |included_role|
         return true if manageable_by?([included_role])
       end
@@ -151,42 +145,38 @@ class Role < ActiveYaml::Base
 
     def actions
       return @actions if @actions
-
       actions = (@ability_data["actions"] if @ability_data.is_a?(Hash)) || @ability_data
-
       actions = [actions] unless actions.is_a?(Array)
-
       @actions = actions.map!(&:to_sym)
     end
 
     def possible_parent_associations
       ary = @parent.to_s.split("::").map(&:underscore)
-
       possibilities = []
       current = nil
-
       until ary.empty?
         current = "#{ary.pop}#{"_" unless current.nil?}#{current}"
         possibilities << current
       end
-
       possibilities.map(&:to_sym)
     end
 
     def condition
       return @condition if @condition
-
       return nil unless @parent_ids
-
       if @model == @parent
         return @condition = {id: @parent_ids}
       end
-
-      parent_association = possible_parent_associations.find { |association| @model.method_defined? association }
-
+      parent_association = possible_parent_associations.find { |association| @model.method_defined?(association) || @model.method_defined?("#{association}_id") }
       return nil unless parent_association.present?
-
-      @condition = {parent_association => {id: @parent_ids}}
+      # If possible, use the team_id attribute because it saves us having to join all the way back to the sorce parent model
+      # In some scenarios this may be quicker, or if the parent model is in a different database shard, it may not even
+      # be possible to do the join
+      if @model.method_defined?("#{parent_association}_id")
+        @condition = {"#{parent_association}_id".to_sym => @parent_ids}
+      else
+        @condition = {parent_association => {id: @parent_ids}}
+      end
     end
   end
 end

data/lib/roles/permit.rb

@@ -8,23 +8,18 @@ module Roles
 
       # When changing permissions during development, you may also want to do this on each request:
       # User.update_all ability_cache: nil if Rails.env.development?
-
       output = []
       added_roles = Set.new
-
       user.send(through).map(&:roles).flatten.uniq.each do |role|
         unless added_roles.include?(role)
           output << "########### ROLE: #{role.key}"
-
           output += add_abilities_for(role, user, through, parent)
-
           added_roles << role
         end
 
         role.included_roles.each do |included_role|
           unless added_roles.include?(included_role)
             output << "############# INCLUDED ROLE: #{included_role.key}"
-
             output += add_abilities_for(included_role, user, through, parent)
           end
         end
@@ -40,17 +35,14 @@ module Roles
 
     def add_abilities_for(role, user, through, parent)
       output = []
-
       role.ability_generator(user, through, parent) do |ag|
         if ag.valid?
           output << "can #{ag.actions}, #{ag.model}, #{ag.condition}"
-
           can(ag.actions, ag.model, ag.condition)
         else
           output << "# #{ag.model} does not respond to #{parent} so we're not going to add an ability for the #{through} context"
         end
       end
-
       output
     end
   end

data/lib/roles/support.rb

@@ -13,16 +13,13 @@ module Roles
 
       def assignable_roles
         return Role.assignable if @allowed_roles.nil?
-
         Role.assignable.select { |role| @allowed_roles.include?(role.key.to_sym) }
       end
 
       # Note default_role is an ActiveRecord core class method so we need to use something else here
       def default_roles
         default_role = Role.default
-
         return [default_role] if @allowed_roles.nil?
-
         @allowed_roles.include?(default_role.key.to_sym) ? [default_role] : []
       end
     end
@@ -30,11 +27,7 @@ module Roles
     included do
       validate :validate_roles
 
-      # This query will return records that have a role "included" in a different role they have.
-      # For example, if you do with_roles(editor) it will return admin users if the admin role includes the editor role
-      scope :with_roles, ->(roles) { where("#{table_name}.role_ids ?| array[:keys]", keys: roles.map(&:key_plus_included_by_keys).flatten.uniq.map(&:to_s)) }
-
-      # This query will return roles that include the given role.  See with_roles above for details
+      # This query will return roles that include the given role.  See self.with_roles below for details
       scope :with_role, ->(role) { role.nil? ? all : with_roles([role]) }
       scope :viewers, -> { where("#{table_name}.role_ids = ?", [].to_json) }
       scope :editors, -> { with_role(Role.find_by_key("editor")) }
@@ -43,6 +36,26 @@ module Roles
       after_save :invalidate_cache
       after_destroy :invalidate_cache
 
+      # This query will return records that have a role "included" in a different role they have.
+      # For example, if you do with_roles(editor) it will return admin users if the admin role includes the editor role
+      def self.with_roles(roles)
+        # Mysql and postgres have different syntax for searching json or jsonb columns so we need different queries depending on the database
+        ActiveRecord::Base.connection.adapter_name.downcase.include?("mysql") ? with_roles_mysql(roles) : with_roles_postgres(roles)
+      end
+
+      def self.with_roles_mysql(roles)
+        queries = []
+        roles.map(&:key_plus_included_by_keys).flatten.uniq.map(&:to_s).each do |role|
+          queries << "JSON_CONTAINS(#{table_name}.role_ids, '\"#{role}\"')"
+        end
+        query = queries.join(" OR ")
+        where(query)
+      end
+
+      def self.with_roles_postgres(roles)
+        where("#{table_name}.role_ids ?| array[:keys]", keys: roles.map(&:key_plus_included_by_keys).flatten.uniq.map(&:to_s))
+      end
+
       def validate_roles
         self.role_ids = role_ids&.select(&:present?) || []
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-roles
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Prabin Poudel
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-10 00:00:00.000000000 Z
+date: 2022-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug