hot-glue 0.6.7 → 0.6.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4145a5b0431eb0e5527da881e94fe7dbd3e98afd1eea8186e5082705e295e6e1
-  data.tar.gz: 87f4eeedf75612c0ee90c116d9d8487be17bfb217c4aaeb06314b7fba93f6266
+  metadata.gz: 86900d536cda31c5759bd3603aff4e32a7c141bd015f4c3910c1ac2fbd67c083
+  data.tar.gz: 4dfeabc8f4a4f65a626cf6510b11a546d6cf860735a6cb582b6811ac25bdb1a2
 SHA512:
-  metadata.gz: 7c5146d1150afca3a2d65956a06d1e1ee8b7f0bd172d9db3d1772f832a954abbc01849ff3002b6aaf617036d28d6cfd405aa31dd0e09be1aaaf497e16f5a074a
-  data.tar.gz: 2099aef1b686d42ebd546b4c9d77d32534476d9eb3fed28c9b43482549fe846fba69a07eb90ade6cc3838aee628cad51e3ed8b90ccad3ec27485fad3833d7627
+  metadata.gz: 40f77d7d6552441122511e1fbd144ff9090fac458840333d9d4062c443466e9fe12932fb2748e40a9799562b71fa028b53910f34da77eae281bb18b8055e0cd5
+  data.tar.gz: 281870175e5d080e79f0afc9d190e5f6047660cea7cc16470fe3feec2cdd18da67ef99e0d686fa2c9378d45a77cf4b0b9a041635df3aeee57c84796a972f69fe

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hot-glue (0.6.6.1)
+    hot-glue (0.6.8)
       ffaker (~> 2.16)
       kaminari (~> 1.2)
       rails (> 5.1)
@@ -90,7 +90,7 @@ GEM
       xpath (~> 3.2)
     concurrent-ruby (1.1.10)
     crass (1.0.6)
-    date (3.3.4)
+    date (3.4.1)
     devise (4.8.1)
       bcrypt (~> 3.0)
       orm_adapter (~> 0.1)
@@ -139,7 +139,7 @@ GEM
     mini_mime (1.1.2)
     mini_portile2 (2.8.4)
     minitest (5.16.3)
-    net-imap (0.4.14)
+    net-imap (0.5.1)
       date
       net-protocol
     net-pop (0.1.2)
@@ -235,7 +235,7 @@ GEM
     stimulus-rails (1.1.1)
       railties (>= 6.0.0)
     thor (1.2.1)
-    timeout (0.4.1)
+    timeout (0.4.2)
     turbo-rails (1.3.2)
       actionpack (>= 6.0.0)
       activejob (>= 6.0.0)

data/README.md

@@ -690,10 +690,60 @@ Notice that each modifiers can be used with specific field types.
 | tinymce                       | applies to text fields only, be sure to setup TineMCE globally                                                                                                       | text fields only                  |    |   |
 | typeahead                     | turns a foreign key (only) into a searchable typeahead field                                                                                                         | foreign keys only                 |   |   |
 | timezone                      | turns a string (varchar) into a drop down of timezones                                                                                                               | foreign keys only                 |   |   |
-
+| none                          | special modifier for using badges |
 
 Except for "(truthy label)" and "(falsy label)" which use the special syntax, use the modifier _exactly_ as it is named.
 
+apply badge behavior using `[` and `]` markers after the modification marker. 
+
+`--modify=opened_at{opened|closed}[bg-primary|bg-secondary]`
+Applies a badge `bg-primary` to rows with opened_at truthy and `bg-secondary` to rows with opened_at falsy.
+
+to display a badge on everything, use the `none` modifier with the
+`--modify=opened_at{none}[bg-dark]`
+
+
+
+### `--alt-foreign-key-lookup=`
+
+Use for a join table to specify that a field should be looked up by a different field
+
+
+`./bin/rails generate hot_glue:scaffold AccountUser --alt-foreign-key-lookup=user_id{email}`
+
+Here we are specifying that the `user_id` field should be looked up by the `email` field on the User table. 
+If no existing user exists, we create one because we are using the `find_or_create_by!` method.
+
+Use with a factory pattern like this one:
+``` 
+class AccountUserFactory
+  attr_accessor :account_user
+
+  def initialize(params: {}, account: nil)
+    begin
+      user = User.find_or_create_by!( email: params[:__lookup_email])
+    rescue ActiveRecord::RecordInvalid => e
+      @account_user = AccountUser.new({account: account})
+
+      @account_user.errors.add(:user, e.message)
+    end
+
+    @account_user = AccountUser.new(params.tap{|x| x.delete(:__lookup_email)}
+                                          .merge({user: user,
+                                                  account: account}))
+  end
+end
+```
+
+this works with a factory creation syntax like so:
+
+```
+--factory-creation='factory = AccountUserFactory.new(params: account_user_params, account: account)
+```
+*See the `--factory-creation` section. 
+
+
+
 ### `--pundit`
 If you enable Pundit, your controllers will look for a Policy that matches the name of the thing being built.
 
@@ -1612,6 +1662,18 @@ These automatic pickups for partials are detected at buildtime. This means that
 
 # VERSION HISTORY
 
+
+#### 2024-12-05 - v0.6.8
+• fixes in modify_date_inputs_on_params for current_user_object
+
+• adds back alt_lookup feature from version 0.5.7; use with --alt-foreign-key-lookup
+
+• badges can be added to modified fields using `[` and `]` which come after the modification flag inside `{...}`. 
+for booleans separate with pipes `|`
+
+• you can add badges to fields that have no other modification using the `none` modifier
+
+
 #### 2024-11-26 - v0.6.7
 
 Patch for my non-:00 seconds problem. I have discovered that the root of my issues was a quirk in how browsers display datetime-local fields.
@@ -2154,7 +2216,7 @@ div[class$="--phone_number"] {
 #### 2023-02-13 - v0.5.7 - factory-creation, alt lookups, update show only, fixes to Enums, support for Ruby 3.2
 • See `--factory-creation` section.
 
-• `--alt-lookup-foreign-keys`
+• `--alt-foreign-key-lookup`
 Allows you to specify that a foreign key should act as a search field, allowing the user to input a unique value (like an email) to search for a related record.
 
 • `--update-show-only`

data/app/helpers/hot_glue/controller_helper.rb

@@ -69,7 +69,7 @@ module HotGlue
     end
 
     def modify_date_inputs_on_params(modified_params, current_user_object = nil, field_list = nil)
-      use_timezone = (current_user.try(:timezone)) || Time.zone
+      use_timezone = (current_user_object.try(:timezone)) || Time.zone
       modified_params = modified_params.tap do |params|
         params.keys.each{|k|
 

data/lib/generators/hot_glue/field_factory.rb

@@ -49,6 +49,7 @@ class FieldFactory
             end
     @class_name = class_name
 
+
     @field = field_class.new(name: name,
                              layout_strategy: generator.layout_strategy,
                              form_placeholder_labels: generator.form_placeholder_labels,
@@ -57,6 +58,7 @@ class FieldFactory
                              hawk_keys: generator.hawk_keys,
                              auth: generator.auth,
                              class_name: generator.singular_class,
+                             alt_lookup: generator.alt_lookups[name] || nil,
                              singular: generator.singular,
                              self_auth: generator.self_auth,
                              update_show_only: generator.update_show_only,

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

@@ -3,9 +3,9 @@ require_relative './field.rb'
 
 class AssociationField < Field
 
-  attr_accessor :assoc_name, :assoc_class, :assoc
+  attr_accessor :assoc_name, :assoc_class, :assoc, :alt_lookup
 
-  def initialize( class_name: , default_boolean_display:, display_as: ,
+  def initialize( alt_lookup: , class_name: , default_boolean_display:, display_as: ,
                  name: , singular: ,
                  update_show_only: ,
                  hawk_keys: , auth: , sample_file_path:,  ownership_field: ,
@@ -13,6 +13,7 @@ class AssociationField < Field
                  form_labels_position:, modify_as: , self_auth: , namespace:, pundit:  )
     super
 
+
     @assoc_model = eval("#{class_name}.reflect_on_association(:#{assoc})")
 
     if assoc_model.nil?
@@ -47,7 +48,7 @@ class AssociationField < Field
   end
 
   def spec_setup_and_change_act(which_partial)
-    if which_partial == :update && update_show_only.include?(name)
+    if which_partial == :update_show_only && update_show_only.include?(name)
 
     else
       "      #{name}_selector = find(\"[name='#{singular}[#{name}]']\").click \n" +
@@ -75,10 +76,38 @@ class AssociationField < Field
     "  let!(:#{assoc}1) {create(:#{the_foreign_class}" +  hawk_keys_on_lets + ")}"
   end
 
+  def raw_view_field
+    assoc_name = name.to_s.gsub("_id","")
+    assoc = eval("#{class_name}.reflect_on_association(:#{assoc_name})")
+    if assoc.nil?
+      exit_message = "*** Oops. on the #{singular_class} object, there doesn't seem to be an association called '#{assoc_name}'"
+      exit
+    end
+    is_owner = name == ownership_field
+    assoc_class_name = assoc.class_name.to_s
+    display_column = HotGlue.derrive_reference_name(assoc_class_name)
+
+
+    "<%= #{singular}.#{assoc_name}.#{display_column} %>"
+  end
+
   def form_field_output
     assoc_name = name.to_s.gsub("_id","")
     assoc = eval("#{class_name}.reflect_on_association(:#{assoc_name})")
-    if modify_as && modify_as[:typeahead]
+
+    if alt_lookup
+      alt = alt_lookup[:lookup_as]
+      assoc_name = name.to_s.gsub("_id","")
+      assoc = eval("#{class_name}.reflect_on_association(:#{assoc_name})")
+
+      alt = alt_lookup[:lookup_as]
+      "<%= f.text_field :__lookup_#{alt}, value: @#{singular}.#{assoc_name}.try(:#{alt}), placeholder: \"search by #{alt}\" %>"
+
+      # if modify_as
+      #   modified_display_output
+      # else
+      # end
+    elsif modify_as && modify_as[:typeahead]
       search_url  = "#{namespace ? namespace + "_" : ""}#{assoc.class_name.downcase.pluralize}_typeahead_index_url"
       "<div class='typeahead typeahead--#{assoc.name}_id'
       data-controller='typeahead'
@@ -122,25 +151,19 @@ class AssociationField < Field
   end
 
   def form_show_only_output
-    assoc_name = name.to_s.gsub("_id","")
-    assoc = eval("#{class_name}.reflect_on_association(:#{assoc_name})")
-    if assoc.nil?
-      exit_message = "*** Oops. on the #{singular_class} object, there doesn't seem to be an association called '#{assoc_name}'"
-      exit
-    end
 
-    is_owner = name == ownership_field
-    assoc_class_name = assoc.class_name.to_s
-    display_column = HotGlue.derrive_reference_name(assoc_class_name)
 
-    if hawk_keys[assoc.foreign_key.to_sym]
-      hawk_definition = hawk_keys[assoc.foreign_key.to_sym]
-      hawked_association = hawk_definition.join(".")
+    # if hawk_keys[assoc.foreign_key.to_sym]
+    #   hawk_definition = hawk_keys[assoc.foreign_key.to_sym]
+    #   hawked_association = hawk_definition.join(".")
+    # else
+    #   hawked_association = "#{assoc.class_name}.all"
+    # end
+    if modify_as && modify_as[:none]
+      "<span class='badge #{modify_as[:badges]}'>" + raw_view_field + "</span>"
     else
-      hawked_association = "#{assoc.class_name}.all"
+      raw_view_field
     end
-    "<%= #{singular}.#{assoc_name}.#{display_column} %>"
-
   end
 
   def line_field_output

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

@@ -1,9 +1,24 @@
 class AttachmentField < Field
   attr_accessor :attachment_data
-  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: , namespace:, pundit:   )
+  def initialize(alt_lookup:,
+                 attachment_data:,
+                 auth:,
+                 class_name:,
+                 display_as:, singular:,
+                 default_boolean_display: ,
+                 form_placeholder_labels: ,
+                 form_labels_position:,
+                 hawk_keys:,
+                 layout_strategy: ,
+                 name:,
+                 namespace:,
+                 modify_as:,
+                 ownership_field:,
+                 pundit: ,
+                 sample_file_path: nil,
+                 self_auth:,
+                 update_show_only:
+  )
     super
 
     @attachment_data = attachment_data

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

@@ -1,5 +1,5 @@
 class Field
-  attr_accessor :assoc_model, :assoc_name, :assoc_class, :associations, :alt_lookups, :auth,
+  attr_accessor :assoc_model, :assoc_name, :assoc_class, :associations, :alt_lookup, :auth,
                 :assoc_label,  :class_name, :default_boolean_display, :display_as, :form_placeholder_labels,
                 :form_labels_position,
                 :hawk_keys,   :layout_strategy, :limit, :modify_as, :name, :object, :sample_file_path,
@@ -11,6 +11,7 @@ class Field
     auth: ,
     attachment_data: nil,
     class_name: ,
+    alt_lookup: ,
     default_boolean_display: ,
     display_as: ,
     form_labels_position:,
@@ -29,7 +30,7 @@ class Field
   )
     @name = name
     @layout_strategy = layout_strategy
-    @alt_lookups = alt_lookups
+    @alt_lookup = alt_lookup
     @singular = singular
     @class_name = class_name
     @update_show_only = update_show_only
@@ -123,13 +124,22 @@ class Field
 
   def viewable_output
     if modify_as
-      modified_display_output
+      modified_display_output(show_only: true)
+    else
+      field_view_output
+    end
+  end
+
+  def field_view_output
+    if modify_as && modify_as[:none]
+      "<span class='badge #{modify_as[:badges]}'>" + field_view_output + "</span>"
     else
       "<%= #{singular}.#{name} %>"
     end
   end
 
-  def modified_display_output
+
+  def modified_display_output(show_only: false)
     res = +''
 
     if modify_as[:cast] && modify_as[:cast] == "$"
@@ -141,19 +151,21 @@ class Field
     elsif modify_as[:timezone]
       res += "<%= #{singular}.#{name} %>"
     elsif modify_as[:enum]
-      res += "<%= render partial: #{singular}.#{name}, locals: {#{singular}: #{singular}} %>"
+    elsif modify_as[:none]
+        field_view_output
+      # res += "<%= render partial: #{singular}.#{name}, locals: {#{singular}: #{singular}} %>"
     end
 
-    if modify_as[:badges]
-      badge_code = if modify_as[:binary]
-                     "#{singular}.#{name} ? '#{modify_as[:badges].split("|")[0]}' : '#{modify_as[:badges].split("|")[1]}'"
-                   else
-                     modify_as[:badges].split("|").to_s + "[#{singular}.#{name}]"
-                   end
-      res = "<span class='badge <%= #{badge_code} %>'>" + res + "</span>"
-    end
-    # byebug
 
+    # if modify_as[:badges]
+    #   badge_code = if modify_as[:binary]
+    #                  "#{singular}.#{name} ? '#{modify_as[:badges].split("|")[0]}' : '#{modify_as[:badges].split("|")[1]}'"
+    #                else
+    #                  modify_as[:badges].split("|").to_s + "[#{singular}.#{name}]"
+    #                end
+    #   res = "<span class='badge <%= #{badge_code} %>'>" + res + "</span>"
+    # end
+    # byebug
     res
   end
 

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

@@ -150,7 +150,7 @@ module  HotGlue
               elsif update_show_only.include?(col) && @pundit && eval("defined? #{singular_class}Policy") && eval("#{singular_class}Policy").instance_methods.include?("#{col}_able?".to_sym)
                 "<% if @action == 'new' && policy(@#{singular}).#{col}_able? %>" + columns_map[col].form_field_output + "<% else %>" + columns_map[col].form_show_only_output + "<% end %>"
 
-                             # show only on the update action overrides any pundit policy
+                 # show only on the update action overrides any pundit policy
             elsif @pundit && eval("defined? #{singular_class}Policy") && eval("#{singular_class}Policy").instance_methods.include?("#{col}_able?".to_sym)
               "<% if policy(@#{singular}).#{col}_able? %>" + columns_map[col].form_field_output + "<% else %>" + columns_map[col].form_show_only_output  + "<% end %>"
             else

data/lib/generators/hot_glue/scaffold_generator.rb

@@ -16,7 +16,9 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
   hook_for :form_builder, :as => :scaffold
 
   source_root File.expand_path('templates', __dir__)
-  attr_accessor :attachments, :auth, :big_edit, :button_icons, :bootstrap_column_width, :columns,
+  attr_accessor :alt_lookups, :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,
@@ -260,6 +262,8 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
           @modify_as[key.to_sym] =  {typeahead: 1, badges: $3}
         elsif $2 == "timezone"
           @modify_as[key.to_sym] =  {timezone: 1, badges: $3}
+        elsif $2 == "none"
+          @modify_as[key.to_sym] =  {none: 1, badges: $3}
         else
           raise "unknown modification direction #{$2}"
         end
@@ -466,6 +470,30 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
     buttons_width = ((!@no_edit && 1) || 0) + ((!@no_delete && 1) || 0) + @magic_buttons.count
 
 
+    # alt_lookups_entry =
+
+
+    @alt_lookups = {}
+
+    options['alt_foreign_key_lookup'].split(",").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
+
 
 
     # build a new polymorphic object
@@ -554,6 +582,15 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
     @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
 
 
@@ -612,6 +649,10 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
         end
 
         hawk_scope = key.gsub("_id", "").pluralize
+        if eval(singular_class + ".reflect_on_association(:#{key.gsub('_id', '')})").nil?
+          raise "Could not find `#{key.gsub('_id', '')}` association; add this to the #{singular_class} class: \nbelongs_to :#{key.gsub('_id', '')} "
+        end
+
         optional = eval(singular_class + ".reflect_on_association(:#{key.gsub('_id', '')})").options[:optional]
 
         @hawk_keys[key.to_sym] = { bind_to: [hawk_to], optional: optional }
@@ -1253,9 +1294,10 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
   def insert_into_nav_template
     # how does this get called(?)
     nav_file = "#{Rails.root}/app/views/#{namespace_with_trailing_dash}_nav.html.#{@markup}"
-    if include_nav_template && @nested_set.none?
+
+    if include_nav_template
       append_text = "  <li class='nav-item'>
-    <%= link_to '#{@list_label_heading}', #{path_helper_plural}, class: \"nav-link \#{'active' if nav == '#{plural_name}'}\" %>
+    <%= link_to '#{@list_label_heading.humanize}', #{path_helper_plural(@nested_set.any? ? true: false)}, class: \"nav-link \#{'active' if nav == '#{plural_name}'}\" %>
   </li>"
 
       text = File.read(nav_file)

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

@@ -226,7 +226,7 @@ class <%= controller_class_name %> < <%= controller_descends_from %>
   end<% end %><% end %>
 
   def <%=singular_name%>_params
-    params.require(:<%= testing_name %>).permit(<%= ((fields_filtered_for_strong_params - @show_only ) + @magic_buttons.collect{|x| "__#{x}"}).collect{|sym| ":#{sym}"}.join(", ") %><%= ", " + @related_sets.collect{|key, rs| "#{rs[:association_ids_method]}: []"}.join(", ") if @related_sets.any? %>)
+    params.require(:<%= testing_name %>).permit(<%= ((fields_filtered_for_strong_params - @show_only ) + @magic_buttons.collect{|x| "__#{x}"}).collect{|sym| ":#{sym}"}.join(", ") %><%= ", " + @related_sets.collect{|key, rs| "#{rs[:association_ids_method]}: []"}.join(", ") if @related_sets.any? %><%= ", " +  @alt_lookups.collect{|k,v|  ":__lookup_#{v[:lookup_as]}"  }.join(", ") if @alt_lookups.any? %>)
   end<% if @update_show_only %>
 
   <% unless @no_edit %>

data/lib/hotglue/version.rb

@@ -1,5 +1,5 @@
 module HotGlue
   class Version
-    CURRENT = '0.6.7'
+    CURRENT = '0.6.8'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hot-glue
 version: !ruby/object:Gem::Version
-  version: 0.6.7
+  version: 0.6.8
 platform: ruby
 authors:
 - Jason Fleetwood-Boldt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-26 00:00:00.000000000 Z
+date: 2024-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -59,7 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".circleci/DISABLED__config.yml"
 - ".github/FUNDING.yml"
 - ".github/workflows/test_suite.yml"
 - ".gitignore"