hot-glue 0.7.9 → 0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76c922f98d4c719eebde65cdc53c37d2c8be4c77ef56790bc749332f3d65eefc
-  data.tar.gz: 32b2ae025eae1edd8f75a702c00efb9cad09797c72f9af56343c881d0850d9b9
+  metadata.gz: 555bc8c92663c9e6797856debce6569ef5532f1d8f0536d862f1226b08b3e297
+  data.tar.gz: 2cc566882dc10083d857ebf8e254a126cf2842cde280509ff56ce37a86c4766e
 SHA512:
-  metadata.gz: 4cb18544f2114c1633fd2c00ccfe8beecaed890a0e6fdfec5cd0bf6ebb536ef9a80d8cf586b4d5bf9baf6097afc8149380d77f85df04465b01872239f09033b7
-  data.tar.gz: 180a70ce42a44d9bf0f6919e689762dad6589530746e51e98d6b18fe8568d3c52f699859e715b2a3045c9240813ad6537a39a0f2416f8d7e8739da3e2e2d606e
+  metadata.gz: 9592d760df6d8b79e41fdd71bb8e8a89f62745056c512b56cf1d31bed0174e9169146531febdec68dfb7ca2017e26e048f52055718ab04279e444c2742016482
+  data.tar.gz: c4e5ab6b7289ba6ac225eb4f40267bd2bb5b0163b1dc029ba43b55161552255ae4e541028a89aa4b988f6a83ea8123da7102216d4afe52a226dead4ca0e71c98

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hot-glue (0.7.8)
+    hot-glue (0.7.9)
       ffaker (~> 2.16)
       rails (> 5.1)
 
@@ -134,7 +134,7 @@ GEM
       net-protocol
     net-pop (0.1.2)
       net-protocol
-    net-protocol (0.2.2)
+    net-protocol (0.3.0)
       timeout
     net-smtp (0.5.1)
       net-protocol

data/README.md

@@ -1096,8 +1096,6 @@ The effect will be that the fields will be stacked together into nicely fit colu
 
 **If your customer is used to Excel, this feature will confuse them.**
 
-Also, this feature will **probably not** be supported by the SORTING (not yet implemented). (You will be forced to choose between the two which I think makes sense.)
-
 The layout builder works from right-to-left and starts with 12, the number of Bootstrap's columns.
 
 It reserves 2 columns for the default buttons. Then +1 additional column for **each magic button** you have specified.
@@ -2000,6 +1998,17 @@ _Notice that Stimulus requires object registration when used in a Node environme
 Instead, use the generator and the registry will be updated for you automatically. 
 
 
+## Sorting
+
+#### `--sortable` (true of flagged; false otherwise; does not take an argument)
+To add sorting to your columns add `--sortable` to your build
+sortable fields are integers, floats, string, text, datetime, time, dates excluding anything that is a foreign key, not UUIDs
+
+#### `--sort-fields=` 
+List of field names (separated by commas) 
+Leave off (do not specify) to sort by all sort-eligible fields
+
+
 ## Attachments
 
 #### `--attachments=` Long form syntax with 1st and 2nd parameters
@@ -2489,6 +2498,15 @@ These automatic pickups for partials are detected at build time. This means that
 
 # VERSION HISTORY
 
+#### 2026-08-30 - v0.8
+- `--sortable` (true of flagged; false otherwise; does not take an argument)
+To add sorting to your columns add `--sortable` to your build
+sortable fields are integers, floats, string, text, datetime, time, dates excluding anything that is a foreign key, not UUIDs
+- `--sort-fields=` 
+List of field names (separated by commas) 
+Leave off (do not specify) to sort by all sort-eligible fields
+
+
 #### 2026-08-29 - v0.7.9
 -  Render float fields as type="number" step="any" for HTML5 validation; float fields should not be correctly validated on input
 
@@ -2523,12 +2541,13 @@ for example, if we have a `thing` that can belong (via parent_id and parent_type
 
 Hot glue wil convert the spaces to commas when writing the controller code. 
 
-A child controller to with a polymorphic parent:
-- This special case assume that that the parent being build is not actually a polymoprh, it is a real object, but its children have foreign keys to it which are polymorphic. 
+A child controller with a polymorphic parent:
+
+- This special case assumes that that the parent being build is not actually a polymoprh, it is a real object, but its children have foreign keys to it which are polymorphic. 
 
-`--nested=abc(parent) `
+`--nested=abc(parent)`
 
-Example: In my data model, targets have a polymorphic parent (parent_id and parent_type) and can belong to either Companies or Schools. Here, we are building the Companies view with a child to Targets, but notice for these targets we are using polymorphism and also using a controller prefix, so tha this child controller will be built as CompanyTargets. In the companies build, we downnest `company_targets(targets)` (`company_targets` is the name of the child controller, but it is acting on an object called `targets`, as seen in the downnest specification.)
+Example: In my data model, targets have a polymorphic parent (parent_id and parent_type) and can belong to either Companies or Schools. Here, we are building the Companies view with a child to Targets, but notice for these targets we are using polymorphism and also using a controller prefix, so that this child controller will be built as CompanyTargets. In the companies build, we downnest `company_targets(targets)` (`company_targets` is the name of the child controller, but it is acting on an object called `targets`, as seen in the downnest specification.)
 
 ```
 bin/rails generate hot_glue:scaffold Company --namespace='account_dashboard' --nested='account'  --downnest='company_targets(targets)'

data/app/helpers/hot_glue_helper.rb

@@ -10,4 +10,36 @@ module HotGlueHelper
   def enum_to_collection_select(hash)
     hash.collect{|k,v| KVObject.new(key: k, value: v)}
   end
+
+  def sort_link(field, label)
+    field = field.to_s
+    active = params[:sort] == field
+    direction = active ? params[:direction] : nil
+
+    next_direction =
+      if !active
+        'asc'
+      elsif direction == 'asc'
+        'desc'
+      else
+        nil
+      end
+
+    new_params = request.query_parameters.except('sort', 'direction', 'page')
+    if next_direction
+      new_params['sort'] = field
+      new_params['direction'] = next_direction
+    end
+
+    arrow =
+      if active && direction == 'asc'
+        ' ▲'
+      elsif active && direction == 'desc'
+        ' ▼'
+      else
+        ''
+      end
+
+    link_to (label + arrow).html_safe, "#{request.path}?#{new_params.to_query}".chomp('?'), style: 'white-space: nowrap', 'data-turbo-action': 'advance'
+  end
 end

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

@@ -33,6 +33,10 @@ class AssociationField < Field
 
   end
 
+  def sortable?
+    false
+  end
+
   def assoc_name
     assoc
   end

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

@@ -52,6 +52,10 @@ class Field
     @name
   end
 
+  def sortable?
+    true
+  end
+
   def form_field_output
     raise "superclass must implement"
   end

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

@@ -13,7 +13,7 @@ module  HotGlue
                   :form_path, :layout_object, :search_clear_button, :search_autosearch,
                   :stimmify, :stimmify_camel, :hidden_create, :hidden_update, :invisible_create,
                   :invisible_update, :plural, :phantom_search, :pagination_style,
-                  :namespace, :controller_build_folder
+                  :namespace, :controller_build_folder, :sortable, :sortable_fields
 
 
     def initialize(singular:, singular_class: ,
@@ -27,9 +27,12 @@ module  HotGlue
                  search_clear_button:, search_autosearch:, layout_object:,
                  form_path: , stimmify: , stimmify_camel:, hidden_create:, hidden_update: ,
                  invisible_create:, invisible_update: , plural: , phantom_search:,
-                   pagination_style:, namespace: nil, controller_build_folder: nil )
+                   pagination_style:, namespace: nil, controller_build_folder: nil,
+                   sortable: false, sortable_fields: [] )
 
 
+      @sortable = sortable
+      @sortable_fields = sortable_fields
       @form_path = form_path
       @search = search
       @search_fields = search_fields
@@ -106,7 +109,11 @@ module  HotGlue
         "<div class='#{layout_strategy.column_classes_for_column_headings(size)} hg-heading-row heading--#{singular}--#{column.join("-")}' " + col_style + ">" +
           column.map(&:to_s).map{|col_name|
             unless col_name.starts_with?("**")
-              the_output = "#{col_name.humanize}"
+              if @sortable && @sortable_fields.collect(&:to_s).include?(col_name)
+                the_output = "<%= sort_link(:#{col_name}, '#{col_name.humanize}') %>"
+              else
+                the_output = "#{col_name.humanize}"
+              end
             else
               the_output = ""
             end

data/lib/generators/hot_glue/scaffold_generator.rb

@@ -34,7 +34,8 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
                 :search_clear_button, :search_autosearch, :include_object_names,
                 :stimmify, :stimmify_camel, :hidden_create, :hidden_update,
                 :invisible_create, :invisible_update, :phantom_create_params,
-                :phantom_update_params, :lazy, :back_link_to_parent, :polymorphic_parents
+                :phantom_update_params, :lazy, :back_link_to_parent, :polymorphic_parents,
+                :sortable, :sortable_fields
 
   # important: using an attr_accessor called :namespace indirectly causes a conflict with Rails class_name method
   # so we use namespace_value instead
@@ -144,6 +145,10 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
 
   class_option :phantom_search, default: nil
 
+  # SORT OPTIONS
+  class_option :sortable, type: :boolean, default: false
+  class_option :sort_fields, default: nil # comma separated whitelist; defaults to all sortable-type fields
+
 
 
   def initialize(*meta_args)
@@ -752,6 +757,27 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
       @columns_map[col] = this_column_object.field
     end
 
+    @sortable = options['sortable']
+
+    if @sortable
+      if options['sort_fields']
+        @sortable_fields = options['sort_fields'].split(',').collect(&:to_sym)
+        @sortable_fields.each do |field|
+          if !@columns_map[field]
+            raise "You specified a sort field for #{field} but that field is not in the list of columns"
+          elsif !@columns_map[field].sortable?
+            raise "You specified a sort field for #{field} but that field type cannot be sorted (e.g. an association or a UUID)"
+          end
+        end
+      else
+        @sortable_fields = @columns_map.select { |col, field| field.sortable? }.keys
+      end
+
+      warn_about_unindexed_sortable_fields
+    else
+      @sortable_fields = []
+    end
+
 
     @columns_map.each do |key, field|
       if field.is_a?(AssociationField)
@@ -928,7 +954,9 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
         phantom_search: @phantom_search,
         pagination_style: @pagination_style,
         namespace: @namespace,
-        controller_build_folder: @controller_build_folder
+        controller_build_folder: @controller_build_folder,
+        sortable: @sortable,
+        sortable_fields: @sortable_fields
       )
     elsif @markup == "slim"
       raise(HotGlue::Error, "SLIM IS NOT IMPLEMENTED")
@@ -1997,6 +2025,17 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
   end
 
 
+  def warn_about_unindexed_sortable_fields
+    indexed_columns = @the_object.connection.indexes(@the_object.table_name).collect { |index| index.columns.first }
+    unindexed = @sortable_fields.reject { |field| indexed_columns.include?(field.to_s) }
+    return if unindexed.empty?
+
+    puts "********************"
+    puts "WARNING: The following fields are sortable but have no database index, which may cause slow queries as the table grows: #{unindexed.join(', ')}"
+    puts "Consider adding indexes, e.g.: " + unindexed.collect { |field| "add_index :#{plural}, :#{field}" }.join("; ")
+    puts "********************"
+  end
+
   def load_all_code
     # the inner method definition of the load_all_* method
     res = +""
@@ -2068,6 +2107,12 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
       res << "\n"
     end
 
+    if @sortable
+      res << "\n"
+      res << "    if SORTABLE_FIELDS.include?(params[:sort]) && %w[asc desc].include?(params[:direction])\n"
+      res << "      @#{plural} = @#{plural}.order(params[:sort] => params[:direction].to_sym)\n"
+      res << "    end"
+    end
 
     if @pagination_style == "kaminari"
       res << "    @#{plural} = @#{plural}.page(params[:page])#{ ".per(per)" if @paginate_per_page_selector }"

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

@@ -77,6 +77,8 @@ class <%= controller_class_name %> < <%= controller_descends_from %>
     params[:per] || 10
   end<% end %>
   <% unless @no_list %>
+<% if @sortable %>  SORTABLE_FIELDS = %w[<%= @sortable_fields.join(' ') %>].freeze
+<% end %>
   def load_all_<%= plural %><% if @search == "set" %>
     @q = params[:q] || <%= search_default %> <% end %>
 <%= load_all_code %>

data/lib/hotglue/version.rb

@@ -1,5 +1,5 @@
 module HotGlue
   class Version
-    CURRENT = '0.7.9'
+    CURRENT = '0.8'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hot-glue
 version: !ruby/object:Gem::Version
-  version: 0.7.9
+  version: '0.8'
 platform: ruby
 authors:
 - Jason Fleetwood-Boldt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-29 00:00:00.000000000 Z
+date: 2026-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails