hot-glue 0.6.10 → 0.6.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e97635a9b4a9f05502eaec8834622f0eca2bcf6a984b32819aa92b1f94afebce
-  data.tar.gz: 05c5ca3e88a7d2fe2e0dce9f22824ae817a3d909f03f8c4a8053bd6d12b72632
+  metadata.gz: a9b9cdb44bde02376148703d050944c0c7cc169b42349b021539098afd8532bf
+  data.tar.gz: e4baffd1a1d3d4cf01b811c850b02827c803f7d1188a5b5166f40b11730a0821
 SHA512:
-  metadata.gz: 47afa457097e68f69f7aaa85d07f8ebe70d47f052875eb52863796122846e9b8993d13e678e8eb927ce44a0331b2a56972a189d8af0e1c4272bd2b2661837548
-  data.tar.gz: 525847e13f04fec313576a235d864fa2a59781d448bd4a94ed2425d0c2bbb508efd83f0b97d37a9f9f5ab5af7f49b5d9e6dc3797648e5ab39bf7b67823794ef8
+  metadata.gz: f298a2685d19ebc5a27c16d72cb05806a74bdf3ffbe15b7f85e799164e0d4c56ae1605d950a0843749a3db840c957d1f8a30feb27d68b276656a277a3dd21d53
+  data.tar.gz: e5984cc18282e0b5b99f5992d764395dc9964c1a81b08c6848d9f498564e04e8623275fd40b4c67ca2759d400fe3d4e952ea4db61aada50a63f7fab3ef67a6d9

data/README.md

@@ -987,6 +987,13 @@ Omits controller.
 
 Omits list views. 
 
+`--new-button-position` (above, below; default: above)
+Show the new button above or below the list.
+
+`--downnest-shows-headings` (default: false)
+Show headings above downnested portals.
+
+
 ### `--big-edit`
 
 If you do not want inline editing of your list items but instead want to fallback to full-page style behavior for your edit views, use `--big-edit`. 
@@ -1106,7 +1113,16 @@ Use `before` to make the labels come before or `after` to make them come after.
 
 Omits the heading of column names that appears above the 1st row of data.
 
+### `--include-object-names`
+
+When you are "Editing X" we specify that X is a ___ (author, book, room, etc)
 
+e.g. "Editing author Edgar Allan Poe" vs "Editing Edgar Allan Poe"
+
+Can also be specified globally in `config/hot_glue.yml`
+
+
+### Code insertions
 
 `--code-before-create`
 `--code-after-create`
@@ -1585,6 +1601,76 @@ 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.
 
+The typeahead itself can be both namespaced and nested. (Remember, all controllers are generated at the namespace.)
+
+Pay close attention to a nested typeahead: When generating the typeahead scaffold use both `--namespace=aaa` and `--nested=bbb/ccc`
+
+In this example, the typeahead controller will operate at a namespace of `aaa` with two parents: `bbb` and `ccc`
+
+Combined with `--auth-identifier`, you can load only objects that are related from the `ccc` thing that gets loaded off the `bbb` thing that gets loaded off the current_user.
+
+This scopes the list returned by the typeahead. 
+
+You need to specify this twice: Once when specifying the typehead scaffold, and also any place in a regular scaffold that uses typeahead:
+
+For example, assuming we have a reciprocal has_many through for Accounts & Users
+
+user.rb
+```
+has_many :account_users
+has_many :accounts, through: :account_users
+```
+
+
+account.rb
+```
+has_many :account_users
+has_many :users, through: :account_users
+```
+
+
+`bin/rails generate hot_glue:scaffold Member --auth='current_user' --auth-identifier='user' --auth-identifier=user --modify='user_id{typeahead}[account]'`
+
+in our routes.rb file, we have
+```
+namespace :account_dashboard do
+  resources :accounts do
+    resources :users_typeahead
+    resources :rooms do
+      resources :members
+    end
+  end
+end 
+```
+
+Notice that the scaffold with the references to users is 2 levels deep: accounts -> rooms -> members (and is also in a namespace)
+
+Notice also that the *users typeahead* operates only one level deep in the same namespace.
+
+This means that to find users within the search, the essential piece of information is the account, because we want to scope the result set to the users belong to that account.
+
+• The account must belong to the current_user (notice the account uses nested account provided by the route)
+• Any users found by the typeahead must belong to the account
+
+```
+  def account
+    @account ||= current_user.accounts.find(params[:account_id]) 
+  end
+  
+  def index
+    authorize User, :typeahead? 
+    query = params[:query]
+    @typeahead_identifier = params[:typeahead_identifier]
+    @users = account.users.where("LOWER(email) LIKE ?  ", "%#{query.downcase}%").limit(10)
+    render layout: false
+  end
+```
+
+
+
+--
+
+
 ### TinyMCE
 1. `bundle add tinymce-rails` to add it to your Gemfile
 
@@ -1663,6 +1749,42 @@ These automatic pickups for partials are detected at buildtime. This means that
 
 # VERSION HISTORY
 
+
+#### 2025-01-28 v0.6.11
+
+• Typeahead now can use --auth, --auth-identifier, --namespace, and --nested
+• Works similar to how same flags work on scaffold generator. (Notice that the typeahead generator is a completely separate generator). 
+• When using nested, your results are scoped the parent objects in the nest chain (which is the last one)
+
+e.g.
+`bin/rails generate hot_glue:scaffold Member --auth='current_user' --auth-identifier='user' --auth-identifier=user --modify='user_id{typeahead}[account]'`
+
+here the user_id field on members will use a typeahead that is built in the namespace `account_dashboard` under 1 parent: `account`
+
+This would be used in conjunction with a typeahead built using the same namespace and nesting that matches:
+
+```
+bin/rails generate hot_glue:typeahead User --namespace='account_dashboard' --nested='account' --auth-identifier='user' --auth='current_user'
+```
+
+(See 'typeahead' section for details)
+
+`--include-object-names`
+
+When you are "Editing X" we specify that X is a ___ (author, book, room, etc)
+
+e.g. "Editing author Edgar Allan Poe" vs "Editing Edgar Allan Poe"
+
+Can also be specified globally in `config/hot_glue.yml`
+
+
+`--new-button-position` (above, below; default: above)
+Show the new button above or below the list.
+
+`--downnest-shows-headings` (default: false)
+Show headings above downnested portals.
+
+
 #### 2024-12-25 v0.6.10
     • adds `--no-nav-menu` option to supress writing to the _nav template
     • the _nav template itself can now end with either .html.erb or .erb

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

@@ -110,7 +110,15 @@ class AssociationField < Field
       # else
       # end
     elsif modify_as && modify_as[:typeahead]
-      search_url  = "#{namespace ? namespace + "_" : ""}#{assoc.class_name.downcase.pluralize}_typeahead_index_url"
+      search_url  = "#{namespace ? namespace + "_" : ""}" +
+        modify_as[:nested].join("_") +
+        + "_#{assoc.class_name.downcase.pluralize}_typeahead_index_url"
+
+
+      if @modify_as[:nested].any?
+        search_url  << "(" + modify_as[:nested].collect{|x| "#{x}"}.join(",") + ")"
+      end
+
       "<div class='typeahead typeahead--#{assoc.name}_id'
       data-controller='typeahead'
       data-typeahead-url-value='<%= #{search_url} %>'

data/lib/generators/hot_glue/scaffold_generator.rb

@@ -28,7 +28,7 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
                 :layout_strategy, :form_placeholder_labels,
                 :form_labels_position, :no_nav_menu, :pundit,
                 :self_auth, :namespace_value, :record_scope, :related_sets,
-                :search_clear_button, :search_autosearch
+                :search_clear_button, :search_autosearch, :include_object_names
   # important: using an attr_accessor called :namespace indirectly causes a conflict with Rails class_name method
   # so we use namespace_value instead
 
@@ -98,7 +98,9 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
   class_option :code_after_update, default: nil
   class_option :record_scope, default: nil
   class_option :no_nav_menu, type: :boolean, default: false # suppress writing to _nav template
-
+  class_option :include_object_names, type: :boolean, default: false
+  class_option :new_button_position, type: :string, default: 'above'
+  class_option :downnest_shows_headings, type: :boolean, default: nil
 
 
   # SEARCH OPTIONS
@@ -260,7 +262,8 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
         elsif $2 == "tinymce"
           @modify_as[key.to_sym] =  {tinymce: 1, badges: $3}
         elsif $2 == "typeahead"
-          @modify_as[key.to_sym] =  {typeahead: 1, badges: $3}
+          nested = $3.split("/")
+          @modify_as[key.to_sym] =  {typeahead: 1, nested: nested}
         elsif $2 == "timezone"
           @modify_as[key.to_sym] =  {timezone: 1, badges: $3}
         elsif $2 == "none"
@@ -337,6 +340,9 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
 
     @smart_layout = options['smart_layout']
     @record_scope = options['record_scope']
+    @downnest_shows_headings = options['downnest_shows_headings']
+    @new_button_position = options['new_button_position']
+
 
     @pundit = options['pundit']
 
@@ -361,6 +367,10 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
       @downnest_object = HotGlue.construct_downnest_object(@downnest)
     end
 
+    @include_object_names = options['include_object_names'] || get_default_from_config(key: :include_object_names)
+
+
+
     if @god
       # @auth = nil
     end
@@ -463,6 +473,7 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
     identify_object_owner
     setup_fields
 
+
     if (@columns - @show_only - (@ownership_field ? [@ownership_field.to_sym] : [])).empty?
       @no_field_form = true
     end
@@ -1069,7 +1080,7 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
     HotGlue.optionalized_ternary(namespace: @namespace,
                                  target: @controller_build_folder,
                                  nested_set: @nested_set,
-                                 with_params: true,
+                                 with_params: false,
                                  top_level: false)
   end
 
@@ -1077,7 +1088,7 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
     HotGlue.optionalized_ternary(namespace: @namespace,
                                  target: @singular,
                                  nested_set: @nested_set,
-                                 with_params: true,
+                                 with_params: false,
                                  put_form: true,
                                  top_level: false)
   end
@@ -1086,7 +1097,7 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
     HotGlue.optionalized_ternary(namespace: @namespace,
                                  target: @singular,
                                  nested_set: @nested_set,
-                                 with_params: true,
+                                 with_params: false,
                                  put_form: true)
   end
 
@@ -1095,7 +1106,7 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
                                  target: @singular,
                                  nested_set: @nested_set,
                                  modifier: "edit_",
-                                 with_params: true,
+                                 with_params: false,
                                  put_form: true)
   end
 
@@ -1124,7 +1135,7 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
                                  target: singular,
                                  nested_set: @nested_set,
                                  modifier: "new_",
-                                 with_params: true)
+                                 with_params: false)
   end
 
   def nested_assignments
@@ -1222,7 +1233,7 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
       path: HotGlue.optionalized_ternary( namespace: @namespace,
                                           target: @singular,
                                           nested_set: @nested_set,
-                                          with_params: true,
+                                          with_params: false,
                                           put_form: true),
                                           big_edit: @big_edit,
                                           singular: singular,

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

@@ -154,7 +154,7 @@ class <%= controller_class_name %> < <%= controller_descends_from %>
     @action = 'edit'
     render :edit<% if @pundit %>
   rescue Pundit::NotAuthorizedError
-    flash[:notice] = "Editing #{@<%= singular %>.<%= display_class %>} not authorized."
+    flash[:notice] = "Editing <%= singular + ' ' if @include_object_names %>#{@<%= singular %>.<%= display_class %>} not authorized."
     render :index <% end %>
   end
 

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

@@ -3,7 +3,7 @@
   <\% if <%= singular %>.errors.any? %>
   <\%= render(partial: "<%= namespace_with_trailing_dash %>errors", locals: {resource: <%= singular %> }) %>
   <\% end %>
-  <h2>Editing <\%= <%= singular %>.<%= display_class %> %></h2>
+  <h2>Editing <%= singular + " " if @include_object_names %><\%= <%= singular %>.<%= display_class %> %></h2>
   <\%= form_with model: <%= singular %>, url: <%= form_path_edit_helper %><%= ", html: {'data-turbo': false}" if @big_edit %> do |f| %>
     <\%=  render partial: "<%= namespace_with_trailing_dash + @controller_build_folder + "/" %>form", locals: {:<%=  singular  %> => <%= singular %>, f: f}<%= @nested_set.collect{|arg| ".merge(#{arg[:singular]} ? {#{arg[:singular]}: #{arg[:singular]}} : {})" }.join %> \%>
   <% if @edit_within_form_partial %><\%= render partial: "edit_within_form", locals: {f: f, <%=  singular  %>: <%= singular %>}<%= @nested_set.collect{|arg| ".merge(#{arg[:singular]} ? {#{arg[:singular]}: #{arg[:singular]}} : {})" }.join %> %><% end %>

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

@@ -7,7 +7,9 @@
       </h4><% end %>
     <% end %>
 
+    <% if @new_button_position == 'above' %>
     <% unless @no_create %><%= '<%= render partial: "' + ((@namespace+"/" if @namespace) || "") +  @controller_build_folder + '/new_button", locals: {}' + @nested_set.collect{|arg| ".merge(defined?(#{arg[:singular]}) ? {#{arg[:singular]}: #{arg[:singular]}} : {})"}.join()  + ' %\>'.gsub('\\',"")  %><br /><% end %>
+    <% end %>
 
     <% unless @no_list %>
       <% unless @no_list_heading %>
@@ -66,5 +68,10 @@
       <% end %>
     <%=  @no_paginate ? "" : paginate %>
   <% end  %>
+
+
+  <% if @new_button_position == 'below' %>
+    <% unless @no_create %><%= '<%= render partial: "' + ((@namespace+"/" if @namespace) || "") +  @controller_build_folder + '/new_button", locals: {}' + @nested_set.collect{|arg| ".merge(defined?(#{arg[:singular]}) ? {#{arg[:singular]}: #{arg[:singular]}} : {})"}.join()  + ' %\>'.gsub('\\',"")  %><br /><% end %>
+  <% end %>
   </div>
 <\% end %>

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

@@ -12,7 +12,12 @@
     <% downnest_object_name = eval("#{downnest_class}.table_name") %>
     <% downnest_style = @layout_strategy.downnest_style %>
     <% if !@stacked_downnesting %><div class="<%= @layout_strategy.downnest_portal_column_width(downnest)  %> scaffold-downnest" <%= downnest_style  %> ><% end %>
-  <\%= render partial: "<%= namespace_with_trailing_dash %><%= downnest_object_name %>/list", locals: {
+    <% if @downnest_shows_headings %>
+      <h3>
+        <%= downnest_object_name.pluralize.humanize %>
+      </h3>
+    <% end %>
+    <\%= render partial: "<%= namespace_with_trailing_dash %><%= downnest_object_name %>/list", locals: {
         <%= @singular %>: <%= @singular %>,
         <%= downnest_object_name %>: <%= @singular %>.<%= downnest %>
       }

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

@@ -20,7 +20,11 @@
           <% downnest_class = downnest_object.class_name %>
           <% downnest_object_name = eval("#{downnest_class}.table_name") %>
           <% downnest_style = @layout_strategy.downnest_style %>
-
+          <% if @downnest_shows_headings %>
+            <h3>
+              <%= downnest_class.humanize %>
+            </h3>
+          <% end %>
           <\%= render partial: "<%= namespace_with_trailing_dash %><%= downnest_object_name %>/list", locals: {<%= @singular %>: @<%= @singular %>,  <%= downnest_object_name %>: @<%= @singular %>.<%= downnest %><% if @nested_set.any? %>, <%= @nested_set.collect{|x| "#{x[:singular]}: @#{x[:singular]}"}.join(", ") %>, nested_for: "<%= @nested_set.collect{|x| "#{x[:singular]}-" + "\#{" + "@#{x[:singular]}.id}"}.join("__") %>__<%= singular %>-#{@<%= @singular %>.id}" <% end %> } \%>
 
           </div>

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

@@ -4,12 +4,38 @@ class <%= ((@namespace.titleize.gsub(" ", "") + "::" if @namespace) || "") + @pl
   <% end %># <%= regenerate_me_code %><% if defined?(RuboCop) %>
   # rubocop:enable Layout/LineLength <% end %>
 
+
+  <% @nested_set.each do |nest| %>before_action :<%= nest[:singular] %>
+  def <%= nest[:singular] %>
+    @<%= nest[:singular] %> ||= current_user.accounts.find(params[:account_id])
+  end
+  <% end %>
+
+  <% nest_chain = [] %>
+  <% @nested_set.each { |arg|
+      if @auth_identifier == arg[:singular]
+        this_scope = auth_object
+      elsif nest_chain.empty?
+        this_scope = "#{@auth ? @auth : class_name}.#{arg[:plural]}"
+      else
+        this_scope = "#{nest_chain.last}.#{arg[:plural]}"
+      end
+       nest_chain << arg
+     }%>
+
   def index
     <% if @pundit %>authorize <%= @class_name %>, :typeahead? <% end %>
     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)
 
+
+    <% if @nested_set.none? %>
+    @<%= @plural %> = <%= @singular.titleize.gsub(" ", "") %>.where("<%= @search_by.collect{|search| "LOWER(#{search}) LIKE ?" }.join(" OR ") %>", <%= @search_by.collect{|search|  "\"%\#{query.downcase}%\"" }.join(", ") %>).limit(10)
+    <% else %>
+    <% @nested_set.each do |arg| %>
+    @<%= @plural %> = <%= @nested_set.last[:singular] %>.<%= @plural %>.where("<%= @search_by.collect{|search| "LOWER(#{search}) LIKE ?" }.join(" OR ") %>", <%= @search_by.collect{|search|  "\"%\#{query.downcase}%\"" }.join(", ") %>).limit(10)
+    <% end %>
+      <% end %>
     render layout: false
   end
 end

data/lib/generators/hot_glue/typeahead_generator.rb

@@ -5,6 +5,10 @@ module HotGlue
     source_root File.expand_path('templates', __dir__)
     class_option :namespace, type: :string, default: nil
     class_option :search_by, type: :string, default: nil
+    class_option :nested, type: :string, default: nil
+    class_option :auth, type: :string, default: nil
+    class_option :auth_identifier, type: :string, default: nil
+
 
     include DefaultConfigLoader
     def filepath_prefix
@@ -28,6 +32,25 @@ module HotGlue
       @class_name = args.first
       @plural = args.first.tableize.pluralize
       @namespace = options['namespace']
+      @nested = options['nested'] if options['nested']
+
+      if !@nested.nil?
+        @nested_set = @nested.split("/").collect { |arg|
+          is_optional = arg.start_with?("~")
+          arg.gsub!("~", "")
+          {
+            singular: arg,
+            plural: arg.pluralize,
+            optional: is_optional
+          }
+        }
+        puts "NESTING: #{@nested_set}"
+      else
+        @nested_set = []
+      end
+
+      @auth = options['auth'] || "current_user"
+      @auth_identifier = options['auth_identifier'] || "user"
 
       if options['search_by']
         @search_by = options['search_by'].split(",")

data/lib/hotglue/version.rb

@@ -1,5 +1,5 @@
 module HotGlue
   class Version
-    CURRENT = '0.6.10'
+    CURRENT = '0.6.11'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hot-glue
 version: !ruby/object:Gem::Version
-  version: 0.6.10
+  version: 0.6.11
 platform: ruby
 authors:
 - Jason Fleetwood-Boldt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-25 00:00:00.000000000 Z
+date: 2025-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails