hot-glue 0.5.2 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f420219d9ff451f6fa20c743bef94003726a86c452fba51c8487f4d537d3c258
-  data.tar.gz: c031f7ffe2fb832a17ce13bd78051296baec30ed279de3d6b7b73c04dfdfd3c3
+  metadata.gz: 4770a6dafa96c7d17e2104d7349caf126a7922c660b3055b29c6a7eab6e7d851
+  data.tar.gz: cd730bb99e9d9dad8ca5ee22a504a9e91ace01123ce900e11c7ccffae3e26630
 SHA512:
-  metadata.gz: f72f3d5376e8b2ca6c50e3a7c8044b83ed6b62b550a91d1c2e76cf6a4b33eeab882ea760f67ee744e6d8e5c844ba1019a51368325eab5d5f4de56bd2edcbd768
-  data.tar.gz: 3299ae7f5aff59f94b65b7fae3af98f31dc935e7aa3c3b132e41c05057ae790c1ee10e8888ef34ebe9d6e8ddf221f5dac7a3d1ce4a8261968bca2b5b59761739
+  metadata.gz: 5f59544515a51f85e494bd7a1ec7ee4586ab761919554f53ad751b845906e412a5cd80f65e1447183d79246e295abbb1fe468814ef572cd93888970603aafb7a
+  data.tar.gz: 045115777e9399ddffd06f9b400d44cc1d5e230579ea9d2017213cf74ae786efe2ae42d52639dbc60b496d0628f8a955c0d03807cd7262203de1961e0ecf87c8

data/.github/workflows/test.yml

@@ -0,0 +1,15 @@
+name: Test
+on: [ push, pull_request ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          # Not needed with a .ruby-version file
+          # runs 'bundle install' and caches installed gems automatically
+          bundler-cache: true
+      - run: script/test

data/.gitignore

@@ -12,6 +12,8 @@ dump.rdb
 tmp/
 
 
+Gemfile.lock
+
 db/*.sqlite3
 
 spec/dummy/app/views/
@@ -21,4 +23,4 @@ spec/dummy/specs/
 spec/dummy/node_modules/
 spec/dummy/log/
 
-coverage/
+coverage/

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/.travis.yml

@@ -9,7 +9,7 @@ branches:
     - main
 
 
-script: "rake spec"
+script: "script/test"
 
 rvm:
-  - 2.7.2
+  - 3.1.2

data/Gemfile

@@ -8,14 +8,24 @@ gemspec
 # not required for your app
 gem 'sqlite3'
 gem 'byebug'
-gem 'rails'
-gem 'devise', require: true
 # gem 'progress_formatter'
 
 # for testing
-gem "rails-controller-testing", group: [:test]
-gem "database_cleaner", group: [:test]
-gem "rspec-rails", group: [:test]
-gem "rspec_junit_formatter", group: [:test]
-gem "factory_bot", group: [:test]
 gem 'simplecov-rcov'
+gem 'rake'
+gem "rspec-rails"
+gem "factory_bot_rails"
+gem "ffaker"
+gem "capybara"
+gem "selenium-webdriver"
+gem "webdrivers"
+
+gem "sprockets-rails"
+gem "importmap-rails"
+gem "stimulus-rails"
+gem "turbo-rails"
+
+
+gem "puma", "~> 5.0"
+
+gem "devise"

data/LICENSE

@@ -3,22 +3,8 @@ This software is 'fauxpen source,' which means you can think of it like 'free' a
 
 It is definitely 'free' as in Britney.
 
-FOR HOBBYISTS/STUDENTS/TEACHERS/INDIVIDUALS/NON-PROFITS:
-
-Permission is hereby granted to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-Any users of this software agree to work to
-1) dismantle systemic racism
-2) seek justice for black, brown, transgender people, women, and
-3) work towards LGBTQIAA+ representation and inclusion
-Organizations using this software agree to center the narratives of black, brown, transgender, and non-advantaged people in the world.
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-Just sign the pledge at https://heliosdev.shop/hot-glue-license and your email will be granted lifetime usage access.
-
 TO PURCHASE A COMMERCIAL USAGE LICENSE PLEASE VISIT
 https://heliosdev.shop/hot-glue-license
 
-OR JUST BUY THE TUTORIAL (all purchases come with lifetime license)
-https://jfb.teachable.com/p/hot-glue-in-depth-tutorial
+OR PURCHASE THE TUTORIAL (all purchases come with lifetime license)
+https://jfbcodes.com/p/hot-glue-in-depth-tutorial

data/README.md

@@ -1,13 +1,11 @@
 
-[![Hot Glue](https://circleci.com/gh/jasonfb/hot-glue.svg?style=shield)](https://circleci.com/gh/jasonfb/hot-glue)
+![Integrated Logo design-639x264](https://user-images.githubusercontent.com/59002/189544688-c1a8226f-9dbd-4758-bc0c-712fc2754cbd.png)
 
 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)).
 
 Using Turbo-Rails and Hotwire (default in Rails 7) you get a lightning-fast out-of-the-box CRUD-building experience.
 
-Every page displays only a list view: new and edit operations happen as 'edit-in-place,' so the user never leaves the page.
-
-Because all page navigation is Turbo's responsibility, everything plugs & plays nicely into a Turbo-backed Rails app.
+Every page displays only a list view: new and edit operations happen as 'edit-in-place,' so the user never leaves the page. Because all page navigation is Turbo's responsibility, everything plugs & plays nicely into a Turbo-backed Rails app.
 
 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.
 
@@ -27,30 +25,26 @@ Hot Glue generates functionality that is quick and dirty. It lets you be crafty.
 * Nest your routes model-by-model for built-in poor man's authentication.
 * Throw the scaffolding away when your app is ready to graduate to its next phase.
 
+How is it different than Rails scaffolding?
 
-# Get Hot Glue
-## [Licence Only Option Now Available](https://heliosdev.shop/p/hot-glue/?utm_source=github.com&utm_campaign=github_hot_glue_readme_page) **only $50 USD!**
-## [GET THE COURSE TODAY (includes Licence)](https://jfbcodes.com/courses/hot-glue-in-depth-tutorial/?utm_source=github.com&utm_campaign=github_hot_glue_readme_page) **only $60 USD!**
-
-|   |  |  
-| ------------- | ------------- |
-| ![Teachable-225x225](https://user-images.githubusercontent.com/59002/147857335-a919e095-e6de-4718-8513-736d1f283a0b.png)  | Now avaiale on [Teachable](https://jfbcodes.com/courses/hot-glue-in-depth-tutorial/?utm_source=github.com&utm_campaign=github_hot_glue_readme_page)  |
+Although inspired by the Rails scaffold generators (built-in to Rails), Hot Glue does something similiar but has made opinionated decisions that deviate from the normal Rails scaffold: 
 
+1. The Hot Glue scaffolds are complete packages and pre-optimized for 'edit-in-place.' (the Rails scaffolds still generate views that make you flip between pages to do create/update operations)
+2. Hot Glue does not create your models along with your scaffolding. Instead, create them first using `rails model new`
+3. Hot Glue *reads* the fields on your database and the relationships defined on your models, so unlike the Rails scaffolding you must do that step before building your scaffolding.
+4. Hot Glue has many more features for building layouts quickly, like choosing which fields to include or exclude and how to lay them out on the page, for stiching together related objects (nesting and child portals), and more. 
 
----
-
+Other than the opinionated differences and additional features, Hot Glue produces code that is fundamentally very similiar and works consistent with the Rails 7 ways of working. 
 
-## NEW GETTING STARTED VIDEO
-The getting started video is newly updated with an explanation of the options for **`jsbundling-rails`/`cssbudling-rails`** when creating a new Rails 7 app.
+# Get Hot Glue
 
-Check it out on Youtube at https://www.youtube.com/watch?v=bKjKHMTvzZc
+## [GET THE COURSE TODAY](https://jfbcodes.com/courses/hot-glue-in-depth-tutorial/?utm_source=github.com&utm_campaign=github_hot_glue_readme_page) **only $60 USD!**
 
-While you're over there could you give my Youtube channel a 'Subscribe'? (look for the RED SUBSCRIBE BUTTON) Thanks so much!
 
+[![Hot Glue Course](https://user-images.githubusercontent.com/59002/189544503-6edbcd40-1728-4b13-ac9a-c7772ccb8284.jpg)](https://jfbcodes.com/courses/hot-glue-in-depth-tutorial/?utm_source=github.com&utm_campaign=github_hot_glue_readme_page)
 
 ---
- 
-
+---
 ## HOW EASY?
 
 ```
@@ -71,43 +65,129 @@ _If you are on Rails 6, see [LEGACY SETUP FOR RAILS 6](https://github.com/jasonf
 
 ## 1. Rails 7 New App
 
-There are two ways to create new apps on Rails 7: With or Without ImportMap. These instructions prefer the **without Importmap** method using ESBuild as the bundler, but to help you choose [see this post](https://jasonfleetwoodboldt.com/courses/stepping-up-rails/rails-7-do-i-need-importmap-rails/)
+To run Turbo (which Hot Glue requires), you must either (1) be running an ImportMap-Rails app, or (2) be running a Node-compiled app using any of JSBundling, Shakapacker, or its alternatives. 
 
-`rails new --css=bootstrap --javascript=esbuild --database=postgresql`
+For reference, see https://jasonfleetwoodboldt.com/courses/stepping-up-rails/rails-7-do-i-need-importmap-rails/
 
-**If using JSBundling, make sure to use the new `./bin/dev` to start your server instead of the old `rails server` or else your Turbo interactions will not work correctly.** 
+Once you create the new Rails app, you can skip to the 'Super-Quick Setup' below.
 
-Confirm that both Stimulus and Turbo are working.
+(1) To use ImportMap Rails, start with
+`rails new`
 
-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/).
+(For full instructions to install Bootstrap with Importmap, check out [these instructions](https://jasonfleetwoodboldt.com/courses/stepping-up-rails/importmap-rails-with-bootstrap-sprockets-stimulus-and-turbo-long-tutorial/))
 
-(Note that Bootstrap is optional for Hot Glue. Here, I am just showing you the default installation for simplicity.)
+(2) To use JSBundling, start with
+`rails new --javascript=jsbundling`
 
-For the old method of installing Bootstrap [see this post](https://jasonfleetwoodboldt.com/courses/stepping-up-rails/rails-7-bootstrap/)
 
-Remember, for Rails 6 you must go through the [LEGACY SETUP FOR RAILS 6](https://github.com/jasonfb/hot-glue/README2.md) before continuing. 
+**If using JSBundling, make sure to use the new `./bin/dev` to start your server instead of the old `rails server` or else your Turbo interactions will not work correctly.**
+(If you want Bootstrap for a JSBundling app, install it following [these instructions](https://jasonfleetwoodboldt.com/courses/stepping-up-rails/rails-7-up-running-with-jsbundling-esbuild-stimulus-turbo-bootstrap-circleci/))
+
+(3) To use Shakapacker, start with `rails new --skip-javascript` and [see this post](https://jasonfleetwoodboldt.com/courses/react-heart-rails/rails-7-shakapacker-and-reactonrails-quick-setup-part-1/)
+
+(For the old method of installing Bootstrap [see this post](https://jasonfleetwoodboldt.com/courses/stepping-up-rails/rails-7-bootstrap/))
+
+(Remember, for Rails 6 you must go through the [LEGACY SETUP FOR RAILS 6](https://github.com/jasonfb/hot-glue/blob/main/README2.md) before continuing.)
+
+If you doing the 'Super-Quick Setup', you can skip the additional blog posts linked above because the steps in them are covered in the shell script(s) below.
+
+## The Super-Quick Setup
+
+Be sure to do `git add .` and `git commit -m "initial commit"` after creating your new Rails 7 app.
+
+```
+bundle add rspec-rails factory_bot_rails ffaker --group "development, test" && 
+git add . && git commit -m "adds gems" && 
+rails generate rspec:install && 
+git add . && git commit -m "adds rspec" && 
+rm app/assets/stylesheets/application.css &&
+echo "" > app/assets/stylesheets/application.scss && 
+sed -i '' -e  's/# gem "sassc-rails"//g' Gemfile && sed -i '' -e 's/# Use Sass to process CSS//g' Gemfile && 
+bundle install && bundle add sassc-rails && git add . && git commit -m "adds sassc-rails" && 
+rm -rf test/ && git add . && git commit -m "removes minitest" && 
+bundle add hot-glue && git add . && git commit -m "adds hot-glue" && 
+rails generate hot_glue:install --layout=bootstrap && 
+git add . && git commit -m "hot glue setup" &&
+bundle add bootstrap &&
+echo "\n@import 'bootstrap';\n" >> app/assets/stylesheets/application.scss
+sed -i '' -e  's/# Rails.application.config.assets.precompile += %w( admin.js admin.css )/Rails.application.config.assets.precompile += %w( application.scss )/g' config/initializers/assets.rb &&
+sed -i '' -e 's/Rails.application.configure do/Rails.application.configure do\n  config.sass.inline_source_maps = true/g' config/environments/development.rb 
+git add . && git commit -m "bootstrap install" &&
+bundle add font_awesome5_rails && 
+echo "\n@import 'font_awesome5_webfont';\n" >> app/assets/stylesheets/application.scss
+git add . && git commit -m "adds fontawesome" &&  
+bundle add kaminari && 
+rails generate kaminari:views bootstrap4 && 
+git add . && git commit -m "adding kaminari and views" &&
+bundle add devise && bundle install && 
+git add . && git commit -m "adding devise gem" && 
+rails generate devise:install && 
+rails g devise:views && 
+sed -i '' -e  's/Rails.application.configure do/Rails.application.configure do\n  config.action_mailer.default_url_options = { host: "localhost", port: 3000 }/g' config/environments/development.rb && 
+sed -i '' -e  's/# root "articles#index"//g' config/routes.rb && 
+sed -i '' -e  's/Rails.application.routes.draw do/Rails.application.routes.draw do\n  root to: "welcome#index"/g' config/routes.rb && 
+git add . && git commit -m 'devise view fixes' &&
+rails generate controller Welcome &&
+sed -i '' -e 's/class WelcomeController < ApplicationController/class WelcomeController < ApplicationController\n  def index\n\n  end/g' app/controllers/welcome_controller.rb &&
+echo "hello world" > app/views/welcome/index.erb &&
+git add . && git commit -m "generates Welcome controller" &&
+sed -i '' -e 's/html: { method: :post }/html: { method: :post, 'data-turbo': false}/g' app/views/devise/confirmations/new.html.erb &&
+sed -i '' -e 's/ url: session_path(resource_name))/ url: session_path(resource_name), html: {"data-turbo": false})/g' app/views/devise/sessions/new.html.erb && 
+sed -i '' -e 's/ url: registration_path(resource_name))/ url: registration_path(resource_name), html: {"data-turbo": false})/g' app/views/devise/registrations/new.html.erb && 
+sed -i '' -e 's/, html: { method: :post })/, html: { method: :post, "data-turbo": false })/g' app/views/devise/passwords/new.html.erb && 
+git add . && git commit -m 'devise view fixes' &&
+rails generate model User name:string &&
+rails generate devise User && git add . && git commit -m "adds Users model with devise" && 
+rails db:migrate &&
+git add . && git commit -m "schema file"
+```
 
-## 2. ADD RSPEC, FACTORY-BOT, AND FFAKER
 
-add these 3 gems to your gemfile **inside a group for both :development and :test*. Do not add these gems to only the :test group or else your will have problems with the generators.
+For Importmap apps:
 ```
-gem 'rspec-rails'
-gem 'factory_bot_rails'
-gem 'ffaker'
+./bin/importmap pin "bootstrap@5.1.3" &&
+./bin/importmap pin "@popperjs/core@2.11.2" &&
+git add . && git commit -m "pinning boostrap and popper js for bootstrap"
 ```
 
+For JSBundling & Shakapacker:
+```
+echo "\ncss: yarn build:css --watch\n" >> Procfile.dev &&
+yarn add @popperjs/core bootstrap bootstrap-icons sass &&
+sed -i '' -e 's/\/\/= link_directory ..\/stylesheets .css//g' app/assets/config/manifest.js &&
+sed -i '' -e 's/  "scripts": {/  "scripts": {\n    "build:css": "sass .\/app\/assets\/stylesheets\/application.scss:.\/app\/assets\/builds\/application.css --no-source-map --load-path=node_modules",/g' package.json &&
+yarn install &&
+git add . && git commit -m "adding bootstrap packages"
+```
+
+
+## Step-By-Step Setup
+
+### 2. ADD RSPEC, FACTORY-BOT, AND FFAKER
+
+add these 3 gems to your gemfile **inside a group for both :development and :test*. 
+Do not add these gems to *only* the :test group or else your Rspec installer and generators will not work correctly.
+```
+group :development, :test do 
+  gem 'rspec-rails'
+  gem 'factory_bot_rails'
+  gem 'ffaker'
+end 
+```
+
+#### Rspec Installer
 - run `rails generate rspec:install`
 
+- Because you are not using Minitest, you can delete the `test/` folder at the root of your repository.
 
 
-## 3. HOTGLUE INSTALLER
-Add `gem 'hot-glue'` to your Gemfile & `bundle install`
 
-Purchase a license at https://heliosdev.shop/p/hot-glue
+### 3. HOTGLUE INSTALLER
+Add `gem 'hot-glue'` to your Gemfile & `bundle install`
 
 During in installation, you MUST supply a `--layout` flag.
 
-### `--layout` flag (only two options: `hotglue` or `bootstrap`; default is `bootstrap`) 
+#### `--layout` flag (only two options: `hotglue` or `bootstrap`; default is `bootstrap`) 
 Here you will set up and install Hot Glue for the first time. 
 
 It will install a config file that will save two preferences: layout (`hotglue` or `bootstrap`)
@@ -115,7 +195,7 @@ It will install a config file that will save two preferences: layout (`hotglue`
 The installer will create `config/hot_glue.yml`. 
 
 
-### `--theme` flag 
+#### `--theme` flag 
 During the installation, **if** your `--layout` flag is set to `hotglue` you must also pass `--theme` flag.
 
 the themes are:
@@ -126,21 +206,21 @@ the themes are:
 • like_cupertino (modern Apple-UX inspired)
 
 
-### `--markup` flag (NOTE: haml and slim are no longer supported at this time)
+#### `--markup` flag (NOTE: haml and slim are no longer supported at this time)
 
 default is `erb`. IMPORTANT: As of right now, HAML and SLIM are not currently supported so the only option is also the default `erb`.
 
 
-### example installing ERB using Bootstrap layout:
+#### example installing ERB using Bootstrap layout:
 `rails generate hot_glue:install --markup=erb --layout=bootstrap`
 
-### Example installing using Hot Glue layout and the 'like_mountain_view' (Gmail-inspired) theme:
+#### Example installing using Hot Glue layout and the 'like_mountain_view' (Gmail-inspired) theme:
 `rails generate hot_glue:install --markup=erb --layout=hotglue --theme=like_mountain_view`
 
 The Hot Glue installer did several things for you in this step. Examine the git diffs or see 'Hot Glue Installer Notes' below.
 
 
-## 4. install font-awesome (optional)
+### 4. Font-awesome (optional)
 
 I recommend
 https://github.com/tomkra/font_awesome5_rails
@@ -148,14 +228,9 @@ or
 https://github.com/FortAwesome/font-awesome-sass
 
 
-## 5. Devise
-!!! Warning: as of 2022-03-22, Devise is still not compatible out-of-the-box with Rails 7.
-
-please see https://github.com/heartcombo/devise/issues/5478 or check this README for updated information. 
-
-
+### 5. Devise
 (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)
-
+https://github.com/jasonfb/hot-glue/blob/main/README2.md
 
 You MUST run the installer FIRST or else you will put your app into a non-workable state:
 ```
@@ -183,13 +258,26 @@ Those features come by default with Devise, and you'll find the fields for them
 In this example above, you are creating all of those fields along with a simple 'name' (string) field for your User table.
 
 
+!!! Warning: as of 2022-09-19, Devise is still not compatible out-of-the-box with Rails Turbo.
+
+To fix this, run
+`rails generate devise:views`
+
 
+Then manually add `html: {'data-turbo' => "false"}` to all of the Devise forms. You will need to edit the following forms:
+`views/devise/sessions/new.html.erb`, `views/devise/registrations/edit.html.erb`, 
+`views/devise/registrations/new.html.erb`, and  
 
-### Hot Glue Installer Notes 
+Add the data-turbo false option in the html key of the form, shown in bold here: 
+
+form_for(resource, as: resource_name, **html: {'data-turbo' => "false"},** url: session_path(resource_name) ) do |f|
+
+
+#### Hot Glue Installer Notes 
 
 These things were **done for you** in Step #3 (above). You don't need to think about them but if you are familiar with Capybara and/or adding Hot Glue to an existing app, you may want to:
 
-####  Hot Glue modified `application.html.erb`
+#####  Hot Glue modified `application.html.erb`
 Note: if you have some kind of non-standard application layout, like one at a different file
 or if you have modified your opening <body> tag, this may not have been automatically applied by the installer.
 
@@ -198,7 +286,7 @@ or if you have modified your opening <body> tag, this may not have been automati
   <%= render partial: 'layouts/flash_notices' %>
 ```
 
-#### Hot Glue modified `rails_helper.rb`
+##### Hot Glue modified `rails_helper.rb`
 Note: if you have some kind of non-standard rails_helper.rb, like one that does not use the standard ` do |config|` syntax after your `RSpec.configure`
 this may not have been automatically applied by the installer.
 
@@ -211,7 +299,7 @@ this may not have been automatically applied by the installer.
   ```  
 
 
-#### Hot Glue switched Capybara from RACK-TEST to HEADLESS CHROME
+##### Hot Glue switched Capybara from RACK-TEST to HEADLESS CHROME
 
 - By default Capybara is installed with :rack_test as its driver.
 - This does not support Javascript. Hot Glue is not targeted for fallback browsers.
@@ -251,7 +339,7 @@ Alternatively, you can define your own driver like so:
     
   ```
 
-#### Hot Glue Added a Quick (Old-School) Capybara Login For Devise
+##### Hot Glue Added a Quick (Old-School) Capybara Login For Devise
 
 - for a quick Capybara login, create a support helper in `spec/support/` and log-in as your user
 - in the default code, the devise login would be for an object called account and lives at the route `/accounts/sign_in`
@@ -269,7 +357,7 @@ Alternatively, you can define your own driver like so:
 
 ---
 ---
-
+---
 
 # HOT GLUE DOCS
 
@@ -278,6 +366,9 @@ Alternatively, you can define your own driver like so:
 
 TitleCase class name of the thing you want to build a scaffoling for.
 
+rails generate hot_glue:scaffold Thing
+
+(note: Your Thing object must belong_to an authenticated User or alternatively you must create a Gd controller, see below.)
 
 ## Options With Arguments
 
@@ -502,14 +593,12 @@ An better alternative is to define the non-standard plurlizations globally in yo
 Make a file at `config/initializers/inflections.rb`
 
 # Add new inflection rules using the following format
+```
 ActiveSupport::Inflector.inflections do |inflect|
     inflect.irregular 'clothing', 'clothes'
     inflect.irregular 'human', 'humans'  
-
-
-    # the standard pluralization is pretty sexist and will pluralize `human` to `humen`
 end
-
+```
 
 ### `--form-labels-position` (default: `after`; options are **before**, **after**, and **omit**)
 By default form labels appear after the form inputs. To make them appear before or omit them, use this flag.
@@ -528,8 +617,6 @@ If you specify any exclude list, those excluded **and** the default exclude list
 
 `rails generate hot_glue:scaffold Account --exclude=password`
 
-(The default excluded list is:  If you want to edit any fields with the same name, you must use the include flag instead.)
-
 
 ### `--include=`
 Separate field names by COMMA
@@ -766,8 +853,19 @@ Sometimes you might want to redisplay the entire list after you make an update (
 
 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.
 
+### `--with-turbo-streams`
+
+If and only if you specify `--with-turbo-streams`, your views will contain `turbo_stream_from` directives. Whereas your views will always contain `turbo_frame_tags` (wether or not this flag is specified) and will use the Turbo stream replacement mechanism for non-idempotent actions (create & update). This flag just brings the magic of live-reload to the scaffold interfaces themselves.
 
+**_To test_**: Open the same interface in two separate browser windows. Make an edit in one window and watch your edit appear in the other window instantly.
 
+This happens using two interconnected mechanisms:
+
+1) by default, all Hot Glue scaffold is wrapped in `turbo_frame_tag`s. The id of these tags is your namespace + the Rails dom_id(...). That means all Hot Glue scaffold is namespaced to the namespaces you use and won't collide with other turbo_frame_tag you might be using elsewhere
+
+2) by appending **model callbacks**, we can automatically broadcast updates to the users who are using the Hot Glue scaffold. The model callbacks (after_update_commit and after_destroy_commit) get appended automatically to the top of your model file. Each model callback targets the scaffold being built (so just this scaffold), using its namespace, and renders the line partial (or destroys the content in the case of delete) from the scaffolding.
+
+please note that *creating* and *deleting* do not yet have a full & complete implementation: Your pages won't re-render the pages being viewed cross-peer (that is, between two users using the app at the same time) if the insertion or deletion causes the pagination to be off for another user.
 
 
 ## Automatic Base Controller
@@ -807,12 +905,26 @@ Child portals have the headings omitted automatically (there is a heading identi
 
 # VERSION HISTORY
 
-#### ???? - v0.5.2 - Hawked Foreign Keys
+#### 2022-11-27 - v0.5.4 - new flag --with-turbo-streams will append callbacks after_update_commit and after_destroy_commit to the MODEL you are building with to use turbo to target the scaffolding being built and programmatically update it
+
+Adds `--with-turbo-streams`. Use `--with-turbo-streams` to create hot (live reload) interfaces. See docs above.
 
 
+#### 2022-11-24 - v0.5.3 - New testing paradigm & removes license requirements
 
+New testing paradigm
+Code cleanup
+Testing on CircleCI
+License check has been removed (Hot Glue is now free to use for hobbyists and individuals. Business licenses are still available at https://heliosdev.shop/hot-glue-license)
 
 
+#### 2022-03-23 - v0.5.2 - Hawked Foreign Keys
+
+ - You can now protect your foreign keys from malicious input and also restrict the scope of drop downs to show only records with the specified access control restriction.
+ - [Example #3](https://jfb.teachable.com/courses/hot-glue-in-depth-tutorial/lectures/38584014) in the Hot Glue Tutorial shows you how to use the hawk to limit the scope to the logged in user.
+ - [Example #4](https://jfb.teachable.com/courses/hot-glue-in-depth-tutorial/lectures/38787505) in the Hot Glue Tutorial shows how to hawk to a non-usual scope, the inverse of the current user's belongs_to (that is, hawk the scope to X where current_user `belongs_to :x`)
+ 
+
 #### 2022-03-12  - v0.5.1 - Inline List Labels
 
 `--inline-list-labels` (default: `after`; options are **before**, **after**, and **omit**)
@@ -872,8 +984,6 @@ Omits the list heading. Note that the listing heading is omitted:
 3) if the model has `@@table_label_plural = nil`, or 
 4) if you are constructing a nested child portal with only non-optionalized parents. 
 
-
-
 #### 2022-02-09 - v0.4.8.1 - Issue with Installer for v0.4.8
     - There was an issue for the installer for v0.4.8. This new version v0.4.8.1 correts it.
 
@@ -958,47 +1068,33 @@ Omits the list heading. Note that the listing heading is omitted:
 #### 2021-02-24 - v0.0.1 - first proof of concept release -- basic CRUD works
 
 
-
 # HOW THIS GEM IS TESTED
 
-SETUP:
-• Run bundle install
-• if you can't get through see https://stackoverflow.com/questions/68050807/gem-install-mimemagic-v-0-3-10-fails-to-install-on-big-sur/68170982#68170982
-
-
-The dummy sandbox is found at `spec/dummy`
-
-The dummy sandbox lives as mostly checked- into the repository, **except** the folders where the generated code goes (`spec/dummy/app/views/`, `spec/dummy/app/controllers/`, `spec/dummy/specs/` are excluded from Git)
+The gem is tested against both generated specs and internal specs. The generated specs are regenerated with the test run, whereas the internal specs live as artifacts in the codebase as you would normally expected specs would.
 
-When you run the **internal specs**, which you can do **at the root of this repo** using the command `rspec`, a set of specs will run to assert the generators are erroring when they are supposed to and producing code when they are supposed to.
-
-The DUMMY testing DOES NOT test the actual functionality of the output code (it just tests the functionality of the generation process).
+The generated specs are created with a small set of 'starter seeds' that exercise the gem's featureset. You can examine the setup easily by looking at the contents of `script/test`
 
+• To setup for testing, start with
+```
+sudo gem install rails
+sudo gem install rspec
+```
 
-# DATABASE
-being able to run `rake spec` at the root of this repo is achieved using
 ```
-ln -s  spec/dummy/db/schema.rb db/schema.rb
+sudo gem install minitest -v 5.1.0
 ```
 
- 
+Unfortunately because of the wrapped nature of the specs, these must be run from globally installed Rubies.
 
-Run rspec as
-``` 
-rake spec
-```
-Or with test coverage report:
+• Once you've done the above, run `script/test`
 
-```
-COVERGE=on rake spec
+This runs both the **generated specs** and also the **internal specs**. Examine this file for details.
 
-```
+To run only the internal specs, use 
 
---
---
- 
-Test coverage as of 2022-02-14 (v0.4.9)
+`COVERGE=on rspec spec`
 
-![Screen Shot 2022-02-14 at 8 33 29 PM](https://user-images.githubusercontent.com/59002/153975911-30fa9c84-c8d8-49e7-bd5c-e2b958d6f10e.png)
+Internal Test coverage as of 2022-03-23 (v0.5.2)
 
+![HG 84 89 coverage report](https://user-images.githubusercontent.com/59002/159719583-a956cfb3-1797-4186-b32c-237ed19e8e2b.png)
 

data/README2.md

@@ -71,9 +71,7 @@ Edit `devise/registrations/new`, `devise/sessions/new`, `devise/passwords/new` a
 form_for(resource, as: resource_name, url: session_path(resource_name) ) do |f|
 
 add the data-turbo false option in the html key:
-```bigquery
 
-```
 form_for(resource, as: resource_name, **html: {'data-turbo' => "false"},** url: session_path(resource_name) ) do |f|
 
 This tells Devise to fall back to non-Turbo interaction for the log-in and registration. For the rest of the app, we will use Turbo Rails interactions.

data/config/database.yml

@@ -1,11 +1,25 @@
-development:
-  adapter: postgresql
-  database: dummy_dev
-  pool: 5
+# SQLite. Versions 3.8.0 and up are supported.
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem "sqlite3"
+#
+default: &default
+  adapter: sqlite3
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
   timeout: 5000
 
+development:
+  <<: *default
+  database: dummy/db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
 test:
-  adapter: postgresql
-  database: dummy_test
-  pool: 5
-  timeout: 5000
+  <<: *default
+  database: dummy/db/test.sqlite3
+
+production:
+  <<: *default
+  database: dummy/db/production.sqlite3