bullet_train 1.12.2 → 1.12.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 359c742c2ad95d55fd469407fac668cbd94d6fd43643c0e1dedd705afaff1564
-  data.tar.gz: 504b342f64b691e89630dde9dd763bbcd9c23056c4fc6437532993e417f0716b
+  metadata.gz: 918897d730dbf7dd7fd31f51609a2fbd25c56800a6442b3b0caa81ed7a9f8f40
+  data.tar.gz: 45a93a17f839e4a1e03a193f88cb6a8e23d81150bb17d8059473f4d86484cecf
 SHA512:
-  metadata.gz: 4099fd8c3c38bed877f1844127f998fc2b16d64beb9b4f3ff637f4706c18f8d0fdb74c5b1264c13a1e72b80d98cb0c71be799100f93a903480447562abbe2396
-  data.tar.gz: 0a74b016a9d0d7b027ce2c73cff11abfe6dc341d77854a50dbb127c086188187186c98ed23ed728d867d711c18339f0185c3699ec8dde5f09caa5435fda010a3
+  metadata.gz: 44f73475e4a154a35aa52ca0edb39900e23d286d1b870a1ba537a88997fdeac49986250719241ba081c8fecdf06c993436a753c569599862d9213f7e0123012b
+  data.tar.gz: ad26cf90042f42fec84595cf292bb9556131d0e2ffc40368857017e78c7aec83ea2e6430b9cc9ee601d41a942de06b3f34d484153f5bfabc8b325675c3c01f23

data/docs/super-scaffolding/targets.md

@@ -0,0 +1,104 @@
+# Targets for Super Scaffolding
+
+Super Scaffolding relies on "magic comments" that we use as targets (also known as hooks) that help us put newly generated code in the right place.
+
+For instance if you Super Scaffold a `Project` resource your model file will look like this:
+
+```ruby
+class Project < ApplicationRecord
+  # 🚅 add concerns above.
+
+  # 🚅 add attribute accessors above.
+
+  belongs_to :team
+  # 🚅 add belongs_to associations above.
+
+  # 🚅 add has_many associations above.
+
+  # 🚅 add has_one associations above.
+
+  # 🚅 add scopes above.
+
+  validates :name, presence: true
+  # 🚅 add validations above.
+
+  # 🚅 add callbacks above.
+
+  # 🚅 add delegations above.
+
+  # 🚅 add methods above.
+end
+```
+
+All of those comments are used by the Super Scaffolder to put things in the right place.
+
+**DON'T REMOVE THEM!**
+
+If you remove them then we won't be able to make modifications to that file, and subsequent super scaffolding commands won't work correctly.
+
+If you do remove them then you should see a warning the next time you try to add a field that requires modifications that model. (Not all attribute types do. File and Image fields are examples of ones that do.)
+
+```
+$ rails generate super_scaffold:field Project documents:file_field{multiple}
+Adding new fields to Project with 'bin/rails generate migration add_documents_to_projects documents:attachments'
+
+Updating './app/views/account/projects/_form.html.erb'.
+Updating './app/views/account/projects/show.html.erb'.
+Updating './app/views/account/projects/_index.html.erb'.
+Replacing in './app/views/account/projects/_index.html.erb'.
+Updating './app/views/account/projects/_project.html.erb'.
+Updating './config/locales/en/projects.en.yml'.
+Updating './config/locales/en/projects.en.yml'.
+Updating './app/controllers/api/v1/projects_controller.rb'.
+Updating './app/controllers/api/v1/projects_controller.rb'.
+Updating './test/controllers/api/v1/projects_controller_test.rb'.
+Updating './app/views/api/v1/projects/_project.json.jbuilder'.
+Updating './test/controllers/api/v1/projects_controller_test.rb'.
+
+-------------------------------
+Heads up! We weren't able to find a super scaffolding hook where we expected it to be.
+In ./app/models/project.rb
+We expected to find a line like this:
+# 🚅 add has_many associations above.
+
+See https://bullettrain.co/docs/super-scaffolding/targets for more details.
+-------------------------------
+
+
+-------------------------------
+Heads up! We weren't able to find a super scaffolding hook where we expected it to be.
+In ./app/models/project.rb
+We expected to find a line like this:
+# 🚅 add attribute accessors above.
+
+See https://bullettrain.co/docs/super-scaffolding/targets for more details.
+-------------------------------
+
+
+-------------------------------
+Heads up! We weren't able to find a super scaffolding hook where we expected it to be.
+In ./app/models/project.rb
+We expected to find a line like this:
+# 🚅 add methods above.
+
+See https://bullettrain.co/docs/super-scaffolding/targets for more details.
+-------------------------------
+
+
+-------------------------------
+Heads up! We weren't able to find a super scaffolding hook where we expected it to be.
+In ./app/models/project.rb
+We expected to find a line like this:
+# 🚅 add callbacks above.
+
+See https://bullettrain.co/docs/super-scaffolding/targets for more details.
+-------------------------------
+```
+
+## How to Replace Missing Targets
+
+If you've removed some targets and need to get them back you have a few options:
+
+1. If the removal of the targets hasn't been committed to source control yet, you can use `git checkout` to restore the files to their previous state.
+2. If the removal has been committed you could revert the commit that removed them.
+3. You could use Super Scaffolding to generate a new resource and then copy &amp; paste the targets from your new resource into the existing one.

data/docs/super-scaffolding.md

@@ -17,6 +17,8 @@ Here’s a list of what Super Scaffolding takes care of for you each time you ad
 
 When adding just one model, Super Scaffolding generates ~30 different files on your behalf.
 
+**NOTE** Super Scaffolding generates code that contains special "magic comments" that we use as targets for later Super Scaffolding operations. You shouldn't remove those comments. See [Targets for Super Scaffolding](/docs/super-scaffolding/targets.md) for more details.
+
 ## Living Templates
 
 Bullet Train's Super Scaffolding engine is a unique approach to code generation, based on template files that are functional code instead of obscure DSLs that are difficult to customize and maintain. Super Scaffolding automates the most repetitive and mundane aspects of building out your application's basic structure. Furthermore, it does this without leaning on the magic of libraries that force too high a level of abstraction. Instead, it generates standard Rails code that is both ready for prime time, but is also easy to customize and modify.
@@ -184,6 +186,20 @@ end
 
 (The `current_and_invited` scope just filters out people that have already been removed from the team.)
 
+**NOTE:** It's possible to define the source for `valid_leads` in your super scaffolding command.
+You need to wrap the bits inside the curly brackets with double qoutes, and then add
+`,source=team.memberships.current_and_invited` inside the quotes:
+
+```
+{"class_name=Membership,source=team.memberships.current_and_invited"}
+```
+
+So the whole command would be:
+
+```
+rails generate super_scaffold:field Project lead_id:super_select{"class_name=Membership,source=team.memberships.current_and_invited"}
+```
+
 ### 6. Scaffolding Has-Many-Through Associations with `join_model`
 
 Finally, working from the same example, imagine the following requirement:
@@ -299,3 +315,7 @@ HIDE_THINGS: true
  - [Super Scaffolding Options](/docs/super-scaffolding/options.md)
  - [Super Scaffolding with Delegated Types](/docs/super-scaffolding/delegated-types.md)
  - [Super Scaffolding with the `--sortable` option](/docs/super-scaffolding/sortable.md)
+
+## Additional Info
+
+ - [Targets for Super Scaffolding](/docs/super-scaffolding/targets.md)

data/lib/bullet_train/version.rb

@@ -1,3 +1,3 @@
 module BulletTrain
-  VERSION = "1.12.2"
+  VERSION = "1.12.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train
 version: !ruby/object:Gem::Version
-  version: 1.12.2
+  version: 1.12.3
 platform: ruby
 authors:
 - Andrew Culver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-18 00:00:00.000000000 Z
+date: 2024-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -780,6 +780,7 @@ files:
 - docs/super-scaffolding/delegated-types.md
 - docs/super-scaffolding/options.md
 - docs/super-scaffolding/sortable.md
+- docs/super-scaffolding/targets.md
 - docs/teams.md
 - docs/testing.md
 - docs/themes.md