hot-glue 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a29f1b4b001de5e14dbfc1ce046aae144d53f81eb5efecb05c88a69cad06b09
-  data.tar.gz: e4efb4c1d9d87cda11f835750475b6cfc86ea9daa4c25ce5cc08eebca1968d97
+  metadata.gz: 51ed0488e72bcd508f979de89c9f9d11ee1284c702c22066e72311d9cee03894
+  data.tar.gz: f30e2325ec4a08af8df44fa54e955b103aed04b650e2b165bcded589d2f8faa6
 SHA512:
-  metadata.gz: 1b2b2f354390c5d2d0cef4fbd87dfee63de72b69112efc4e1c24c23037ca96f899d077b8876f81a6b8347787d3b997b1b5a7d08608c3039640003398c4974071
-  data.tar.gz: f933f8f06deff1d2f80632ed4b2e4d9ed5ff4d70246c8c99562a15b13ece0a75b3aa9fa86e27935de4555744ee6039183d960debd89eb9bc82f6f2937ab99730
+  metadata.gz: 8eb5cf4982698c4b51ac9caa4c223885ea9f8c2eac423c45e11ff2c7ccbb6c8aaad0e5f43d00cdf4ef3376a04bdc5ea3477813302a1fec8cc3d82e22463a5b51
+  data.tar.gz: 94af84f2f7e66846e593e8ab7ac5c441fbd4b8814c1fc390823a97350fe00854f6c91868094820ca3461e28b10a671cc892430b5d86621a88ef8700376b81a87

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+
+before_install:
+  - gem update --system
+
+
+branches:
+  only:
+    - main
+
+
+script: "rake spec"
+
+rvm:
+  - 2.7.2

data/Gemfile

@@ -3,8 +3,14 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 gemspec
 
+# not required for your app
 gem 'sqlite3'
 gem 'byebug'
-
 gem 'rails', '6.1'
-gem 'devise', require: true
+gem 'devise', require: true
+
+
+# for testing
+gem "rails-controller-testing", group: [:test]
+gem "database_cleaner", group: [:test]
+gem "rspec-rails", group: [:test]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hot-glue (0.2.2)
+    hot-glue (0.2.3)
       ffaker (~> 2.16)
       haml-rails (~> 2.0)
       kaminari (~> 1.2)
@@ -76,12 +76,19 @@ GEM
     byebug (11.1.3)
     concurrent-ruby (1.1.9)
     crass (1.0.6)
+    database_cleaner (2.0.1)
+      database_cleaner-active_record (~> 2.0.0)
+    database_cleaner-active_record (2.0.1)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
     devise (4.8.0)
       bcrypt (~> 3.0)
       orm_adapter (~> 0.1)
       railties (>= 4.1.0)
       responders
       warden (~> 1.2.3)
+    diff-lcs (1.4.4)
     erubi (1.10.0)
     erubis (2.7.0)
     ffaker (2.19.0)
@@ -154,6 +161,10 @@ GEM
       bundler (>= 1.15.0)
       railties (= 6.1.0)
       sprockets-rails (>= 2.0.0)
+    rails-controller-testing (1.0.5)
+      actionpack (>= 5.0.1.rc1)
+      actionview (>= 5.0.1.rc1)
+      activesupport (>= 5.0.1.rc1)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
@@ -169,6 +180,23 @@ GEM
     responders (3.0.1)
       actionpack (>= 5.0)
       railties (>= 5.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-rails (5.0.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.2)
     ruby_parser (3.17.0)
       sexp_processor (~> 4.15, >= 4.15.1)
     sass-rails (6.0.0)
@@ -193,7 +221,7 @@ GEM
     temple (0.8.2)
     thor (1.1.0)
     tilt (2.0.10)
-    turbo-rails (0.7.11)
+    turbo-rails (0.8.1)
       rails (>= 6.0.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
@@ -210,10 +238,13 @@ PLATFORMS
 
 DEPENDENCIES
   byebug
+  database_cleaner
   devise
   hot-glue!
   rails (= 6.1)
+  rails-controller-testing
+  rspec-rails
   sqlite3
 
 BUNDLED WITH
-   2.2.19
+   2.1.4

data/README.md

@@ -1,7 +1,17 @@
 
+[![Build Status](https://app.travis-ci.com/jasonfb/hot-glue.svg?branch=main)](https://travis-ci.com/jasonfb/hot-glue)
+
+
 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 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. 
+
+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 responsibilty, 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-- like an admin interface -- while still treating the rest of the Rails app as an API or building out other features by hand. 
 
 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. 
 
@@ -15,7 +25,7 @@ Hot Glue generates functionality that's quick and dirty. It let's you be crafty.
 * 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)
+* Nest your routes model-by-model for built-in poor man's access control. (Customers have_many :invoices; Invoices have_many :line_items; etc)
 * Plays nicely with Devise, but you can implement your own current_user object instead.
 * Kaminari for pagination.
 * Create specs automatically along with the controllers.
@@ -48,14 +58,19 @@ Instantly get a simple CRUD interface
 
 - Install Turbo `rails turbo:install` (?)
 
-- Add `gem 'hot-glue'` to your Gemfile & `bundle install`
-  `rails generate hot_glue:install --markup=erb`
+- Add `gem 'hot-glue'` to your Gemfile
+- `bundle install`
+- `rails generate hot_glue:install --markup=erb` for ERB
+- or `rails generate hot_glue:install --markup=haml` for HAML
 
 - Add to your `application.html.erb`
 ```
   <%= render partial: 'layouts/flash_notices' %>
 ```
-
+- Or for Haml add to your `application.haml`
+```
+    = render partial: 'layouts/flash_notices' 
+```
 
 ## TO INSTALL (RAILS 6)
 
@@ -114,10 +129,10 @@ FOR HAML:
     ```
 
 ## Install Bootstrap using Sprockets (IMPORTANT: YOU DO NOT NEED JQUERY*)
-    - Bootstrap with Sprockets for Rails 5 or 7 default — Rails 6 custom
+Bootstrap with Sprockets for Rails 5 or 7 default — Rails 6 custom
       - use twbs/bootstrap-rubygem gem
       - see README for bootstrap-rubygem to install
-    - Bootstrap with Webpack for FOR RAILS 7 :
+Bootstrap with Webpack for FOR RAILS 7 :
           
 - add to Gemfile
 - gem 'bootstrap', '~> 5.1.0'
@@ -229,7 +244,7 @@ Then, finally the @charge will be loaded
 
 `@charge = @line.charges.find(params[:id])`
 
-It's called "poor man's auth" because if a user attempts to hack the URL by passing ids for objects they don't own--- which Rails makes relatively easy with its default URL pattern-- they will hit ActiveRecord not found errors (the objects they don't own won't be found in the associated relationship).
+It's called "poor man's access control" because if a user attempts to hack the URL by passing ids for objects they don't own--- which Rails makes relatively easy with its default URL pattern-- they will hit ActiveRecord not found errors (the objects they don't own won't be found in the associated relationship).
 
 It works, but it isn't granular. As well, it isn't appropriate for a large app with any level of intricacy to access control (that is, having roles).
 
@@ -242,7 +257,7 @@ By default, it will be assumed you have a `current_user` for your user authentic
 
 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.
 
-Of course this is a sloppy way to do authentication, and can easily leave open endpoints your real users shouldn't have access to.
+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.
 
 When you display anything built with the scaffolding, we assume 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. In this way, we know that all object are 'anchored' to the logged-in user.
 
@@ -344,9 +359,18 @@ IMPORTANT: By default, all fields that begin with an underscore (`_`) are automa
 
 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.
 
-### `stimulus_syntax` (default is false for Rails <=6; true for Rails 7)
+### `--stimulus_syntax=true` or `--stimulus_syntax=false`
+(for Rails <=6, default is false. For Rails 7, default is true.)
+
+Stimulus is only used for the delete button's confirmation dialog. 
+
+If you don't have stimulus syntax enabled, your delete buttons have this. This will confirm the delete with a simple alert if you have UJS enabled. 
 
-Your delete buttons will look like so:
+```
+{confirm: 'Are you sure?'}
+```
+
+If you do have Stimulus syntax enabled, your delete buttons will look like so:
 ```
     <%= button_to "Delete <i class='fa fa-1x fa-remove'></i>".html_safe, 
         thing_path(branch), method: :delete, 
@@ -356,8 +380,6 @@ Your delete buttons will look like so:
             'action': 'confirmation#confirm'
         },  
         disable_with: "Loading...", class: "delete-branch-button btn btn-primary " %>
-
-
 ```
 
 Your install script will output an additional stimulus controller:
@@ -416,13 +438,39 @@ 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`.
+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.
+
 
+## Automatic Base Controller
 
+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.
+
+Obviously, the created controller will always have this base controller as its subclass. In this way, you are encouraged to implement functionality common to the *namespace* (shared between the controllers in the namespace), using this technique.
+
+## Field Types Supported
+
+- Integers that don't end with `_id`, they will be displayed as text fields.
+- Integers that do end with `_id` will be treated automatically as associations. You should have a Rails association defined. (Hot Glue will warn you if it can't find one.)
+- String*
+- Text*
+- Float*
+- Datetime
+- Date (TOOD: implement this)
+- Time (TOOD: implement this)
+- Boolean 
+- Enum - will be magically displayed as a value list populated from the enum list defined on your model. see https://jasonfleetwoodboldt.com/courses/stepping-up-rails/enumerated-types-in-rails-and-postgres/
+    
+* shows in a size-aware container, i.e. in a bigger box if the field allows for more content
 
 
 
 # VERSION HISTORY
+
+#### 2021-10-07 - v0.2.4 - removes erroneous icons display in delete buttos (these don't work inside of button_to); 
+                            - adds support for ENUM types direclty on your field types
+                            - you  must use activerecord-pgenum
+                            - see my blog post at https://jasonfleetwoodboldt.com/courses/stepping-up-rails/enumerated-types-in-rails-and-postgres/
+
 #### 2021-09-30 - v0.2.3 - fixes ERB output for show-only fields; fixes flash_notices for erb or haml; adds @stimulus_syntax flag for delete confirmations with stimulus
 
 #### 2021-09-27  - v0.2.2 - Fixes some issues with related fields; unlocks Rails 7 in Gemspec file

data/Rakefile

@@ -1,32 +1,42 @@
+
 begin
   require 'bundler/setup'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'HotGlue'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
-load 'rails/tasks/engine.rake'
-
-load 'rails/tasks/statistics.rake'
-
-require 'bundler/gem_tasks'
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => :spec
+rescue LoadError
+  puts 'FAILED: unable to load rspec/core/rake_task in Rakefile'
 end
 
-task default: :test
+#
+# require 'rdoc/task'
+#
+# RDoc::Task.new(:rdoc) do |rdoc|
+#   rdoc.rdoc_dir = 'rdoc'
+#   rdoc.title    = 'HotGlue'
+#   rdoc.options << '--line-numbers'
+#   rdoc.rdoc_files.include('README.md')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end
+#
+# APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+# load 'rails/tasks/engine.rake'
+#
+# load 'rails/tasks/statistics.rake'
+#
+# require 'bundler/gem_tasks'
+
+# require 'rake/testtask'
+#
+# Rake::TestTask.new(:test) do |t|
+#   t.libs << 'test'
+#   t.pattern = 'test/**/*_test.rb'
+#   t.verbose = false
+# end
+#
+# task default: :test

data/app/helpers/hot_glue_helper.rb

@@ -1,4 +1,8 @@
 module HotGlueHelper
 
+  def enum_to_collection_select(hash)
+    hash.collect{|k,v| OpenStruct.new({key: k, value: v})}
+
+  end
 
 end

data/lib/generators/hot_glue/install_generator.rb

@@ -18,6 +18,11 @@ module HotGlue
         copy_file "erb/_flash_notices.erb", "#{'spec/dummy/' if Rails.env.test?}app/views/layouts/_flash_notices.erb"
 
       end
+
+      if Rails.version.split(".")[0].to_i >= 7
+        copy_file "confirmable.js", "#{'spec/dummy/' if Rails.env.test?}app/javascript/controllers/confirmable.js"
+
+      end
     end
   end
 end

data/lib/generators/hot_glue/markup_templates/erb.rb

@@ -19,7 +19,6 @@ module  HotGlue
 
 
     def all_form_fields(*args)
-
       columns = args[0][:columns]
       show_only = args[0][:show_only]
       singular_class = args[0][:singular_class]
@@ -113,7 +112,14 @@ module  HotGlue
               "  <%= f.radio_button(:#{col.to_s}, '1',  checked: #{singular}.#{col.to_s}  ? 'checked' : '') %>\n" +
               "  <%= f.label(:#{col.to_s}, value: 'Yes', for: '#{singular}_#{col.to_s}_1') %>\n" +
             "</div>"
+          when :enum
+            enum_name ="enum_name"
+            "<div class='#{col_identifier} form-group <%= 'alert-danger' if #{singular}.errors.details.keys.include?(:#{col.to_s}) %>' >
+<%= f.collection_select(:#{col.to_s},  enum_to_collection_select( #{singular_class}.defined_enums['#{col.to_s}']), :key, :value, {prompt: true, selected: @#{singular}.#{col.to_s} }, class: 'form-control') %>
+<label class='small form-text text-muted'>#{col.to_s.humanize}</label></div>"
+
           end
+
         end
       }.join("\n")
       return res
@@ -216,6 +222,14 @@ module  HotGlue
     NO
   <% end %>
 </div>
+"        when :enum
+                                                                                                         "<div class='#{col_identifer}'>
+  <% if #{singular}.#{col}.nil? %>
+      <span class='alert-danger'>MISSING</span>
+  <% else %>
+    <%=  #{singular}.#{col} %>
+  <% end %>
+</div>
 "
         end #end of switch
       }.join("\n")

data/lib/generators/hot_glue/scaffold_generator.rb

@@ -286,6 +286,8 @@ module HotGlue
       nil
     end
 
+
+
     def copy_controller_and_spec_files
       @default_colspan = @columns.size
       unless @specs_only
@@ -662,7 +664,7 @@ module HotGlue
     if !@stimulus_syntax
      "{confirm: 'Are you sure?'}"
     else
-     "{controller: 'confirmable', 'confirm-message': \"Are you sure you want to delete \#{ @#{@singular}.#{ display_class } } \", 'action': 'confirmation#confirm'}"
+     "{controller: 'confirmable', 'confirm-message': \"Are you sure you want to delete \#{ #{@singular}.#{ display_class } } \", 'action': 'confirmation#confirm'}"
     end
   end
 

data/lib/generators/hot_glue/templates/confirmable.js

@@ -0,0 +1,14 @@
+import { Controller } from "@hotwired/stimulus"
+
+console.log("defining Confirmable....")
+export default class extends Controller {
+  static values = { message: String }
+
+  confirm(event) {
+
+    if(!window.confirm(this.message)) {
+      event.preventDefault();
+      event.stopPropagation()
+    }
+  }
+}

data/lib/generators/hot_glue/templates/erb/_show.erb

@@ -1,7 +1,7 @@
 <%= all_line_fields %>
 <div class="col">
   <% if destroy_action %>
-    <\%= button_to "Delete <i class='fa fa-1x fa-remove'></i>".html_safe, <%= path_helper_singular %>(<%= path_helper_args %>), method: :delete, data: <%= delete_confirmation_syntax  %>,  disable_with: "Loading...", class: "delete-<%= singular %>-button btn btn-primary " %>
+    <\%= button_to "Delete".html_safe, <%= path_helper_singular %>(<%= path_helper_args %>), method: :delete, data: <%= delete_confirmation_syntax  %>,  disable_with: "Loading...", class: "delete-<%= singular %>-button btn btn-primary " %>
   <% end %>
   &nbsp;
   <\%= link_to "Edit <i class='fa fa-1x fa-list-alt'></i>".html_safe, edit_<%= path_helper_singular %>(<%= path_helper_args %>), <% if @big_edit %>'data-turbo' => 'false', <% end %>disable_with: "Loading...", class: "edit-<%= singular %>-button btn btn-primary " %>

data/lib/hotglue/version.rb

@@ -1,3 +1,3 @@
 module HotGlue
-  VERSION = '0.2.3'
+  VERSION = '0.2.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hot-glue
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Jason Fleetwood-Boldt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-30 00:00:00.000000000 Z
+date: 2021-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -109,6 +109,7 @@ extra_rdoc_files: []
 files:
 - ".github/FUNDING.yml"
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENCE
@@ -133,6 +134,7 @@ files:
 - lib/generators/hot_glue/markup_templates/slim.rb
 - lib/generators/hot_glue/scaffold_generator.rb
 - lib/generators/hot_glue/templates/base_controller.rb.erb
+- lib/generators/hot_glue/templates/confirmable.js
 - lib/generators/hot_glue/templates/controller.rb.erb
 - lib/generators/hot_glue/templates/erb/_errors.erb
 - lib/generators/hot_glue/templates/erb/_flash_notices.erb