hot-glue 0.6.25 → 0.6.26.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 484a64a521f4d21dbb5b437ce26950d218e5a7ea5917261eb0fbb59119bc19d5
-  data.tar.gz: 8d4570fcf5fc850c1bee98868fa19bd2805f794fa6a94425876c2bc9d4bc94af
+  metadata.gz: 077bb2e61017931d3db8f961922f3af0d4440bfd9900cc56f86bfa26aeb2e188
+  data.tar.gz: 3feecb2d560274cab61e7cb5f673175cf426fd6d7cef09112612e72f88e74038
 SHA512:
-  metadata.gz: 49bc8ddab30ed9cb637dbbe9da496fd47836239c9f260a61b03b81ef23ef3dab864aba2c84a634dad6004720cb6a9697afed9cbbdcb2ff3de76324bc42ab760e
-  data.tar.gz: 3145730b0c6510dcf6d813ff59acca04b867c248fb4f8107cae496c6a9405cf29260c6a8bde3e644aadf4e9853275fc55ba741409ef30014ac48fdd6fc12c2ef
+  metadata.gz: e2add6dcc569806f8953976332a63f29ea4cfa309ced3b8fdeb97b5c9108d030711d01a39fde8029bbfcacdde8fd7b0229861647258a40e340d1deeacfed13f8
+  data.tar.gz: 0c36945b6007e22bd672822bd206f842a1cd7eea54e819652fce71d613c66d8791b3902c51cb7c177f1c743a6e7a7241679b19e274e34e12bafe1dd06acbc187

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hot-glue (0.6.25)
+    hot-glue (0.6.26)
       ffaker (~> 2.16)
       kaminari (~> 1.2)
       rails (> 5.1)

data/README.md

@@ -1620,20 +1620,20 @@ bin/rails generate hot_glue:set_search_interface_install
 ```
 
 _Additional search option for Set Search_
-##### `--search-fields=aaa,bbb,ccc,ddd,eee` 
+### `--search-fields=aaa,bbb,ccc,ddd,eee` 
 to specify which fields you want to be searchable.
 
 
-##### `--search-query-fields=aaa,ddd` 
+### `--search-query-fields=aaa,ddd` 
 to specify a list of strings only which will be taken out of the search set and presented in a singular query box (allowing search across multiple string fields)
 
-##### `--search-position=vertical` 
+### `--search-position=vertical` 
 to specify vertical or horizontal (default: horizontal)
 
-##### `--search-clear-button` (no option) 
+### `--search-clear-button` (no option) 
 to specify whether to show a clear button to clear the whole search form at once (default: false)
 
-##### `--search-autosearch` (no option) 
+### `--search-autosearch` (no option) 
 to specify whether to automatically search when the user exit or changes any field (default: false)
 
 examples:
@@ -1657,12 +1657,56 @@ Here's how you would add a search interface to Example #1 in the [Hot Glue Tutor
 bin/rails generate Book --include=name,author_id --search=set --search-fields=name,author_id
 ```
 
+### `--phantom-search='{type}_{name}[All|choice A:scope_a|choice B:scope_b]`
+
+A phantom search is a search we are doing on this result set that doesn't correspond to a single field. Currently, the only available implementation is for scopes with no arguments, as in the example below. It is called 'phantom' because it could be (probably is) querying fields within the scope, but the search doesn't match up with a single field on your model. (So it's like creating 'phantom' criteria.). Only RADIO type is implemented, dropdown & checkboxes an a way to input a search value passed into the scope as an argument is TBD.
+
+{type} is any of: radio, dropdown, checkboxes
+
+{name} is a designation for this phantom search. Should NOT match any field name on your table. This should describe the kind of categorization we are performing.
+
+Your phantom search selector will be appended to the search fields and will be treated like a first-class search input, able to be combined with any of the other fields specified in a set search.
+
+Note that multiple phantom searched can be specified by separating them by comma (`,`), like so:
+
+`--phantom-search='radio_xxxx[All|choice A:scope_a|choice B:scope_b],radio_yyyy[All|choice W:scope_w|choice Z:scope_z|]`
+(this creates two phantom searches: `xxxx` and `yyyy` both radio selection lists)
+
+After the type & name, comes a block marked by square braces [ ... ] 
+
+Within the square  braces, each search option is separated by a pipe (|) character. 
+
+Within each option is a label and ruby scope, separated by a colon (:).
+
+The label comes before the colon the ruby scope. The ruby scope should be specified here without a dot. Each ruby scope must be defined on your model. If there is no scope specified, we assume "all", but we still need to specify a label for "All", which is why in the example above "All" has no colon after it.
+
+example
+
+`--phantom-search='radio_status[Pending:pending|Rejected:rejected|Accepted:accepted|All]'`
+
+On my model, I have these scopes defined:
+
+scope :pending_review, -> { not_approved.not_rejected }
+scope :approved, -> { where.not(approved_at: nil) }
+scope :rejected, -> { where.not(rejected_at: nil) }
+scope :not_rejected, -> { where(rejected_at: nil) }
+scope :not_approved, -> { where(approved_at: nil) }
+
+This produces a search interface with four options listed as radio buttons:
+° Pending
+° Approved
+° Rejected
+° All
+
+(Notice that my search options are called 'approved' and 'rejected' but the field names are slightly different: approved_at, rejected_at)
+
+The pending, approved, and rejected options will return search results with the corresponding scopes applied. The 'All' option will behave as a no-op, leaving the root search intact (giving all of the other modifications that Hot glue provides in different functionality).
+
 #### Predicate Search
 NOT IMPLEMENTED YET
 TODO: implement me
 
 
-
 ### `--stimmify` or `--stimmify=xyz`
 
 Automatically build the new and edit form with `data-controller='xyz'` to attach stimulus
@@ -2166,6 +2210,25 @@ These automatic pickups for partials are detected at build time. This means that
 
 
 # VERSION HISTORY
+#### 2025-09-16 - v0.6.26
+• Phantom Searching
+`--phantom-search='{type}_{name}[All|choice A:scope_a|choice B:scope_b],radio_yyyy[choice C:scope_c|]`
+
+A phantom search is a search we are doing on this result set that doesn't correspond to a single field. Currently, the only available implementation is for scopes with no arguments, as in the example below. It is called 'phantom' because it could be (probably is) querying fields within the scope, but the search doesn't match up with a single field on your model. (So it's like creating 'phantom' criteria.). Only RADIO type is implemented, dropdown & checkboxes an a way to input a search value passed into the scope as an argument is TBD.
+
+{type} is any of: radio, dropdown, checkboxes
+
+{name} is a designation for this phantom search. Should NOT match any field name on your table. This should describe the kind of categorization we are performing.
+see `--phantom-search` above for details.
+
+• Fixing duplicitous creation of Stimulus JS files when installing the search features
+
+
+#### 2025-08-31 - v0.6.25
+- very small fix to typeahead controller supporting typeaheads and nested routes
+- updates documentation for typeaheads
+
+
 #### 2025-08-22 - v0.6.24
 `--related-sets` fixes issue with related sets due to ruby syntax
 

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

@@ -12,7 +12,7 @@ module  HotGlue
                   :search, :search_fields, :search_query_fields, :search_position,
                   :form_path, :layout_object, :search_clear_button, :search_autosearch,
                   :stimmify, :stimmify_camel, :hidden_create, :hidden_update, :invisible_create,
-                  :invisible_update, :plural
+                  :invisible_update, :plural, :phantom_search
 
 
     def initialize(singular:, singular_class: ,
@@ -25,7 +25,7 @@ module  HotGlue
                  search:, search_fields:, search_query_fields: , search_position:,
                  search_clear_button:, search_autosearch:, layout_object:,
                  form_path: , stimmify: , stimmify_camel:, hidden_create:, hidden_update: ,
-                 invisible_create:, invisible_update: , plural: )
+                 invisible_create:, invisible_update: , plural: , phantom_search:)
 
 
       @form_path = form_path
@@ -65,6 +65,7 @@ module  HotGlue
       @update_show_only = update_show_only
       @attachments = attachments
       @related_sets = related_sets
+      @phantom_search = phantom_search
     end
 
     def add_spaces_each_line(text, num_spaces)
@@ -130,18 +131,43 @@ module  HotGlue
             search_field_result =  columns_map[col].search_field_output
 
             add_spaces_each_line( "\n  <span class='' >\n" +
-                                    add_spaces_each_line( (form_labels_position == 'before' ? the_label || "" : "") +
-                                                            +  " <br />\n" + search_field_result +
-                                                            (form_labels_position == 'after' ? the_label : "")   , 4) +
+                                add_spaces_each_line( (form_labels_position == 'before' ? the_label || "" : "") +
+                                  +  " <br />\n" + search_field_result +
+                                  (form_labels_position == 'after' ? the_label : "")   , 4) +
                                     "\n  </span>\n  <br />", 2)
           end
         }.compact.join("\n")
 
+
+
         size = layout_object[:columns][:bootstrap_column_width][columns.index(column)]
         "  <div class='#{layout_strategy.column_classes_for_form_fields(size)} search-cell--#{singular}--#{column.join("-")}' >" +
           cols_result + "</div>"
 
       }.join("\n")
+
+      # phantom searches
+      @phantom_search.each_key do |search_field|
+        data = @phantom_search[search_field]
+        if data[:type] == "radio"
+          res << "<div>"
+
+          res << "<label>#{data[:name]}</label><br />"
+
+          data[:choices].each do |choice|
+            res << "\n<input type='radio'
+                            id='#{search_field}_search__#{choice[:label]}'
+                            name='q[0][#{search_field}_search]' value='#{choice[:label]}'
+           <%= 'checked' if  @q['0'][:#{search_field}_search] == \"#{choice[:label]}\" %> />"
+            res << "\n<label for='#{search_field}_search__#{choice[:label]}'>#{choice[:label]}</label> <br/>"
+          end
+
+          res << "</div>"
+
+        end
+      end
+
+
       res << "</div>"
       res << "<div class='#{layout_strategy.column_classes_for_form_fields(nil)}'>"
       if @search_clear_button

data/lib/generators/hot_glue/scaffold_generator.rb

@@ -134,6 +134,10 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
   # TDB
 
 
+  class_option :phantom_search, default: nil
+
+
+
   def initialize(*meta_args)
     super
 
@@ -449,6 +453,8 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
     end
 
 
+
+
     @include_object_names = options['include_object_names'] || get_default_from_config(key: :include_object_names)
 
 
@@ -699,11 +705,56 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
       end
     end
 
+
+    if options['phantom_search']
+      ps_input = options['phantom_search']
+
+      ps_input =~ /(.*)\[(.*)\]/
+      type_and_label, settings = $1, $2
+
+
+      type = type_and_label.split("_")[0]
+      label = type_and_label.split("_")[1]
+
+      @phantom_search = {}
+      choices = settings.split("|")
+
+
+      @phantom_search[label.to_sym] = {
+        type: type,
+        name: label.humanize,
+        choices: []
+      }
+
+      choices.each do |choice|
+        choice_label = choice.split(":")[0]
+        choice_scope = choice.split(":")[1]
+        if choice_scope.nil?
+          choice_scope = "all"
+        end
+
+        choice_scope = ".#{choice_scope}" if !choice_scope.start_with?(".")
+        @phantom_search[label.to_sym][:choices] << {
+          label: choice_label,
+          scope: choice_scope,
+        }
+      end
+      puts "phantom search #{@phantom_search}"
+    else
+      @phantom_search = {}
+    end
+
     # search
     @search = options['search']
+
     if @search == 'set'
       if options['search_fields'].nil?
-        @search_fields = @columns
+        if  !@phantom_search
+          puts "Since you did not specify search fields or phantom search fields I am including all columns in search"
+          @search_fields = @columns
+        else
+          @search_fields = []
+        end
       else
         @search_fields = options['search_fields'].split(',')
       end
@@ -715,12 +766,6 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
 
       @search_fields = @search_fields - @search_query_fields
 
-      @search_fields.each do |field|
-        if !@columns.include?(field.to_sym)
-          raise "You specified a search field for #{field} but that field is not in the list of columns"
-        end
-      end
-
       @search_clear_button = !!options['search_clear_button']
       @search_autosearch = !!options['search_autosearch']
 
@@ -728,22 +773,24 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
 
     end
 
+    if @search_fields
+      @search_fields.each do |field|
+        if !@columns.include?(field.to_sym) && !@phantom_search.include?(field.to_sym)
+          raise "You specified a search field for #{field} but that field is not in the list of columns"
+        end
+      end
+    end
+
     builder = HotGlue::Layout::Builder.new(generator: self,
                                            include_setting: options['include'],
                                            buttons_width: buttons_width)
 
     @layout_object = builder.construct
 
-
-
     # syntax should be xyz_id{xyz_email},abc_id{abc_email}
     # 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`)
 
-
-
-
-
     # create the template object
 
 
@@ -780,6 +827,7 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
         hidden_update: @hidden_update,
         invisible_create: @invisible_create,
         invisible_update: @invisible_update,
+        phantom_search: @phantom_search
       )
     elsif @markup == "slim"
       raise(HotGlue::Error, "SLIM IS NOT IMPLEMENTED")
@@ -1741,12 +1789,11 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
         if !@columns_map[field.to_sym].load_all_query_statement.empty?
           @columns_map[field.to_sym].load_all_query_statement
         end
-      }.compact.join("\n" + spaces(4))
-      res << "\n"
+      }.compact.join("\n" + spaces(4)) + "\n"
     end
 
     if pundit
-      res << "    @#{ plural_name } = policy_scope(#{ object_scope })#{record_scope}.page(params[:page])#{ n_plus_one_includes }#{ ".per(per)" if @paginate_per_page_selector }"
+      res << "    @#{ plural_name } = policy_scope(#{ object_scope })#{record_scope}\n"
     else
       if !@self_auth
 
@@ -1760,22 +1807,38 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
             end
           }.compact.join
         end
-        res << ".page(params[:page])#{ '.per(per)' if @paginate_per_page_selector }"
+
+
+
+        # res << "\n    @#{plural} = @#{plural}.page(params[:page])#{ '.per(per)' if @paginate_per_page_selector }"
 
       elsif @nested_set[0] && @nested_set[0][:optional]
         res << "@#{ plural_name } = #{ class_name }.#{record_scope}.all"
       else
         res << "@#{ plural_name } = #{ class_name }.#{record_scope}.where(id: #{ auth_object.gsub("@",'') }.id)#{ n_plus_one_includes }"
 
-        res << "#{record_scope}.page(params[:page])#{ ".per(per)" if @paginate_per_page_selector }"
+        # res << "#{record_scope}"
       end
+      res << "\n"
+
     end
-    res << "\n"
     if @search_fields
+      res << "\n"
       res << @search_fields.collect{ |field|
         spaces(4) + "@#{plural_name} = @#{plural_name}" + @columns_map[field.to_sym].where_query_statement + " if #{field}_query"
-      }.join("\n")
+      }.join("\n") + "\n"
+    end
+
+    @phantom_search.each do |phantom_key, phantom_data|
+      phantom_data[:choices].each do |choice|
+        unless choice[:scope] == ".all"
+          res << "\n    @#{plural} = @#{plural}#{choice[:scope]} if @q['0'][:#{phantom_key}_search] == \"#{choice[:label]}\""
+        end
+      end
+      res << "\n"
     end
+
+    res << "    @#{plural} = @#{plural}.page(params[:page])#{ ".per(per)" if @paginate_per_page_selector }"
     res
   end
 
@@ -1830,4 +1893,22 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
       res
     }.join("\n")
   end
+
+
+  def search_default
+    default_fields = @search_fields.collect{ |foo|
+      { "#{foo}_match".to_sym =>
+            (@columns_map[foo.to_sym].modify_as && @columns_map[foo.to_sym].modify_as[:binary]) ? "-1" : "", "#{foo}_search".to_sym => ""
+      }
+    }.reduce({}, :merge)
+
+    phantom_search_fields = @phantom_search.collect{| k,v|
+      default = v[:choices][0]
+      {
+        "#{k}_match".to_sym => "",
+        "#{k}_search".to_sym => "#{default[:label]}"
+      }
+    }.reduce({}, :merge)
+    return {"0" => (default_fields.merge(phantom_search_fields))}
+  end
 end

data/lib/generators/hot_glue/set_search_interface_install_generator.rb

@@ -12,10 +12,14 @@ module HotGlue
     def initialize(*args) #:nodoc:
       super
 
-      ['date_range_picker','time_range_picker','search_form'].each do |file|
+      ['date_range_picker',
+       'time_range_picker',
+       'search_form'].each do |file|
+
+
         system("./bin/rails generate stimulus #{file.titlecase.gsub(" ", "")}")
-        copy_file "javascript/#{file}_controller.js", "#{filepath_prefix}app/javascript/controllers/#{file}.js"
-        puts "HOT GLUE --> copying #{file} stimulus controller into app/javascript/controllers/#{file}.js"
+        copy_file "javascript/#{file}_controller.js", "#{filepath_prefix}app/javascript/controllers/#{file}_controller.js"
+        puts "HOT GLUE --> copying #{file} stimulus controller into app/javascript/controllers/#{file}_controller.js"
 
       end
     end

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

@@ -75,8 +75,8 @@ class <%= controller_class_name %> < <%= controller_descends_from %>
   end<% end %>
   <% unless @no_list %>
   def load_all_<%= plural %><% if @search == "set" %>
-    @q = params[:q] ||  <%= {"0" => @search_fields.collect{|foo| {"#{foo}_match".to_sym => ((@columns_map[foo.to_sym].modify_as && @columns_map[foo.to_sym].modify_as[:binary]) ? "-1" : ""), "#{foo}_search".to_sym => ""}}.reduce({}, :merge)  } %> <% end %>
-  <%= load_all_code %>
+    @q = params[:q] || <%= search_default %> <% end %>
+<%= load_all_code %>
   end
 
   def index

data/lib/hotglue/version.rb

@@ -1,5 +1,5 @@
 module HotGlue
   class Version
-    CURRENT = '0.6.25'
+    CURRENT = '0.6.26.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hot-glue
 version: !ruby/object:Gem::Version
-  version: 0.6.25
+  version: 0.6.26.1
 platform: ruby
 authors:
 - Jason Fleetwood-Boldt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-31 00:00:00.000000000 Z
+date: 2025-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails