hot-glue 0.5.22 → 0.5.23.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2d92541aa687117c64a4a52b034f9103f06f95ae7996bcbd1cf7f71f986ec34
-  data.tar.gz: 751619956a66052dc837b4f13ab85cbe3fe655b60c8ad820150b7e21f3737696
+  metadata.gz: bdb39b06854037640b63ad674ce2785fcdbb5ea7947b9bf62483b8bc81f24aed
+  data.tar.gz: d64d081e67e29d893849950568ba70bbdaccb057da5d2ade725ea26e74040664
 SHA512:
-  metadata.gz: f5c4dfb35d0a673cc6f8b8a4b3833feafa7fca86a0e07d616b825c11c3c132af98fde4ec4a73ef9538f9f74a0982f38c2fceb562c1ca43f72764ad7d604bb864
-  data.tar.gz: f520ab73bebb9597e5cc4cc3651e4ef45641641157f99353c79abf7004cf9340b59d8222e2a1462d51b269bfef62e3c725732c962d21185bfc0f62f87dcc5a51
+  metadata.gz: f09eb212dc5f40325cccb88273088e3fd8ab096fbccf42f4c99d4bb9fb8964efde375be68e9b927fadd5b077d846d8b208b149030b93cabe4348d76a0ad4758d
+  data.tar.gz: 2dc1598871b44d6199011e2b36e6ed8c88c4a2564c249e363130cda931dfb5cef5c4900dade36182ec68216da12ca52f51b941db02056c2ee6d9abb8e68bacf8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hot-glue (0.5.22)
+    hot-glue (0.5.23.1)
       ffaker (~> 2.16)
       kaminari (~> 1.2)
       rails (> 5.1)
@@ -146,7 +146,7 @@ GEM
       net-protocol
     net-protocol (0.2.1)
       timeout
-    net-smtp (0.3.3)
+    net-smtp (0.4.0)
       net-protocol
     nio4r (2.5.8)
     nokogiri (1.13.9)

data/README.md

@@ -1404,6 +1404,54 @@ end
 
 # VERSION HISTORY
 
+#### 2023-10-01 - v0.5.23
+
+- You can now use the modify flag on enum type fields to display a partial with the same name of that enum type.
+
+`--modify=status{partials}`
+
+Here, `status` is an enum field on your table; you must use the exact string `partials` when using this feature.
+
+You're telling Hot Glue to build scaffold that will display the `status` enum field as a partial. 
+
+It will look for a partial in the same build directory, whose name matches to the value of the enum. You will need to create a partial _for each enum option_ that you have defined.
+
+Remember when defining enums Rails will patch methods on your objects with the name of the enum types, so you must avoid namespace collisions with existing Ruby or Rails methods that are common to all objects -- like, for example, `new`.
+
+- Before this feature, enums always rendered like this on the show page:
+`<%= domain.status %>`
+(or, if you use custom labels:)
+`<%= Domain.status_labels(domain.status)`
+
+- After, you if you use the `--modify` flag and modify the enum to 'partials', your show output will render:
+```
+<%= render partial: thing.status, locals: {thing: thing} %>
+```
+(In this example `Thing` is the name of the model being built.)
+
+Your form will also render the partial, but after the collection_select used to create the drop-down.
+(This implementation has the draw-back that there is no immediate switch between the partials when changing the drop-down)
+
+Assuming your Thing enum is defined like so:
+```
+enum :status {abc: 'abc', dfg: 'dfg', hgk: 'hgk'}
+```
+
+You then would create three partials in the `things` directory. Make sure to create a partial for each defined enum, or else your app will crash when it tries to render a record with that enum.
+```
+_abc.html.erb
+_dfg.html.erb
+_hgk.html.erb
+```
+
+If your enum is on the show-only list, then the drop-down does not appear (but the partial is rendered).
+
+Proof-of-concept can be found here:
+https://github.com/hot-glue-for-rails/HGEnumWithPartials1
+
+Remember to see the section marked 'A Note About Enums' for more about working with Rails 7 enums.
+
+
 #### 2023-09-20- v0.5.22
 - adds back magic button tap-away params in the controller
 - changes creation of flash[:notice] in update method

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

@@ -1,7 +1,7 @@
 class EnumField < Field
   def spec_setup_and_change_act(which_partial = nil)
     # what is the enum name
-    "      list_of_#{enum_type} = #{class_name}.defined_enums['#{enum_type}'].keys \n" +
+    "      list_of_#{enum_type} = #{class_name}.defined_enums['#{name}'].keys \n" +
       "      " + "new_#{name} = list_of_#{enum_type}[rand(list_of_#{enum_type}.length)].to_s \n" +
       '      find("select[name=\'' + singular + '[' + name + ']\']  option[value=\'#{new_' + name + '}\']").select_option'
   end
@@ -32,13 +32,19 @@ class EnumField < Field
 
   def form_field_output
     enum_type = eval("#{class_name}.columns.select{|x| x.name == '#{name}'}[0].sql_type")
-
     if eval("defined? #{class_name}.#{enum_type}_labels") == "method"
       enum_definer = "#{class_name}.#{enum_type}_labels"
     else
-      enum_definer = "#{class_name}.defined_enums['#{enum_type}']"
+      enum_definer = "#{class_name}.defined_enums['#{name}']"
+    end
+
+    res = "<%= f.collection_select(:#{name},  enum_to_collection_select(#{enum_definer}), :key, :value, {selected: #{singular}.#{name} }, class: 'form-control') %>"
+
+
+    if modify && modify[:enum] == :partials
+      res << partial_render
     end
-    return "<%= f.collection_select(:#{name},  enum_to_collection_select(#{enum_definer}), :key, :value, {selected: #{singular}.#{name} }, class: 'form-control') %>"
+    res
   end
 
   def line_field_output
@@ -47,14 +53,30 @@ class EnumField < Field
     if eval("defined? #{class_name}.#{enum_type}_labels") == "method"
       enum_definer = "#{class_name}.#{enum_type}_labels"
     else
-      enum_definer = "#{class_name}.defined_enums['#{enum_type}']"
+      enum_definer = "#{class_name}.defined_enums['#{name}']"
     end
-    "
+
+    res = "
     <% if #{singular}.#{name}.nil? %>
-        <span class='alert-danger'>MISSING</span>
-    <% else %>
-      <%=  #{enum_definer}[#{singular}.#{name}.to_sym] %>
-    <% end %>
-"
+        <span class='alert-danger'>Missing #{name}</span>
+    <% else %>"
+
+    if modify && modify[:enum] == :partials
+      res << partial_render
+    else
+      res << "<%=  #{enum_definer}[#{singular}.#{name}.to_sym] %>"
+    end
+
+    res << "<% end %>"
+    res
+  end
+
+  def partial_render
+    "<% if #{singular}.#{name} %><%=  render partial: #{singular}.#{name}, locals: { #{singular}: #{singular} } %><% end %>"
+  end
+
+
+  def form_show_only_output
+    viewable_output
   end
 end

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

@@ -119,6 +119,8 @@ class Field
       "<%= number_to_currency(#{singular}.#{name}) %>"
     elsif modify[:binary]
       "<%= #{singular}.#{name} ? '#{modify[:binary][:truthy]}' : '#{modify[:binary][:falsy]}' %>"
+    elsif modify[:enum]
+      "<%= render partial: #{singular}.#{name}, locals: {#{singular}: #{singular}} %>"
     end
   end
 

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

@@ -97,18 +97,17 @@ module  HotGlue
               elsif update_show_only.include?(col) && !@pundit
                 "<% if action_name == 'edit' %>" + columns_map[col].form_show_only_output + "<% else %>" + columns_map[col].form_field_output + "<% end %>"
               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_name == 'create' && policy(@#{singular}).#{col}_able? %>" + columns_map[col].form_show_only_output + "<% else %>" + columns_map[col].form_field_output + "<% end %>"
+                "<% if action_name == '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
             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
               columns_map[col].form_field_output
-                           end
-
+            end
             add_spaces_each_line( "\n  <span class='<%= \"alert-danger\" if #{singular}.errors.details.keys.include?(:#{field_error_name}) %>'  #{'style="display: inherit;"'}  >\n" +
-                                    add_spaces_each_line( (form_labels_position == 'before' ? the_label : "") +
-                                                        +  field_result +
+                                    add_spaces_each_line( (form_labels_position == 'before' ? the_label || "" : "") +
+                                                        +  " <br />\n" + field_result +
                                         (form_labels_position == 'after' ? the_label : "")   , 4) +
                                     "\n  </span>\n  <br />", 2)
 

data/lib/generators/hot_glue/scaffold_generator.rb

@@ -206,6 +206,7 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
 
     @modify = {}
     if !options['modify'].empty?
+
       modify_input = options['modify'].split(",")
       modify_input.each do |setting|
         setting =~ /(.*){(.*)}/
@@ -216,6 +217,11 @@ class HotGlue::ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
         elsif $2.include?("|")
           binary = $2.split("|")
           @modify[key.to_sym] =  {binary: {truthy: binary[0], falsy: binary[1]}}
+        elsif $2 == "partial"
+          @modify[key.to_sym] =  {enum: :partials}
+
+        else
+          raise "unknown modification direction #{$2}"
         end
       end
     end

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

@@ -142,7 +142,7 @@ class <%= controller_class_name %> < <%= controller_descends_from %>
   end
 
 <% end %><% if @build_update_action %>  def update
-    flash[:notice] = ""
+    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"

data/lib/hotglue/version.rb

@@ -1,5 +1,5 @@
 module HotGlue
   class Version
-    CURRENT = '0.5.22'
+    CURRENT = '0.5.23.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hot-glue
 version: !ruby/object:Gem::Version
-  version: 0.5.22
+  version: 0.5.23.1
 platform: ruby
 authors:
 - Jason Fleetwood-Boldt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-20 00:00:00.000000000 Z
+date: 2023-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails