bullet_train 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26d50ad6167e3e1f7d3b8a550313094548a2b82bba8c60106ec8549db38abd51
-  data.tar.gz: ffe18a2a1265a052929fc52bd9213de99f565327384d022bf644b43cb4aa3174
+  metadata.gz: b1acc9aef5bfdec082aae9de0b523afc27395b9b41022ec4cf243e83a1d36e75
+  data.tar.gz: fef8231d3e320ce6b23978924b9a132585fae765842743112482f7bdbd2bb7e7
 SHA512:
-  metadata.gz: d7e1ddd05c6a9bebad198f5cf6e48db86e09fa8194ef8ae5cc83bb12a141efe174716ea98b6b6b3032cc13a4d466dd6ed3a85dd044643aa717c3a72a58ba5c75
-  data.tar.gz: 04c8e18fea2b7db8ed9e08876cfa2f0fb51264f99c4cfb1a54323bb3497f3c7f2a42a4699cadaefe8ca639f42a78391138b79424e3a8493de6721efa85e6fbb2
+  metadata.gz: ebbab67c9b4ed7880f6ee020bddc7e6ed1cd337604835a76a5b0402fc962a60f24aa851e07806cba4bc8c7adc562c0b9242a17904321b3516bb41fa977934ce9
+  data.tar.gz: 8f6bf47611928395122564d43b85bb2c121843a651ce49201a41383b40c8e4c2b1802d6b1e300420180e62327cfaff4901654cd5127bb86a83f589c03e037126

data/docs/action-models.md

@@ -73,7 +73,6 @@ bin/super-scaffold action-model:targets-one-parent
 ### 1. Generate and scaffold an example `Project` model.
 
 ```
-rails g model Project team:references name:string
 bin/super-scaffold crud Project Team name:text_field
 ```
 
@@ -104,7 +103,6 @@ Because Action Models are just regular models, you can add new fields to them wi
 For example:
 
 ```
-rails g migration add_notify_users_to_projects_archive_actions notify_users:boolean
 # side quest: update the generated migration with `default: false` on the new boolean field.
 bin/super-scaffold crud-field Projects::ArchiveAction notify_users:boolean
 ```

data/docs/field-partials/file-field.md

@@ -47,6 +47,5 @@ Run the following command to generate the scaffolding for the `documents` field
 If you're starting fresh, and don't have an existing model you can do something like this:
 
 ```
-rails g model Project team:references name:string specification:attachment documents:attachments
 bin/super-scaffold crud Project Team name:text_field specification:file_field documents:file_field{multiple}
 ```

data/docs/field-partials.md

@@ -147,12 +147,15 @@ Certain form field partials like `buttons` and `super_select` can also have thei
 For Cloudinary you should use `string`, and for ActiveStorage you should use `attachment`.
 
 ## A Note On Data Types
-Set the data type to `jsonb` whenever passing the `multiple` option to a new attribute.
+When creating a `multiple` option attribute, Bullet Train generates these values as a `jsonb`.
 ```
-> rails generate model Project team:references multiple_buttons:jsonb
-> bin/super-scaffold crud Project Team multiple_buttons:buttons{multiple}
+bin/super-scaffold crud Project Team multiple_buttons:buttons{multiple}
 ```
 
+This will run the following rails command.
+```
+rails generate model Project team:references multiple_buttons:jsonb
+```
 ## Formating `date` and `date_and_time`
 After Super Scaffolding a `date` or `date_and_time` field, you can pass a format for the object like so:
 

data/docs/getting-started.md

@@ -8,16 +8,15 @@ Whether you want to build a new application with Bullet Train or contribute to B
 
 If you're using Bullet Train for the first time, begin by learning these five important techniques:
 
-1. Use `rails g model` to create and `bin/super-scaffold crud` to scaffold a new model:
+1. Use `bin/super-scaffold crud` to scaffold a new model:
 
     ```
-    rails g model Project team:references name:string
     bin/super-scaffold crud Project Team name:text_field
     ```
 
     In this example, `Team` refers to the immediate parent of the `Project` resource. For more details, just run `bin/super-scaffold` or [read the documentation](/docs/super-scaffolding.md).
 
-2. Use `rails g migration` and `bin/super-scaffold crud-field` to add a new field to a model you've already scaffolded:
+2. Use `bin/super-scaffold crud-field` to add a new field to a model you've already scaffolded:
 
     ```
     rails g migration add_description_to_projects description:text

data/docs/modeling.md

@@ -68,7 +68,7 @@ Even if you know there's an attribute or model that you're going to want to poli
 
 ## A Systematic Approach
 
-### 1. Write `rails g` and `bin/super-scaffold` commands in a scratch file.
+### 1. Write `bin/super-scaffold` commands in a scratch file.
 
 See the [Super Scaffolding documentation](/docs/super-scaffolding.md) for more specific guidance. Leave plenty of comments in your scratch file describing anything that isn't obvious and providing examples of values that might populate attributes.
 

data/docs/super-scaffolding/delegated-types.md

@@ -39,7 +39,7 @@ Note that in this specific approach we don't need a `team:references` on `Messag
 ### 2. Super Scaffolding for `Entry`
 
 ```
-bin/super-scaffold crud Entry Team entryable_type:buttons
+bin/super-scaffold crud Entry Team entryable_type:buttons --skip-migration-generation
 ```
 
 We use `entryable_type:buttons` because we're going to allow people to choose which type of `Entry` they're creating with a list of buttons. This isn't the only option available to us, but it's the easiest to implement for now.

data/docs/super-scaffolding.md

@@ -41,25 +41,28 @@ Let's implement the following feature:
 
 > An organization has many projects.
 
-First, generate the model with the standard Rails generator:
+First, run the `crud` scaffolder:
+```
+bin/super-scaffold crud Project Team name:text_field
+rake db:migrate
+```
+
+In the above example, `team` represents the model that a `Project` primarily belongs to. Also, `text_field` was selected from [the list of available field partials](/docs/field-partials.md). We'll show examples with `trix_editor` and `super_select` later.
+
+Super Scaffolding automatically generates models for you. However, if you want to split this process, you can pass the `--skip-migration-generation` to the command.
 
+For example, generate the model with the standard Rails generator:
 ```
 rails g model Project team:references name:string
 ```
 
-In the above example, `team` represents the model that a `Project` primarily belongs to.
-
 ⚠️ Don't run migrations right away. It would be fine in this case, but sometimes the subsequent Super Scaffolding step actually updates the migration as part of its magic.
 
-Next, run the `crud` scaffolder:
-
+Then you can run the scaffolder with the flag:
 ```
-bin/super-scaffold crud Project Team name:text_field
-rake db:migrate
+bin/super-scaffold crud Project Team name:text_field --skip-migration-generation
 ```
 
-In the above example, `text_field` was selected from [the list of available field partials](/docs/field-partials.md). We'll show examples with `trix_editor` and `super_select` later.
-
 ### 2. Nested CRUD Scaffolding with `crud`
 
 Building on that example, let's implement the following feature:
@@ -68,22 +71,14 @@ Building on that example, let's implement the following feature:
 A project has many goals.
 ```
 
-Again, we'll generate the model using the standard Rails generator:
-
-```
-rails g model Goal project:references description:string
-```
-
-You can see in the example above that there is no direct reference to team, but to `project` instead, since that's where a `Goal` belongs.
-
-Now, run the `crud` scaffolder:
+First, run the `crud` scaffolder:
 
 ```
 bin/super-scaffold crud Goal Project,Team description:text_field
 rake db:migrate
 ```
 
-You can see in the example above how we've specified `Project,Team`, because we want to specify the entire chain of ownership back to the `Team`. This allows Super Scaffolding to automatically generate the required permissions.
+You can see in the example above how we've specified `Project,Team`, because we want to specify the entire chain of ownership back to the `Team`. This allows Super Scaffolding to automatically generate the required permissions. Take note that this generates a foreign key for `Project` and not for `Team`.
 
 ### 3. Adding New Fields with `crud-field`
 
@@ -93,13 +88,7 @@ Building on the earlier example, consider the following new requirement:
 
 > In addition to a name, a project can have a description.
 
-First, use the standard Rails migration generator to add the attribute in the database:
-
-```
-rails g migration add_description_to_projects description:text
-```
-
-Then, use the `crud-field` scaffolder to add it throughout the application:
+Use the `crud-field` scaffolder to add it throughout the application:
 
 ```
 bin/super-scaffold crud-field Project description:trix_editor
@@ -113,6 +102,11 @@ If you want to scaffold a new field to use for read-only purposes, add the follo
 bin/super-scaffold crud-field Project description:trix_editor{readonly}
 ```
 
+Again, if you would like to automatically generate the migration on your own, pass the `--skip-migration-generation` flag:
+```
+bin/super-scaffold crud-field Project description:trix_editor --skip-migration-generation
+```
+
 ### 4. Adding Option Fields with Fixed, Translatable Options
 
 Continuing with the earlier example, let's address the following new requirement:
@@ -124,7 +118,6 @@ We have multiple [field partials](/docs/field-partials.md) that we could use for
 In this example, let's add a status attribute and present it as buttons:
 
 ```
-rails g migration add_status_to_projects status:string
 bin/super-scaffold crud-field Project status:buttons
 ```
 
@@ -152,21 +145,16 @@ Although you might think this calls for a reference to `User`, we've learned the
 
 We can accomplish this like so:
 
-```
-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}
 rake db:migrate
 ```
 
-There are two important things to point out here:
+There are three important things to point out here:
 
-1. When we use `rails g model` or `rails g migration`, we specify the `references` column name as `lead`, but when we're specifying the _field_ we want to scaffold, we specify it as `lead_id`, because that's the name of the attribute on the form, in strong parameters, etc.
-2. We have to specify the model name with the `class_name` option so that Super Scaffolding can fully work it's magic. We can't reflect on the association, because at this point the association isn't properly defined yet. With this information, Super Scaffolding can handle that step for you.
+1. The scaffolder automatically adds a foreign key for `lead` to `Project`.
+2. When adding this foreign key the `references` column is generated under the name `lead`, but when we're specifying the _field_ we want to scaffold, we specify it as `lead_id`, because that's the name of the attribute on the form, in strong parameters, etc.
+3. We have to specify the model name with the `class_name` option so that Super Scaffolding can fully work it's magic. We can't reflect on the association, because at this point the association isn't properly defined yet. With this information, Super Scaffolding can handle that step for you.
 
 Finally, Super Scaffolding will prompt you to edit `app/models/project.rb` and implement the required logic in the `valid_leads` method. This is a template method that will be used to both populate the select field on the `Project` form, but also enforce some important security concerns in this multi-tenant system. In this case, you can define it as:
 
@@ -189,17 +177,12 @@ We can accomplish this with a new model, a new join model, and a `super_select`
 First, let's create the tag model:
 
 ```
-rails g model Projects::Tag team:references name:string
 bin/super-scaffold crud Projects::Tag Team name:text_field
 ```
 
 Note that project tags are specifically defined at the `Team` level. The same tag can be applied to multiple `Project` models.
 
-Now, let's create a join model for the has-many-through association:
-
-```
-rails g model Projects::AppliedTag project:references tag:references
-```
+Now, let's create a join model for the has-many-through association.
 
 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:
 
@@ -237,34 +220,39 @@ Bullet Train comes with two different ways to handle image uploads.
 
 #### Scaffolding images with Cloudinary
 
-When you scaffold your model you need to include a `string` where Cloudinary can store a reference to the image.
+When you scaffold your model a `string` is generated where Cloudinary can store a reference to the image.
+
+Make sure you have the `CLOUDINARY_URL` environment variable to use Cloudinary for your images.
 
 For instance to scaffold a `Project` model with a `logo` image upload.
+Use `image` as a field type for super scaffolding:
 
 ```
-rails g model Project team:references name:string logo:string
+bin/super-scaffold crud Project Team name:text_field logo:image
+rake db:migrate
 ```
 
-Then you can use `image` as a field type for super scaffolding:
-
+Under the hood, Bullet Train will generate your model with the following command:
 ```
-bin/super-scaffold crud Project Team name:text_field logo:image
+bin/super-scaffold crud Project Team name:text_field
 rake db:migrate
 ```
+
 #### Scaffolding images with ActiveStorage
 
-When you scaffold your model you need to generate an `attachment` type attribute.
+When you scaffold your model we generate an `attachment` type attribute.
 
 For instance to scaffold a `Project` model with a `logo` image upload.
+Use `image` as a field type for super scaffolding:
 
 ```
-rails g model Project team:references name:string logo:attachment
+bin/super-scaffold crud Project Team name:text_field logo:image
+rake db:migrate
 ```
 
-Then you can use `image` as a field type for super scaffolding:
-
+Under the hood, Bullet Train will generate your model with the following command:
 ```
-bin/super-scaffold crud Project Team name:text_field logo:image
+bin/super-scaffold crud Project Team name:text_field
 rake db:migrate
 ```
 

data/lib/bullet_train/version.rb

@@ -1,3 +1,3 @@
 module BulletTrain
-  VERSION = "1.5.2"
+  VERSION = "1.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Andrew Culver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-03 00:00:00.000000000 Z
+date: 2023-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -164,20 +164,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: masamune-ast
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: image_processing
   requirement: !ruby/object:Gem::Requirement