hot-glue 0.4.9.1 → 0.4.9.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/FUNDING.yml +1 -2
- data/README.md +78 -65
- data/lib/generators/hot_glue/install_generator.rb +1 -1
- data/lib/generators/hot_glue/scaffold_generator.rb +2 -2
- data/lib/generators/hot_glue/templates/controller.rb.erb +10 -5
- data/lib/generators/hot_glue/templates/erb/_list.erb +2 -2
- data/lib/hotglue/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b96fed7ffa4bfccbe2dbe0d22e4dc784a70304aebf50e0ef672b2fb30c6f4641
|
4
|
+
data.tar.gz: bb0398bf9529ad73c69c7703209a5888081ba0a629376a82880b726d5d74faa6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5064b5d5432f0f7f518b70b61a21b7d98a0182efd73a7e8784009f1e8d381edfa5f64cd6222214aefaebc1d9d30fd4adb4be870bf854fc2e8896d7bc77e66120
|
7
|
+
data.tar.gz: 6d88a66a54966f7179f4c041d61670fb799c6bcdddc5a0fc5b3d984011ebc3cabbb5b8713fa05fa534b68a1f07f912f8c1ad8b955be3d0f1281618e2b04f3429
|
data/.github/FUNDING.yml
CHANGED
@@ -1,2 +1 @@
|
|
1
|
-
custom: ["https://
|
2
|
-
"https://jfbcodes.com/p/hot-glue-in-depth-tutorial?utm_source=github.com&utm_campaign=github_hot_glue_repo_funding_link"]
|
1
|
+
custom: ["https://jfbcodes.com/p/hot-glue-in-depth-tutorial?utm_source=github.com&utm_campaign=github_hot_glue_repo_funding_link"]
|
data/README.md
CHANGED
@@ -3,24 +3,24 @@
|
|
3
3
|
|
4
4
|
Hot Glue is a Rails scaffold builder for the Turbo era. It is an evolution of the admin-interface style scaffolding systems of the 2010s ([activeadmin](https://github.com/activeadmin/activeadmin), [rails_admin](https://github.com/sferik/rails_admin), and [active_scaffold](https://github.com/activescaffold/active_scaffold)).
|
5
5
|
|
6
|
-
Using Turbo-Rails and Hotwire (default in Rails 7) you get a lightning-fast out-of-the-box CRUD
|
6
|
+
Using Turbo-Rails and Hotwire (default in Rails 7) you get a lightning-fast out-of-the-box CRUD-building experience.
|
7
7
|
|
8
|
-
Every page displays only a list view: new and edit operations happen as 'edit-in-place'
|
8
|
+
Every page displays only a list view: new and edit operations happen as 'edit-in-place,' so the user never leaves the page.
|
9
9
|
|
10
|
-
Because all page navigation is Turbo's
|
10
|
+
Because all page navigation is Turbo's responsibility, everything plugs & plays nicely into a Turbo-backed Rails app.
|
11
11
|
|
12
|
-
Alternatively, you can use this tool to create a Turbo-backed *section* of your Rails app--
|
12
|
+
Alternatively, you can use this tool to create a Turbo-backed *section* of your Rails app -- such as an admin interface -- while still treating the rest of the Rails app as an API or building out other features by hand.
|
13
13
|
|
14
|
-
It will read your relationships and field types to generate your code for you, leaving you with a 'sourdough starter' to work from. If you modify the generated code, you're on your own if you want to preserve your changes and also re-generate
|
14
|
+
It will read your relationships and field types to generate your code for you, leaving you with a 'sourdough starter' to work from. If you modify the generated code, you're on your own if you want to preserve your changes and also re-generate scaffolding after adding fields.
|
15
15
|
|
16
16
|
By default, it generates code that gives users full control over objects they 'own' and by default it spits out functionality giving access to all fields.
|
17
17
|
|
18
|
-
Hot Glue generates functionality that
|
18
|
+
Hot Glue generates functionality that is quick and dirty. It lets you be crafty. As with a real glue gun, use it with caution.
|
19
19
|
|
20
20
|
* Build plug-and-play scaffolding mixing generated ERB with the power of Hotwire and Turbo-Rails
|
21
|
-
* Everything edits-in-place (unless you use `--big-edit
|
22
|
-
* Automatically
|
23
|
-
* Excellent for CREATE-READ-UPDATE-DELETE (CRUD), lists with pagination
|
21
|
+
* Everything edits-in-place (unless you use `--big-edit`)
|
22
|
+
* Automatically reads your models (make them AND migrate your database before building your scaffolding!)
|
23
|
+
* Excellent for CREATE-READ-UPDATE-DELETE (CRUD), lists with pagination
|
24
24
|
* Great for prototyping, but you should learn Rails fundamentals first.
|
25
25
|
* 'Packaged' with Devise, Kaminari, Rspec, FontAwesome
|
26
26
|
* Create system specs automatically along with the generated code.
|
@@ -68,9 +68,9 @@ Confirm that both Stimulus and Turbo are working.
|
|
68
68
|
|
69
69
|
**If using JSBundling, make sure to use the new `bin/dev rails` instead of the old `rails server` or else your Webpack will not compile.**
|
70
70
|
|
71
|
-
For the quick step-by-step to help you confirm that both Stimulus and Turbo are working for your new JSBundling-Rails/CSSBunlding-Rails setup [see this post](https://jasonfleetwoodboldt.com/courses/stepping-up-rails/rails-7-new-app-with-js-bundling-css-bundling/).
|
71
|
+
For the quick step-by-step guide to help you confirm that both Stimulus and Turbo are working for your new JSBundling-Rails/CSSBunlding-Rails setup [see this post](https://jasonfleetwoodboldt.com/courses/stepping-up-rails/rails-7-new-app-with-js-bundling-css-bundling/).
|
72
72
|
|
73
|
-
(Note that Bootstrap is optional for Hot Glue. Here, I am just showing you the default
|
73
|
+
(Note that Bootstrap is optional for Hot Glue. Here, I am just showing you the default installation for simplicity.)
|
74
74
|
|
75
75
|
For the old method of installing Bootstrap [see this post](https://jasonfleetwoodboldt.com/courses/stepping-up-rails/rails-7-bootstrap/)
|
76
76
|
|
@@ -92,18 +92,20 @@ gem 'ffaker'
|
|
92
92
|
## 3. HOTGLUE INSTALLER
|
93
93
|
Add `gem 'hot-glue'` to your Gemfile & `bundle install`
|
94
94
|
|
95
|
-
Purchase a license at https://heliosdev.shop/hot-glue
|
95
|
+
Purchase a license at https://heliosdev.shop/p/hot-glue
|
96
96
|
|
97
97
|
During in installation, you MUST supply a `--layout` flag.
|
98
98
|
|
99
|
-
### `--layout` flag (
|
99
|
+
### `--layout` flag (only two options: `hotglue` or `bootstrap`; default is `bootstrap`)
|
100
100
|
Here you will set up and install Hot Glue for the first time.
|
101
101
|
|
102
102
|
It will install a config file that will save two preferences: layout (`hotglue` or `bootstrap`)
|
103
103
|
|
104
104
|
The installer will create `config/hot_glue.yml`.
|
105
105
|
|
106
|
-
|
106
|
+
|
107
|
+
### `--theme` flag
|
108
|
+
During the installation, **if** your `--layout` flag is set to `hotglue` you must also pass `--theme` flag.
|
107
109
|
|
108
110
|
the themes are:
|
109
111
|
• like_mountain_view (Google)
|
@@ -112,15 +114,16 @@ the themes are:
|
|
112
114
|
• dark_knight (_The Dark Night_ (2008) inspired)
|
113
115
|
• like_cupertino (modern Apple-UX inspired)
|
114
116
|
|
115
|
-
### `--markup` flag
|
116
117
|
|
117
|
-
|
118
|
+
### `--markup` flag (NOTE: haml and slim are no longer supported at this time)
|
119
|
+
|
120
|
+
default is `erb`. IMPORTANT: As of right now, HAML and SLIM are not currently supported so the only option is also the default `erb`.
|
118
121
|
|
119
122
|
|
120
123
|
### example installing ERB using Bootstrap layout:
|
121
124
|
`rails generate hot_glue:install --markup=erb --layout=bootstrap`
|
122
125
|
|
123
|
-
### Example installing
|
126
|
+
### Example installing using Hot Glue layout and the 'like_mountain_view' (Gmail-inspired) theme:
|
124
127
|
`rails generate hot_glue:install --markup=erb --layout=hotglue --theme=like_mountain_view`
|
125
128
|
|
126
129
|
The Hot Glue installer did several things for you in this step. Examine the git diffs or see 'Hot Glue Installer Notes' below.
|
@@ -140,11 +143,11 @@ https://github.com/FortAwesome/font-awesome-sass
|
|
140
143
|
|
141
144
|
Add to your Gemfile
|
142
145
|
|
143
|
-
As of
|
146
|
+
As of now, Devise for Rails 7 is still not released so you must use **main branch**, like so:
|
144
147
|
|
145
148
|
`gem 'devise', branch: 'main', git: 'https://github.com/heartcombo/devise.git'`
|
146
149
|
|
147
|
-
(If you are on Rails 6, you must do ALL of the steps in the Legacy Setup steps. Be sure not to skip **Legacy Step #5**
|
150
|
+
(If you are on Rails 6, you must do ALL of the steps in the Legacy Setup steps. Be sure not to skip **Legacy Step #5** below)
|
148
151
|
|
149
152
|
For Rails 7, be sure you are on the main branch of devise above and your logins should work. (The previously necessary step of disabling turbo shown in Legacy Step #5 is no longer needed. )
|
150
153
|
|
@@ -205,7 +208,7 @@ this may not have been automatically applied by the installer.
|
|
205
208
|
#### Hot Glue switched Capybara from RACK-TEST to HEADLESS CHROME
|
206
209
|
|
207
210
|
- By default Capybara is installed with :rack_test as its driver.
|
208
|
-
- This does not support Javascript
|
211
|
+
- This does not support Javascript. Hot Glue is not targeted for fallback browsers.
|
209
212
|
- From the [Capybara docs](https://github.com/teamcapybara/capybara#drivers):
|
210
213
|
```
|
211
214
|
By default, Capybara uses the :rack_test driver, which is fast but limited: it does not support JavaScript
|
@@ -300,7 +303,7 @@ end
|
|
300
303
|
|
301
304
|
### `--nested=`
|
302
305
|
|
303
|
-
This object is nested within another tree of objects, and there is a nested route in your `routes.rb` file. When specifying the parent(s), be sure to use **singular case**.
|
306
|
+
This object is nested within another tree of objects, and there is a nested route in your `routes.rb` file with the specified parent controllers above this controller. When specifying the parent(s), be sure to use **singular case**.
|
304
307
|
|
305
308
|
#### Example #1: One-level Nesting
|
306
309
|
Invoice `has_many :lines` and a Line `belongs_to :invoice`
|
@@ -364,11 +367,11 @@ This is "starfish access control" or "poor man's access control." It works when
|
|
364
367
|
|
365
368
|
#### Optionalized Nested Parents
|
366
369
|
|
367
|
-
Add `~` in front of any nested parameter (any parent in the `--
|
370
|
+
Add `~` in front of any nested parameter (any parent in the `--nested` list) you want to make optional. This creates a two-headed controller: It can operate with or without that optionalized parameter.
|
368
371
|
|
369
|
-
This is an advanced feature
|
372
|
+
This is an advanced feature. To use, **make duplicative routes to the same controller**. You can only use this feature with Gd controller.
|
370
373
|
|
371
|
-
Specify your controller *twice* in your routes.rb. Then, in your `--
|
374
|
+
Specify your controller *twice* in your routes.rb. Then, in your `--nested` setting, add `~` to any nested parent you want to **make optional**. "Make optional" means the controller will behave as-if it exists in two places: once, at the normal nest level. Then the same controller will 'exist' again one-level up in your routes. **If the route has sub-routes, you'll need to re-specify the entire subtree also**.
|
372
375
|
```
|
373
376
|
namespace :admin
|
374
377
|
resources :users do
|
@@ -378,15 +381,15 @@ namespace :admin
|
|
378
381
|
end
|
379
382
|
```
|
380
383
|
|
381
|
-
Even though we have two routes pointed to invoices
|
384
|
+
Even though we have two routes pointed to **invoices**, both will go to the same controller (`app/controllers/admin/invoices_controller.rb`)
|
382
385
|
|
383
386
|
```
|
384
|
-
rails generate hot_glue:scaffold User --namespace=admin --gd
|
385
|
-
rails generate hot_glue:scaffold Invoice --namespace=admin --gd --
|
387
|
+
rails generate hot_glue:scaffold User --namespace=admin --gd
|
388
|
+
rails generate hot_glue:scaffold Invoice --namespace=admin --gd --nested=~users
|
386
389
|
```
|
387
390
|
Notice for the Invoice build, the parent user is *optionalized* (not 'optional'-- optionalized: to be made so it can be made optional).
|
388
391
|
|
389
|
-
The Invoices controller, which is a Gd controller, will load the User if a user is specified in the route (`/admin/users/:user_id/invoices/`). It will ALSO work at `/admin/invoices` and will switch back into loading directly from the base class when routed
|
392
|
+
The Invoices controller, which is a Gd controller, will load the User if a user is specified in the route (`/admin/users/:user_id/invoices/`). It will ALSO work at `/admin/invoices` and will switch back into loading directly from the base class when routed without the parent user.
|
390
393
|
|
391
394
|
|
392
395
|
|
@@ -394,11 +397,11 @@ The Invoices controller, which is a Gd controller, will load the User if a user
|
|
394
397
|
|
395
398
|
By default, it will be assumed you have a `current_user` for your user authentication. This will be treated as the "authentication root" for the "poor man's auth" explained above.
|
396
399
|
|
397
|
-
The poor man's auth presumes that object graphs have only one natural way to traverse them (that is, one primary way to traverse them), and that all relationships infer that a set of things or their descendants are granted access to me for reading, writing, updating, and deleting.
|
400
|
+
The poor man's auth presumes that object graphs have only one natural way to traverse them (that is, one primary way to traverse them), and that all relationships infer that a set of things or their descendants are granted access to "me" for reading, writing, updating, and deleting.
|
398
401
|
|
399
402
|
Of course this is a sloppy way to do access control, and can easily leave open endpoints your real users shouldn't have access to.
|
400
403
|
|
401
|
-
When you display anything built with the scaffolding,
|
404
|
+
When you display anything built with the scaffolding, Hot Glue assumes the `current_user` will have `has_many` association that matches the pluralized name of the scaffold. In the case of nesting, we will automatically find the nested objects first, then continue down the nest chain to find the target object. This is how Hot Glue assumes all object are 'anchored' to the logged-in user. (As explained in the `--nested` section.)
|
402
405
|
|
403
406
|
If you use Devise, you probably already have a `current_user` method available in your controllers. If you don't use Devise, you can implement it in your ApplicationController.
|
404
407
|
|
@@ -444,6 +447,8 @@ The default (do not pass `auth_identifier=`) will match the `auth` (So if you us
|
|
444
447
|
|
445
448
|
|
446
449
|
`rails generate hot_glue:scaffold Thing --auth=current_account --auth_identifier=login`
|
450
|
+
|
451
|
+
|
447
452
|
In this example, the controller produced with:
|
448
453
|
```
|
449
454
|
before_action :authenticate_login!
|
@@ -454,11 +459,12 @@ However, the object graph anchors would continue to start from current_account.
|
|
454
459
|
```
|
455
460
|
|
456
461
|
Use empty string to **turn this method off**:
|
462
|
+
|
457
463
|
`rails generate hot_glue:scaffold Thing --auth=current_account --auth_identifier=''`
|
458
464
|
|
459
465
|
In this case a controller would be generated that would have NO before_action to authenticate the account, but it would still treat the current_account as the auth root for the purpose of loading the objects.
|
460
466
|
|
461
|
-
Please note that this example would
|
467
|
+
Please note that this example would produce non-functional code, so you would need to manually fix your controllers to make sure `current_account` is available to the controller.
|
462
468
|
|
463
469
|
|
464
470
|
### `--plural=`
|
@@ -469,14 +475,14 @@ You don't need this if the pluralized version is just + "s" of the singular vers
|
|
469
475
|
### `--exclude=`
|
470
476
|
(separate field names by COMMA)
|
471
477
|
|
472
|
-
By default, all fields are included unless they are on the exclude list. (The default
|
478
|
+
By default, all fields are included unless they are on the default exclude list. (The default exclude list is `id`, `created_at`, `updated_at`, `encrypted_password`, `reset_password_token`, `reset_password_sent_at`, `remember_created_at`, `confirmation_token`, `confirmed_at`, `confirmation_sent_at`, `unconfirmed_email`.)
|
473
479
|
|
474
|
-
If you specify
|
480
|
+
If you specify any exclude list, those excluded **and** the default exclude list will be excluded. (If you need any of the fields on the default exclude list, you must use `--include` instead.)
|
475
481
|
|
476
482
|
|
477
483
|
`rails generate hot_glue:scaffold Account --exclude=password`
|
478
484
|
|
479
|
-
(The default excluded list is:
|
485
|
+
(The default excluded list is: If you want to edit any fields with the same name, you must use the include flag instead.)
|
480
486
|
|
481
487
|
|
482
488
|
### `--include=`
|
@@ -488,42 +494,46 @@ If you specify an include list, it will be treated as a whitelist: no fields wil
|
|
488
494
|
|
489
495
|
You may not specify both include and exclude.
|
490
496
|
|
491
|
-
Include setting is affected by both specified grouping and
|
497
|
+
Include setting is affected by both specified grouping mode and smart layouts, explained below.
|
492
498
|
|
493
499
|
|
494
500
|
#### Specified Grouping Mode
|
495
501
|
|
496
502
|
To specify grouped columns, separate COLUMNS by a COLON, then separate fields with commas. Specified groupings work like smart layouts (see below), except you drive which groupings make up the columns.
|
497
503
|
|
498
|
-
(
|
504
|
+
(Smart layouts, below, achieves the same effect but automatically group your fields into a smart number of columns.)
|
499
505
|
|
500
506
|
If you want to group up fields together into columns, use a COLON (`:`) character to specify columns.
|
501
507
|
|
502
508
|
Your input **may** have a COLON at the end of it, but otherwise your columns will made **flush left**.
|
503
509
|
|
504
|
-
Without specified grouping (and not using smart layout), no
|
505
|
-
|
506
|
-
|
507
|
-
With a trailing colon you would be specifying the grouping. You're telling Hot Glue to make the two fields into column #1. (There is no other column.)
|
508
|
-
`--include=api_id,api_key:`
|
510
|
+
Without specified grouping (and not using smart layout), no grouping will happen. So these two fields would display in two (small, 1-column Bootstrap) columns:
|
511
|
+
|
512
|
+
`--include=first,last`
|
509
513
|
|
514
|
+
With a **trailing colon** you switch Hot Glue into specified grouping mode. You're telling Hot Glue to make the two fields into column #1. (There is no other column.)
|
515
|
+
`--include=first,last:`
|
510
516
|
|
511
|
-
|
512
|
-
`--include=name:api_id,api_key`
|
517
|
+
Hot Glue also happens to know that, for example, when you say "one column" you really want _one visual_ column made up of the available Bootstrap columns. For example, with 1 child portal (4) + the default edit/create buttons (2), you would have 6 remaining bootstrap columns (2+4+6=12). With 6 remaining Bootstrap columns Hot Glue will make 1 _visual colum_ into a 6-column Bootstrap column.
|
513
518
|
|
519
|
+
If, for example, you wanted to put the `email` field into column #1 and then the `first` and `last` into column #2, you would use:
|
520
|
+
`--include=email:first,last`
|
514
521
|
|
522
|
+
Assuming we have the same number of columns as the above example (6), Hot Glue knows that you now have 2 _visual columns_. It then gives each visual column 3-colum bootstrap columns, which makes your layout into a 3+3+4+2=12 Bootstrap layout.
|
515
523
|
|
516
|
-
Specifying any colon in your include syntax switches the builder into specified grouping mode
|
524
|
+
**Specifying any colon in your include syntax switches the builder into specified grouping mode.**
|
525
|
+
|
526
|
+
The effect will be that the fields will be stacked together into nicely fit columns. (This will look confusing if your end-user is expecting an Excel-like interface.)
|
517
527
|
|
518
|
-
With
|
528
|
+
With Hot Glue in specified grouping or smart layout mode, it automatically attempts to fit everything into Bootstrap 12-columns.
|
519
529
|
|
520
|
-
Using Bootstrap with neither specified grouping nor smart layouts may make 12 columns, which will produce strange
|
530
|
+
Using Bootstrap with neither specified grouping nor smart layouts may make more than 12 columns, which will produce strange results. (Bootstrap is not designed to work with, for example, a 13-column layout.)
|
521
531
|
|
522
532
|
You should typically either specify your grouping or use smart layouts when building with Bootstrap, but if your use case does not fit the stacking feature you can specify neither flag and then you may then have to deal with the over-stuffed layouts as explained.
|
523
533
|
|
524
534
|
|
525
535
|
|
526
|
-
### `--smart-layout`
|
536
|
+
### `--smart-layout` (also known as automatic grouping)
|
527
537
|
|
528
538
|
Smart layouts are like specified grouping but Hot Glue does the work of figuring out how many fields you want in each column.
|
529
539
|
|
@@ -535,7 +545,7 @@ The effect will be that the fields will be stacked together into nicely fit colu
|
|
535
545
|
|
536
546
|
**If your customer is used to Excel, this feature will confuse them.**
|
537
547
|
|
538
|
-
Also, this feature will **probably not** be supported by the SORTING (not yet implemented
|
548
|
+
Also, this feature will **probably not** be supported by the SORTING (not yet implemented). (You will be forced to choose between the two which I think makes sense.)
|
539
549
|
|
540
550
|
The layout builder works from right-to-left and starts with 12, the number of Bootstrap's columns.
|
541
551
|
|
@@ -547,7 +557,7 @@ If you're keeping track, that means we may have used 6 to 8 out of our Bootstrap
|
|
547
557
|
|
548
558
|
If we have 2 downnested portals and only the default buttons, that uses 10 out of 12 Bootstrap columns, leaving only 2 bootstrap columns for the fields.
|
549
559
|
|
550
|
-
The layout builder takes the number of columns
|
560
|
+
The layout builder takes the number of columns remaining and then distributes the feilds 'evenly' among them. However, note that order specified translates to up-to-down within the column, and then left-to-right across the columns, like so:
|
551
561
|
|
552
562
|
A D G
|
553
563
|
|
@@ -557,7 +567,7 @@ C F I
|
|
557
567
|
|
558
568
|
This is what would happen if 9 fields, specified in the order A,B,C,D,E,F,G,H,I, were distributed across 3 columns.
|
559
569
|
|
560
|
-
(If you had a number of fields that wasn't easily divisible by the number of columns, it would leave the final column a few fields short of the others.)
|
570
|
+
(If you had a number of fields that wasn't easily divisible by the number of columns, it would leave the final column one or a few fields short of the others.)
|
561
571
|
|
562
572
|
|
563
573
|
|
@@ -658,39 +668,41 @@ Omits pagination. (All list views have pagination by default.)
|
|
658
668
|
|
659
669
|
### `--no-list`
|
660
670
|
|
661
|
-
Omits list action. Only makes sense to use this if
|
671
|
+
Omits list action. Only makes sense to use this if want to create a view where you only want the create button or to navigate to the update screen alternative ways. (The new/create still appears, as well the edit, update & destroy actions are still created even though there is no natural way to navigate to them.)
|
662
672
|
|
663
673
|
|
664
|
-
### `--no-list-
|
674
|
+
### `--no-list-label`
|
665
675
|
|
666
|
-
Omits list
|
676
|
+
Omits list LABEL itself above the list. (Do not confuse with the field labels.)
|
667
677
|
|
668
|
-
|
678
|
+
(Note that on a per model basis, you can also globally omit the label or set a unique label value using
|
679
|
+
`@@table_label_singular` and `@@table_label_plural` on your model objects.)
|
669
680
|
|
670
|
-
|
681
|
+
Note that list labels may be automatically omitted on downnested scaffolds.
|
671
682
|
|
672
|
-
|
673
|
-
|
683
|
+
### `--no-list-heading`
|
684
|
+
|
685
|
+
Omits the heading of column names that appears above the 1st row of data.
|
674
686
|
|
675
687
|
### `--no-create`
|
676
688
|
|
677
|
-
Omits create
|
689
|
+
Omits new & create actions.
|
678
690
|
|
679
691
|
### `--no-delete`
|
680
692
|
|
681
|
-
Omits delete action.
|
693
|
+
Omits delete button & destroy action.
|
682
694
|
|
683
695
|
### `--big-edit`
|
684
696
|
|
685
|
-
If you do not want inline editing of your list items but instead to fall back to full page style behavior for your edit views, use `--big-edit`. Turbo still handles the page interactions, but the user is taken to a full-screen edit page instead of an edit-in-place interaction.
|
697
|
+
If you do not want inline editing of your list items but instead want to fall back to full page style behavior for your edit views, use `--big-edit`. Turbo still handles the page interactions, but the user is taken to a full-screen edit page instead of an edit-in-place interaction.
|
686
698
|
|
687
|
-
### `--display-list-after-update`
|
699
|
+
### `--display-list-after-update`
|
688
700
|
|
689
701
|
After an update-in-place normally only the edit view is swapped out for the show view of the record you just edited.
|
690
702
|
|
691
703
|
Sometimes you might want to redisplay the entire list after you make an update (for example, if your action removes that record from the result set).
|
692
704
|
|
693
|
-
To do this, use flag `--
|
705
|
+
To do this, use flag `--display-list-after-update`. The update will behave like delete and re-fetch all the records in the result and tell Turbo to swap out the entire list.
|
694
706
|
|
695
707
|
|
696
708
|
|
@@ -700,14 +712,14 @@ To do this, use flag `--display_list_after_update`. The update will behave like
|
|
700
712
|
|
701
713
|
HotGlue will copy a file named base_controller.rb to the same folder where it tries to create any controller, unless such a file exists there already.
|
702
714
|
|
703
|
-
|
715
|
+
The created controller will always have this base controller as its subclass. You are encouraged to implement functionality common to the *namespace* (shared between the controllers in the namespace) using this technique.
|
704
716
|
|
705
717
|
## Special Table Labels
|
706
718
|
|
707
719
|
If your object is very wordy (like MyGreatHook) and you want it to display in the UI as something shorter,
|
708
|
-
add `@@table_label_plural = "
|
720
|
+
add `@@table_label_plural = "Hooks"` and `@@table_label_singular = "Hook"`.
|
709
721
|
|
710
|
-
Hot Glue will use this as the
|
722
|
+
Hot Glue will use this as the **list heading** and **New record label**, respectively. This affects only the UI only.
|
711
723
|
|
712
724
|
You can also set these to `nil` to omit the labels completely.
|
713
725
|
|
@@ -727,6 +739,7 @@ Child portals have the headings omitted automatically (there is a heading identi
|
|
727
739
|
- Time: displayed as HTML5 time picker
|
728
740
|
- Boolean: displayed radio buttons yes/ no
|
729
741
|
- Enum - displayed as a drop-down list (defined the enum values on your model). For Rails 6 see https://jasonfleetwoodboldt.com/courses/stepping-up-rails/enumerated-types-in-rails-and-postgres/
|
742
|
+
- AFAIK, you must specify the enum definition both in your model and also in your database migration for both Rails 6 + Rails 7
|
730
743
|
|
731
744
|
|
732
745
|
# VERSION HISTORY
|
@@ -38,7 +38,7 @@ module HotGlue
|
|
38
38
|
require 'open-uri'
|
39
39
|
|
40
40
|
# ask HeliosDev.shop if this email is good
|
41
|
-
stream = URI.open("https://heliosdev.shop/check_licenses/hot-glue
|
41
|
+
stream = URI.open("https://heliosdev.shop/check_licenses/hot-glue?email=#{license_email}")
|
42
42
|
resp = JSON.parse(stream.read)
|
43
43
|
|
44
44
|
if resp['status'] == 'success'
|
@@ -125,7 +125,7 @@ module HotGlue
|
|
125
125
|
class_option :smart_layout, type: :boolean, default: false
|
126
126
|
class_option :markup, type: :string, default: nil # deprecated -- use in app config instead
|
127
127
|
class_option :layout, type: :string, default: nil # if used here it will override what is in the config
|
128
|
-
class_option :
|
128
|
+
class_option :no_list_label, type: :boolean, default: false
|
129
129
|
class_option :no_list_heading, type: :boolean, default: false
|
130
130
|
|
131
131
|
class_option :before_list_labels, type: :boolean, default: false
|
@@ -264,7 +264,7 @@ module HotGlue
|
|
264
264
|
|
265
265
|
@no_edit = options['no_edit'] || false
|
266
266
|
@no_list = options['no_list'] || false
|
267
|
-
@
|
267
|
+
@no_list_label = options['no_list_label'] || false
|
268
268
|
@no_list_heading = options['no_list_heading'] || false
|
269
269
|
|
270
270
|
@display_list_after_update = options['display_list_after_update'] || false
|
@@ -40,12 +40,17 @@ class <%= controller_class_name %> < <%= controller_descends_from %>
|
|
40
40
|
@<%= @nested_set[0][:singular] %> ||= <%= root_object %> <% else %>
|
41
41
|
@<%= @nested_set[0][:singular] %> ||= <%= root_object %>.find(params[:<%= @nested_set[0][:singular] %>_id])<%= " if params.include?(:#{@nested_set[0][:singular]}_id)" if @nested_set[0][:optional] %> <% end %>
|
42
42
|
end
|
43
|
-
<% end %><% if any_nested? %><% nest_chain = [@nested_set[0][:singular]]; this_scope = @nested_set[0][:plural]; %>
|
44
|
-
|
45
|
-
|
43
|
+
<% end %><% if any_nested? %><% nest_chain = [@nested_set[0][:singular]]; this_scope = @nested_set[0][:plural]; %>
|
44
|
+
<% for index in 0..(@nested_set.count - 1) do
|
45
|
+
arg = @nested_set[index]
|
46
|
+
last_arg = (index == 0 ? nil : @nested_set[index-1])
|
47
|
+
|
48
|
+
this_scope = "#{nest_chain.last}.#{arg[:plural]}"
|
49
|
+
nest_chain << arg %>
|
46
50
|
def <%= arg[:singular] %>
|
47
|
-
@<%= arg[:singular] %> ||= (<%= this_scope %>.find(params[:<%= arg[:singular] %>_id])<%= " if params.include?(:#{
|
48
|
-
|
51
|
+
@<%= arg[:singular] %> ||= (<%= this_scope %>.find(params[:<%= arg[:singular] %>_id])<%= " if params.include?(:#{last_arg[:singular]}_id)" if last_arg && @god && last_arg[:optional] %>)
|
52
|
+
<% if @god && (last_arg[:optional] ) %>@<%= arg[:singular] %> ||= (<%= collect_objects[index-1] %>.find(params[:<%= arg[:singular] %>_id]) if params.include?(:<%= arg[:singular] %>_id) ) <% end %>
|
53
|
+
end<% end %> <% end %> <% if !@self_auth %>
|
49
54
|
|
50
55
|
def load_<%= singular_name %>
|
51
56
|
@<%= singular_name %> = (<%= object_scope.gsub("@",'') %>.find(params[:id])<%= " if params.include?(:#{@nested_set.last[:singular]}_id)" if @nested_set[0] && @nested_set[0][:optional] %>)<% if @nested_set[0] && @nested_set[0][:optional] %> || <%= class_name %>.find(params[:id])<% end %>
|
@@ -1,6 +1,6 @@
|
|
1
1
|
<\%= turbo_frame_tag "<%= plural %>-list" <%= nested_for_turbo_id_list_constructor %> do %>
|
2
2
|
<div class="<%= @container_name %> scaffold-list">
|
3
|
-
<% unless @no_list
|
3
|
+
<% unless @no_list || @no_list_label || (@nested_set.any? && !@nested_set.collect{|x| x[:optional]}.any?) %>
|
4
4
|
<% unless list_label.nil? %><h4>
|
5
5
|
<%= list_label %>
|
6
6
|
</h4><% end %>
|
@@ -9,7 +9,7 @@
|
|
9
9
|
<% unless @no_create %><%= '<%= render partial: "' + ((@namespace+"/" if @namespace) || "") + @controller_build_folder + '/new_button", locals: {}' + @nested_set.collect{|arg| ".merge(defined?(#{arg[:singular]}) ? {#{arg[:singular]}: #{arg[:singular]}} : {})"}.join() + ' %\>'.gsub('\\',"") %><br /><% end %>
|
10
10
|
|
11
11
|
<% unless @no_list %>
|
12
|
-
<% unless @
|
12
|
+
<% unless @no_list_heading %>
|
13
13
|
<div class="row scaffold-heading-row">
|
14
14
|
<%= list_column_headings %>
|
15
15
|
<% if @downnest_object.any? %>
|
data/lib/hotglue/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: hot-glue
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.4.9.
|
4
|
+
version: 0.4.9.2
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Jason Fleetwood-Boldt
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-02-
|
11
|
+
date: 2022-02-28 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: rails
|