hot-glue 0.6.0 → 0.6.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 822437dfda890941c29f2ff18b927c60a84279306c0937d354f69e18c67f51e5
-  data.tar.gz: 193b9bb92313ae7440c72d8d7598f918400136f7edabc70bf7ec7def1b4f96ed
+  metadata.gz: 8ffc84538112521ab7f15e7c0d234de7ffc5e5231e49a6ffb3cb3fd77c4f0545
+  data.tar.gz: f9e7c8e6b171aace305d5fae08ee24d08f6304c0127e5044579e8d3c30cc6ca6
 SHA512:
-  metadata.gz: '0210383122eded31e46b9cc02bc6a7c230d95936f13635149c884774e762b178eb326e3722466a6ff8e365fd3d45782a05c0a60733d678499762ff49d6f7b58d'
-  data.tar.gz: 8cc9ed4dc85875d66dbd66ecac22908bfd6a8759588e37a2b26bb03522a16b8559ca0bc0ee0311a28a627f2f25af703ed744ea1aba6f8f1d48c5fbc35d28748a
+  metadata.gz: 53da97a3e0c570c41594ae47ed50149a5519e512d1677c38dc70fb118e69893d67165b7f7de89e0e8f56325f766934225f810c52fba501c9b9a1a71943cdc365
+  data.tar.gz: f6fd036dd5abeb33724927a6a25e2fab560f553f4df23cf186438f09036e68f147aef50ce356b7c9c3858cd3fbe81c02bc9649b46076562da3a3cf43f0cf0530

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hot-glue (0.5.26)
+    hot-glue (0.6.0)
       ffaker (~> 2.16)
       kaminari (~> 1.2)
       rails (> 5.1)
@@ -139,7 +139,7 @@ GEM
     mini_mime (1.1.2)
     mini_portile2 (2.8.4)
     minitest (5.16.3)
-    net-imap (0.4.2)
+    net-imap (0.4.4)
       date
       net-protocol
     net-pop (0.1.2)

data/README.md

@@ -64,25 +64,23 @@ _If you are on Rails 6, see [LEGACY SETUP FOR RAILS 6](https://github.com/jasonf
 
 ## The Super-Quick Setup
 
-https://jasonfleetwoodboldt.com/courses/stepping-up-rails/rails-quick-scripts/
+https://jasonfleetwoodboldt.com/courses/stepping-up-rails/jason-fleetwood-boldts-rails-cookbook/
 
-Copy & paste the whole code block from each section into your terminal. (Pick only ONE option for each section.)
+Copy & paste the whole code block from each section into your terminal. Remember, there is a small "Copy" button at the top-right of each code block to help you copy & paste the script into your terminal. 
 
+These are the sections you need, you can ignore any others:
 
-From section #1 (`rails new`), choose either (1) ImportMap Rails, (2) JSBundling, or (3) Shakapacker. 
-
-For Hot Glue, you will need:
-
-Section #1 is to create a new Rails app. (Or you can do that yourself.)
-
-Section #2 is to setup Rspec, FactoryBot, and Faker — choose 2B for Rspec0
-
-Skip #3 and #4 is optional. #5 is optional but recommended. 
-
-Sectoin #6 is for Hot Glue itself, and Section #7 is for Kaminari
-
-You will also need section #8 to setup Devise if you want authentication.
+* Section 1A for a new JS Bundling app, then skip down to 
+* Section 2B: Rspec + Friends
+* Section 2B-Capy: Capybara for Rspec, then skip down to 
+* Section 3 for a welcome controller
+( you can skip everything in Section 4 )
+* Section 5 for debugging tools
+* _Section 6 is the Hot Glue installer itself_ (this gem) - for Bootstrap, choose section 6A
+* Section 7A to install Bootstrap along with CSSBundling
+* Section 8 to set up Devise if you want authentication. (See how Hot Glue interacts with Devise below.)
 
+If you do this through the quick setup above, you can then skip down past the next section to the "HOT GLUE DOCS" below. 
 
 ## Step-By-Step Setup
 
@@ -294,10 +292,21 @@ Alternatively, you can define your own driver like so:
 
 # HOT GLUE DOCS
 
+Remember: Use `bin/rails generate model Thing` to generate models. Then add `has_many`, `belongs_to`, and _migrate your database_ before building the scaffold with Hot Glue.
+
+You will also need every Rails model to contain _either_ a database column _or_ an object-level method named one of these five things:
+`name`
+`to_label`
+`full_name`
+`display_name`
+`email`
+
+If your database doesn't contain one of these five, add a method to your model using `def to_label`. This will be used as the default label for the object throughout the Hot Glue build system. 
+
 ## First Argument
 (no double slash)
 
-TitleCase class name of the thing you want to build a scaffoling for.
+TitleCase class name of the thing you want to build a scaffolding for.
 
 ```
 ./bin/rails generate hot_glue:scaffold Thing
@@ -1393,7 +1402,7 @@ You can now use a typeahead when editing the book. Instead of displaying the aut
 You will do these three things:
 
 1. As a one-time setup step for your app, run
-`bin/rails generate hot_glue:install_typeahead`
+`bin/rails generate hot_glue:typeahead_install`
 2. When generating a scaffold you want to make a typeahead association, use `--modify='parent_id{typeahead}'` where `parent_id` is the foreign key
 `bin/rails generate hot_glue:scaffold Book --include=title,author_id --modify='author_id{typeahead}'`
 3. Within each namespace, you will generate a special typeahead controller (it exists for the associated object to be searched on
@@ -1476,7 +1485,7 @@ from a searchable typehead input.
 The typeahead is implemented with a native Stimulus JS pair of controllers and is a modern & clean replacement to the old typeahead options.
 
 1. As a one-time setup step for your app, run
-   `bin/rails generate hot_glue:install_typeahead`
+   `bin/rails generate hot_glue:typeahead_install`
 2. When generating a scaffold you want to make a typeahead association, use `--modify='parent_id{typeahead}'` where `parent_id` is the foreign key
    `bin/rails generate hot_glue:scaffold Book --include=title,author_id --modify='author_id{typeahead}'`
 3. Within each namespace, you will generate a special typeahead controller (it exists for the associated object to be searched on

data/lib/generators/hot_glue/field_factory.rb

@@ -44,7 +44,6 @@ class FieldFactory
               AttachmentField
             end
     @class_name = class_name
-
     @field = field_class.new(name: name,
                              layout_strategy: generator.layout_strategy,
                              form_placeholder_labels: generator.form_placeholder_labels,

data/lib/generators/hot_glue/fields/association_field.rb

@@ -80,20 +80,20 @@ class AssociationField < Field
     assoc = eval("#{class_name}.reflect_on_association(:#{assoc_name})")
 
     if modify_as && modify_as[:typeahead]
-         search_url  = "#{namespace ? namespace + "_" : ""}#{assoc.plural_name}_typeahead_index_url"
-
-         "<div class='typeahead typeahead--#{singular}--#{assoc.name}_id'
-           data-controller='typeahead'
-           data-typeahead-url-value='<%= #{search_url} %>'
-           data-typeahead-typeahead-results-outlet='#search-results'>
-           <%= text_field_tag :#{assoc.plural_name}_query, '', placeholder: 'Search #{assoc.plural_name}', class: 'search__input',
-                             data: { action: 'keyup->typeahead#fetchResults keydown->typeahead#navigateResults', typeahead_target: 'query' },
-                             autofocus: true,
-                             autocomplete: 'off',
-                             value: #{singular}.try(:#{assoc.name}).try(:name) %>
-           <%= f.hidden_field :#{assoc.name}_id, value: #{singular}.try(:#{assoc.name}).try(:id), 'data-typeahead-target': 'hiddenFormValue' %>
-           <div data-typeahead-target='results'></div>
-         </div>"
+      search_url  = "#{namespace ? namespace + "_" : ""}#{assoc.plural_name}_typeahead_index_url"
+      "<div class='typeahead typeahead--#{assoc.name}_id'
+      data-controller='typeahead'
+      data-typeahead-url-value='<%= #{search_url} %>'
+      data-typeahead-typeahead-results-outlet='#search-results'>
+      <%= text_field_tag :#{assoc.plural_name}_query, '', placeholder: 'Search #{assoc.plural_name}', class: 'search__input',
+                     data: { action: 'keyup->typeahead#fetchResults keydown->typeahead#navigateResults', typeahead_target: 'query' },
+                     autofocus: true,
+                     autocomplete: 'off',
+                     value: #{singular}.try(:#{assoc.name}).try(:name) %>
+      <%= f.hidden_field :#{assoc.name}_id, value: #{singular}.try(:#{assoc.name}).try(:id), 'data-typeahead-target': 'hiddenFormValue' %>
+      <div data-typeahead-target='results'></div>
+      <div data-typeahead-target='classIdentifier' data-id=\"typeahead--#{assoc_name}_id\"></div>
+      </div>"
     else
       if assoc.nil?
         exit_message = "*** Oops. on the #{class_name} object, there doesn't seem to be an association called '#{assoc_name}'"

data/lib/generators/hot_glue/fields/field.rb

@@ -43,7 +43,7 @@ class Field
 
     @self_auth = self_auth
     @default_boolean_display = default_boolean_display
-    @namesapce = namespace
+    @namespace = namespace
 
     # TODO: remove knowledge of subclasses from Field
     unless self.class == AttachmentField

data/lib/generators/hot_glue/templates/typeahead_controller.rb.erb

@@ -6,7 +6,7 @@ class <%= ((@namespace.titleize.gsub(" ", "") + "::" if @namespace) || "") + @pl
 
   def index
     query = params[:query]
-
+    @typeahead_identifier = params[:typeahead_identifier]
     @<%= @plural %> = <%= @singular.titleize.gsub(" ", "") %>.where("<%= @search_by.collect{|search| "LOWER(#{search}) LIKE ?" }.join(" OR ") %>", <%= @search_by.collect{|search|  "\"%\#{query.downcase}%\"" }.join(", ") %>).limit(10)
 
     render layout: false

data/lib/generators/hot_glue/templates/typeahead_views/index.html.erb

@@ -1,7 +1,7 @@
 
 <div class="typeahead-results__<%= @plural %>"
      data-controller="typeahead-results"
-     data-typeahead-results-typeahead-outlet=".typeahead--book--<%= @singular %>_id"
+     data-typeahead-results-typeahead-outlet=".<\%= @typeahead_identifier %>"
      data-typeahead-results-current-class="search__result--current" >
   <ul class="search__results" data-typeahead-results-target="result">
     <\% if @<%= @plural %>.any? %>

data/lib/generators/hot_glue/templates/typeahead_views/typeahead_controller.js

@@ -1,7 +1,8 @@
 import { Controller } from "@hotwired/stimulus"
 
 export default class extends Controller {
-  static targets = [ "query", "results", "hiddenFormValue" ]
+  static targets = [ "query", "results", "hiddenFormValue",
+    "classIdentifier"]
   static values = { url: String }
   static outlets = [ "typeahead-results" ]
 
@@ -10,6 +11,10 @@ export default class extends Controller {
   }
 
   fetchResults() {
+
+
+    var typeaheadIdentifier = this.classIdentifierTarget.dataset.id
+
     if(this.query == "") {
       this.reset()
       return
@@ -22,6 +27,7 @@ export default class extends Controller {
 
     const url = new URL(this.urlValue)
     url.searchParams.append("query", this.query)
+    url.searchParams.append("typeahead_identifier", typeaheadIdentifier)
 
     this.abortPreviousFetchRequest()
 

data/lib/generators/hot_glue/templates/typeahead_views/typeahead_results_controller.js

@@ -12,7 +12,6 @@ export default class extends Controller {
 
   connect() {
     this.currentResultIndex = 0
-
     const allElements = this.resultTarget.querySelectorAll(".search-result-item");
 
     allElements.forEach((element, index) => {
@@ -29,7 +28,6 @@ export default class extends Controller {
     const result_id = element.dataset.id;
 
     // how to pass this to the search controller, set the field value and clear out the search
-    console.log("search item clicked...", result_value, result_id)
 
     this.typeaheadOutlets.forEach(outlet => {
       outlet.hiddenFormValueTarget.value = result_id;

data/lib/hotglue/version.rb

@@ -1,5 +1,5 @@
 module HotGlue
   class Version
-    CURRENT = '0.6.0'
+    CURRENT = '0.6.0.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hot-glue
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.0.1
 platform: ruby
 authors:
 - Jason Fleetwood-Boldt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-03 00:00:00.000000000 Z
+date: 2023-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails