bullet_train 1.0.35 → 1.0.38

data/docs/themes.md

@@ -0,0 +1,101 @@
+# Themes
+
+Bullet Train has a theme subsystem designed to allow you the flexibility to either extend or completely replace the stock “Light” and “Clean” UI templates.
+
+## Inheritance Structure
+
+To reduce duplication of code across themes, Bullet Train implements an inheritance structure. For example, the official Bullet Train themes are structured hierarchically like so:
+
+- “Base”
+  - “Bootstrap” (in the future)
+    - “Clean” (in the future)
+  - “Tailwind CSS”
+    - “Light”
+
+Any component partials that can be shared are pushed up the inheritance structure. For example, [Bullet Train's library of field partials](/docs/field-partials.md) provide a good example of this, illustrating the power of the approach we’ve taken here:
+
+ - The most general field styling varies substantially between Tailwind CSS and Bootstrap, so a `_field.html.erb` component partial exists in both the foundational “Tailwind CSS” and “Bootstrap” themes, but also a further customized version exists in themes like “Light”.
+ - However, many concrete field types like `_text_field.html.erb` and `_phone_field.html.erb` leverage `_field.html.erb`, and they themselves are completely framework agnostic as a result. These partials can live in the shared “Base” theme.
+
+At run-time, this means:
+
+- When rendering `_text_field.html.erb`, it renders from “Base”.
+- However, when `_text_field.html.erb` references `_field.html.erb`, that renders from “Light”.
+- If you extend “Light” and override `_field.html.erb`, rendering `_text_field.html.erb` will now use your theme’s `_field.html.erb`.
+
+## Theme Component Usage
+
+To use a theme component, simply include it from "within" `shared` like so:
+
+```
+<%= render 'shared/fields/text_field', method: :text_field_value %>
+```
+
+We say "within" because while a `shared` view partial directory does exist, the referenced `shared/fields/_text_field.html.erb` doesn't actually exist within it. Instead, the theme engine picks up on `shared` and also works its way through the theme directories to find the appropriate match.
+
+### Dealing with Indirection
+
+This small piece of indirection buys us an incredible amount of power in building and extending themes, but as with any indirection, it could potentially come at the cost of developer experience. That's why Bullet Train includes additional tools for smoothing over this experience. Be sure to read the section on [dealing with indirection].
+
+
+## Theme Configuration
+
+You can specify the theme you’d like to use and its inheritance structure in `app/helpers/theme_helper.rb`. The code there is well commented to help you.
+
+## Theme Structure
+
+Themes are represented in a few places. Taking “Light” as an example, we have:
+
+- A directory of theme-specific component partials in `app/views/themes/light`, including a layout ERB template.
+- A theme-specific stylesheet in `app/javascript/stylesheets/light/application.scss`.
+- A theme-specific pack in `app/javascript/packs/light.js`. You’ll see there that the actual JavaScript dependencies and code are shared across all themes. The whole purpose of this theme-specific pack is to serve up the theme-specific stylesheet.
+- Theme-specific logos and images in `app/javascript/images/light`.
+
+## Adding a New Theme
+
+To extend the “Light” theme in a new theme called “Tokyo”, we would:
+
+1. Copy `app/javascript/packs/light.js` to `app/javascript/packs/tokyo.js` and update references to `light` therein to `tokyo`.
+2. Copy `app/views/themes/light/layouts` to `app/views/themes/tokyo/layouts` and update references to `light` in the contained files to `tokyo`. It's possible this is too much duplication, but in practice most people want to customize these two layouts in their custom themes.
+3. Create a new file at `app/javascript/stylesheets/tokyo/application.scss`. To start just add `@import "../light/application";` at the top, which represents the fact that “Tokyo” extends “Light”. Any custom styles can be added below that.
+4. Add `"tokyo"` as the first item in the `THEME_DIRECTORY_ORDER` array in `app/helpers/theme_helper.rb`.
+
+You should be good to go! We'll try to add a generator for this in the future.
+
+## Additional Guidance and Principles
+
+### Should you extend or replace?
+
+For most development projects, the likely best path for customizing the UI is to extend “Light” or another complete Bullet Train theme. It’s difficult to convey how many hours have gone into making the Bullet Train themes complete and coherent from end to end. Every type of field partial, all the third-party libraries, all the responsiveness scenarios, etc. It’s taken many hours and many invoices.
+
+Extending an existing theme is like retaining an option on shipping. By extending a theme that is already complete, you allow yourself to say “enough is enough” at a certain point and just living with some inherited defaults in exchange for shipping your product sooner. You can always do more UI work later, but it doesn’t look unpolished now!
+
+On the other hand, if you decide to try to build a theme from the ground up, you risk getting to that same point, but not being able to stop because there are bits around the edges that don’t feel polished and cohesive.
+
+### Don’t reference theme component partials directly, even within the same theme!
+
+#### ❌ Don’t do this, even in theme partials:
+
+```
+<%= render "themes/light/box" do |p| %>
+  ...
+<% end %>
+```
+
+#### ✅ Instead, always do this:
+
+```
+<%= render "shared/box" do |p| %>
+  ...
+<% end %>
+```
+
+This allows the theme engine to resolve which theme in the inheritance chain to include the `box` partial from. For example:
+
+ - It might come from the “Light” theme today, but if you switch to the “Bold” theme later, it’ll can start pulling it from there.
+ - If you start extending “Light”, you can override its `box` implementation and your application will pick up the new customized version from your theme automatically.
+ - If (hypothetically) `box` became generalized and move into the parent “Tailwind CSS” theme, your application would pick it up from the appropriate place.
+
+### Let your designer name their theme.
+
+You're going to have to call your theme something and there are practical reasons to not call it something generic. If you're pursuing a heavily customized design, consider allowing the designer or designers who are creating the look-and-feel of your application to name their own masterpiece. Giving it a distinct name will really help differentiate things when you're ready to start introducing additional facets to your application or a totally new look-and-feel down the road.

data/docs/tunneling.md

@@ -0,0 +1,29 @@
+# HTTP Tunneling with ngrok
+
+Before your application can take advantage of features that depend on incoming webhooks, you'll need to setup an HTTP tunnel using a service like [ngrok](https://ngrok.com).
+
+## Use a Paid Plan
+
+You should specifically sign up for a paid account. Although ngrok offers a free plan, their $5/month paid plan will allow you to reserve a custom subdomain for reuse each time you spin up your tunnel. This is a critical productivity improvement, because in practice you'll end up configuring your tunnel URL in a bunch of different places like `config/application.yml` but also in external systems like when you [configure payment providers to deliver webhooks to you](docs/billing/stripe.md).
+
+## Usage
+
+Once you have ngrok installed, you can start your tunnel like so, replacing `your-subdomain` with whatever subdomain you reserved in your ngrok account:
+
+```
+ngrok http 3000 -subdomain=your-subdomain
+```
+
+## Updating Your Configuration
+
+Before your Rails application will accept connections on your tunnel hostname, you need to update `config/application.yml` with:
+
+```
+BASE_URL: https://your-subdomain.ngrok.io
+```
+
+You'll also need to restart your Rails server:
+
+```
+rails restart
+```

data/docs/upgrades.md

@@ -0,0 +1,69 @@
+# Upgrading Your Bullet Train Application
+
+## Upgrading the Framework
+
+The vast majority of Bullet Train's functionality is distributed via Ruby gems, so you can pull the latest updates by running `bundle update`.
+
+## Pulling Updates from the Starter Repository
+
+There are times when you'll want to pull updates from the starter repository into your local application. Thankfully, `git merge` provides us with the perfect tool for just that. You can simply merge the upstream Bullet Train repository into your local repository. If you haven’t tinkered with the starter repository defaults at all, then this should happen with no meaningful conflicts at all. Simply run your automated tests (including the comprehensive integration tests Bullet Train ships with) to make sure everything is still working as it was before.
+
+If you _have_ modified some starter repository defaults _and_ we also happened to update that same logic upstream, then pulling the most recent version of the starter repository should cause a merge conflict in Git. This is actually great, because Git will then give you the 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.
+
+### 1. Make sure you're working with a clean local copy.
+
+```
+git status
+```
+
+If you've got uncommitted or untracked files, you can clean them up with the following.
+
+```
+# ⚠️ This will destroy any uncommitted or untracked changes and files you have locally.
+git checkout .
+git clean -d -f
+```
+
+### 2. Fetch the latest and greatest from the Bullet Train repository.
+
+```
+git fetch starter-repo
+````
+
+### 3. Create a new "upgrade" branch off of your main branch.
+
+```
+git checkout main
+git checkout -b updating-starter-repo
+```
+
+### 4. Merge in the newest stuff from Bullet Train and resolve any merge conflicts.
+
+```
+git merge starter-repo/main
+```
+
+It's quite possible you'll get some merge conflicts at this point. No big deal! Just go through and resolve them like you would if you were integrating code from another developer on your team. We tend to comment our code heavily, but if you have any questions about the code you're trying to understand, let us know on Slack!
+
+```
+git diff
+git add -A
+git commit -m "Upgrading Bullet Train."
+```
+
+### 5. Run Tests.
+
+```
+rails test
+```
+
+### 6. Merge into `main` and delete the branch.
+
+```
+git checkout main
+git merge updating-starter-repo
+git push origin main
+git branch -d updating-starter-repo
+```
+
+Alternatively, if you're using GitHub, you can push the `updating-starter-repo` 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/webhooks/incoming.md

@@ -0,0 +1,3 @@
+# Incoming Webhooks
+
+> TODO This section needs to be written and should probably delegate a lot of details to the README of the [Bullet Train Incoming Webhooks repository](https://github.com/bullet-train-co/bullet_train-incoming_webhooks).

data/docs/webhooks/outgoing.md

@@ -0,0 +1,3 @@
+# Outgoing Webhooks
+
+> TODO This section needs to be written and should probably delegate a lot of details to the README of the [Bullet Train Outgoing Webhooks repository](https://github.com/bullet-train-co/bullet_train-outgoing_webhooks).

data/lib/bullet_train/version.rb

@@ -1,3 +1,3 @@
 module BulletTrain
-  VERSION = "1.0.35"
+  VERSION = "1.0.38"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train
 version: !ruby/object:Gem::Version
-  version: 1.0.35
+  version: 1.0.38
 platform: ruby
 authors:
 - Andrew Culver
@@ -535,6 +535,34 @@ files:
 - db/migrate/20210816072508_add_locale_to_teams.rb
 - db/migrate/20211020200855_add_doorkeeper_application_to_memberships.rb
 - db/migrate/20211027002944_add_doorkeeper_application_to_users.rb
+- docs/api.md
+- docs/authentication.md
+- docs/billing/stripe.md
+- docs/desktop.md
+- docs/field-partials.md
+- docs/field-partials/buttons.md
+- docs/field-partials/super-select.md
+- docs/font-awesome-pro.md
+- docs/getting-started.md
+- docs/heroku.md
+- docs/i18n.md
+- docs/index.md
+- docs/indirection.md
+- docs/modeling.md
+- docs/namespacing.md
+- docs/oauth.md
+- docs/onboarding.md
+- docs/permissions.md
+- docs/seeds.md
+- docs/super-scaffolding.md
+- docs/super-scaffolding/delegated-types.md
+- docs/teams.md
+- docs/testing.md
+- docs/themes.md
+- docs/tunneling.md
+- docs/upgrades.md
+- docs/webhooks/incoming.md
+- docs/webhooks/outgoing.md
 - lib/bullet_train.rb
 - lib/bullet_train/engine.rb
 - lib/bullet_train/resolver.rb