bullet_train 1.1.7 → 1.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 398b4fbeb7a7498078dfce7f74bdb6518763246d4dac6186fe751cbbafc6ddeb
-  data.tar.gz: 5b98cfa4d24635d9a2290637ef2ae4a16614943c59dad22669032c23f4f3b1b1
+  metadata.gz: 861c6f60ec10ff83389d2ac53d5a702dd230db869b890b6e46f84896fecb8b7b
+  data.tar.gz: 55d51e53583ef3e2bdd179f821e7a48920483acea55adb818a736ca411106a70
 SHA512:
-  metadata.gz: 84b8c473cdf360347dd498dd3ae3721ae0b776587e6f93da18b289c59ed470d7795a47fa7ee73c214d2800a636ead41ee8666ce9bdd4d22364385e0075c91a02
-  data.tar.gz: f7e34ab6d0112a3cddf5a3ad18e4c740c9fecdd9b46ccb24ad34cac6aadab0269aece837c3abcf03738558aef4e86ee0d190dad0ce42632e0dbdab01f437d08f
+  metadata.gz: a5ddb5c77373a119154c1f1fd1993b9f89723dd0239f4e71402e3c7399100f38734edbd0bb9768d2545e607d98281da486ab7ac6c2d55e3b06da902eceebc4a3
+  data.tar.gz: 47337cee5019ad52c09e325cb9ef035b24d59da94083337a817cc45342ea0c0feac586e115ac793b3bd802e20e1b985aecd479b603dbed2b1765dbaf2638333a

data/app/controllers/concerns/account/teams/controller_base.rb

@@ -1,5 +1,6 @@
 module Account::Teams::ControllerBase
   extend ActiveSupport::Concern
+  extend Controllers::Base
 
   included do
     load_and_authorize_resource :team, class: "Team", prepend: true,
@@ -21,7 +22,9 @@ module Account::Teams::ControllerBase
 
     private
 
-    include strong_parameters_from_api
+    if defined?(Api::V1::ApplicationController)
+      include strong_parameters_from_api
+    end
   end
 
   # GET /teams

data/app/controllers/concerns/documentation_support.rb

@@ -3,8 +3,8 @@ module DocumentationSupport
 
   def docs
     target = params[:page].presence || "index"
-    files = `find -L tmp/gems/*/docs | grep \.md`.lines.map(&:chomp).sort
-    @file = files.detect { |file| file.include?(target) }
+    all_paths = ([Rails.root.to_s] + `bundle show --paths`.lines.map(&:chomp))
+    @path = all_paths.map { |path| path + "/docs/#{target}.md" }.detect { |path| File.exist?(path) }
     render :docs, layout: "docs"
   end
 end

data/app/javascript/controllers/index.js

@@ -6,6 +6,7 @@ import ClipboardController from './clipboard_controller'
 import FormController from './form_controller'
 import MobileMenuController from './mobile_menu_controller'
 import TextToggleController from './text_toggle_controller'
+import SelectAllController from './select_all_controller'
 
 export const controllerDefinitions = [
   [BulkActionFormController, 'bulk_action_form_controller.js'],
@@ -14,6 +15,7 @@ export const controllerDefinitions = [
   [FormController, 'form_controller.js'],
   [MobileMenuController, 'mobile_menu_controller.js'],
   [TextToggleController, 'text_toggle_controller.js'],
+  [SelectAllController, 'select_all_controller.js'],
 ].map(function(d) {
   const key = d[1]
   const controller = d[0]

data/app/javascript/controllers/select_all_controller.js

@@ -0,0 +1,82 @@
+import { Controller } from "@hotwired/stimulus";
+
+export default class extends Controller {
+  static targets = [ "checkbox", "toggleCheckbox", "toggleLabel", "wrapper" ]
+  static classes = [ "unavailable" ]
+  
+  connect() {
+    this.enableSelectAll()
+  }
+  
+  enableSelectAll() {
+    if (!this.hasWrapperTarget) { return }
+    if (!this.hasUnavailableClass) { return }
+    
+    this.wrapperTarget.classList.remove(this.unavailableClass)
+    this.updateToggle()
+  }
+  
+  selectAllOrNone(event) {
+    event.preventDefault()
+    event.stopPropagation()
+    if (this.allSelected) {
+      this.selectNone()
+    } else {
+      this.selectAll()
+    }
+    this.updateToggle()
+    this.dispatch('toggled')
+  }
+  
+  selectAll() {
+    this.checkboxTargets.forEach(checkbox => {
+      checkbox.checked = true
+    })
+  }
+  
+  selectNone() {
+    this.checkboxTargets.forEach(checkbox => {
+      checkbox.checked = false
+    })
+  }
+  
+  updateToggle() {
+    let checkbox = this.toggleCheckboxTarget
+    let useAlternateLabel = false
+    
+    if (this.allSelected) {
+      if (checkbox) {
+        checkbox.checked = true
+        checkbox.indeterminate = false
+      }
+      useAlternateLabel = true
+    } else if (this.selectedValues.length > 0) {
+      if (checkbox) {
+        checkbox.indeterminate = true
+      }
+    } else {
+      if (checkbox) {
+        checkbox.checked = false
+        checkbox.indeterminate = false
+      }
+    }
+    
+    if (this.hasToggleLabelTarget) {
+      this.toggleLabelTarget.dispatchEvent(new CustomEvent(`${this.identifier}:toggle-select-all-label`, { detail: { useAlternate: useAlternateLabel }} ))
+    }
+  }
+  
+  get selectedValues() {
+    let values = []
+    this.checkboxTargets.forEach(checkbox => {
+      if (checkbox.checked) {
+        values.push(checkbox.value)
+      }
+    })
+    return values
+  }
+  
+  get allSelected() {
+    return this.selectedValues.length === this.checkboxTargets.length
+  }
+}

data/app/views/public/home/docs.html.erb

@@ -1,6 +1,6 @@
-<% @body = markdown(File.read(Rails.root.to_s + "/#{@file}").gsub('.md)', ')')) %>
+<% @body = markdown(File.read(@path).gsub('.md)', ')')) %>
 
-<% if @file == "tmp/gems/bullet_train/docs/index.md" %>
+<% if @path.include?("docs/index.md") %>
   <% header, groups = @body.split("<h2>", 2) %>
   <%= header.html_safe %>
 

data/config/locales/en/framework_packages.yml

@@ -6,38 +6,34 @@ en:
     bullet_train-api:
       git: "bullet-train-co/bullet_train-api"
     bullet_train-fields:
-      git: "bullet-train-co/bullet_train-fields"
+      git: "bullet-train-co/bullet_train-core"
       npm: "@bullet-train/fields"
     bullet_train-has_uuid:
-      git: "bullet-train-co/bullet_train-has_uuid"
+      git: "bullet-train-co/bullet_train-core"
     bullet_train-incoming_webhooks:
-      git: "bullet-train-co/bullet_train-incoming_webhooks"
+      git: "bullet-train-co/bullet_train-core"
     bullet_train-integrations:
-      git: "bullet-train-co/bullet_train-integrations"
+      git: "bullet-train-co/bullet_train-core"
     bullet_train-integrations-stripe:
-      git: "bullet-train-co/bullet_train-base-integrations-stripe"
+      git: "bullet-train-co/bullet_train-core"
     bullet_train-obfuscates_id:
-      git: "bullet-train-co/bullet_train-obfuscates_id"
+      git: "bullet-train-co/bullet_train-core"
     bullet_train-outgoing_webhooks:
       git: "bullet-train-co/bullet_train-outgoing_webhooks"
-    bullet_train-outgoing_webhooks-core:
-      git: "bullet-train-co/bullet_train-outgoing_webhooks-core"
     bullet_train-scope_questions:
-      git: "bullet-train-co/bullet_train-scope_questions"
+      git: "bullet-train-co/bullet_train-core"
     bullet_train-scope_validator:
-      git: "bullet-train-co/bullet_train-scope_validator"
+      git: "bullet-train-co/bullet_train-core"
     bullet_train-sortable:
-      git: "bullet-train-co/bullet_train-sortable"
+      git: "bullet-train-co/bullet_train-core"
       npm: "@bullet-train/bullet-train-sortable"
     bullet_train-super_scaffolding:
       git: "bullet-train-co/bullet_train-super_scaffolding"
     bullet_train-super_load_and_authorize_resource:
-      git: "bullet-train-co/bullet_train-super_load_and_authorize_resource"
+      git: "bullet-train-co/bullet_train-core"
     bullet_train-themes:
-      git: "bullet-train-co/bullet_train-themes"
-    bullet_train-themes-base:
-      git: "bullet-train-co/bullet_train-themes-base"
+      git: "bullet-train-co/bullet_train-core"
     bullet_train-themes-light:
-      git: "bullet-train-co/bullet_train-themes-light"
+      git: "bullet-train-co/bullet_train-core"
     bullet_train-themes-tailwind_css:
-      git: "bullet-train-co/bullet_train-themes-tailwind_css"
+      git: "bullet-train-co/bullet_train-core"

data/docs/billing/usage.md

@@ -0,0 +1,148 @@
+# Bullet Train Usage Limits
+
+Bullet Train provides a holistic method for defining model-based usage limits in your Rails application.
+
+## Installation
+
+### 1. Purchase Bullet Train Pro
+
+First, [purchase Bullet Train Pro](https://buy.stripe.com/aEU7vc4dBfHtfO89AV). Once you've completed this process, you'll be issued a private token for the Bullet Train Pro package server. The process is currently completed manually, so you may have to way a little to receive your keys.
+
+### 2. Install the Package
+
+### 2.1. Add the Private Ruby Gems
+
+You'll need to specify both Ruby gems in your `Gemfile`, since we have to specify a private source for both:
+
+```ruby
+source "https://YOUR_TOKEN_HERE@gem.fury.io/bullettrain" do
+  gem "bullet_train-billing"
+  gem "bullet_train-billing-stripe" # Or whichever billing provider you're using.
+  gem "bullet_train-billing-usage"
+end
+```
+
+### 2.2. Bundle Install
+
+```
+bundle install
+```
+
+### 2.3. Copy Database Migrations
+
+Use the following two commands on your shell to copy the required migrations into your local project:
+
+```
+cp `bundle show --paths | grep bullet_train-billing | sort | head -n 1`/db/migrate/* db/migrate
+cp `bundle show --paths | grep bullet_train-billing-stripe | sort | head -n 1`/db/migrate/* db/migrate
+```
+
+Note this is different than how many Rails engines ask you to install migrations. This is intentional, as we want to maintain the original timestamps associated with these migrations.
+
+### 2.4. Run Migrations
+
+```
+rake db:migrate
+```
+
+## Configuration 
+Usage limit configuration piggybacks on your [product definitions](/docs/billing/stripe.md) in `config/models/billing/products.yml`. It may help to make reference to the [default product definitions in the Bullet Train starter repository](https://github.com/bullet-train-co/bullet_train/blob/main/config/models/billing/products.yml).
+
+## Basic Usage Limits
+All limit definitions are organized by product, then by model, and finally by _verb_. For example, you can define the number of projects a team is allowed to have on a basic plan like so:
+
+```yaml
+basic:
+  prices:
+    # ...
+  limits:
+    projects:
+      have:
+        count: 3
+        enforcement: hard
+        upgradable: true
+```
+
+It's important to note that `have` is a special verb and represents the simple `count` of a given model on a `Team`. All _other_ verbs will be interpreted as time-based usage limits.
+
+### Options
+ - `enforcement` can be `hard` or `soft`. 
+   - When a `hard` limit is hit, the create form will be disabled.
+   - When a `soft` limit is hit, users are simply notified, but can continue to surpass the limit.
+ - `upgradable` indicates whether or not a user should be prompted to upgrade when they hit this limit.
+
+### Excluding Records from `have` Usage Limits
+All models have an overridable `billable` scope that includes all records by default. You can override this scope to ensure that certain records are filtered out from consideration when calculating usage limits. For example, we do the following on `Membership` to exclude removed team members from contributing to any limitation put on the number of team members, like so:
+
+```ruby
+scope :billable, -> { current_and_invited }
+```
+
+## Time-Based Usage Limits
+
+### Configuring Limits
+In addition to simple `have` usage limits, you can specify other types of usage limits by defining other verbs. For example, you can limit the number of blog posts that can be published in a 3-day period on the free plan like this:
+
+```yaml
+free:
+  limits:
+    blogs/posts:
+      publish:
+        count: 1
+        duration: 3
+        interval: days
+        enforcement: hard
+```
+
+ - `count` is how many times something can happen.
+ - `duration` and `interval` represent the time period we'll track for, e.g. "3 days" in this case. 
+ - Valid options for `interval` are anything you can append to an integer, e.g. `minutes`, `hours`, `days`, `weeks`, `months`, etc., both plural and singular.
+
+### Tracking Usage
+For these custom verbs, it's important to also instrument the application for tracking when these actions have taken place. For example:
+
+```ruby
+class Blogs::Post < ApplicationRecord
+  # ...
+
+  def publish!
+    update(published_at: Time.zone.now)
+    track_billing_usage(:published)
+  end
+end
+```
+
+If you'd like to increment the usage count by more than one, you can pass a quantity like `count: 5` to this call.
+
+### Cycling Trackers Regularly
+We include a Rake task you'll need to run on a regular basis in order to cycle the usage trackers that are created at a `Team` level. By default, you should probably run this every five minutes:
+
+```
+rake billing:cycle_usage_trackers
+```
+
+## Checking Usage Limits
+
+### Checking Basic Limits
+For basic `have` limits, forms generated by Super Scaffolding will be automatically disabled when a `hard` limit has been hit. Index views will also alert users to a limit being hit or broken for both `hard` and `soft` limits.
+
+> If your Bullet Train application scaffolding predates this feature, you can reference the newest Tangible Things [index template](https://github.com/bullet-train-co/bullet_train-super_scaffolding/blob/main/app/views/account/scaffolding/completely_concrete/tangible_things/_index.html.erb) and [form template](https://github.com/bullet-train-co/bullet_train-super_scaffolding/blob/main/app/views/account/scaffolding/completely_concrete/tangible_things/_form.html.erb) to see how we're using the `shared/limits/index` and `shared/limits/form` partials to present and enforce usage limits, and copy this usage in your own views.
+
+### Checking Time-Based Limits
+To make decisions based on or enforce time-based limits in your views and controllers, you can use the `current_limits` helper like this:
+
+```
+current_limits.can?(:publish, Blogs::Post)
+```
+
+(You can also pass quantities like `count: 5` as an option.)
+
+#### Presenting an Error
+
+If you're checking on this in a controller before taking an action and you want to present an error to the user based on their usage, you can redirect with this special flash error message key:
+
+```
+flash[:error] = :create_limit
+redirect_to [:account, @post]
+```
+> TODO This technically works but needs to be redone. Too limited.

data/lib/bullet_train/version.rb

@@ -1,3 +1,3 @@
 module BulletTrain
-  VERSION = "1.1.7"
+  VERSION = "1.1.10"
 end

data/lib/colorizer.rb

@@ -21,7 +21,7 @@ module Colorizer
     r = l
     g = l
     b = l
-    v = l <= 0.5 ? (l * (1.0 + sl)) : (l + sl - l * sl)
+    v = (l <= 0.5) ? (l * (1.0 + sl)) : (l + sl - l * sl)
     if v > 0
       m = l + l - v
       sv = (v - m) / v

data/lib/tasks/bullet_train_tasks.rake

@@ -97,17 +97,18 @@ namespace :bullet_train do
 
     if gem
       details = framework_packages[gem]
+      package = details[:git].split("/").last
 
       puts "OK! Let's work on `#{gem}` together!".green
       puts ""
 
-      if File.exist?("local/#{gem}")
-        puts "We found the repository in `local/#{gem}`. We will try to use what's already there.".yellow
+      if File.exist?("local/#{package}")
+        puts "We found the repository in `local/#{package}`. We will try to use what's already there.".yellow
         puts ""
 
         # Adding these flags enables us to execute git commands in the gem from our starter repo.
-        work_tree_flag = "--work-tree=local/#{gem}"
-        git_dir_flag = "--git-dir=local/#{gem}/.git"
+        work_tree_flag = "--work-tree=local/#{package}"
+        git_dir_flag = "--git-dir=local/#{package}/.git"
 
         git_status = `git #{work_tree_flag} #{git_dir_flag} status`
         unless git_status.match?("nothing to commit, working tree clean")
@@ -119,7 +120,7 @@ namespace :bullet_train do
         current_branch = `git #{work_tree_flag} #{git_dir_flag} branch`.split("\n").select { |branch_name| branch_name.match?(/^\*\s/) }.pop.gsub(/^\*\s/, "")
         unless current_branch == "main"
           puts "Previously on #{current_branch}.".blue
-          puts "Switching local/#{gem} to main branch.".blue
+          puts "Switching local/#{package} to main branch.".blue
           stream("git #{work_tree_flag} #{git_dir_flag} checkout main")
         end
 
@@ -127,7 +128,7 @@ namespace :bullet_train do
         stream("git #{work_tree_flag} #{git_dir_flag} pull origin main")
       else
         # Use https:// URLs when using this task in Gitpod.
-        stream "git clone #{`whoami`.chomp == "gitpod" ? "https://github.com/" : "git@github.com:"}#{details[:git]}.git local/#{gem}"
+        stream "git clone #{(`whoami`.chomp == "gitpod") ? "https://github.com/" : "git@github.com:"}#{details[:git]}.git local/#{package}"
       end
 
       stream("git #{work_tree_flag} #{git_dir_flag} fetch")
@@ -141,24 +142,27 @@ namespace :bullet_train do
         stream("git #{work_tree_flag} #{git_dir_flag} checkout #{input}")
       end
 
+      glob = if package == "bullet_train-core"
+        ", glob: \"#{gem}/#{gem}.gemspec\""
+      end
+
       puts ""
       puts "Now we'll try to link up that repository in the `Gemfile`.".blue
-      if `cat Gemfile | grep "gem \\\"#{gem}\\\", path: \\\"local/#{gem}\\\""`.chomp.present?
+      if `cat Gemfile | grep "gem \\\"#{gem}\\\", path: \\\"local/#{package}\\\""`.chomp.present?
         puts "This gem is already linked to a checked out copy in `local` in the `Gemfile`.".green
       elsif `cat Gemfile | grep "gem \\\"#{gem}\\\","`.chomp.present?
         puts "This gem already has some sort of alternative source configured in the `Gemfile`.".yellow
         puts "We can't do anything with this. Sorry! We'll proceed, but you have to link this package yourself.".red
       elsif `cat Gemfile | grep "gem \\\"#{gem}\\\""`.chomp.present?
         puts "This gem is directly present in the `Gemfile`, so we'll update that line.".green
-
         text = File.read("Gemfile")
-        new_contents = text.gsub(/gem "#{gem}"/, "gem \"#{gem}\", path: \"local/#{gem}\"")
+        new_contents = text.gsub(/gem "#{gem}"/, "gem \"#{gem}\", path: \"local/#{package}\"#{glob}")
         File.open("Gemfile", "w") { |file| file.puts new_contents }
       else
         puts "This gem isn't directly present in the `Gemfile`, so we'll add it temporarily.".green
         File.open("Gemfile", "a+") { |file|
           file.puts
-          file.puts "gem \"#{gem}\", path: \"local/#{gem}\" # Added by \`bin/develop\`."
+          file.puts "gem \"#{gem}\", path: \"local/#{package}\"#{glob} # Added by `bin/develop`."
         }
       end
 
@@ -172,7 +176,7 @@ namespace :bullet_train do
 
       puts ""
       puts "OK, we're opening that package in your IDE, `#{ENV["IDE"] || "code"}`. (You can configure this with `export IDE=whatever`.)".blue
-      `#{ENV["IDE"] || "code"} local/#{gem}`
+      `#{ENV["IDE"] || "code"} local/#{package}`
 
       puts ""
       if details[:npm]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 1.1.10
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-18 00:00:00.000000000 Z
+date: 2022-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bullet_train-routes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: devise
   requirement: !ruby/object:Gem::Requirement
@@ -475,6 +489,7 @@ files:
 - app/javascript/controllers/form_controller.js
 - app/javascript/controllers/index.js
 - app/javascript/controllers/mobile_menu_controller.js
+- app/javascript/controllers/select_all_controller.js
 - app/javascript/controllers/text_toggle_controller.js
 - app/javascript/electron/index.js
 - app/javascript/index.js
@@ -611,6 +626,7 @@ files:
 - docs/action-models.md
 - docs/authentication.md
 - docs/billing/stripe.md
+- docs/billing/usage.md
 - docs/desktop.md
 - docs/field-partials.md
 - docs/field-partials/buttons.md