bullet_train-roles 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c87ff4b45f3eed3dc5e3b2d7e6239160d4f83c3fee07483647b960f10e22ff1
-  data.tar.gz: 9302b17d61bbf57210ba56edacb75a5b4e4b00e4568ac67fe157fe9872cfcff5
+  metadata.gz: f03a796a2c17954ad4c25e313caea68ba0b60b7e8901e7c1acf83d869e100592
+  data.tar.gz: 131e6518cefb00c6ea280d4ac4bf492961cb6f45b6d0ef3d695b66de9366d906
 SHA512:
-  metadata.gz: f766e94d3a385fa76603f50d462e1606d9fc7038b17855fa5300f227a81160c79fc489ad201e457c8e35ee1a364d27617e8d8b839fd94071bb581dd0b7d91dce
-  data.tar.gz: cd8e636d008364f3e6169dd67e0839fbb362167ce4cf19fce135d35020a81143573072848f5062683c94fb696a4c69020c83e72f4339733d5e4d212c6cc1e184
+  metadata.gz: 7df53d71fb2d393e84a30a5efb1fa9f351781653b40e1cc31e5cf565d4432228b3a78b6924d021908c5d463695dfdeb0dff834a0f1c63a26438774e8159f4438
+  data.tar.gz: 56a0c8b76f5105959d828db3f619c863cc917fd3caf1e8dc838151268da68da1bce455ebd3378f68dfa7bf78d804d673df311f6351cfd0a47a2b4f43a6c68c07

data/Gemfile.lock

@@ -9,7 +9,7 @@ GIT
 PATH
   remote: .
   specs:
-    bullet_train-roles (0.1.0)
+    bullet_train-roles (0.1.4)
       active_hash
       activesupport
       cancancan
@@ -173,6 +173,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-20
+  arm64-darwin-21
 
 DEPENDENCIES
   active_hash!
@@ -187,4 +188,4 @@ DEPENDENCIES
   standard (~> 1.5.0)
 
 BUNDLED WITH
-   2.2.15
+   2.3.4

data/README.md

@@ -1,8 +1,12 @@
 # Bullet Train Roles
 
-This Ruby Gem provides a Yaml-based configuration layer on top of CanCanCan's ability file. You can use this configuration file to simplify the definition of the most common types of 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`.
 
-## Example Domain Model 
+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
 
 For the sake of this document, we're going to assume the following example modeling around users and teams:
 
@@ -11,18 +15,21 @@ 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/).
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add these lines to your application's Gemfile:
 
 ```ruby
+gem "active_hash", github: "bullet-train-co/active_hash"
 gem "bullet_train-roles"
 ```
 
+> We have to link to a specific downstream version of ActiveHash temporarily while working to merge certain fixes and updates upstream.
+
 And then execute the following in your shell:
 
 ```
@@ -32,25 +39,24 @@ bundle install
 Finally, run the installation generator:
 
 ```
-rails generate bullet_train:roles:install User Membership Team
+rails generate bullet_train:roles:install
 ```
 
-This will:
+The installer defaults to installing a configuration for `Membership` and `Team`, but it will prompt you so you can specify different models if they differ in your application.
+
+The installer will:
 
  - stub out a configuration file in `config/models/roles.yml`.
  - create a database migration to add `role_ids:jsonb` to `Membership`.
  - add `include Role::Support` to `app/models/membership.rb`.
  - 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, you can edit these migrations and 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 (via [ActiveHash](https://github.com/active-hash/active_hash)) by a Yaml configuration in `config/models/roles.yml`.
+The provided `Role` model is backed by a Yaml configuration in `config/models/roles.yml`.
 
-To help explain this configuration and it's options, we'll provide the following hypothetical example:
+To help explain this configuration and its options, we'll provide the following hypothetical example:
 
 ```
 default:

data/bin/setup

@@ -5,4 +5,10 @@ set -vx
 
 bundle install
 
+# We need to cd into the dummy app because it uses a different Rakefile
+cd test/dummy
+bundle install
+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.0"
+  VERSION = "0.1.4"
 end

data/lib/bullet_train/roles.rb

@@ -5,6 +5,7 @@ require_relative "roles/version"
 require_relative "../models/role"
 require_relative "../roles/permit"
 require_relative "../roles/support"
+require_relative "../roles/user"
 
 module Roles
   class Error < StandardError; end

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

@@ -31,6 +31,7 @@ module BulletTrain
         # TODO: follow back Andrew on question about this in Slack
 
         add_permit_to_ability_model(top_level_model, associated_model)
+        add_concern_to_user
       end
 
       private
@@ -46,7 +47,7 @@ module BulletTrain
       end
 
       def db_adapter
-        allowed_adapter_types = %w[mysql sqlite postgresql]
+        allowed_adapter_types = %w[mysql mysql2 sqlite postgresql]
 
         adapter_name = ActiveRecord::Base.connection.adapter_name.downcase
 
@@ -89,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
 
@@ -118,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)
-
         puts("Success 🎉🎉\n\n")
       end
 
@@ -160,22 +151,44 @@ module BulletTrain
       end
 
       def add_permit_to_ability_model(top_level_model, associated_model)
-        # TODO: need to make this more smart e.g.
-        # 1. should know what parameter is used for user e.g. def initialize(user)
-        # 2. what if code doesn't include "if user.present?", maybe we need to handle that, consult with Andrew
         file_location = "app/models/ability.rb"
-        line_to_match = "if user.present?"
-        content_to_add = "\n      permit user, through: :#{top_level_model.downcase.pluralize}, parent: :#{associated_model.downcase}\n"
-
-        puts("Adding 'permit user, through: :#{top_level_model.downcase}, parent: :#{associated_model.downcase}' to #{associated_model}\n\n")
+        line_to_match = "include CanCan::Ability"
+        content_to_add = "\n  include Roles::Permit\n"
+        puts("Adding 'include Roles::Permit' to #{associated_model}\n\n")
 
         if line_exists_in_file?(file_location, content_to_add)
           message = "#{remove_new_lines_and_spaces(content_to_add)} already exists in #{associated_model}!!\n\n"
+          line_already_exists(message)
+        else
+          add_in_file(file_location, line_to_match, content_to_add)
+        end
 
-          return line_already_exists(message)
+        line_to_match = "def initialize(user)"
+        content_to_add = "\n    permit user, through: :#{top_level_model.downcase.pluralize}, parent: :#{associated_model.downcase} if user.present?\n"
+        puts("Adding 'permit' to #{associated_model}\n\n")
+
+        if line_exists_in_file?(file_location, content_to_add)
+          message = "#{remove_new_lines_and_spaces(content_to_add)} already exists in #{associated_model}!!\n\n"
+          line_already_exists(message)
+        else
+          add_in_file(file_location, line_to_match, content_to_add)
         end
 
-        add_in_file(file_location, line_to_match, content_to_add)
+        puts("Success 🎉🎉\n\n")
+      end
+
+      def add_concern_to_user
+        file_location = "app/models/user.rb"
+        line_to_match = "class User < ApplicationRecord"
+        content_to_add = "\n  include Roles::User\n"
+        puts("Adding 'include Roles::User' to User\n\n")
+
+        if line_exists_in_file?(file_location, content_to_add)
+          message = "#{remove_new_lines_and_spaces(content_to_add)} already exists in User!!\n\n"
+          line_already_exists(message)
+        else
+          add_in_file(file_location, line_to_match, content_to_add)
+        end
 
         puts("Success 🎉🎉\n\n")
       end

data/lib/generators/bullet_train/roles/install/templates/roles.yml

@@ -1,10 +1,8 @@
 default:
   models:
-    -
 
 editor:
   models:
-    -
   manageable_roles:
     - editor
 

data/lib/models/role.rb

@@ -2,8 +2,6 @@
 
 require "active_hash"
 
-class RemovingLastTeamAdminException < RuntimeError; end
-
 class Role < ActiveYaml::Base
   include ActiveYaml::Aliases
   set_root_path "config/models"
@@ -111,23 +109,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

data/lib/roles/support.rb

@@ -44,7 +44,7 @@ module Roles
       after_destroy :invalidate_cache
 
       def validate_roles
-        self.role_ids = role_ids.select(&:present?)
+        self.role_ids = role_ids&.select(&:present?) || []
 
         return if @allowed_roles.nil?
 
@@ -66,7 +66,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

data/lib/roles/user.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "active_support"
+
+module Roles
+  module User
+    extend ActiveSupport::Concern
+
+    included do
+      def parent_ids_for(role, through, parent)
+        parent_id_column = "#{parent}_id"
+        key = "#{role.key}_#{through}_#{parent_id_column}s"
+        # TODO Maybe we should make ability caching a default feature of the gem?
+        # If we do that, we would just make it check whether `ability_cache` exists.
+        # return ability_cache[key] if ability_cache && ability_cache[key]
+        role = nil if role.default?
+        value = send(through).with_role(role).distinct.pluck(parent_id_column)
+        # TODO Maybe we should make ability caching a default feature of the gem?
+        # current_cache = ability_cache || {}
+        # current_cache[key] = value
+        # update_column :ability_cache, current_cache
+        value
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-roles
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.4
 platform: ruby
 authors:
 - Prabin Poudel
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-06 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -192,6 +192,7 @@ files:
 - lib/models/role.rb
 - lib/roles/permit.rb
 - lib/roles/support.rb
+- lib/roles/user.rb
 homepage: https://github.com/bullet-train-co/bullet_train-roles
 licenses:
 - MIT