bullet_train 1.33.0 → 1.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46fec3f6437afa98558519d9d3c78c8d62ef76f98adf20489fa86fbdddea4360
-  data.tar.gz: f736adc2b99e130132e29ca2490b8b5769c3561f9cdf712f8a52f7cdd3d872ed
+  metadata.gz: f74254bfbcc983a2ed2fbdab69dbaa872dc49a86f5a73e7b8b43e7878f2e1ae4
+  data.tar.gz: b5bbc3302df6e353bd86535087317b562bbba274e943fed5b9edf0e47cb3a62e
 SHA512:
-  metadata.gz: 7cdafd0a4582cec14721c4363f8372639e232168eabd10dd4ead60876c157a18b445eb29049bf8bd4acaa3bbf216a24a04a9669c1a940013f65bdd490d9a8acf
-  data.tar.gz: 3892477bdaa2174461dae69f6b78e947460e7cb3b263c85b1c2d920ada30486d1c587e043f0e6429eb90db90fd920e81c5778242457c4369afd7123787b79c7e
+  metadata.gz: 544b025b243fc8f09b4e710258481715e6276e98a061f6256687aa90777ff88b15e9da2b17b29f485c49be5c78016797c7022ae9494f3503b313fa670f0b7666
+  data.tar.gz: 14c932887fdaf6c184da191f638be7b46f48cc18fd897f700a5b4c8646c804d21ad8ef4952af0c59e81349361777f8d384f1c1c7deeaaeb33d82d548b90e50d0

data/app/views/account/memberships/_membership.html.erb

@@ -1,7 +1,7 @@
 <tr data-id="<%= membership.id %>">
   <td class="px-6 py-4 whitespace-nowrap">
     <%= link_to [:account, membership], class: 'block flex items-center group hover:no-underline no-underline' do %>
-      <div class="flex-shrink-0 h-10 w-10">
+      <div class="shrink-0 h-10 w-10">
         <%= image_tag membership_profile_photo_url(membership), title: membership.label_string, class: 'h-10 w-10 rounded-full' %>
       </div>
 

data/app/views/account/memberships/_tombstones.html.erb

@@ -24,7 +24,7 @@
 
               <td class="px-6 py-4 whitespace-nowrap">
                 <%= link_to [:account, membership], class: 'block flex items-center group hover:no-underline no-underline' do %>
-                  <div class="flex-shrink-0 h-10 w-10">
+                  <div class="shrink-0 h-10 w-10">
                     <%= image_tag membership_profile_photo_url(membership), title: membership.label_string, class: 'h-10 w-10 rounded-full' %>
                   </div>
 

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

@@ -42,7 +42,7 @@
       >
 
         <% menu = capture do %>
-          <div class="flex items-center flex-shrink-0 p-4 bg-blue-700 md:rounded-tl-lg">
+          <div class="flex items-center shrink-0 p-4 bg-blue-700 md:rounded-tl-lg">
             <%= image_tag image_path("logo/logo.png"), class: 'h-5 w-auto mx-auto' %>
 
             <div class="lg:hidden absolute right-0">
@@ -171,6 +171,12 @@
                     <i class="fal fa-brackets-curly ti ti-view-list-alt"></i>
                   <% end %>
                 <% end %>
+
+                <%= render 'account/shared/menu/item', url: '/docs/contributing.md', label: 'Contributing' do |p| %>
+                  <% p.content_for :icon do %>
+                    <i class="fal fa-github-alt ti ti-github"></i>
+                  <% end %>
+                <% end %>
               <% end %>
 
               <%= render 'account/shared/menu/section', title: 'Accounts & Teams' do %>
@@ -353,11 +359,11 @@
             >
               <%= menu %>
             </div>
-            <div class="flex-shrink-0 w-14" aria-hidden="true"></div>
+            <div class="shrink-0 w-14" aria-hidden="true"></div>
           </div>
         </div>
 
-        <div class="hidden lg:flex lg:flex-shrink-0 overflow-y-auto bg-gradient-to-b from-primary-700 to-primary-800 dark:from-base-800 dark:to-base-800">
+        <div class="hidden lg:flex lg:shrink-0 overflow-y-auto bg-gradient-to-b from-primary-700 to-primary-800 dark:from-base-800 dark:to-base-800">
           <div class="w-64">
             <%= menu %>
           </div>

data/docs/contributing.md

@@ -0,0 +1,94 @@
+# Contributing to Bullet Train
+
+To contribute to Bullet Train there are two main repos that are involved:
+
+* [The starter repo](https://github.com/bullet-train-co/bullet_train) - This is the repo that you clone to start a new Bullet Train app.
+* [The `core` repo](https://github.com/bullet-train-co/bullet_train-core) - This is where all (OK, most) of the gems live.
+
+## Linking Ruby gems
+
+When working on bug fixes or new features it can be useful to use a local copy of the `core` gems instead of the published versions.
+You can do this in either the starter repo itself, or in a "downstream app" that has been created from the starter repo.
+
+We have a convenience script in the starter repo at `bin/hack` which helps get things setup for you.
+
+`bin/hack` supports two different models of organizing your filesystem for `core` development.
+
+1.  The "nested repo approach" - If you run `bin/hack` with no arguments it will clone the `core` repo into your project at `local/bullet_train-core`.
+    It will also attempt to open that repo in your editor/IDE.
+2.  The "peer repo approach" - If you already have the `core` repo cloned you can pass the `--link` option to `bin/hack` followed by a path to `core`.
+    For instance `bin/hack --link ../bullet_train-core`.
+
+In either case `bin/hack` will modify the `Gemfile` in your project and change the lines for all of the `bullet_train*` gems to point to a local copy.
+
+Lines that start like this:
+
+```ruby
+gem "bullet_train", BULLET_TRAIN_VERSION
+```
+
+Will become this:
+
+```ruby
+gem "bullet_train", path: "../bullet_train-core/bullet_train"
+```
+
+Once that's done you can start/restart your dev server and then chnages you make within your `core` repo will be reflected in your local app.
+
+## Linking Javascript packages
+
+If you need to make changes to any of the Javascript packages from the `core` gems the process is a little bit different.
+
+We use `yalc` to handle the details of making a local package available to your local app.
+
+First you need to go into the directory for the gem/package that you're working with, then build the JS package, and make it available to local projects using `yalc push`.
+(Don't worry, you're not pushing to anywhere other than your local dev environment.)
+
+So, if you're working with the `bullet_train-fields` JS package you'd do this:
+
+```
+cd bullet_train-core/bullet_train-fields
+yarn build
+yarn yalc push
+```
+
+After pushing you should see a line in your terminal that looks something like this:
+
+```
+@bullet-train/fields@1.32.0 published in store.
+```
+
+Next you can link that package into your local app or starter repo. (You'll be bouncing between the gem directory and your app directory, so it's convenient to use two different terminal sessions for this.)
+Go into your app or starter repo directory and then use `yalc link` to connect your local package.
+
+```
+cd bullet_train
+yarn yalc link @bullet-train/fields
+```
+
+Now your local app will be running with the JS code from your local copy.
+
+As you're making changes you can test them out in your local app by building and pushing the package again.
+
+So, for this example, back in the `bullet_train-core/bullet_train-fields` directory you can run:
+
+```
+yarn build; yarn yalc push
+```
+
+Now in addition to seeing a line about the package being published to the store, you should also seem some lines about it being pushed into your local app.
+
+```
+@bullet-train/fields@1.32.0 published in store.
+Pushing @bullet-train/fields@1.32.0 in /Users/jgreen/projects/bullet-train-co/bullet_train
+Package @bullet-train/fields@1.32.0 linked ==> /Users/jgreen/projects/bullet-train-co/bullet_train/node_modules/@bullet-train/fields
+```
+
+Each time that you rebuild and re-push the package the file watcher in your project (or starter repo) should notice the change and rebuild your assets.
+
+## Managing cross-repo pull requests
+
+Sometimes a particular change will require modifications to both the starter repo and the `core` repo. In these cases you should use the same branch
+name in both repos. That will allow CI to hook them together and run tests in the right way.
+
+Happy hacking!

data/docs/index.md

@@ -24,6 +24,8 @@
  - [Test Suite](/docs/testing.md)
  - [Magic Test: Point-and-Click Test Writing](https://github.com/bullet-train-co/magic_test) <i class="ti ti-new-window ml-2"></i>
  - [Application Options](/docs/application-options.md)
+ - [Application Hash](/docs/application-hash.md)
+ - [Contributing to Bullet Train](/docs/contributing.md)
 
 ## Accounts & Teams
  - [Authentication](/docs/authentication.md)

data/lib/bullet_train/version.rb

@@ -1,3 +1,3 @@
 module BulletTrain
-  VERSION = "1.33.0"
+  VERSION = "1.34.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train
 version: !ruby/object:Gem::Version
-  version: 1.33.0
+  version: 1.34.0
 platform: ruby
 authors:
 - Andrew Culver
@@ -597,6 +597,7 @@ files:
 - docs/authentication.md
 - docs/billing/stripe.md
 - docs/billing/usage.md
+- docs/contributing.md
 - docs/desktop.md
 - docs/docker.md
 - docs/field-partials.md