hot-glue 0.0.2 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46cd5cd43915874022d96f3342d3cd9b28f7c926c94ea04c29eb8df63152623f
-  data.tar.gz: 932672afaa6e13d9a0ebebf3014a3b67e9ec506b7531a23fa9cde4032652bbb8
+  metadata.gz: ae1088aa0a809a10fb6332fa7ca062e1af6aa39a1c8541dabdf4d8451c5ba04d
+  data.tar.gz: a3ff6d5d8a171e1d1d361df692f6255f855720609e692c21573d6311fbeb41e2
 SHA512:
-  metadata.gz: 7dacdf0e6d3f91883084799025a5dd02a0d1016e55f455a9d9cbf177f1e723cadfc06bd2ddca7f1ad8ecf4e33dec8e3d851689578e123b78cf7a2d8bf2e4a349
-  data.tar.gz: ddc83432caf2a0ab52a952fbda552ab11ab8696efcdf967debd05988a699a8b62ceab227c0d4d00df68c204578adb5ab604683fafa4735b44140a616f375a46a
+  metadata.gz: f65f042a47123cb7a7f69222ddf6618ca085f8cb38bf372179f3bb3da6e47fb07cb383ecba4e0c22642d775db004c0ab111fc99667f575fde62869f7d4c4efba
+  data.tar.gz: e6c36f5bb8a516ee2e74250000174eede61f39c38c46fb74ac963cfa958ac2c5ba2bd3323832b1359ef452e532b7e01b24e04ff68bb67b28df781ccf04e958a4

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,12 +1,13 @@
 PATH
   remote: .
   specs:
-    hot-glue (0.0.1)
+    hot-glue (0.0.7)
       ffaker (~> 2.16)
       haml-rails (~> 2.0)
       kaminari (~> 1.2)
       rails (~> 6.0)
       sass-rails
+      turbo-rails (~> 0.5)
 
 GEM
   remote: https://rubygems.org/
@@ -70,12 +71,20 @@ GEM
       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.17.0)
+    ffaker (2.18.0)
     ffi (1.14.2)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
@@ -117,10 +126,13 @@ GEM
     method_source (1.0.0)
     mimemagic (0.3.5)
     mini_mime (1.0.2)
-    minitest (5.14.3)
-    nio4r (2.5.4)
-    nokogiri (1.11.1-x86_64-darwin)
+    mini_portile2 (2.5.0)
+    minitest (5.14.4)
+    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)
@@ -152,35 +164,39 @@ GEM
       rake (>= 0.8.7)
       thor (~> 1.0)
     rake (13.0.3)
-    rb-fsevent (0.10.4)
-    rb-inotify (0.10.1)
-      ffi (~> 1.0)
-    ruby_parser (3.15.0)
+    responders (3.0.1)
+      actionpack (>= 5.0)
+      railties (>= 5.0)
+    ruby_parser (3.15.1)
       sexp_processor (~> 4.9)
-    sass (3.7.4)
-      sass-listen (~> 4.0.0)
-    sass-listen (4.0.0)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-    sass-rails (5.1.0)
-      railties (>= 5.2.0)
-      sass (~> 3.1)
-      sprockets (>= 2.8, < 4.0)
-      sprockets-rails (>= 2.0, < 4.0)
-      tilt (>= 1.1, < 3)
-    sexp_processor (4.15.1)
-    sprockets (3.7.2)
+    sass-rails (6.0.0)
+      sassc-rails (~> 2.1, >= 2.1.1)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    sassc-rails (2.1.2)
+      railties (>= 4.0.0)
+      sassc (>= 2.0)
+      sprockets (> 3.0)
+      sprockets-rails
+      tilt
+    sexp_processor (4.15.2)
+    sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
     sprockets-rails (3.2.2)
       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)
+    turbo-rails (0.5.9)
+      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)
@@ -190,7 +206,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  byebug
+  devise
   hot-glue!
+  rails (= 6.1)
+  sqlite3
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -6,7 +6,7 @@ As well, its premise is a little different than the configuration-heavy admin in
 
 It gives users full control over objects they 'own' and by default it spits out functionality giving access to all fields. 
 
-Hot Glue generates functionality that's quick and dirty. It let's you be crafty. Like a real glue gun with hot glue, take care not to burn yourself while using it. 
+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. 
 
 * Build plug-and-play scaffolding mixing HAML and turbo_stream responses
 * Automatically Reads Your Models (make them before building your scaffolding!)
@@ -35,20 +35,29 @@ rails generate hot_glue:scaffold Thing
 
 ## TO INSTALL
 
-- Add Turbo-Rails to your Gemfile & bundle install, then install it with `rails turbo:install`
+- Add 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 hot_glue:install`
+- Add `hot_glue` to your Gemfile & `bundle install`
+  
+- Then install it with `rails generate hot_glue:install`
+
+- Add to your `application.html.erb`
+```
+  <%= render partial: 'layouts/flash_notices' %>
+```
 
 - Install Bootstrap (optional)
 
-with Webpack: 
+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 contents
+  - create a new file at `app/javascript/css/site.scss` with this content
     ```
-    @import "~bootstrap/scss/bootstrap.scss
+    @import "~bootstrap/scss/bootstrap.scss";
     ```
     
   - add to `app/javascript/packs/application.js` 
@@ -56,28 +65,31 @@ with Webpack:
     import 'css/site'
     ```
     
+Bootstrap with Sprockets:
+  - use bootstrap-rails gem 
     
 
 - Install Devise or implement your own authentication
 
+- Also recommended: font-awesome-sass
 
 
-## Options
+### First Argument
+(no double slash)
 
-Note that the arguments are not preceded by dashes and are followed by equal sign and the input you are giving.
+TitleCase class name of the thing you want to build a scaffoling for.
 
-Flags take two dashes (--) and do not take any value. Always pass options first, followed by the flags (or else your options won't work!)
 
-### First Argument
+## Options With Arguments 
 
-TitleCase class name of the thing you want to build a scaffoling for.
+All options two dashes (--) and these take an `=` and a value
 
-### `namespace=`
+### `--namespace=`
 
-pass `namespace=` as an option to denote a namespace to apply to the Rails path helpers
+pass `--namespace=` as an option to denote a namespace to apply to the Rails path helpers
 
 
-`rails generate hot_glue:scaffold Thing namespace=dashboard`
+`rails generate hot_glue:scaffold Thing --namespace=dashboard`
 
 This produces several views at `app/views/dashboard/things/` and a controller at`app/controllers/dashboard/things_controller.rb`
 
@@ -96,12 +108,12 @@ end
 ```
 
 
-### `nest=`
+### `--nest=`
 
-pass `nest=` to denote a nested resources
+pass `--nest=` to denote a nested resources
 
 
-`rails generate hot_glue:scaffold Line nest=invoice`
+`rails generate hot_glue:scaffold Line --nest=invoice`
 
 In this example, it is presumed that the current user has_many :invoices, and that invoices have many :lines
 
@@ -120,7 +132,7 @@ In this example, it is presumed that the current user has_many :invoices, and th
 
 
 To generate scaffold:
-`rails generate hot_glue:scaffold Charge nest=invoice/line`
+`rails generate hot_glue:scaffold Charge --nest=invoice/line`
 
 The order of the nest should match the nested resources you have in your own app.  In particular, you auth root will be used as the starting point when loading the objects from the URL:
 
@@ -143,7 +155,7 @@ It works, but it isn't granular. As well, it isn't appropriate for a large app w
 Your customers can delete their own objects by default (may be a good idea or a bad idea for you). If you don't want that, you should strip out the delete actions off the controllers.
 
 
-### `auth=`
+### `--auth=`
 
 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.
 
@@ -157,7 +169,7 @@ If you use Devise, you probably already have a `current_user` method available i
 
 If you use a different object other than "User" for authentication, override using the `auth` option.
 
-`rails generate hot_glue:scaffold Thing auth=current_account`
+`rails generate hot_glue:scaffold Thing --auth=current_account`
 
 You will note that in this example it is presumed that the Account object will have an association for `things`
 
@@ -168,7 +180,7 @@ If you supply nesting (see below), your nest chain will automatically begin with
 
 
 
-### `auth_identifier=`
+### `--auth_identifier=`
 
 Your controller will call a method authenticate_ (AUTH IDENTIFIER) bang, like:
 
@@ -198,7 +210,7 @@ As well, the `after_sign_in_path_for(user)` here is a hook for Devise also that
 The default (do not pass `auth_identifier=`) will match the `auth` (So if you use 'account' as the auth, `authenticate_account!` will get invoked from your generated controller; the default is always 'user', so you can leave both auth and auth_identifier off if you want 'user')
 
 
-`rails generate hot_glue:scaffold Thing auth=current_account auth_identifier=login`
+`rails generate hot_glue:scaffold Thing --auth=current_account --auth_identifier=login`
 In this example, the controller produced with:
 ```
    before_action :authenticate_login!
@@ -209,25 +221,55 @@ However, the object graph anchors would continue to start from current_account.
 ```
 
 Use empty string to **turn this method off**:
-`rails generate hot_glue:scaffold Thing auth=current_account auth_identifier=''`
+`rails generate hot_glue:scaffold Thing --auth=current_account --auth_identifier=''`
 
 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.
 
 Please note that this example would product non-functional code, so you would need to manually fix your controllers to make sure `current_account` is available to the controller.
 
 
-### `plural=`
+### `--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 which is non-standard for Rails)
+
+
+### `--exclude=`
+(separate field names by COMMA)
+
+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 and the default excluded list will be excluded.
+
+
+`rails generate hot_glue:scaffold Account --exclude=password`
 
-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)
+(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.)
 
 
-### `--god`
+### `--include=`
+(separate field names by COMMA)
 
-Use this flag to create controllers with no root authentication. You can still use an auth_identifier, which can be useful for a meta-leval authentication to the controoler.
+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. 
 
-For example, FOR ADMIN CONTROLLERS ONLY, supply a auth_identifier and use `--god` flag
+`rails generate hot_glue:scaffold Account --include=first_name,last_name,company_name,created_at,kyc_verified_at`
 
-In God mode, the objects are loaded directly from the base class (these controllers have full access)
+
+### `--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`
+
+Use this flag to create controllers with no root authentication. You can still use an auth_identifier, which can be useful for a meta-leval authentication to the controller.
+
+For example, FOR ADMIN CONTROLLERS ONLY, supply a auth_identifier and use `--god` flag. 
+
+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])
@@ -235,7 +277,8 @@ end
 
 ```
 
-
+## FLAGS (Options with no values)
+These options (flags) also uses `--` syntax but do not take any values. Everything is assumed (default) to be false unless specified.
 
 ### `--specs-only`
 
@@ -247,7 +290,43 @@ Produces ONLY the controller spec file, nothing else.
 Produces all the files except the spec file.
 
 
+### `--no-paginate`
+
+Omits pagination. (All list views have pagination by default.)
+
+
+### `--no-create`
+
+Omits create action. 
+
+### `--no-delete`
+
+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-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
+
+#### 2021-02-25 - v0.0.2 - bootstrapy
+
 #### 2021-02-24 - v0.0.1 - first proof of concept release -- basic CRUD works 
 
 #### 2021-02-23 - v0.0.0 - Port of my prior work from github.com/jasonfb/common_core_js
@@ -260,3 +339,34 @@ Produces all the files except the spec file.
 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
+
+The testing of functionality-within-functionality is a little tricky and requires thinking outside the box.
+
+We have two kinds of "sandboxes": a DUMMY sandbox, and also a STRAWMAN 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).
+
+For this reason, I've also added something I call STRAWMAN testing, which is a set of steps that does these things:
+
+The Strawman isn't in the repository, but if you build it locally, it will create itself into
+
+`spec/strawman/`
+
+1) Builds you a strawman sandbox app from scratch, using the native `rails new`
+2) Makes a few small modifications to the new app to support this gem
+3) Create two nonsense tables called OmnitableA and OmnitableB. Each omnitable has one of each kind of field (integer, text, string, date, time, etc)
+4) In this way, it is a "Noah's Arc" testing strategy: It will build you a fully functional app using all of the feature sets of the gem.
+5) The built app itself will contain its own specs
+6) You will then cd into `spec/strawman` and run `rspec`. This second test suite now runs to full test all of the *generated* code. 
+
+