hot-glue 0.5.26 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 226e0b7e11441c4332105233fc63eb44f879d582c4ce791e18e56bd54de56627
-  data.tar.gz: a1befc9f7e6d059b502730f4d7411d7aab538b8a239572163e112d85a364d39a
+  metadata.gz: 822437dfda890941c29f2ff18b927c60a84279306c0937d354f69e18c67f51e5
+  data.tar.gz: 193b9bb92313ae7440c72d8d7598f918400136f7edabc70bf7ec7def1b4f96ed
 SHA512:
-  metadata.gz: fb0ce5e6cf19d8528f3a7cdf421f4cdaf81a10c8670b132a6994ee178361e353b9ffba58de34bf14c8f422bae485bd4994c5c55a06240b2f0ab358419fd2660f
-  data.tar.gz: b9bc2326b8d1b8430e278a3fc9b74a6a198238fdfc015e21b37024761283f1dbb770b15e4a90bbf8bfebcb6acf5e110a704409e3a22093067fdd0d6ddd4ad4ff
+  metadata.gz: '0210383122eded31e46b9cc02bc6a7c230d95936f13635149c884774e762b178eb326e3722466a6ff8e365fd3d45782a05c0a60733d678499762ff49d6f7b58d'
+  data.tar.gz: 8cc9ed4dc85875d66dbd66ecac22908bfd6a8759588e37a2b26bb03522a16b8559ca0bc0ee0311a28a627f2f25af703ed744ea1aba6f8f1d48c5fbc35d28748a

data/README.md

@@ -772,7 +772,7 @@ Note that Hot Glue still generates a singular partial (`_form`) for both actions
  <% end %>
 ```
 
-This works for both regular fields, association fields, and alt lookup fields.
+This works for both regular fields, association fields.
 
 
 When mixing the show only, update show only, and Pundit features, notice that the show only + update show only will act to override whatever the policy might say.
@@ -954,38 +954,6 @@ This happens using two interconnected mechanisms:
 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.
 
 
-### `--alt-foreign-key-lookup` (Foreign Key Lookups)
-
-Example #1
-`--alt-foreign-key-lookup=user_id{email}`
-
-Let's assume a `Company` `has_many :company_users` and also a `Company` `has_many :users, through: :company_users`
-
-Normally, you would be constructing a CompanyUsers downnest portal on the Company page. (Showing you only CompanyUsers associated with that company.)
-
-A drop down of _all users in the_ database will be display on the screen where you create a new CompanyUser (join) record.
-
-Let's say instead you don't want to expose the full list of all users to this controller, but instead make your user enter the full email address of the user to identify them.
-
-Instead of a drop-down, the interface will present an input box for the user to supply an *search by* email.
-
-Example #2
-```
---alt-foreign-key-lookup='agent_id{email+}'
-```
-
-First, assume the current able has a `belongs_to` association for `agent_id` to a foreign model, `Agent`
-
-Here, we would build a scaffold that would treat the foreign key `agent_id` as an alt lookup, allowing the user to search for foreign records by email (the agent's email).
-
-The `+` symbol indicates to automatically make a new `agent` record (without it, the agent_id will be set to nil if there is no associated agent record found -- this may cause the update to fail, unless `optional: true` is on the belongs_to association.)
-
-
-
-** Note: Current implementation does not work in conjunction with hawked associations to protect against users from accessing associated records not within scope.**
-TODO: make it work with hawked associations to protect against users from accessing associated records not within scope
-
-
 ## "Thing" Label
 
 Note that on a per model basis, you can also globally omit the label or set a unique label value using
@@ -1256,7 +1224,7 @@ end
 ```
 
 
-If you are using factory creation along with with alt lookups, be sure your factory code creates a local variable that follows this name
+be sure your factory code creates a local variable that follows this name
 
 **<downcase association name>**_factory.<downcase association name>
 
@@ -1410,6 +1378,33 @@ end
 
 ```
 
+### Typeahead Foreign Keys
+
+Let's go back to the first Books & Authors example.
+assuming you have created
+`bin/rails generate model Book title:string author_id:integer`
+and
+`bin/rails generate model Author name:string`
+and also added `has_many :books` to Author and `belongs_to :author` to Book
+
+
+You can now use a typeahead when editing the book. Instead of displaying the authors in a drop-down list, the authors will appear in a searchable typehead.
+
+You will do these three things:
+
+1. As a one-time setup step for your app, run
+`bin/rails generate hot_glue:install_typeahead`
+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
+`bin/rails generate hot_glue:typehead Author`
+This will create a controller for `AuthorsTypeaheadController` that will allow text search against any *string* field on the `Author` model.
+This special generator takes flags `--namespace` as the normal generator and also `--search-by` to let you specify the list of fields you want to search by.
+
+Your new and edit views that were built on books now give you a search box for the author spot. Notice that just making the selection
+puts the value into the search box and the id into a hidden field.
+
+You need to making a selection *and* click "Save" to update the record.
 
 ### TinyMCE
 1. `bundle add tinymce-rails` to add it to your Gemfile
@@ -1469,6 +1464,30 @@ bin/rails generate Thing --include=my_story --modify='my_story{tinymce}'
 
 # VERSION HISTORY
 
+#### 2023-11-03 - v0.6.0
+
+Typeahead Associations
+
+You can now use a typeahead when editing any foreign key.
+
+Instead of displaying the foreign key in a drop-down list, the associated record is now selectable 
+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`
+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
+   `bin/rails generate hot_glue:typehead Author`
+   This will create a controller for `AuthorsTypeaheadController` that will allow text search against any *string* field on the `Author` model.
+   This special generator takes flags `--namespace` like the normal generator and also `--search-by` to let you specify the list of fields you want to search by.
+
+The example Books & Authors app with typeahead is here:
+
+https://github.com/hot-glue-for-rails/BooksAndAuthorsWithTypeahead2
+
 
 #### 2023-10-23 - v0.5.26
 

data/lib/generators/hot_glue/field_factory.rb

@@ -53,7 +53,6 @@ class FieldFactory
                              hawk_keys: generator.hawk_keys,
                              auth: generator.auth,
                              class_name: generator.singular_class,
-                             alt_lookups: generator.alt_lookups,
                              singular: generator.singular,
                              self_auth: generator.self_auth,
                              update_show_only: generator.update_show_only,
@@ -61,6 +60,7 @@ class FieldFactory
                              sample_file_path: generator.sample_file_path,
                              modify_as: generator.modify_as[name.to_sym] || nil,
                              display_as: generator.display_as[name.to_sym] || nil,
-                             default_boolean_display: generator.default_boolean_display)
+                             default_boolean_display: generator.default_boolean_display,
+                             namespace: generator.namespace_value)
   end
 end

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

@@ -5,12 +5,12 @@ class AssociationField < Field
 
   attr_accessor :assoc_name, :assoc_class, :assoc
 
-  def initialize(alt_lookups: , class_name: , default_boolean_display:, display_as: ,
+  def initialize( class_name: , default_boolean_display:, display_as: ,
                  name: , singular: ,
                  update_show_only: ,
                  hawk_keys: , auth: , sample_file_path:,  ownership_field: ,
                  attachment_data: nil , layout_strategy: , form_placeholder_labels: nil,
-                 form_labels_position:, modify_as: , self_auth: )
+                 form_labels_position:, modify_as: , self_auth: , namespace: )
     super
 
     @assoc_model = eval("#{class_name}.reflect_on_association(:#{assoc})")
@@ -48,10 +48,7 @@ class AssociationField < Field
 
   def spec_setup_and_change_act(which_partial)
     if which_partial == :update && update_show_only.include?(name)
-      # do not update tests
-    elsif alt_lookups.keys.include?(name.to_s)
-      lookup = alt_lookups[name.to_s][:lookup_as]
-      "      find(\"[name='#{singular}[__lookup_#{lookup}]']\").fill_in( with: #{assoc}1.#{lookup} )"
+
     else
       "      #{name}_selector = find(\"[name='#{singular}[#{name}]']\").click \n" +
       "      #{name}_selector.first('option', text: #{assoc}1.name).select_option"
@@ -82,10 +79,21 @@ class AssociationField < Field
     assoc_name = name.to_s.gsub("_id","")
     assoc = eval("#{class_name}.reflect_on_association(:#{assoc_name})")
 
-
-    if @alt_lookups.keys.include?(name.to_s)
-      alt = @alt_lookups[name.to_s][:lookup_as]
-      "<%= f.text_field :__lookup_#{alt}, value: @#{singular}.#{assoc_name}.try(:#{alt}), placeholder: \"search by #{alt}\" %>"
+    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>"
     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/attachment_field.rb

@@ -1,10 +1,10 @@
 class AttachmentField < Field
   attr_accessor :attachment_data
-  def initialize(name:, class_name:, alt_lookups:, default_boolean_display: ,
+  def initialize(name:, class_name:, default_boolean_display: ,
                  display_as:,
                  singular:, update_show_only:, hawk_keys:, auth:,
                  sample_file_path: nil, attachment_data:, ownership_field:, layout_strategy: ,
-                 form_placeholder_labels: , form_labels_position:, modify_as:, self_auth: )
+                 form_placeholder_labels: , form_labels_position:, modify_as:, self_auth: , namespace:  )
     super
 
     @attachment_data = attachment_data

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

@@ -5,11 +5,10 @@ class Field
                 :hawk_keys,   :layout_strategy, :limit, :modify_as, :name, :object, :sample_file_path,
                 :self_auth,
                 :singular_class,  :singular, :sql_type, :ownership_field,
-                :update_show_only
+                :update_show_only, :namespace
 
   def initialize(
     auth: ,
-    alt_lookups: ,
     attachment_data: nil,
     class_name: ,
     default_boolean_display: ,
@@ -24,7 +23,8 @@ class Field
     sample_file_path: nil,
     singular: ,
     update_show_only:,
-    self_auth:
+    self_auth:,
+    namespace:
   )
     @name = name
     @layout_strategy = layout_strategy
@@ -43,6 +43,7 @@ class Field
 
     @self_auth = self_auth
     @default_boolean_display = default_boolean_display
+    @namesapce = namespace
 
     # TODO: remove knowledge of subclasses from Field
     unless self.class == AttachmentField

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

@@ -8,7 +8,7 @@ module  HotGlue
                   :inline_list_labels, :layout_object,
                   :columns,  :col_identifier, :singular,
                   :form_placeholder_labels, :hawk_keys, :update_show_only,
-                  :alt_lookups, :attachments, :show_only, :columns_map, :pundit
+                  :attachments, :show_only, :columns_map, :pundit
 
 
       def initialize(singular:, singular_class: ,
@@ -17,7 +17,7 @@ module  HotGlue
                    ownership_field: , form_labels_position: ,
                    inline_list_labels: ,
                    form_placeholder_labels:, hawk_keys: ,
-                   update_show_only:, alt_lookups: , attachments: , columns_map:, pundit: )
+                   update_show_only:, attachments: , columns_map:, pundit: )
 
       @singular = singular
       @singular_class = singular_class
@@ -38,7 +38,6 @@ module  HotGlue
       @form_placeholder_labels = form_placeholder_labels
       @hawk_keys = hawk_keys
       @update_show_only = update_show_only
-      @alt_lookups = alt_lookups
       @attachments = attachments
     end
 

data/lib/generators/hot_glue/scaffold_generator.rb

@@ -16,14 +16,16 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
   hook_for :form_builder, :as => :scaffold
 
   source_root File.expand_path('templates', __dir__)
-  attr_accessor :alt_lookups, :attachments, :auth, :big_edit, :button_icons, :bootstrap_column_width, :columns,
+  attr_accessor :attachments, :auth, :big_edit, :button_icons, :bootstrap_column_width, :columns,
                 :default_boolean_display,
                 :display_as, :downnest_children, :downnest_object, :hawk_keys, :layout_object,
                 :modify_as,
                 :nest_with, :path, :plural, :sample_file_path, :show_only_data, :singular,
                 :singular_class, :smart_layout, :stacked_downnesting, :update_show_only, :ownership_field,
                 :layout_strategy, :form_placeholder_labels, :form_labels_position, :pundit,
-                :self_auth
+                :self_auth, :namespace_value
+  # important: using an attr_accessor called :namespace indirectly causes a conflict with Rails class_name method
+  # so we use namespace_value instead
 
   class_option :singular, type: :string, default: nil
   class_option :plural, type: :string, default: nil
@@ -160,6 +162,7 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
 
     @plural = options['plural'] || @singular.pluralize # respects what you set in inflections.rb, to override, use plural option
     @namespace = options['namespace'] || nil
+    @namespace_value = @namespace
     use_controller_name = plural.titleize.gsub(" ", "")
     @controller_build_name = ((@namespace.titleize.gsub(" ", "") + "::" if @namespace) || "") + use_controller_name + "Controller"
     @controller_build_folder = use_controller_name.underscore
@@ -224,6 +227,10 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
           @modify_as[key.to_sym] =  {enum: :partials}
         elsif $2 == "tinymce"
           @modify_as[key.to_sym] =  {tinymce: 1}
+        elsif $2 == "typeahead"
+          @modify_as[key.to_sym] =  {typeahead: 1}
+
+
         else
           raise "unknown modification direction #{$2}"
         end
@@ -251,26 +258,6 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
     # instead of a drop-down for the foreign entity, a text field will be presented
     # You must ALSO use a factory that contains a parameter of the same name as the 'value' (for example, `xyz_email`)
 
-    alt_lookups_entry = options['alt_foreign_key_lookup'].split(",")
-    @alt_lookups = {}
-    @alt_foreign_key_lookup = alt_lookups_entry.each do |setting|
-      setting =~ /(.*){(.*)}/
-      key, lookup_as = $1, $2
-      assoc = eval("#{class_name}.reflect_on_association(:#{key.to_s.gsub("_id", "")}).class_name")
-
-      data = { lookup_as: lookup_as.gsub("+", ""),
-               assoc: assoc,
-               with_create: lookup_as.include?("+") }
-      @alt_lookups[key] = data
-    end
-
-    puts "------ ALT LOOKUPS for #{@alt_lookups}"
-
-    @update_alt_lookups = @alt_lookups.collect { |key, value|
-      @update_show_only.include?(key) ?
-        { key: value }
-        : nil }.compact
-
     @label = options['label'] || (eval("#{class_name}.class_variable_defined?(:@@table_label_singular)") ? eval("#{class_name}.class_variable_get(:@@table_label_singular)") : singular.gsub("_", " ").titleize)
     @list_label_heading = options['list_label_heading'] || (eval("#{class_name}.class_variable_defined?(:@@table_label_plural)") ? eval("#{class_name}.class_variable_get(:@@table_label_plural)") : plural.gsub("_", " ").upcase)
 
@@ -449,6 +436,25 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
       @columns_map[col] = this_column_object.field
     end
 
+    @columns_map.each do |key, field|
+      if field.is_a?(AssociationField)
+        if @modify_as && @modify_as[key] && @modify_as[key][:typeahead]
+          assoc_name = field.assoc_name
+          file_path = "app/controllers/#{namespace ? namspace + "/" : ""}#{assoc_name.pluralize}_typeahead_controller.rb"
+
+          if ! File.exist?(file_path)
+
+            assoc_model = eval("#{class_name}.reflect_on_association(:#{field.assoc_name})")
+            assoc_class = assoc_model.class_name
+            puts "##############################################"
+            puts "WARNING: you specified --modify=#{key}{typeahead} but there is no file at `#{file_path}`; please create one with:"
+            puts "bin/rails generate hot_glue:typeahead #{assoc_class} #{namespace ? " --namespace=\#{namespace}" : ""}"
+            puts "##############################################"
+          end
+        end
+      end
+    end
+
     # create the template object
     if @markup == "erb"
       @template_builder = HotGlue::ErbTemplate.new(
@@ -464,7 +470,6 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
         ownership_field: @ownership_field,
         form_labels_position: @form_labels_position,
         form_placeholder_labels: @form_placeholder_labels,
-        alt_lookups: @alt_lookups,
         attachments: @attachments,
         columns_map: @columns_map,
         pundit: @pundit,
@@ -672,24 +677,18 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
   end
 
   def fields_filtered_for_email_lookups
-    @columns.reject { |c| @alt_lookups.keys.include?(c) } + @alt_lookups.values.map { |v| ("__lookup_#{v[:lookup_as]}").to_sym }
+    @columns
   end
 
   def creation_syntax
-    merge_with = @alt_lookups.collect { |key, data|
-      "#{data[:assoc].downcase}: #{data[:assoc].downcase}_factory.#{data[:assoc].downcase}"
-    }.join(", ")
-
     if @factory_creation == ''
-      "@#{singular } = #{ class_name }.create(modified_params#{'.merge(' + merge_with + ')' if !merge_with.empty?})"
+      "@#{singular } = #{ class_name }.create(modified_params)"
     else
       "#{@factory_creation}\n" +
         "    @#{singular } = factory.#{singular}"
     end
   end
 
-
-
   def formats
     [format]
   end
@@ -1285,11 +1284,7 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
     }.join("")
   end
 
-  def controller_update_params_tap_away_alt_lookups
-    @alt_lookups.collect { |key, data|
-      ".tap{ |ary| ary.delete('__lookup_#{data[:lookup_as]}') }"
-    }.join("")
-  end
+
 
   def nested_for_turbo_id_list_constructor
     if @nested_set.any?

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

@@ -98,15 +98,10 @@ class <%= controller_class_name %> < <%= controller_descends_from %>
   end
 
   def create
-<% if @alt_lookups.any? %><%= @alt_lookups.collect{|key, data|
-    "    #{data[:assoc].downcase} = #{data[:assoc]}.#{data[:with_create] ? "find_or_create_by" : "find_by"}(#{data[:lookup_as]}: #{ singular_name }_params[:__lookup_#{data[:lookup_as]}])\n"
-       }.join("/n") %><% end %> <% merge_lookups = @alt_lookups.collect{|key, data| "#{key.gsub("_id", "")}: #{key.gsub("_id", "")}" }.join(",") %>
-    modified_params = modify_date_inputs_on_params(<%= singular_name %>_params.dup<%= controller_update_params_tap_away_alt_lookups  %>, <%= current_user_object %>, <%= datetime_fields_list %>) <% if @object_owner_sym &&  eval("#{class_name}.reflect_on_association(:#{@object_owner_sym})").class == ActiveRecord::Reflection::BelongsToReflection  %>
+    modified_params = modify_date_inputs_on_params(<%= singular_name %>_params.dup, <%= current_user_object %>, <%= datetime_fields_list %>) <% if @object_owner_sym &&  eval("#{class_name}.reflect_on_association(:#{@object_owner_sym})").class == ActiveRecord::Reflection::BelongsToReflection  %>
     modified_params = modified_params.merge(<%= @object_owner_sym %>: <%= @object_owner_eval %>) <% elsif @object_owner_optional && any_nested? %>
     modified_params = modified_params.merge(<%= @object_owner_name %> ? {<%= @object_owner_sym %>: <%= @object_owner_eval %>} : {}) <% elsif !@object_owner_eval.empty? %>
-    modified_params = modified_params.merge(<%= @object_owner_eval %>) <% end %><%  if !merge_lookups.empty?  %>
-    modified_params = modified_params.merge(<%= merge_lookups %>)
-    <% end %>
+    modified_params = modified_params.merge(<%= @object_owner_eval %>) <% end %>
 
       <% if @hawk_keys.any? %>
     modified_params = hawk_params({<%= hawk_to_ruby %>}, modified_params)<% end %>
@@ -151,31 +146,19 @@ class <%= controller_class_name %> < <%= controller_descends_from %>
 <% end %><% if @build_update_action %>  def update
     flash[:notice] = +''
     flash[:alert] = nil
-<% if @alt_lookups.filter{|key,d| ! @update_show_only.include?(key.to_sym) }.any? %><%= @alt_lookups.filter{|key,d| ! @update_show_only.include?(key.to_sym) }.collect{|key, data|
-    "    #{data[:assoc].downcase} = #{data[:assoc]}.#{data[:with_create] ? "find_or_create_by" : "find_by"}(#{data[:lookup_as]}: #{ singular_name }_params[:__lookup_#{data[:lookup_as]}])\n"
-       }.join("\n") %><% end %> <% merge_lookups = @alt_lookups.filter{|key,d| ! @update_show_only.include?(key.to_sym) }.collect{|key, data| "#{key.gsub("_id", "")}: #{key.gsub("_id", "")}" }.join(",") %>
     <% @magic_buttons.each do |button| %>
     if <%= singular_name %>_params[:__<%= button %>]
       @<%= singular_name %>.<%= button %>!
       flash[:notice] << "<% singular %> <%= button.titlecase %>."
     end
     <% end %>
-    modified_params = modify_date_inputs_on_params(<% if @update_show_only %>update_<% end %><%= singular_name %>_params.dup<%= controller_update_params_tap_away_alt_lookups  %><%= controller_update_params_tap_away_magic_buttons  %>, <%= current_user_object %>, <%= datetime_fields_list %>) <% if @object_owner_sym &&  eval("#{class_name}.reflect_on_association(:#{@object_owner_sym})").class == ActiveRecord::Reflection::BelongsToReflection  %>
+    modified_params = modify_date_inputs_on_params(<% if @update_show_only %>update_<% end %><%= singular_name %>_params.dup<%= controller_update_params_tap_away_magic_buttons  %>, <%= current_user_object %>, <%= datetime_fields_list %>) <% if @object_owner_sym &&  eval("#{class_name}.reflect_on_association(:#{@object_owner_sym})").class == ActiveRecord::Reflection::BelongsToReflection  %>
     modified_params = modified_params.merge(<%= @object_owner_sym %>: <%= @object_owner_eval %>) <% elsif @object_owner_optional && any_nested? %>
     modified_params = modified_params.merge(<%= @object_owner_name %> ? {<%= @object_owner_sym %>: <%= @object_owner_eval %>} : {}) <% elsif ! @object_owner_eval.empty?  && !@self_auth%>
-    modified_params = modified_params.merge(<%= @object_owner_eval %>) <% end %><%  if !merge_lookups.empty?  %>
-    modified_params = modified_params.merge(<%= merge_lookups %>)
-      <% end %>
+    modified_params = modified_params.merge(<%= @object_owner_eval %>) <% end %>
 
     <% if @hawk_keys.any? %>    modified_params = hawk_params({<%= hawk_to_ruby %>}, modified_params)<% end %>
-<% if @alt_lookups.any? %><%= @alt_lookups.collect{|key, data|
-    unless @factory_creation.include?("#{data[:assoc].downcase} = ")
-"    #{data[:assoc].downcase} = #{data[:assoc]}.#{data[:with_create] ? "find_or_create_by" : "find_by"}(#{data[:lookup_as]}: #{ singular_name }_params[:__lookup_#{data[:lookup_as]}])\n"
-    end
-   }.join("/n") %><% end %><% if (@update_alt_lookups).any? %>
-      <%= @update_alt_lookups.collect{|key, data|
-   "    @#{ singular_name }.#{key.gsub("_id", "")} = #{key.gsub("_id", "")}"
-   }.join("/n") %><% end %><%= controller_attachment_orig_filename_pickup_syntax %>
+      <%= controller_attachment_orig_filename_pickup_syntax %>
     <% if @pundit %>
     if @<%= singular_name %>.attributes = modified_params
         authorize @<%= singular_name %>

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

@@ -0,0 +1,14 @@
+class <%= ((@namespace.titleize.gsub(" ", "") + "::" if @namespace) || "") + @plural.titleize.gsub(" ", "") + "TypeaheadController" %> < <%= controller_descends_from %>
+  # regenerate this controller with
+  <% if defined?(RuboCop) %># rubocop:disable Layout/LineLength
+  <% end %># <%= regenerate_me_code %><% if defined?(RuboCop) %>
+  # rubocop:enable Layout/LineLength <% end %>
+
+  def index
+    query = params[:query]
+
+    @<%= @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
+  end
+end

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

@@ -0,0 +1,5 @@
+<li class="search__result" >
+  <span class="search-result-item" data-id="<\%= <%= @singular %>.id %>" data-value="<\%= <%= @singular %>.name %>">
+    <\%= <%= @singular %>.name %>
+  </span>
+</li>

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

@@ -0,0 +1,13 @@
+
+<div class="typeahead-results__<%= @plural %>"
+     data-controller="typeahead-results"
+     data-typeahead-results-typeahead-outlet=".typeahead--book--<%= @singular %>_id"
+     data-typeahead-results-current-class="search__result--current" >
+  <ul class="search__results" data-typeahead-results-target="result">
+    <\% if @<%= @plural %>.any? %>
+      <\%= render partial: "<%= @singular %>", collection: @<%= @plural %> %>
+    <\% else %>
+      <li class="search__result search__result--empty">No results</li>
+    <\% end %>
+  </ul>
+</div>

data/lib/generators/hot_glue/templates/typeahead_views/typeahead.scss

@@ -0,0 +1,46 @@
+.typeahead {
+
+}
+
+.search__input {
+  border: 1px solid gray;
+  border-radius: 2px;
+  padding: 10px;
+  font-size: 16px;
+  box-sizing: border-box;
+}
+
+[data-typeahead-target="results"] {
+  position: absolute;
+}
+
+.search__results {
+  border: 1px solid gray;
+  border-radius: 2px;
+  border-top: none;
+  margin: 0;
+  padding: 0;
+  list-style-type: none;
+  top: -1px;
+}
+
+.search__result  {
+  span.search-result-item {
+    text-decoration: none;
+    color: black;
+    padding: 10px;
+    display: block;
+    cursor: pointer;
+    &:hover {
+      background: #86b7fe;
+    }
+  }
+}
+
+.search__result--current, .search__result:hover {
+  background: #e0e0e0;
+}
+
+.search__result--empty {
+  padding: 10px;
+}

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

@@ -0,0 +1,61 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static targets = [ "query", "results", "hiddenFormValue" ]
+  static values = { url: String }
+  static outlets = [ "typeahead-results" ]
+
+  disconnect() {
+    this.reset()
+  }
+
+  fetchResults() {
+    if(this.query == "") {
+      this.reset()
+      return
+    }
+
+    if(this.query == this.previousQuery) {
+      return
+    }
+    this.previousQuery = this.query
+
+    const url = new URL(this.urlValue)
+    url.searchParams.append("query", this.query)
+
+    this.abortPreviousFetchRequest()
+
+    this.abortController = new AbortController()
+
+    fetch(url, { signal: this.abortController.signal })
+      .then(response => response.text())
+      .then(html => {
+        this.resultsTarget.innerHTML = html
+      })
+      .catch(() => {})
+  }
+
+  navigateResults(event) {
+    if(this.hasSearchResultsOutlet) {
+      this.searchResultsOutlet.navigateResults(event)
+    }
+  }
+
+  // private
+
+  reset() {
+    this.resultsTarget.innerHTML = ""
+    this.queryTarget.value = ""
+    this.previousQuery = null
+  }
+
+  abortPreviousFetchRequest() {
+    if(this.abortController) {
+      this.abortController.abort()
+    }
+  }
+
+  get query() {
+    return this.queryTarget.value
+  }
+}

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

@@ -0,0 +1,87 @@
+import { Controller } from "@hotwired/stimulus"
+
+const upKey = 38
+const downKey = 40
+const enterKey = 13
+const navigationKeys = [upKey, downKey, enterKey]
+
+export default class extends Controller {
+  static classes = [ "current" ]
+  static targets = [ "result" ]
+  static outlets = [ "typeahead" ]
+
+  connect() {
+    this.currentResultIndex = 0
+
+    const allElements = this.resultTarget.querySelectorAll(".search-result-item");
+
+    allElements.forEach((element, index) => {
+      element.addEventListener("click", () => {
+        // Call the searchItemClicked member function when the element is clicked
+        this.searchItemClicked(element, index);
+      });
+    })
+    this.selectCurrentResult()
+  }
+
+  searchItemClicked(element, index) {
+    const result_value = element.dataset.value;
+    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;
+      outlet.queryTarget.value = result_value;
+    })
+
+    this.resultTarget.innerHTML = "";
+  }
+
+  navigateResults(event) {
+    if(!navigationKeys.includes(event.keyCode)) {
+      return
+    }
+
+    event.preventDefault()
+
+    switch(event.keyCode) {
+      case downKey:
+        this.selectNextResult()
+        break;
+      case upKey:
+        this.selectPreviousResult()
+        break;
+      case enterKey:
+        this.goToSelectedResult()
+        break;
+    }
+  }
+
+  // private
+
+  selectCurrentResult() {
+    this.resultTargets.forEach((element, index) => {
+      element.classList.toggle(this.currentClass, index == this.currentResultIndex)
+    })
+  }
+
+  selectNextResult() {
+    if(this.currentResultIndex < this.resultTargets.length - 1) {
+      this.currentResultIndex++
+      this.selectCurrentResult()
+    }
+  }
+
+  selectPreviousResult() {
+    if(this.currentResultIndex > 0) {
+      this.currentResultIndex--
+      this.selectCurrentResult()
+    }
+  }
+
+  goToSelectedResult() {
+    this.resultTargets[this.currentResultIndex].firstElementChild.click()
+  }
+}

data/lib/generators/hot_glue/typeahead_generator.rb

@@ -0,0 +1,105 @@
+module HotGlue
+  class TypeaheadGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+    class_option :namespace, type: :string, default: nil
+    class_option :search_by, type: :string, default: nil
+
+    def filepath_prefix
+      # todo: inject the context
+      'spec/dummy/' if $INTERNAL_SPECS
+    end
+
+
+    def initialize(*meta_args)
+      super
+      begin
+        @the_object = eval(meta_args[0][0])
+      rescue StandardError => e
+        message = "*** Oops: It looks like there is no object for #{meta_args[0][0]}. Please define the object + database table first."
+        puts message
+        raise(HotGlue::Error, message)
+      end
+
+      @singular = args.first.tableize.singularize
+
+      @plural = args.first.tableize.pluralize
+      @namespace = options['namespace']
+
+      if options['search_by']
+        @search_by = options['search_by'].split(",")
+      else
+        # todo: read the fields off the table
+
+        eligible_columns = @the_object.columns.filter{ |column|
+          column.sql_type == "character varying"
+        }
+        columns = eligible_columns.map(&:name).map(&:to_sym).reject { |field| [:id, :created_at, :updated_at].include?(field) }
+        @search_by = columns.collect(&:to_s)
+
+      end
+      @meta_args = meta_args
+      dest_file = "#{'spec/dummy/' if $INTERNAL_SPECS}app/controllers/#{@namespace ? @namespace + "/" : ""}#{@plural }_typeahead_controller.rb"
+      template "typeahead_controller.rb.erb", dest_file
+
+
+      dirname =  "app/views/#{@namespace ? @namespace + "/" : ""}#{@plural}_typeahead"
+
+      if !Dir.exist?(dirname)
+        Dir.mkdir dirname
+      end
+      {"typeahead_views/_thing.html.erb" => "_#{@singular}.html.erb",
+       "typeahead_views/index.html.erb" => "index.html.erb"}.each do |source_filename, dest_filename|
+
+        dest_filepath = File.join("#{'spec/dummy/' if $INTERNAL_SPECS}app/views#{namespace_with_dash}",
+                                  "#{@plural}_typeahead", dest_filename)
+
+        template source_filename, dest_filepath
+        text = File.read(dest_filepath)
+        text.gsub!('<\\%=', '<%=' )
+        text.gsub!('<\\%', '<%' )
+        File.open(dest_filepath, "w") { |f| f.write text }
+      end
+
+
+      puts ""
+      puts "be sure to add this your config/routes.rb file:"
+      puts ""
+      if @namespace
+        puts "namespace :#{@namespace} do"
+      end
+      puts "  resources :#{@plural}_typeahead, only: [:index]"
+      if @namespace
+        puts "end"
+      end
+      puts ""
+
+    end
+
+
+    def namespace_with_dash
+      if @namespace
+        "/#{@namespace}"
+      else
+        ""
+      end
+    end
+
+    def filepath_prefix
+      'spec/dummy/' if $INTERNAL_SPECS
+    end
+
+    def controller_descends_from
+      if defined?(@namespace.titlecase.gsub(" ", "") + "::BaseController")
+        @namespace.titlecase.gsub(" ", "") + "::BaseController"
+      else
+        "ApplicationController"
+      end
+    end
+
+    def regenerate_me_code
+      "bin/rails generate hot_glue:typeahead #{ @meta_args[0][0] } #{@meta_args[1].collect { |x| x.gsub(/\s*=\s*([\S\s]+)/, '=\'\1\'') }.join(" ")}"
+    end
+  end
+
+
+end

data/lib/generators/hot_glue/typeahead_install_generator.rb

@@ -0,0 +1,40 @@
+module HotGlue
+  class TypeaheadInstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+    class_option :namespace, type: :string, default: nil
+
+    def filepath_prefix
+      # todo: inject the context
+      'spec/dummy/' if $INTERNAL_SPECS
+    end
+
+
+    def initialize(*args) #:nodoc:
+      super
+
+      copy_file "typeahead_views/typeahead.scss", "#{'spec/dummy/' if $INTERNAL_SPECS}app/assets/stylesheets/typeahead.scss"
+
+
+      try = ["application.scss", "application.bootstrap.scss"]
+      try.each do |filename|
+        main_scss_file = "#{'spec/dummy/' if $INTERNAL_SPECS}app/assets/stylesheets/#{filename}"
+        if File.exist?(main_scss_file)
+          insert_into_file main_scss_file do
+            "@import 'typeahead';\n"
+          end
+          puts  "Inserted @import 'typeahead'; into #{main_scss_file}"
+          break
+        else
+          # puts "Could not find #{main_scss_file}. Please add the following line to your main scss file: @import 'typeahead';"
+        end
+      end
+      copy_file "typeahead_views/typeahead_controller.js", "#{'spec/dummy/' if $INTERNAL_SPECS}app/javascript/controllers/typeahead_controller.js"
+      copy_file "typeahead_views/typeahead_results_controller.js", "#{'spec/dummy/' if $INTERNAL_SPECS}app/javascript/controllers/typeahead_results_controller.js"
+
+      system("bin/rails stimulus:manifest:update")
+    end
+  end
+end
+
+
+

data/lib/hotglue/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hot-glue
 version: !ruby/object:Gem::Version
-  version: 0.5.26
+  version: 0.6.0
 platform: ruby
 authors:
 - Jason Fleetwood-Boldt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-23 00:00:00.000000000 Z
+date: 2023-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -132,6 +132,14 @@ files:
 - lib/generators/hot_glue/templates/themes/hotglue_scaffold_like_bootstrap.scss
 - lib/generators/hot_glue/templates/themes/hotglue_scaffold_like_los_gatos.scss
 - lib/generators/hot_glue/templates/themes/hotglue_scaffold_like_mountain_view.scss
+- lib/generators/hot_glue/templates/typeahead_controller.rb.erb
+- lib/generators/hot_glue/templates/typeahead_views/_thing.html.erb
+- lib/generators/hot_glue/templates/typeahead_views/index.html.erb
+- lib/generators/hot_glue/templates/typeahead_views/typeahead.scss
+- lib/generators/hot_glue/templates/typeahead_views/typeahead_controller.js
+- lib/generators/hot_glue/templates/typeahead_views/typeahead_results_controller.js
+- lib/generators/hot_glue/typeahead_generator.rb
+- lib/generators/hot_glue/typeahead_install_generator.rb
 - lib/hot-glue.rb
 - lib/hotglue/engine.rb
 - lib/hotglue/version.rb