bullet_train-roles 0.1.3 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f41c9b86402531e17f5853d967530968368985d44a5130f011c8d6d0844691a7
-  data.tar.gz: 102b0571926e9a698b2654b8d54128b226e8c67ffdd10f626a18baf23b35c754
+  metadata.gz: 93fd2729ae287aa0389216798de23663aa3703bed3f5f11e571371c4b55bd30a
+  data.tar.gz: e094e75bec9daf0073e1d658dd0113b4743dfb7a138cf2f2e4eb34851ef85d23
 SHA512:
-  metadata.gz: 92706fc57f271f24cdcc2a6c204bbfeb21fe79e0a0b2cedd480c8ea51c62157e93f4665fe7de98f0ad0ff8b96fc04cd6448d408415faced1936e4d68a0521583
-  data.tar.gz: 50c64184545ecfcdab68be3163148ae0d1ee3727f23fb415cfa741418d66b1aed71946f4e3902413d118bd22abe2e6715840d2548835f72d3d4f019412297807
+  metadata.gz: 5a905f35fd471b0dfd2e82355f0ede399ac7d212825509ca180732392418d6af9d5821ae46808c85b183e89515f0aacd029142e1d3f9b23ea1e360a0c754fce9
+  data.tar.gz: 2cbcb69b7244c96854ae4841978ded8b7466e04c13a534de8819e35fd28a65b38c03e28f5dbdad9e039bfff5630702196d691f3e1b64490bab464c433d69e982

data/Gemfile.lock

@@ -9,7 +9,7 @@ GIT
 PATH
   remote: .
   specs:
-    bullet_train-roles (0.1.2)
+    bullet_train-roles (0.1.6)
       active_hash
       activesupport
       cancancan
@@ -106,6 +106,8 @@ GEM
     nio4r (2.5.8)
     nokogiri (1.12.5-arm64-darwin)
       racc (~> 1.4)
+    nokogiri (1.12.5-x86_64-darwin)
+      racc (~> 1.4)
     parallel (1.21.0)
     parser (3.0.3.2)
       ast (~> 2.4.1)
@@ -174,6 +176,7 @@ GEM
 PLATFORMS
   arm64-darwin-20
   arm64-darwin-21
+  x86_64-darwin-21
 
 DEPENDENCIES
   active_hash!

data/README.md

@@ -1,12 +1,12 @@
 # Bullet Train Roles
 
-Bullet Train Roles provides a Yaml-based configuration layer on top of [CanCanCan](https://github.com/CanCanCommunity/cancancan). You can use this configuration file to simplify the definition of many common permissions, while still implementing more complicated permissions in CanCanCan's traditional `app/model/ability.rb`. 
+Bullet Train Roles provides a Yaml-based configuration layer on top of [CanCanCan](https://github.com/CanCanCommunity/cancancan). You can use this configuration file to simplify the definition of many common permissions, while still implementing more complicated permissions in CanCanCan's traditional `app/model/ability.rb`.
 
 Additionally, Bullet Train Roles makes it trivial to assign the same roles and associated permissions at different levels in your application. For example, you can assign someone administrative privileges at a team level, or only at a project level.
 
 Bullet Train Roles was created by [Andrew Culver](http://twitter.com/andrewculver) and [Adam Pallozzi](https://twitter.com/adampallozzi).
 
-## Example Domain Model 
+## Example Domain Model
 
 For the sake of this document, we're going to assume the following example modeling around users and teams:
 
@@ -15,7 +15,7 @@ For the sake of this document, we're going to assume the following example model
 - A `Membership` can have zero, one, or many `Role`s assigned.
 - A `Membership` without a `Role` is just a default team member.
 
-You don't have to name your models the same thing in order to use this Ruby Gem, but it does depend on having a similar structure. 
+You don't have to name your models the same thing in order to use this Ruby Gem, but it does depend on having a similar structure.
 
 > If you're interested in reading more about how and why Bullet Train implements this structure, you can [read about it on our blog](https://blog.bullettrain.co/teams-should-be-an-mvp-feature/).
 
@@ -52,10 +52,6 @@ The installer will:
  - add a basic `permit` call in `app/models/ability.rb`.
 
 
-### Limitations
-
-The generators currently assume you're using PostgreSQL and `jsonb` will be available when generating a `role_ids` column. If you're using MySQL, the generator will use `json` instead, although you won't be able to set a default value and you'll need to take care of this in the model.
-
 ## Usage
 
 The provided `Role` model is backed by a Yaml configuration in `config/models/roles.yml`.

data/bin/setup

@@ -8,7 +8,7 @@ bundle install
 # We need to cd into the dummy app because it uses a different Rakefile
 cd test/dummy
 bundle install
-rake db:test:prepare
+rake db:reset
 cd ../..
 
 # Do any other automated setup that you need to do here

data/lib/bullet_train/roles/version.rb

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

data/lib/generators/bullet_train/roles/install/install_generator.rb

@@ -58,11 +58,6 @@ module BulletTrain
         adapter_name
       end
 
-      def db_adapter_supports_defaults?
-        supported_db_adapters = %w[postgresql]
-        supported_db_adapters.include?(db_adapter)
-      end
-
       def find_json_data_type_identifier
         adapter_name = db_adapter
 
@@ -95,14 +90,6 @@ module BulletTrain
         File.write(file_location, update_file_content.join)
       end
 
-      def add_default_value_to_migration(file_name, table_name)
-        file_location = Dir["db/migrate/*_#{file_name}.rb"].last
-        line_to_match = "add_column :#{table_name.downcase}, :role_ids"
-        content_to_add = ", default: []\n"
-
-        add_in_file(file_location, line_to_match, content_to_add)
-      end
-
       def migration_file_exists?(file_name)
         file_location = Dir["db/migrate/*_#{file_name}.rb"].last
 
@@ -124,8 +111,6 @@ module BulletTrain
 
         generate "migration", "#{migration_file_name} role_ids:#{json_data_type_identifier}"
 
-        add_default_value_to_migration(migration_file_name, top_level_model_table_name) if db_adapter_supports_defaults?
-
         puts("Success 🎉🎉\n\n")
       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
@@ -109,23 +103,21 @@ class Role < ActiveYaml::Base
   class Collection < Array
     def initialize(model, ary)
       @model = model
-
       super(ary)
     end
 
     def <<(role)
       return true if include?(role)
-
-      role_ids = @model.role_ids
-
+      role_ids = @model.role_ids || []
       role_ids << role.id
-
       @model.update(role_ids: role_ids)
     end
 
     def delete(role)
-      @model.role_ids -= [role.key]
-
+      return @model.save unless include?(role)
+      current_role_ids = @model.role_ids || []
+      new_role_ids = current_role_ids - [role.key]
+      @model.role_ids = new_role_ids
       @model.save
     end
   end
@@ -153,42 +145,40 @@ 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
+      # using method_defined? will break with ActiveRecord 7 because now models have team_id defined if they include
+      # has_one :team, through: :membership
+      if @model.column_names.include?("#{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,8 +36,28 @@ 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?)
+        self.role_ids = role_ids&.select(&:present?) || []
 
         return if @allowed_roles.nil?
 
@@ -58,7 +71,7 @@ module Roles
       end
 
       def roles=(roles)
-        self.role_ids = roles.map(&:key)
+        self.update(role_ids: roles.map(&:key))
       end
 
       def assignable_roles
@@ -66,7 +79,7 @@ module Roles
       end
 
       def roles_without_defaults
-        role_ids.map { |role_id| Role.find(role_id) }
+        role_ids&.map { |role_id| Role.find(role_id) } || []
       end
 
       def manageable_roles

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-roles
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.6
 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-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -215,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.0
 signing_key:
 specification_version: 4
 summary: Yaml-backed ApplicationHash for CanCan Roles