hot-glue 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ddd0fff6e983cefb9f4705ecfa218553412a78d6b02e70f246427562b0991e4
-  data.tar.gz: 12971b62efd73dc85db9a48b7d9874f8ba9e81615f1f981af6d00cd2d58a57d7
+  metadata.gz: 88c8ae8859f5a37ed898fb4047ab2a406c5eacbb766bcbf6dc2b43f5d419b751
+  data.tar.gz: 8685951b462a1b9c0f3e5920b193e057a15a2d497d103bf163702dfdbfa4f89f
 SHA512:
-  metadata.gz: 3f436af0a80f4228e2f17f290d9be67aa1ffc7e48379d92a6739889906bf1a148df922db4af8f5989567bc6306336541de7685dbf41a89de4d7c6caa26235d55
-  data.tar.gz: 566393c43f57c2ec3e5e09b2ddd1e3684f643f10fa76468e7343cac20ccd0a015bc6c71f417181cecc60c2e97d10dfecbf36b735c7e2db8dd25556dee5669db0
+  metadata.gz: 54f3cbd725a0ca775b688405d8f00b0aa5611a4bd2d2bbb0566bb72fcf8a1c532e3dc88684e55a0c63dd300c0f0f0f9549f5536b74fba36714f5c97a14467c18
+  data.tar.gz: 269fe5314a3acbc91591efea6b2f43e049244152bfb6e1c803b67c0d4b233a461cf2131fe4825a331e205c830ee7961ba78d7c6b617374291e8c9ebb63952735

data/.github/FUNDING.yml

@@ -1,2 +1,2 @@
 github: [jasonfb]
-custom: ["https://jfb.teachable.com"]
+custom: ["https://www.instagram.com/jfbcodes/"]

data/.gitignore

@@ -1,16 +1,21 @@
 .bundle/
 log/*.log
 pkg/
-test/dummy/db/*.sqlite3
-test/dummy/db/*.sqlite3-journal
-test/dummy/db/*.sqlite3-*
-test/dummy/log/*.log
-test/dummy/storage/
-test/dummy/tmp/
+
 .byebug_history
 
 .idea/
 *.gem
 .DS_Store
 
-dump.rdb
+dump.rdb
+tmp/
+
+
+db/*.sqlite3
+
+spec/dummy/app/views/
+spec/dummy/app/controllers/
+spec/dummy/specs/
+
+spec/strawman/

data/Gemfile

@@ -1,15 +1,10 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-# Declare your gem's dependencies in common_core_js.gemspec.
-# Bundler will treat runtime dependencies like base dependencies, and
-# development dependencies will be added by default to the :development group.
 gemspec
 
-# Declare any dependencies that are still in development here instead of in
-# your gemspec. These might include edge Rails or gems from your path or
-# Git. Remember to move these dependencies to your gemspec before releasing
-# your gem to rubygems.org.
+gem 'sqlite3'
+gem 'byebug'
 
-# To use a debugger
-# gem 'byebug', group: [:development, :test]
+gem 'rails', '6.1'
+gem 'devise', require: true

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hot-glue (0.0.4)
+    hot-glue (0.0.9)
       ffaker (~> 2.16)
       haml-rails (~> 2.0)
       kaminari (~> 1.2)
@@ -12,72 +12,80 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.1.3)
-      actionpack (= 6.1.3)
-      activesupport (= 6.1.3)
+    actioncable (6.1.0)
+      actionpack (= 6.1.0)
+      activesupport (= 6.1.0)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.1.3)
-      actionpack (= 6.1.3)
-      activejob (= 6.1.3)
-      activerecord (= 6.1.3)
-      activestorage (= 6.1.3)
-      activesupport (= 6.1.3)
+    actionmailbox (6.1.0)
+      actionpack (= 6.1.0)
+      activejob (= 6.1.0)
+      activerecord (= 6.1.0)
+      activestorage (= 6.1.0)
+      activesupport (= 6.1.0)
       mail (>= 2.7.1)
-    actionmailer (6.1.3)
-      actionpack (= 6.1.3)
-      actionview (= 6.1.3)
-      activejob (= 6.1.3)
-      activesupport (= 6.1.3)
+    actionmailer (6.1.0)
+      actionpack (= 6.1.0)
+      actionview (= 6.1.0)
+      activejob (= 6.1.0)
+      activesupport (= 6.1.0)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.1.3)
-      actionview (= 6.1.3)
-      activesupport (= 6.1.3)
+    actionpack (6.1.0)
+      actionview (= 6.1.0)
+      activesupport (= 6.1.0)
       rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.1.3)
-      actionpack (= 6.1.3)
-      activerecord (= 6.1.3)
-      activestorage (= 6.1.3)
-      activesupport (= 6.1.3)
+    actiontext (6.1.0)
+      actionpack (= 6.1.0)
+      activerecord (= 6.1.0)
+      activestorage (= 6.1.0)
+      activesupport (= 6.1.0)
       nokogiri (>= 1.8.5)
-    actionview (6.1.3)
-      activesupport (= 6.1.3)
+    actionview (6.1.0)
+      activesupport (= 6.1.0)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.1.3)
-      activesupport (= 6.1.3)
+    activejob (6.1.0)
+      activesupport (= 6.1.0)
       globalid (>= 0.3.6)
-    activemodel (6.1.3)
-      activesupport (= 6.1.3)
-    activerecord (6.1.3)
-      activemodel (= 6.1.3)
-      activesupport (= 6.1.3)
-    activestorage (6.1.3)
-      actionpack (= 6.1.3)
-      activejob (= 6.1.3)
-      activerecord (= 6.1.3)
-      activesupport (= 6.1.3)
+    activemodel (6.1.0)
+      activesupport (= 6.1.0)
+    activerecord (6.1.0)
+      activemodel (= 6.1.0)
+      activesupport (= 6.1.0)
+    activestorage (6.1.0)
+      actionpack (= 6.1.0)
+      activejob (= 6.1.0)
+      activerecord (= 6.1.0)
+      activesupport (= 6.1.0)
       marcel (~> 0.3.1)
       mimemagic (~> 0.3.2)
-    activesupport (6.1.3)
+    activesupport (6.1.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
+    bcrypt (3.1.16)
     builder (3.2.4)
+    byebug (11.1.3)
     concurrent-ruby (1.1.8)
     crass (1.0.6)
+    devise (4.7.3)
+      bcrypt (~> 3.0)
+      orm_adapter (~> 0.1)
+      railties (>= 4.1.0)
+      responders
+      warden (~> 1.2.3)
     erubi (1.10.0)
     erubis (2.7.0)
     ffaker (2.18.0)
-    ffi (1.14.2)
+    ffi (1.15.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     haml (5.2.1)
@@ -118,41 +126,47 @@ GEM
     method_source (1.0.0)
     mimemagic (0.3.5)
     mini_mime (1.0.2)
+    mini_portile2 (2.5.0)
     minitest (5.14.4)
-    nio4r (2.5.5)
-    nokogiri (1.11.1-x86_64-darwin)
+    nio4r (2.5.7)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
+    orm_adapter (0.5.0)
     racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.1.3)
-      actioncable (= 6.1.3)
-      actionmailbox (= 6.1.3)
-      actionmailer (= 6.1.3)
-      actionpack (= 6.1.3)
-      actiontext (= 6.1.3)
-      actionview (= 6.1.3)
-      activejob (= 6.1.3)
-      activemodel (= 6.1.3)
-      activerecord (= 6.1.3)
-      activestorage (= 6.1.3)
-      activesupport (= 6.1.3)
+    rails (6.1.0)
+      actioncable (= 6.1.0)
+      actionmailbox (= 6.1.0)
+      actionmailer (= 6.1.0)
+      actionpack (= 6.1.0)
+      actiontext (= 6.1.0)
+      actionview (= 6.1.0)
+      activejob (= 6.1.0)
+      activemodel (= 6.1.0)
+      activerecord (= 6.1.0)
+      activestorage (= 6.1.0)
+      activesupport (= 6.1.0)
       bundler (>= 1.15.0)
-      railties (= 6.1.3)
+      railties (= 6.1.0)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.1.3)
-      actionpack (= 6.1.3)
-      activesupport (= 6.1.3)
+    railties (6.1.0)
+      actionpack (= 6.1.0)
+      activesupport (= 6.1.0)
       method_source
       rake (>= 0.8.7)
       thor (~> 1.0)
     rake (13.0.3)
+    responders (3.0.1)
+      actionpack (>= 5.0)
+      railties (>= 5.0)
     ruby_parser (3.15.1)
       sexp_processor (~> 4.9)
     sass-rails (6.0.0)
@@ -173,6 +187,7 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
     temple (0.8.2)
     thor (1.1.0)
     tilt (2.0.10)
@@ -180,6 +195,8 @@ GEM
       rails (>= 6.0.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
+    warden (1.2.9)
+      rack (>= 2.0.9)
     websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
@@ -189,7 +206,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  byebug
+  devise
   hot-glue!
+  rails (= 6.1)
+  sqlite3
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,72 +1,118 @@
 # Hot Glue
 
-Hot Glue is an evolution of the best of the admin-style scaffold builders 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) being the most popular of those). It harnesses the power of Rails 6, Turbo-Rails, and Hotwire to deliver a lightning fast experience.
+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)). 
 
-As well, its premise is a little different than the configuration-heavy admin interface toolkits. 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 scaffold after adding fields. 
+Using Turbo-Rails and Hotwire 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. 
 
-It gives users full control over objects they 'own' and by default it spits out functionality giving access to all fields. 
+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 scaffold after adding fields. 
 
-Hot Glue generates functionality that's quick and dirty. It let's you be crafty. As with a real glue gun, take care not to burn yourself while using it. 
+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. 
 
-* Build plug-and-play scaffolding mixing HAML and turbo_stream responses
-* Automatically Reads Your Models (make them before building your scaffolding!)
-* CRUD, lists with pagination, (coming soon: sorting & searching)
-* Wonderful for prototyping.
-* Nest your routes model-by-model for built-in poor man's authentication.
+Hot Glue generates functionality that's quick and dirty. It let's you be crafty. As with a real hot glue gun, use with caution. 
+
+* Build plug-and-play scaffolding for any CRUD on any object
+* mixes HAML and turbo_stream responses
+* Everything edits-in-place (unless you use --big-edit, then it won't)  
+* Automatically reads your ActiveRecord models and relationships (make them before building your scaffolding!)
+* Create-read-update-delete (CRUD) with pagination (one day: sorting & searching)
+* Excellent tool for prototyping and hackathons, but a knowledge of Rails is needed. 
+* Nest your routes model-by-model for built-in poor man's authentication. (Customers have_many :invoices; Invoices have_many :line_items; etc)
 * Plays nicely with Devise, but you can implement your own current_user object instead.
-* Requires & uses Kaminari for pagination.
-* Create specs automatically along with the controllers (* rspec only for now).
+* Kaminari for pagination.
+* Create specs automatically along with the controllers.
 * Throw the scaffolding away when your app is ready to graduate to its next phase (or don't if you like it).
 
-## QUICK START (COMING SOON)
+## QUICK START
 
 It's really easy to get started by following along with this blog post that creates three simple tables (User, Event, and Format).
 
 Feel free to build your own tables when you get to the sections for building the 'Event' scaffold:
 
-https://blog.jasonfleetwoodboldt.com/hot-glue
+https://jasonfleetwoodboldt.com/hot-glue
 
 ## HOW EASY?
 
-
 ```
 rails generate hot_glue:scaffold Thing 
 ```
 
+Generate a quick scaffold to manage a table called `pronouns`
+![hot-glue-3](https://user-images.githubusercontent.com/59002/116405509-bdee2f00-a7fd-11eb-9723-4c6e22f81bd3.gif)
+
+
+
+Instantly get a simple CRUD interface
+
+![hot-glue-4](https://user-images.githubusercontent.com/59002/116405517-c2b2e300-a7fd-11eb-8423-d43e3afc9fa6.gif)
+
+
 ## TO INSTALL
 
-- Add Turbo-Rails to your Gemfile & bundle install, then install it with `rails turbo:install`
+- Add `gem 'turbo-rails'` to your Gemfile & `bundle install`
+  
+- Then install it with `rails turbo:install`
 
 - The Turbo install has switched your action cable settings from 'async' to Redis, so be sure to start a redis server
   
-- Add hot_glue to your Gemfile & bundle install, then install it with `rails generate hot_glue:install`
+- Add `gem 'hot-glue'` to your Gemfile & `bundle install`
+  
+- Run the hot-glue installation with `rails generate hot_glue:install`
 
 - Add to your `application.html.erb`
 ```
   <%= render partial: 'layouts/flash_notices' %>
 ```
 
+- Rspec setup
+  add `gem 'rspec-rails'` to your gemfile inside :development and :test
+  add `gem 'factory_bot_rails'` to your gemfile inside :development and :test
+  run `rails generate rspec:install`
+  configure Rspec to work with Factory Bot inside of `rails_helper.rb`
+    ```
+    RSpec.configure do |config|
+        // ... more rspec configuration (not shown)
+        config.include FactoryBot::Syntax::Methods
+    end
+    ```  
+
+  https://github.com/thoughtbot/factory_bot/blob/master/GETTING_STARTED.md#rspec
+
+  - for a quick Capybara login, create a support helper in `spec/support/` and log-in as your user
+    ```
+    def login_as(account)
+      visit '/accounts/sign_in'
+      within("#new_account") do
+      fill_in 'Email', with: account.email
+      fill_in 'Password', with: 'password'
+      end
+      click_button 'Log in'
+    end
+    ```
+
 - Install Bootstrap (optional)
 
 Bootstrap with Webpack: 
   - change `stylesheet_link_tag` to `stylesheet_pack_tag` in your application layout
-  - `yarn add bootstrap`
-  - create a new file at `app/javascript/css/site.scss` with this content
+  - run `yarn add bootstrap`
+  - create a new file at `app/javascript/require_bootstrap.scss` with this content
     ```
     @import "~bootstrap/scss/bootstrap.scss";
     ```
     
   - add to `app/javascript/packs/application.js` 
     ```
-    import 'css/site'
+    import 'require_bootstrap'
     ```
     
 Bootstrap with Sprockets:
-  - use bootstrap-rails gem 
-    
+  - use bootstrap-rubygem gem 
+  - see README for bootstrap-rubygem to install
+  
 
 - Install Devise or implement your own authentication
+  (or only use --gd mode, see below)
 
+- font-awesome
 
 
 ### First Argument
@@ -225,7 +271,7 @@ Please note that this example would product non-functional code, so you would ne
 
 ### `--plural=`
 
-You don't need this if the pluralized version is just + "s" of the singular version. Only use for non-standard plurlizations, and be sure to pass it as TitleCase (as if  you pluralized the model name)
+You don't need this if the pluralized version is just + "s" of the singular version. Only use for non-standard plurlizations, and be sure to pass it as TitleCase (as if you pluralized the model name which is non-standard for Rails)
 
 
 ### `--exclude=`
@@ -233,9 +279,30 @@ You don't need this if the pluralized version is just + "s" of the singular vers
 
 By default, all fields are included unless they are on the exclude list. (The default for the exclude list is `id`, `created_at`, and `updated_at`  so you don't need to exclude those-- they are added.)
 
-If you specify an exclude list, those fields + id, created_at, and updated_at will be excluded.
+If you specify an exclude list, those and the default excluded list will be excluded.
+
+
+`rails generate hot_glue:scaffold Account --exclude=password`
+
+(The default excluded 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. If you want to edit any fields with the same name, you must use the include flag instead.)
 
 
+### `--include=`
+(separate field names by COMMA)
+
+You may not specify both include and exclude. If you specify an include list, it will be treated as a whitelist: no fields will be included unless specified on the include list. 
+
+`rails generate hot_glue:scaffold Account --include=first_name,last_name,company_name,created_at,kyc_verified_at`
+
+
+### `--show-only=`
+(separate field names by COMMA)
+
+Any fields only the 'show-only' list will appear as non-editable on the generate form. (visible only)
+
+IMPORTANT: By default, all fields that begin with an underscore (`_`) are automatically show-only.
+
+I would recommend this for fields you want globally non-editable by users in your app. For example, a counter cache or other field set only by a backend mechanism.
 
 ### `--god` or `--gd`
 
@@ -243,7 +310,7 @@ Use this flag to create controllers with no root authentication. You can still u
 
 For example, FOR ADMIN CONTROLLERS ONLY, supply a auth_identifier and use `--god` flag. 
 
-In God mode, the objects are loaded directly from the base class (these controllers have full access)
+In Gd mode, the objects are loaded directly from the base class (these controllers have full access)
 ```
 def load_thing
     @thing = Thing.find(params[:id])
@@ -277,12 +344,29 @@ Omits create action.
 
 Omits delete action. 
 
+### `--big-edit`
+
+If you do not want inline editing of your list items but instead to fall back to old fashioned new page behavior for your edit views, use `--big-edit`.
+
+
 
 
 
 # VERSION HISTORY
 
-#### 2021-03-01 - v0.0.4 - Validation magic; refactors the options to the correct Rails::Generators syntax
+#### 2021-04-28 - v0.1.0 - Very please to introduce full behavior specs, found in specs/system/, generated by default on all build code; also many fixes involving nesting and authentication"
+
+#### 2021-03-24 - v0.0.9 - fixes in the automatic field label detection; cleans up junk in spec output
+
+#### 2021-03-21 - v0.0.8 - show only flag; more specific spec coverage in generator spec
+
+#### 2021-03-20 - v0.0.7 - adds lots of spec coverage; cleans up generated cruft code on each run;  adds no-delete, no-create; a working --big-edit with basic data-turbo false to disable inline editing
+
+#### 2021-03-06 - v0.0.6 - internal specs test the error catches and cover basic code generation (dummy testing only)
+
+#### 2021-03-01 - v0.0.5 - Validation magic; refactors the options to the correct Rails::Generators syntax
+
+#### (yanked)   - v0.0.4
 
 #### 2021-02-27 - v0.0.3 - several fixes for namespaces; adds pagination; adds exclude list to fields
 
@@ -293,10 +377,18 @@ Omits delete action.
 #### 2021-02-23 - v0.0.0 - Port of my prior work from github.com/jasonfb/common_core_js
 
 
-# ACKNOWLEDGEMENTS
 
-### "POOR MAN"
 
-I hope one day I will leave this Earth a poor man (like my code) owning only the most simple structure for the simple form of my existence. Thanks for having educated me in this wisdom goes to my former mentor [@trak3r](https://github.com/trak3r)! 
 
+# HOW THIS GEM IS TESTED
+
+We have one kind of "sandboxes": a DUMMY sandbox
+
+The dummy sandbox is found at `spec/dummy`
+
+The dummy 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)
+
+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).