bullet_train 1.4.3 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9521826a1552bab65baf10d7144bc10be7f61da32e17e799d498c3e7fdf32f82
-  data.tar.gz: cf4c3769472e2a4a25a497b1bc40ac95436dd83d9d0b06f78c23bfb30cc9c332
+  metadata.gz: 5d073ab349f58c17453f4e4d3f493e97202a56a9c6d521bffe36109f4e78d63b
+  data.tar.gz: 870e67cb3d4b7562f3fb8faad380bc45d3b0866b9f51bedc808481db82ce61f3
 SHA512:
-  metadata.gz: d6370f74971ba12c953ec66bd63edae2434457a0a84a07ec0dcab44685661026b1b57ba4b99377f2ef696c21bc63aaca6661008f4cc098aeed76fb55751aed68
-  data.tar.gz: 2705720d73d70dcd59ec85bc322d16f786ff6da81e3399a18b58b775a5a52befe7d8336e636f6544041843e829fd641d04096ab07d0cb865c8493f311b0333de
+  metadata.gz: 02a859e9c7b3be4b50ede0d7f45bf4fb53614953a5056bfc94511facb63179b56d4b8b94227fdce6bd23bf3af78d4e5d5ccc0d92c89abf6662a6c868f8c7a15d
+  data.tar.gz: 648560376f7307b66aa2eb52788c82278f5c277e8d34d22f6808d3053216634c5e482fd6b995102af9313c3aed123062764ca89c171eaa5b562475e2c42ec314

data/app/controllers/account/onboarding/invitation_lists_controller.rb

@@ -0,0 +1,3 @@
+class Account::Onboarding::InvitationListsController < Account::ApplicationController
+  include Account::Onboarding::InvitationLists::ControllerBase
+end

data/app/controllers/concerns/account/onboarding/invitation_lists/controller_base.rb

@@ -0,0 +1,64 @@
+module Account::Onboarding::InvitationLists::ControllerBase
+  extend ActiveSupport::Concern
+
+  included do
+    layout "devise"
+
+    before_action do
+      # TODO: Is this okay?
+      @user = current_user
+    end
+  end
+
+  def new
+    @account_onboarding_invitation_list = Account::Onboarding::InvitationList.new
+  end
+
+  def create
+    @account_onboarding_invitation_list = Account::Onboarding::InvitationList.new(account_onboarding_invitation_list_params)
+
+    # Set default values for invitations and memberships.
+    # `save` below checks if the values are valid or not.
+    @account_onboarding_invitation_list.team = current_team
+    @account_onboarding_invitation_list.invitations.each_with_index do |invitation, idx|
+      invitation.team = current_team
+      invitation.from_membership = current_membership
+      invitation.membership.team = current_team
+      invitation.membership.user_email = invitation.email
+    end
+
+    respond_to do |format|
+      if @account_onboarding_invitation_list.save
+        format.html { redirect_to account_team_path(@user.teams.first), notice: "" }
+        format.json { render :show, status: :ok, location: [:account, @user] }
+      else
+        format.html { render :new, status: :unprocessable_entity }
+        format.json { render json: @account_onboarding_invitation_list.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  private
+
+  # Never trust parameters from the scary internet, only allow the white list through.
+  def account_onboarding_invitation_list_params
+    params.require(:account_onboarding_invitation_list).permit(
+      invitations_attributes: [
+        :email,
+        membership_attributes: [
+          role_ids: []
+        ]
+      ]
+    )
+  end
+
+  def current_membership
+    current_user.memberships.find_by(team: current_team)
+  end
+
+  # Since there is only one membership (an admin) on the team when sending bulk invitations,
+  # we don't have to worry about filtering these roles according to if they're manageable or not.
+  def available_roles
+    current_membership.roles.map { |role| [role.attributes[:key]] + role.attributes[:manageable_roles] }.flatten.uniq.reject { |role| role.match?("default") }
+  end
+end

data/app/controllers/concerns/account/onboarding/user_details/controller_base.rb

@@ -24,8 +24,14 @@ module Account::Onboarding::UserDetails::ControllerBase
         # if you update your own user account, devise will normally kick you out, so we do this instead.
         bypass_sign_in current_user.reload
 
+        # Only redirect users to the bulk invitation page if they're the
+        # one who created the team (meaning there's only one membership on the team).
         if @user.details_provided?
-          format.html { redirect_to account_team_path(@user.teams.first), notice: "" }
+          if bulk_invitations_enabled? && @user.teams.first.memberships.size == 1
+            format.html { redirect_to new_account_onboarding_invitation_list_path(@user) }
+          else
+            format.html { redirect_to account_team_path(@user.teams.first), notice: "" }
+          end
         else
           format.html {
             flash[:error] = I18n.t("global.notifications.all_fields_required")

data/app/helpers/account/onboarding/invitation_lists_helper.rb

@@ -0,0 +1,9 @@
+module Account::Onboarding::InvitationListsHelper
+  # When sending bulk invitations, the current user is the only one with a membership on the team.
+  # This means that we can access all of the available roles with the following code.
+  def available_roles
+    current_user.memberships.first.roles.map do |role|
+      [role.attributes[:key]] + role.attributes[:manageable_roles]
+    end.flatten.uniq.reject { |role| role.match?("default") }
+  end
+end

data/app/models/account/onboarding/invitation_list.rb

@@ -0,0 +1,7 @@
+class Account::Onboarding::InvitationList < ApplicationRecord
+  include Account::Onboarding::InvitationLists::Base
+
+  def self.table_name_prefix
+    "account_onboarding_"
+  end
+end

data/app/models/concerns/account/onboarding/invitation_lists/base.rb

@@ -0,0 +1,11 @@
+module Account::Onboarding::InvitationLists::Base
+  extend ActiveSupport::Concern
+
+  included do
+    belongs_to :team
+    has_many :invitations
+    has_many :memberships, through: :invitations
+
+    accepts_nested_attributes_for :invitations, :memberships
+  end
+end

data/app/models/concerns/invitations/base.rb

@@ -4,6 +4,7 @@ module Invitations::Base
   included do
     belongs_to :team
     belongs_to :from_membership, class_name: "Membership"
+    belongs_to :invitation_list, class_name: "Account::Onboarding::InvitationList", optional: true
     has_one :membership, dependent: :nullify
 
     accepts_nested_attributes_for :membership

data/app/views/account/onboarding/invitation_lists/_invitation_form.html.erb

@@ -0,0 +1,11 @@
+<%= form.fields_for :invitations, Invitation.new do |invitation_form| %>
+  <div class="col-span-1">
+    <%= render 'shared/fields/email_field', form: invitation_form, method: :email, options: {autofocus: true} %>
+  </div>
+
+  <%= invitation_form.fields_for :membership, Membership.new do |membership_form| %>
+    <div class="col-span-1">
+      <%= render 'shared/fields/super_select', form: membership_form, method: :role_ids, choices: available_roles, html_options: {multiple: true}, select2_options: {placeholder: t('.membership.roles.default')}, other_options: {label: t('.membership.roles.label')} %>
+    </div>
+  <% end %>
+<% end %>

data/app/views/account/onboarding/invitation_lists/new.html.erb

@@ -0,0 +1,31 @@
+<% @title = t('.header') %>
+
+<%= render 'account/shared/workflow/box' do |box| %>
+  <% box.title @title %>
+  <% box.body do %>
+    <% within_fields_namespace(:self) do %>
+      <%= form_with(model: @account_onboarding_invitation_list, class: 'form', local: true) do |f| %>
+        <% f.object.errors.each do |error| %>
+          <%= render 'account/shared/forms/errors', form: f, attributes: [error.attribute], resource: @account_onboarding_invitation_list %>
+        <% end %>
+        <%= render 'account/shared/notices', form: f %>
+
+        <div class="grid gap-y gap-x grid-cols-2">
+          <% 1.times do %>
+            <%= render 'invitation_form', form: f %>
+          <% end %>
+        </div>
+
+        <div class="buttons">
+          <%= f.submit t('.buttons.next'), class: first_button_primary %>
+          <%= link_to t('.buttons.skip'), main_app.account_teams_path, class: first_button_primary %>
+          <% if other_teams.any? %>
+            <%= link_to t('global.buttons.back'), main_app.account_teams_path, class: first_button_primary %>
+          <% else %>
+            <%= link_to t('menus.main.labels.logout'), main_app.destroy_user_session_path(@user, onboard_logout: true), class: first_button_primary, method: 'delete' %>
+          <% end %>
+        </div>
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>

data/config/locales/en/onboarding/invitation_lists.en.yml

@@ -0,0 +1,16 @@
+en:
+  onboarding: &onboarding
+    invitation_lists:
+      buttons: &buttons
+        next: Next
+        skip: Skip
+      new:
+        header: Invite your team members
+        buttons: *buttons
+      invitation_form:
+        membership:
+          roles:
+            label: Roles
+            default: Default
+  account:
+    onboarding: *onboarding

data/config/routes.rb

@@ -26,6 +26,7 @@ Rails.application.routes.draw do
       namespace :onboarding do
         resources :user_details
         resources :user_email
+        resources :invitation_lists, only: [:new, :create]
       end
 
       # user specific resources.

data/docs/field-partials/super-select.md

@@ -1,4 +1,4 @@
-Note: before you attempt to manually wire up a `super_select` field, note that Super Scaffolding will automatically do that for your models. See [Super Scoffolding](/docs/super-scaffolding.md) docs, section 4, for an example. And make sure Super Scoffolding doesn't automatically do what you're trying to do.
+Note: before you attempt to manually wire up a `super_select` field, note that Super Scaffolding will automatically do that for your models. See [Super Scaffolding](/docs/super-scaffolding.md) docs, section 4, for an example. And make sure Super Scaffolding doesn't automatically do what you're trying to do.
 
 # Examples for the `super_select` Field Partial
 

data/docs/upgrades/yolo-130.md

@@ -136,7 +136,7 @@ gem "bullet_train-themes-tailwind_css", BULLET_TRAIN_VERSION
 (We have to do this since we didn't start explicitly tracking versions until `1.4.0` and
 want to make sure that our gem versions match what the starter repo expects.)
 
-Then run `bundle update`
+Then run `bundle install`
 
 Then go ahead and commit the changes.
 
@@ -247,7 +247,7 @@ BULLET_TRAIN_VERSION = "1.3.1"
 (We have to do this since we didn't start explicitly tracking versions until `1.4.0` and
 want to make sure that our gem versions match what the starter repo expects.)
 
-Then run `bundle update`
+Then run `bundle install`
 
 Then go ahead and commit the changes.
 
@@ -272,7 +272,7 @@ If anything fails, investigate the failures and get things working again, and co
 git checkout main
 git merge updating-bullet-train-v1.3.1
 git push origin main
-git branch -d updating-bullet-train-v1.3.1`
+git branch -d updating-bullet-train-v1.3.1
 ```
 
-Alternatively, if you're using GitHub, you can push the `updating-bullet-train-v1.3.1` branch up and create a PR from it and let your CI integration do it's thing and then merge in the PR and delete the branch there. (That's what we typically do.)
+Alternatively, if you're using GitHub, you can push the `updating-bullet-train-v1.3.1` branch up and create a PR from it and let your CI integration do its thing and then merge in the PR and delete the branch there. (That's what we typically do.)

data/docs/upgrades/yolo-140.md

@@ -57,7 +57,7 @@ generate a new one that matches what you need:
 
 ```
 git checkout HEAD -- Gemfile.lock
-bundle update
+bundle install
 ```
 
 If you choose to sort out `Gemfile.lock` by hand it's a good idea to run `bundle install` just to make
@@ -84,11 +84,11 @@ If anything fails, investigate the failures and get things working again, and co
 
 ```
 git checkout main
-git merge updating-bullet-train-v1.3.0
+git merge updating-bullet-train-v1.4.0
 git push origin main
-git branch -d updating-bullet-train-v1.3.0
+git branch -d updating-bullet-train-v1.4.0
 ```
 
-Alternatively, if you're using GitHub, you can push the `updating-bullet-train-v1.3.0` branch up and create a PR from it and let your CI integration do it's thing and then merge in the PR and delete the branch there. (That's what we typically do.)
+Alternatively, if you're using GitHub, you can push the `updating-bullet-train-v1.4.0` branch up and create a PR from it and let your CI integration do it's thing and then merge in the PR and delete the branch there. (That's what we typically do.)
 
 

data/docs/upgrades.md

@@ -30,6 +30,8 @@ recent version of the starter repository should cause a merge conflict in Git. T
 opportunity to compare our upstream changes with your local customizations and allow you to resolve them in a way that makes sense for
 your application.
 
+⚠️ If you have ejected files or a new custom theme, there is a possibility that those ejected files need to be updated although no merge conflicts arose from `git merge`. You will need to compare your ejected views with the original views in [bullet_train-core](https://github.com/bullet-train-co/bullet_train-core) to ensure everything is working properly. Please refer to the documentation on [indirection](indirection) to find out more about ejected views.
+
 ### 1. Decide which version you want to upgrade to
 
 For the purposes of these instructions we'll assume that you're on version `1.4.0` and are going to upgrade to version `1.4.1`.
@@ -66,7 +68,7 @@ git checkout -b updating-bullet-train-1.4.1
 
 ### 5. Merge in the newest stuff from Bullet Train and resolve any merge conflicts.
 
-Each version of the starter repo is tagged, so you can merge in the tag from the upstread repo.
+Each version of the starter repo is tagged, so you can merge in the tag from the upstream repo.
 
 ```
 git merge v1.4.1
@@ -114,5 +116,5 @@ git branch -d updating-bullet-train-1.4.1
 ```
 
 Alternatively, if you're using GitHub, you can push the `updating-bullet-train-1.4.1` branch up and create a
-PR from it and let your CI integration do it's thing and then merge in the PR and delete the branch there.
+PR from it and let your CI integration do its thing and then merge in the PR and delete the branch there.
 (That's what we typically do.)

data/lib/bullet_train/configuration.rb

@@ -1,7 +1,7 @@
 module BulletTrain
   class Configuration
     include Singleton
-    attr_accessor :strong_passwords, :incoming_webhooks_parent_class_name
+    attr_accessor :strong_passwords, :enable_bulk_invitations, :incoming_webhooks_parent_class_name
 
     @@config = nil
 
@@ -10,6 +10,7 @@ module BulletTrain
 
       # Default values
       @strong_passwords = true
+      @enable_bulk_invitations = false
       @incoming_webhooks_parent_class_name = "ApplicationRecord"
     end
 
@@ -18,6 +19,10 @@ module BulletTrain
         @@config&.strong_passwords
       end
 
+      def enable_bulk_invitations
+        @@config&.enable_bulk_invitations
+      end
+
       def incoming_webhooks_parent_class_name
         @@config&.incoming_webhooks_parent_class_name
       end

data/lib/bullet_train/resolver.rb

@@ -11,12 +11,16 @@ module BulletTrain
     def run(eject: false, open: false, force: false, interactive: false)
       # Try to figure out what kind of thing they're trying to look up.
       source_file = calculate_source_file_details
+      source_file[:relative_path] = nil
 
       if source_file[:absolute_path]
         puts ""
         puts "Absolute path:".green
         puts "  #{source_file[:absolute_path]}".green
         puts ""
+
+        source_file[:relative_path] = source_file[:absolute_path].split(/(?=#{source_file[:package_name]})/).pop
+
         if source_file[:package_name].present?
           puts "Package name:".green
           puts "  #{source_file[:package_name]}".green
@@ -44,9 +48,9 @@ module BulletTrain
               File.open((source_file[:project_path]).to_s, "w+") do |file|
                 case source_file[:project_path].split(".").last
                 when "rb", "yml"
-                  file.puts "# Ejected from `#{source_file[:package_name]}`.\n\n"
+                  file.puts "# Ejected from `#{source_file[:relative_path] || source_file[:package_name]}`.\n\n"
                 when "erb"
-                  file.puts "<% # Ejected from `#{source_file[:package_name]}`. %>\n\n"
+                  file.puts "<% # Ejected from `#{source_file[:relative_path] || source_file[:package_name]}`. %>\n\n"
                 end
               end
               `cat #{source_file[:absolute_path]} >> #{source_file[:project_path]}`.strip

data/lib/bullet_train/version.rb

@@ -1,3 +1,3 @@
 module BulletTrain
-  VERSION = "1.4.3"
+  VERSION = "1.4.4"
 end

data/lib/bullet_train.rb

@@ -167,6 +167,10 @@ def openai_organization_exists?
   ENV["OPENAI_ORGANIZATION_ID"]
 end
 
+def bulk_invitations_enabled?
+  BulletTrain::Configuration.enable_bulk_invitations
+end
+
 def disable_developer_menu?
   ENV["DISABLE_DEVELOPER_MENU"].present?
 end

data/lib/tasks/bullet_train_tasks.rake

@@ -82,20 +82,30 @@ namespace :bullet_train do
       gem_names.each do |gem|
         puts "Searching for locales in #{gem}...".blue
         gem_path = `bundle show #{gem}`.chomp
+        gem_with_version = gem_path.split("/").last
         locales = Dir.glob("#{gem_path}/**/config/locales/**/*.yml").reject { |path| path.match?("dummy") }
         next if locales.empty?
 
         puts "Found locales. Ejecting to your application...".green
         locales.each do |locale|
-          relative_path = locale.split("/config/locales").pop
-          path_parts = relative_path.split("/")
-          base_path = path_parts.join("/")
-          FileUtils.mkdir_p("./config/locales#{base_path}") unless Dir.exist?("./config/locales#{base_path}")
-
-          unless File.exist?("config/locales#{relative_path}")
-            puts "Ejecting #{relative_path}..."
-            File.new("config/locales#{relative_path}", "w")
-            `cp #{locale} config/locales#{relative_path}`
+          relative_path = locale.split(/(?=#{gem_with_version}\/config\/locales)/).last
+          path_in_locale = locale.split("/config/locales").pop
+
+          base_path = relative_path.split("/")
+          base_path.pop
+          base_path = base_path.join("/")
+          starter_repo_locale_path = base_path.gsub(gem_with_version, ".")
+
+          FileUtils.mkdir_p(starter_repo_locale_path) unless Dir.exist?(starter_repo_locale_path)
+
+          unless File.exist?("config/locales#{path_in_locale}")
+            puts "Ejecting #{path_in_locale}..."
+            File.new("config/locales#{path_in_locale}", "w")
+            `cp #{locale} config/locales#{path_in_locale}`
+            file = Pathname.new("config/locales#{path_in_locale}")
+            lines = file.readlines
+            lines.unshift("# Ejected from #{relative_path}\n\n")
+            file.write(lines.join)
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.4.4
 platform: ruby
 authors:
 - Andrew Culver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-14 00:00:00.000000000 Z
+date: 2023-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -513,6 +513,7 @@ files:
 - app/assets/config/bullet_train_manifest.js
 - app/controllers/account/invitations_controller.rb
 - app/controllers/account/memberships_controller.rb
+- app/controllers/account/onboarding/invitation_lists_controller.rb
 - app/controllers/account/onboarding/user_details_controller.rb
 - app/controllers/account/onboarding/user_email_controller.rb
 - app/controllers/account/teams_controller.rb
@@ -521,6 +522,7 @@ files:
 - app/controllers/concerns/account/controllers/base.rb
 - app/controllers/concerns/account/invitations/controller_base.rb
 - app/controllers/concerns/account/memberships/controller_base.rb
+- app/controllers/concerns/account/onboarding/invitation_lists/controller_base.rb
 - app/controllers/concerns/account/onboarding/user_details/controller_base.rb
 - app/controllers/concerns/account/onboarding/user_email/controller_base.rb
 - app/controllers/concerns/account/teams/controller_base.rb
@@ -541,6 +543,7 @@ files:
 - app/helpers/account/locale_helper.rb
 - app/helpers/account/markdown_helper.rb
 - app/helpers/account/memberships_helper.rb
+- app/helpers/account/onboarding/invitation_lists_helper.rb
 - app/helpers/account/role_helper.rb
 - app/helpers/account/teams_helper.rb
 - app/helpers/account/users_helper.rb
@@ -567,12 +570,14 @@ files:
 - app/mailers/concerns/mailers/base.rb
 - app/mailers/devise_mailer.rb
 - app/mailers/user_mailer.rb
+- app/models/account/onboarding/invitation_list.rb
 - app/models/address.rb
 - app/models/addresses/continent.rb
 - app/models/addresses/country.rb
 - app/models/addresses/region.rb
 - app/models/addresses/subcontinent.rb
 - app/models/billing/mock_limiter.rb
+- app/models/concerns/account/onboarding/invitation_lists/base.rb
 - app/models/concerns/addresses/base.rb
 - app/models/concerns/addresses/continents/base.rb
 - app/models/concerns/addresses/countries/base.rb
@@ -606,6 +611,8 @@ files:
 - app/views/account/memberships/edit.html.erb
 - app/views/account/memberships/index.html.erb
 - app/views/account/memberships/show.html.erb
+- app/views/account/onboarding/invitation_lists/_invitation_form.html.erb
+- app/views/account/onboarding/invitation_lists/new.html.erb
 - app/views/account/onboarding/user_details/edit.html.erb
 - app/views/account/onboarding/user_email/edit.html.erb
 - app/views/account/teams/_breadcrumbs.html.erb
@@ -664,6 +671,7 @@ files:
 - config/locales/en/invitations.en.yml
 - config/locales/en/memberships.en.yml
 - config/locales/en/oauth.en.yml
+- config/locales/en/onboarding/invitation_lists.en.yml
 - config/locales/en/onboarding/user_details.en.yml
 - config/locales/en/onboarding/user_email.en.yml
 - config/locales/en/roles.en.yml