bullet_train 1.0.40 → 1.0.45

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d8dd0b6a816a73fcf98800e8416fadbbe71bf5836657a1b4344a8cf85d9f4cb
-  data.tar.gz: 2a92723e1cf1bdf01be90564f85dd45d0168a6ef834c2b244c98bd74b62b7e4a
+  metadata.gz: 041e2b16ba7fe195c4622eca9f52ba3f2ece36e2ca4990e81091dcd7dce77f67
+  data.tar.gz: 4343cfb1d33be84c52dd412e335d15928ad13afb9d8a95eddbc41b751452c335
 SHA512:
-  metadata.gz: 7365104ebdbd0382bb2e040342c6ee83848c60fce20c4be6a1ababf0514e1f482ffe8c9fa5f07e717321b02051d434da754ef54b2d69258694a5545be4d60e43
-  data.tar.gz: b0e7f1cc4aa3230e8a626700ef856806e45d9e09c003be4ad642a4dd132fe1499d92c5cde8eaca8a2b31f75045a056cbfaa16e5023370ceb42240a9e0f606868
+  metadata.gz: fa1d5423f1a3b3ab31ac94b2c75b6d298b9c0fb670f70178a2aec8e8638e9adaf07d3e8c77a2bb0e99edcc79961407058cbf0807a7972fbc50c08e008312de45
+  data.tar.gz: 7875607106a2cb2932a30a537717ac947e62121709a0389c2144be1f4c39366dbd799d5286d2548f8d2b513136992e1b526f5a66782eea4aebea0137ce2c3c9f

data/app/views/layouts/mailer.html.erb

@@ -4,6 +4,366 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
     <title>Welcome to <%= t('application.name') %>!</title>
+    <% # TODO This is not what we want to do long-term. Would love to see this powered by Tailwind CSS. %>
+    <style type="text/css">
+      *:not(br):not(tr):not(html) {
+        font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;
+        box-sizing: border-box;
+      }
+
+      body {
+        width: 100% !important;
+        height: 100%;
+        margin: 0;
+        line-height: 1.4;
+        background-color: #F6F7F8;
+        color: #3E4B5B;
+        font-size: 16px;
+        -webkit-text-size-adjust: none;
+      }
+
+      p,
+      ul,
+      ol,
+      blockquote {
+        line-height: 1.4;
+        text-align: left;
+      }
+
+      a {
+        color: #047BF8;
+      }
+
+      a img {
+        border: none;
+      }
+      /* Layout ------------------------------ */
+
+      .email-wrapper {
+        width: 100%;
+        margin: 0;
+        padding: 0;
+        background-color: #F6F7F8;
+      }
+
+      .email-content {
+        width: 100%;
+        margin: 0;
+        padding: 0;
+      }
+      /* Masthead ----------------------- */
+
+      .email-masthead {
+        padding: 25px 0;
+        text-align: center;
+      }
+
+      .email-masthead_logo {
+        width: 94px;
+      }
+
+      .email-masthead_name {
+        font-size: 16px;
+        /*font-weight: bold;*/
+        color: #bbbfc3;
+        text-decoration: none;
+        /*text-shadow: 0 1px 0 white;*/
+      }
+      /* Body ------------------------------ */
+
+      .email-body {
+        width: 100%;
+        margin: 0;
+        padding: 0;
+        border-top: 1px solid #EDEFF2;
+        border-bottom: 1px solid #EDEFF2;
+        background-color: #FFFFFF;
+
+      }
+
+      .email-body_inner {
+        width: 570px;
+        margin: 0 auto;
+        padding: 0;
+        background-color: #FFFFFF;
+      }
+
+      .email-footer {
+        width: 570px;
+        margin: 0 auto;
+        padding: 0;
+        text-align: center;
+      }
+
+      .email-footer p {
+        color: #AAAAAA;
+      }
+
+      .body-action {
+        width: 100%;
+        margin: 30px auto;
+        padding: 0;
+        text-align: center;
+      }
+
+      .body-sub {
+        margin-top: 25px;
+        padding-top: 25px;
+        border-top: 1px solid #EDEFF2;
+      }
+
+      .content-cell {
+        padding: 35px;
+      }
+
+      .preheader {
+        display: none !important;
+      }
+      /* Attribute list ------------------------------ */
+
+      .attributes {
+        margin: 0 0 21px;
+      }
+
+      .attributes_content {
+        background-color: #EDEFF2;
+        padding: 16px;
+      }
+
+      .attributes_item {
+        padding: 0;
+      }
+      /* Related Items ------------------------------ */
+
+      .related {
+        width: 100%;
+        margin: 0;
+        padding: 25px 0 0 0;
+      }
+
+      .related_item {
+        padding: 10px 0;
+        color: #3E4B5B;
+        font-size: 15px;
+        line-height: 18px;
+      }
+
+      .related_item-title {
+        display: block;
+        margin: .5em 0 0;
+      }
+
+      .related_item-thumb {
+        display: block;
+        padding-bottom: 10px;
+      }
+
+      .related_heading {
+        border-top: 1px solid #EDEFF2;
+        text-align: center;
+        padding: 25px 0 10px;
+      }
+      /* Discount Code ------------------------------ */
+
+      .discount {
+        width: 100%;
+        margin: 0;
+        padding: 24px;
+        background-color: #EDEFF2;
+        border: 2px dashed #9BA2AB;
+      }
+
+      .discount_heading {
+        text-align: center;
+      }
+
+      .discount_body {
+        text-align: center;
+        font-size: 15px;
+      }
+      /* Social Icons ------------------------------ */
+
+      .social {
+        width: auto;
+      }
+
+      .social td {
+        padding: 0;
+        width: auto;
+      }
+
+      .social_icon {
+        height: 20px;
+        margin: 0 8px 10px 8px;
+        padding: 0;
+      }
+      /* Data table ------------------------------ */
+
+      .purchase {
+        width: 100%;
+        margin: 0;
+        padding: 35px 0;
+      }
+
+      .purchase_content {
+        width: 100%;
+        margin: 0;
+        padding: 25px 0 0 0;
+      }
+
+      .purchase_item {
+        padding: 10px 0;
+        color: #3E4B5B;
+        font-size: 15px;
+        line-height: 18px;
+      }
+
+      .purchase_heading {
+        padding-bottom: 8px;
+        border-bottom: 1px solid #EDEFF2;
+      }
+
+      .purchase_heading p {
+        margin: 0;
+        color: #9BA2AB;
+        font-size: 12px;
+      }
+
+      .purchase_footer {
+        padding-top: 15px;
+        border-top: 1px solid #EDEFF2;
+      }
+
+      .purchase_total {
+        margin: 0;
+        text-align: right;
+        /*font-weight: bold;*/
+        color: #3E4B5B;
+      }
+
+      .purchase_total--label {
+        padding: 0 15px 0 0;
+      }
+      /* Utilities ------------------------------ */
+
+      .align-right {
+        text-align: right;
+      }
+
+      .align-left {
+        text-align: left;
+      }
+
+      .align-center {
+        text-align: center;
+      }
+      /*Media Queries ------------------------------ */
+
+      @media only screen and (max-width: 600px) {
+        .email-body_inner,
+        .email-footer {
+          width: 100% !important;
+        }
+      }
+
+      @media only screen and (max-width: 500px) {
+        .button {
+          width: 100% !important;
+        }
+      }
+      /* Buttons ------------------------------ */
+
+      .button {
+        background-color: #047BF8;
+        border-top: 10px solid #047BF8;
+        border-right: 18px solid #047BF8;
+        border-bottom: 10px solid #047BF8;
+        border-left: 18px solid #047BF8;
+        display: inline-block;
+        color: #FFF;
+        text-decoration: none;
+        border-radius: 3px;
+        -webkit-text-size-adjust: none;
+        line-height: 22px;
+        font-size: 16px;
+        color: #FFF;
+      }
+
+      .button--link {
+        background-color: transparent;
+        border-top: 10px solid transparent;
+        border-right: 18px solid transparent;
+        border-bottom: 10px solid transparent;
+        border-left: 18px solid transparent;
+        display: inline-block;
+        color: #047BF8;
+        text-decoration: underline;
+        border-radius: 3px;
+        /*box-shadow: 0 2px 3px rgba(0, 0, 0, 0.16);*/
+        -webkit-text-size-adjust: none;
+      }
+
+      .button--green {
+        background-color: #22BC66;
+        border-top: 10px solid #22BC66;
+        border-right: 18px solid #22BC66;
+        border-bottom: 10px solid #22BC66;
+        border-left: 18px solid #22BC66;
+      }
+
+      .button--red {
+        background-color: #FF6136;
+        border-top: 10px solid #FF6136;
+        border-right: 18px solid #FF6136;
+        border-bottom: 10px solid #FF6136;
+        border-left: 18px solid #FF6136;
+      }
+      /* Type ------------------------------ */
+
+      h1 {
+        margin-top: 0;
+        color: #3E4B5B;
+        font-size: 19px;
+        font-weight: bold;
+        text-align: left;
+      }
+
+      h2 {
+        margin-top: 0;
+        color: #3E4B5B;
+        font-size: 16px;
+        font-weight: bold;
+        text-align: left;
+      }
+
+      h3 {
+        margin-top: 0;
+        color: #3E4B5B;
+        font-size: 14px;
+        font-weight: bold;
+        text-align: left;
+      }
+
+      p {
+        margin-top: 0;
+        color: #3E4B5B;
+        font-size: 16px;
+        line-height: 1.5em;
+        text-align: left;
+      }
+
+      p.sub {
+        font-size: 12px;
+      }
+
+      p.center {
+        text-align: center;
+      }
+
+      .body-action.less-footer {
+        margin-bottom: 10px;
+      }
+    </style>
   </head>
   <body>
     <% if content_for? :preheader %>

data/docs/indirection.md

@@ -1,3 +1,63 @@
-# Overriding Framework Defaults
+# Dealing with Indirection
 
-> TODO This section needs to be written.
+## The Problem with Indirection
+
+In software development, indirection is everywhere and takes many forms.
+
+For example, in vanilla Rails development, you introduce a type of indirection when you extract a button label out of a view file and use the `t` helper to render the string from a translation YAML file. In the future, when another developer goes to update the button label, they will first open the view, they'll see `t(".submit")` and then have to reason a little bit about which translation file they need to open up in order to update that label.
+
+Our goal in Bullet Train is to improve developer experience, not reduce it, so it was important that along with any instances of indirection we were introducing, we also included new tooling to ensure it was never a burden to developers. Thankfully, in practice we found that some of this new tooling improves even layers of indirection that have always been with us in Rails development.
+
+## Figuring Out Class Locations
+
+Most of Bullet Train's functionality is distributed via Ruby gems, not the starter template. As a result, the power of fuzzy searching in your IDE is more limited. For example, `app/controllers/account/users_controller.rb` includes its base functionality from a concern called `Account::Users::ControllerBase`. If you try to fuzzy search for it, you'll quickly find the module isn't included in your application repository. However, you can quickly figure out which Ruby gem is providing that concern and inspect it's source by running:
+
+```
+bin/resolve Account::Users::ControllerBase --open
+```
+
+If you need to modify behavior in these framework-provided classes or modules, see the documentation for [Overriding Framework Defaults](/docs/overriding.md).
+
+## Solving Indirection in Views
+
+### Resolving Partial Paths with `bin/resolve`
+
+Even in vanilla Rails development, when you're looking at a view file, the path you see passed to a `render` call isn't the actual file name of the partial that will be rendered. This is even more true in Bullet Train where certain partial paths are [magically served from theme gems](/docs/themes.md).
+
+`bin/resolve` makes it easy to figure out where where a partial is being served from:
+
+```
+$ bin/resolve shared/box
+```
+
+### Exposing Rendered Views with Xray
+
+> TODO Is this still true in Rails 7? Does it not do something like this by default now?
+
+If you're looking at a rendered view in the browser, it can be hard to know which file to open in order to make a change. To help, Bullet Train includes [Xray](https://github.com/brentd/xray-rails) by default, so you can right click on any element you see, select "Inspect Element", and you'll see comments in the HTML source telling you which file is powering a particular portion of the view, like this:
+
+```
+<!--XRAY START 90 /Users/andrewculver/.rbenv/versions/3.1.1/lib/ruby/gems/3.1.0/gems/bullet_train-themes-light-1.0.10/app/views/themes/light/workflow/_box.html.erb-->
+```
+
+Note that in the example above, the view in question isn't actually coming from the application repository. Instead, it's being included from the `bullet_train-themes-light` package. For instructions on how to customize it, see [Overriding the Framework](/docs/override).
+
+### Drilling Down on Translation Keys
+
+Even in vanilla Rails applications, extracting strings from view files into I18N translation YAML files introduces a layer of indirection. Bullet Train tries to improve the resulting DX with a couple tools that make it easier to figure out where a translation you see in your browser is coming from.
+
+#### Show Translation Keys in the Browser with `?show_locales=true`
+
+You can see the full translation key of any string on the page by adding `?show_locales=true` to the URL.
+
+#### Log Translation Keys to the Console with `?log_locales=true`
+
+You can also log all the translation key for anything being rendered to the console by adding `?log_locales=true` to the request URL. This can make it easier to copy and paste translation keys for strings that are rendered in non-selectable UI elements.
+
+#### Resolving Translation Keys with `bin/resolve`
+
+Once you have the full I18N translation key, you can use `bin/resolve` to figure out which package and file it's coming from. At that point, if you need to customize it, you can also use the `--eject` option to copy the  the framework for customization in your local application:
+
+```
+$ bin/resolve en.account.onboarding.user_details.edit.header --eject --open
+```

data/docs/overriding.md

@@ -1,53 +1,21 @@
-# Dealing with Indirection
+# Overriding Framework Defaults
 
-## The Problem with Indirection
+Most of Bullet Train's functionality is distributed via Ruby gems, not the starter template. We provide the `bin/resolve` tool to help developers figure out which Ruby gem packages are providing which classes, modules, views, and translations, and its usage is covered in the [Dealing With Indirection](/docs/indirection.md) section of the documentation.
 
-In software development, indirection is everywhere and takes many forms.
+However, sometimes you will need to do more than just understand where something is coming from and how it works in the framework. In some situations, you'll specifically want to change or override the default framework behavior. The primary workflow for doing this is much the same as the `bin/resolve` workflow for dealing with indirection in the first place, however, instead of just using `--open` to inspect the source of the framework-provided file, you can add `--eject` to have that file copied into the local repository. From there, it will act as a replacement for the framework-provided file, and you can modify the behavior as needed.
 
-For example, in vanilla Rails development, you introduce a type of indirection when you extract a button label out of a view file and use the `t` helper to render the string from a translation YAML file. In the future, when another developer goes to update the button label, they will first open the view, they'll see `t(".submit")` and then have to reason a little bit about which translation file they need to open up in order to update that label.
+## The Important Role of Active Support Concerns in Bullet Train Customization
 
-Our goal in Bullet Train is to improve developer experience, not reduce it, so it was important that along with any instances of indirection we were introducing, we also included new tooling to ensure it was never a burden to developers. Thankfully, in practice we found that some of this new tooling improves even layers of indirection that have always been with us in Rails development.
+When it comes to object-oriented classes, wholesale copying framework files into your local repository just to be able to modify their behavior or extend them would quickly be untenable, as your app would no longer see upstream updates that would otherwise be incorporated into your application via `bundle update`.
 
-## Solving Indirection in Views
-
-### Resolving Partial Paths with `bin/resolve`
-
-Even in vanilla Rails development, when you're looking at a view file, the path you see passed to a `render` call isn't the actual file name of the partial that will be rendered. This is even more true in Bullet Train where certain partial paths are [magically served from theme gems](/docs/themes.md).
-
-`bin/resolve` makes it easy to figure out where where a partial is being served from:
+For this reason, common points of extension like framework-provided models and controllers actually exist as a kind of "stub" in the local repository, but include their base functionality from framework-provided concerns, like so:
 
 ```
-$ bin/resolve shared/box
-```
-
-### Exposing Rendered Views with Xray
+class User < ApplicationRecord
+  include Users::Core
 
-> TODO Is this still true in Rails 7? Does it not do something like this by default now?
-
-If you're looking at a rendered view in the browser, it can be hard to know which file to open in order to make a change. To help, Bullet Train includes [Xray](https://github.com/brentd/xray-rails) by default, so you can right click on any element you see, select "Inspect Element", and you'll see comments in the HTML source telling you which file is powering a particular portion of the view, like this:
-
-```
-<!--XRAY START 90 /Users/andrewculver/.rbenv/versions/3.1.1/lib/ruby/gems/3.1.0/gems/bullet_train-themes-light-1.0.10/app/views/themes/light/workflow/_box.html.erb-->
+  # ...
+end
 ```
 
-Note that in the example above, the view in question isn't actually coming from the application repository. Instead, it's being included from the `bullet_train-themes-light` package. For instructions on how to customize it, see [Overriding the Framework](/docs/override).
-
-### Drilling Down on Translation Keys
-
-Even in vanilla Rails applications, extracting strings from view files into I18N translation YAML files introduces a layer of indirection. Bullet Train tries to improve the resulting DX with a couple tools that make it easier to figure out where a translation you see in your browser is coming from.
-
-#### Show Translation Keys in the Browser with `?show_locales=true`
-
-You can see the full translation key of any string on the page by adding `?show_locales=true` to the URL.
-
-#### Log Translation Keys to the Console with `?log_locales=true`
-
-You can also log all the translation key for anything being rendered to the console by adding `?log_locales=true` to the request URL. This can make it easier to copy and paste translation keys for strings that are rendered in non-selectable UI elements.
-
-#### Resolving Translation Keys with `bin/resolve`
-
-Once you have the full I18N translation key, you can use `bin/resolve` to figure out which package and file it's coming from. At that point, if you need to customize it, you can also use the `--eject` option to copy the  the framework for customization in your local application:
-
-```
-$ bin/resolve en.account.onboarding.user_details.edit.header --eject --open
-```
+In this case, for most customizations or extensions you would want to make, you don't need to eject `Users::Core` into your local repository. Instead, you can simply re-define methods from that concern in your local `User` model after the inclusion of the concern.

data/docs/super-scaffolding.md

@@ -154,7 +154,7 @@ rails g migration add_lead_to_projects lead:references
 Then, to add the field, we specify the following:
 
 ```
-bin/super-scaffold crud-field Project lead_id:super_select[class_name=Membership]
+bin/super-scaffold crud-field Project lead_id:super_select{class_name=Membership}
 rake db:migrate
 ```
 
@@ -199,7 +199,7 @@ rails g model Projects::AppliedTag project:references tag:references
 We're not going to scaffold this model with the typical `crud` scaffolder, but some preparation is needed before we can use it with the `crud-field` scaffolder, so we need to do the following:
 
 ```
-bin/super-scaffold join-model Projects::AppliedTag project_id[class_name=Project] tag_id[class_name=Projects::Tag]
+bin/super-scaffold join-model Projects::AppliedTag project_id{class_name=Project} tag_id{class_name=Projects::Tag}
 ```
 
 All we're doing here is specifying the name of the join model, and the two attributes and class names of the models it joins. Note again that we specify the `_id` suffix on both of the attributes.
@@ -207,7 +207,7 @@ All we're doing here is specifying the name of the join model, and the two attri
 Now that the join model has been prepared, we can use the `crud-field` scaffolder to create the multi-select field:
 
 ```
-bin/super-scaffold crud-field Project tag_ids:super_select[class_name=Projects::Tag]
+bin/super-scaffold crud-field Project tag_ids:super_select{class_name=Projects::Tag}
 rake db:migrate
 ```
 

data/lib/bullet_train/version.rb

@@ -1,3 +1,3 @@
 module BulletTrain
-  VERSION = "1.0.40"
+  VERSION = "1.0.45"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train
 version: !ruby/object:Gem::Version
-  version: 1.0.40
+  version: 1.0.45
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-24 00:00:00.000000000 Z
+date: 2022-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -497,7 +497,6 @@ files:
 - config/locales/en/onboarding/user_email.en.yml
 - config/locales/en/roles.en.yml
 - config/locales/en/teams.en.yml
-- config/locales/en/user_mailer.en.yml
 - config/locales/en/users.en.yml
 - config/routes.rb
 - db/migrate/20161115160419_devise_create_users.rb

data/config/locales/en/user_mailer.en.yml

@@ -1,36 +0,0 @@
-en:
-  user_mailer:
-    signature: &SIGNATURE
-      html:
-        <p>If you have any questions, please don't hesitate to <a href="mailto:%{support_email}">send us an email</a>.</p>
-        <p>Thanks,<br>Bullet Train, Inc.</p>
-    invited:
-      subject: Invitation to join %{team_name} on Bullet Train!
-      preview: '%{inviter_name} has sent you this invitation.'
-      heading: You're invited!
-      body:
-        html:
-          <p>
-            %{inviter_name} has invited you to join %{team_name} on Bullet Train.
-            You can join %{team_name} by clicking the button below.
-          </p>
-      cta:
-        label: Join %{team_name}
-      signature:
-        <<: *SIGNATURE
-    welcome:
-      subject: Welcome to the Bullet Train demo!
-      preview: This is the default Bullet Train welcome email. Check out the layout!
-      heading: Welcome to Bullet Train!
-      body:
-        html:
-          <p>This is the default welcome email for Bullet Train!</p>
-          <p>If you have any questions about Bullet Train, just reply to this email!</p>
-          <p>It was important to us that Bullet Train applications have a good looking, branded email template by default.</p>
-          <p>Thankfully our friends at <a href="https://postmarkapp.com">Postmark</a> made the foundation of this email template <a href="https://github.com/wildbit/postmark-templates">freely available</a>. From there, we've customized it slightly to better match the default Bullet Train look-and-feel.</p>
-      cta:
-        heading: What's next?
-        body: You can use the following link to always return to your Bullet Train account dashboard.
-        label: View Your Account Dashboard
-      signature:
-        <<: *SIGNATURE