hot-glue 0.5.15 → 0.5.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a4b8f9da30750e8df7e69820c0bd934c0f8b16080bb21f5e5412d49c773dd28
-  data.tar.gz: 66b8fa328ca3f96f12e13c7df2f6006a730ff635078dd7e109d0d42467985502
+  metadata.gz: b466a03ce8d764332b3f3d8673bc29b6071308cb976706632a70713b6efb53b4
+  data.tar.gz: 03f8580d7266c767b1bed6a1e325c515bc09a5d9886356250ed9a4d936bab452
 SHA512:
-  metadata.gz: 45e3e6d56cf8125b67383f68985888a8d131cf2a68643d41e1015f3298b7a0175ff6752a790daed42db151f59b36f567e53b1f293240f393a64498730ee123bd
-  data.tar.gz: 82c3d1439c5333da6f0427994de3d962a0767453432cc1edd25b7df27532c4e264b033421eb2ff8a3bb2885a1882d6495f58141eceafc3ac04848dda4f240f63
+  metadata.gz: 3e0b66aa6cbab6a813a810f6bee04503c0f7437f53dc2a7a2f27aadad8b09a559a1d540f7c6ce850c5a25f641ab847edeb6c5b26fc83c6b6728bb52278bbc3bb
+  data.tar.gz: 5bcc706e9ad0a620c33a5815fc5160fe7afef6b9468d1d920032d1daffbfc3bc304816dc661d1c359b1002fdc854d1757869844e7afe1efa2f0eb021df408827

data/.github/workflows/test.yml

@@ -25,7 +25,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
         with:
           # Not needed with a .ruby-version file
           # runs 'bundle install' and caches installed gems automatically

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hot-glue (0.5.14)
+    hot-glue (0.5.16)
       ffaker (~> 2.16)
       kaminari (~> 1.2)
       rails (> 5.1)
@@ -139,7 +139,7 @@ GEM
     mini_mime (1.1.2)
     mini_portile2 (2.8.4)
     minitest (5.16.3)
-    net-imap (0.3.4)
+    net-imap (0.3.7)
       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.3.2)
+    timeout (0.4.0)
     turbo-rails (1.3.2)
       actionpack (>= 6.0.0)
       activejob (>= 6.0.0)
@@ -245,7 +245,7 @@ GEM
     warden (1.2.9)
       rack (>= 2.0.9)
     websocket (1.2.9)
-    websocket-driver (0.7.5)
+    websocket-driver (0.7.6)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
     xpath (3.2.0)

data/README.md

@@ -605,9 +605,7 @@ With Hot Glue in specified grouping or smart layout mode, it automatically attem
 
 Using Bootstrap with neither specified grouping nor smart layouts may make more than 12 columns, which will produce strange results. (Bootstrap is not designed to work with, for example, a 13-column layout.)
 
-You should typically either specify your grouping or use smart layouts when building with Bootstrap, but if your use case does not fit the stacking feature you can specify neither flag and then you may then have to deal with the over-stuffed layouts as explained. 
-
-
+You should typically either specify your grouping or use smart layouts when building with Bootstrap, but if your use case does not fit the stacking feature you can specify neither flag and then you may then have to deal with the over-stuffed layouts as explained.
 
 ### `--smart-layout` (also known as automatic grouping)
 
@@ -656,6 +654,39 @@ IMPORTANT: By default, all fields that begin with an underscore (`_`) are automa
 
 This is for fields you want globally non-editable by users in your app. For example, a counter cache or other field set only by a backend mechanism.
 
+### `--modify=field1{...},field2{...}`
+
+
+You can apply modification to the viewable (non-edit) display of field using the `--modify` switch.
+
+The syntax is `--modify=cost{$},price{$}`
+
+Here, the `cost` and `price` fields will be displayed as wrapped in `number_to_currency()` when displayed on the list view and when displayed as show-only.
+
+You can also use a binary modifier, which can apply to booleans, datetimes, times, dates or anything else. When using the binary modify, a specific value is displayed if the field is truthy and another one is display if the field is falsy.
+You specify it using a pipe | character like so:
+
+`--modify=paid_at{paid|unpaid}`
+
+here, even though `paid_at` is a datetime field, it will display as-if it is a binary -- showing either the truthy 
+label or the falsy label depending on if `paid_at` is or is not null in the database.  
+For all fields except booleans, this affects only the viewable output — 
+what you see on the list page and on the edit page for show-only fields.  
+For booleans, it affects those outputs as well as the normal edit output: 
+The labels you specify are used as the labels for the radio buttons that the user can select.
+
+
+You will need to separately specify them as show-only if you want them to be non-editable.
+
+The available modifiers are:
+
+| modifier                  | what it does                                                                                                                                                         | can be used on                |   |   |
+|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|---|---|
+| $                         | wraps output in `number_to_currency()`                                                                                                                               | float, integer                |   |   |
+| truthy label\|falsy label | specify a binary switch with a pipe (\|) character if the value is truthy, it will display as "truthy label" if the value is falsy, it will display as "falsy label" | boolean, datetime, date, time |   |   |
+|                           |                                                                                                                                                                      |                               |   |   |
+
+
 
 ### `--update-show-only`
 (separate field names by COMMA)
@@ -1147,7 +1178,29 @@ Always:
 
 Don't include this last line in your factory code. 
 
+## Nav Templates
+At the namespace level, you can have a file called `_nav.html.erb` to create tabbed bootstrap nav (you'll need to create this file manually).
+
+To create the default template, start by running
+```
+bin/rails generate hot_glue:nav_template --namespace=xyz
+
+```
+this will append the file `_nav.html.erb` to the views folder at `views/xyz`
+
+```
+<ul class='nav nav-tabs'>
+</ul>
+```
+
+Once the file is present, any further builds in this namespace will:
 
+1) Append to the `_nav.html.erb` file, adding a tab for the new built scaffold
+2) Add render to the list view of the built scaffold to include the partial:
+```
+<%= render partial: "owner/nav", locals: {nav: "things"} %>
+```
+(in this example `owner/` is the namespace and `things` is the name of the scaffold being built)
 
 ## Automatic Base Controller
 
@@ -1253,6 +1306,41 @@ end
 
 # VERSION HISTORY
 
+#### 2023-08-18 - v0.5.17
+
+• Nav templates (`_nav.html.erb`) are now automatically appended to if they exist. Remember nav template live in the views folder at the root of the *namespace*, which is one folder up from whatever folder is being built.
+If a file exists `_nav.html.erb`, it will get appnded to with content like this:
+
+```
+<li class="nav-item">
+    <%= link_to "Domains", domains_path, class: "nav-link #{'active' if nav == 'domains'}" %>
+  </li>
+```
+
+This append to the `_nav.html.erb` template happens in addition to the partial itself being included from the layout.
+(Also only if it exists, so be sure create it before running the scaffold generators for the namespace. Of course, you only need to create it once for each namespace)
+
+• To create a new `_nav.html.erb` template use
+
+```
+bin/rails generate hot_glue:nav_template --namespace=xyz
+```
+
+Here, you give only the namespace. It will create an empty nav template:
+```
+<ul class='nav nav-tabs'>
+</ul>
+```
+
+• Fixes to specs for datetimes
+
+• Fixes way the flash notices where created that violated frozen string literal
+
+
+#### 2023-08-17 - v0.5.16
+
+- Adds `--modidy` flag to turn numbers into currency and apply binary labels (see docs for `--modify` flag)
+
 #### 2023-08-11 - v0.5.15
 
 - When using big edit, updating a child will now re-render the parent EDIT record automatically.
@@ -1263,7 +1351,6 @@ For example
 
 Whenever the line item is created, updated, or destroyed, the parent invoice record gets (edit action) re-rendered automatically. This happens for the big edit screen of the invoice.
 
-
 - Refactors fields into polymoric objects
 
 - Adds test coverage for Postgres Enums

data/lib/generators/hot_glue/field_factory.rb

@@ -57,6 +57,7 @@ class FieldFactory
                              singular: generator.singular,
                              update_show_only: generator.update_show_only,
                              attachment_data: generator.attachments[name.to_sym],
-                             sample_file_path: generator.sample_file_path)
+                             sample_file_path: generator.sample_file_path,
+                             modify: generator.modify[name.to_sym] || nil )
   end
 end

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

@@ -8,7 +8,7 @@ class AssociationField < Field
   def initialize(name: , class_name: , alt_lookups: , singular: , update_show_only: ,
                  hawk_keys: , auth: , sample_file_path:,  ownership_field: ,
                  attachment_data: nil , layout_strategy: , form_placeholder_labels: nil,
-                 form_labels_position: )
+                 form_labels_position:, modify:  )
     super
 
     @assoc_model = eval("#{class_name}.reflect_on_association(:#{assoc})")

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

@@ -2,7 +2,7 @@ class AttachmentField < Field
   attr_accessor :attachment_data
   def initialize(name:, class_name:, alt_lookups:, singular:, update_show_only:, hawk_keys:, auth:,
                  sample_file_path: nil, attachment_data:, ownership_field:, layout_strategy: ,
-                 form_placeholder_labels: , form_labels_position:)
+                 form_placeholder_labels: , form_labels_position:, modify: )
     super
 
     @attachment_data = attachment_data

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

@@ -13,27 +13,36 @@ class BooleanField < Field
   end
 
   def spec_list_view_assertion
-    "      " + ["expect(page).to have_content(#{singular}#{1}.#{name} ? 'YES' : 'NO')"].join("\n      ")
+    ["expect(page).to have_content(#{singular}#{1}.#{name} ? 'YES' : 'NO')"].join("\n      ")
   end
   
   
   def form_field_output
     (form_labels_position == 'before' ?  " <br />"  : "") +
       "  <%= f.radio_button(:#{name},  '0', checked: #{singular}.#{name}  ? '' : 'checked') %>\n" +
-      "  <%= f.label(:#{name}, value: 'No', for: '#{singular}_#{name}_0') %>\n" +
-      "  <%= f.radio_button(:#{name}, '1',  checked: #{singular}.#{name}  ? 'checked' : '') %>\n" +
-      "  <%= f.label(:#{name}, value: 'Yes', for: '#{singular}_#{name}_1') %>\n" +
+      "  <%= f.label(:#{name}, value: '#{modify_binary? && modify[:binary][:falsy] || 'No'}', for: '#{singular}_#{name}_0') %>\n" +
+      " <br /> <%= f.radio_button(:#{name}, '1',  checked: #{singular}.#{name}  ? 'checked' : '') %>\n" +
+      "  <%= f.label(:#{name}, value: '#{modify_binary? && modify[:binary][:truthy] || 'Yes'}', for: '#{singular}_#{name}_1') %>\n" +
       (form_labels_position == 'after' ?  " <br />"  : "")
   end
 
   def line_field_output
-    "
-    <% if #{singular}.#{name}.nil? %>
+    if modify_binary?
+      "<% if #{singular}.#{name}.nil? %>
+        <span class='alert-danger'>MISSING</span>
+    <% elsif #{singular}.#{name} %>
+      #{modify[:binary][:truthy]}
+    <% else %>
+      #{modify[:binary][:falsy]}
+    <% end %>"
+    else
+      "<% if #{singular}.#{name}.nil? %>
         <span class='alert-danger'>MISSING</span>
     <% elsif #{singular}.#{name} %>
       YES
     <% else %>
       NO
     <% end %>"
+    end
   end
 end

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

@@ -10,7 +10,11 @@ class DateTimeField < Field
   end
 
   def spec_make_assertion
-    "expect(page).to have_content(new_#{name}.in_time_zone(current_timezone).strftime('%m/%d/%Y @ %l:%M %p ') + timezonize(current_timezone))"
+    if !modify_binary?
+      "expect(page).to have_content(new_#{name}.in_time_zone(current_timezone).strftime('%m/%d/%Y @ %l:%M %p ') + timezonize(current_timezone))"
+    else
+      "expect(page).to have_content('#{modify[:binary][:truthy]}'"
+    end
   end
 
   def spec_setup_let_arg
@@ -18,7 +22,15 @@ class DateTimeField < Field
   end
 
   def spec_list_view_assertion
-    "expect(page).to have_content(#{singular}#{1}.#{name}.in_time_zone(current_timezone).strftime('%m/%d/%Y @ %l:%M %p ').gsub(' ', ' ') + timezonize(current_timezone) )"
+    if modify_binary?
+      "expect(page).to have_content('#{modify[:binary][:truthy]}')"
+    else
+      spec_list_view_natural_assertion
+    end
+  end
+
+  def spec_list_view_natural_assertion
+    "expect(page).to have_content(#{singular}#{1}.#{name}.in_time_zone(current_timezone).strftime('%m/%d/%Y @ %l:%M %p ').gsub('  ', ' ') + timezonize(current_timezone) )"
   end
 
   def form_field_output
@@ -26,10 +38,14 @@ class DateTimeField < Field
   end
 
   def line_field_output
-    "<% unless #{singular}.#{name}.nil? %>
+    if modify_binary?
+      modified_display_output
+    else
+      "<% unless #{singular}.#{name}.nil? %>
   <%= #{singular}.#{name}.in_time_zone(current_timezone).strftime('%m/%d/%Y @ %l:%M %p ') + timezonize(current_timezone) %>
   <% else %>
   <span class='alert-danger'>MISSING</span>
   <% end %>"
+    end
   end
 end

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

@@ -1,16 +1,26 @@
 class Field
-  attr_accessor :name, :object, :singular_class, :class_name, :singular,
+  attr_accessor :assoc_model, :assoc_name, :assoc_class, :associations, :alt_lookups, :auth,
+                :assoc_label,  :class_name,  :form_placeholder_labels, :form_labels_position,
+                :hawk_keys,   :layout_strategy, :limit, :modify, :name, :object, :sample_file_path,
+                :singular_class,  :singular, :sql_type, :ownership_field,
                 :update_show_only
-  attr_accessor :assoc_model, :assoc_name, :assoc_class, :associations, :alt_lookups, :assoc_label
-
-  attr_accessor :hawk_keys, :auth, :sample_file_path, :form_placeholder_labels, :ownership_field,
-                :sql_type, :limit, :layout_strategy, :form_labels_position
-
-  def initialize(name: , class_name: , alt_lookups: , singular: , update_show_only: , form_labels_position:,
-                  form_placeholder_labels: ,
-                 auth: , ownership_field: , hawk_keys: nil, layout_strategy:  ,
-                 sample_file_path: nil, attachment_data: nil  )
 
+  def initialize(
+    auth: ,
+    alt_lookups: ,
+    attachment_data: nil,
+    class_name: ,
+    form_labels_position:,
+    form_placeholder_labels: ,
+    hawk_keys: nil,
+    layout_strategy:  ,
+    modify: ,
+    name: ,
+    ownership_field: ,
+    sample_file_path: nil,
+    singular: ,
+    update_show_only:
+  )
     @name = name
     @layout_strategy = layout_strategy
     @alt_lookups = alt_lookups
@@ -23,7 +33,7 @@ class Field
     @form_placeholder_labels = form_placeholder_labels
     @ownership_field = ownership_field
     @form_labels_position = form_labels_position
-
+    @modify = modify
 
     # TODO: remove knowledge of subclasses from Field
     unless self.class == AttachmentField
@@ -52,28 +62,59 @@ class Field
     ""
   end
 
+
   def spec_make_assertion
-    "expect(page).to have_content(new_#{name})"
+    if !modify_binary?
+      "expect(page).to have_content(new_#{name})"
+    else
+      "expect(page).to have_content('#{modify[:binary][:truthy]}'"
+    end
   end
 
+
   def spec_setup_let_arg
 
   end
 
-  def spec_list_view_assertion
+  def spec_list_view_natural_assertion
     "expect(page).to have_content(#{singular}#{1}.#{name})"
   end
 
+  def spec_list_view_assertion
+    if modify_binary?
+      "expect(page).to have_content('#{modify[:binary][:truthy]}'"
+    else
+      spec_list_view_natural_assertion
+    end
+  end
+
+
   def spec_related_column_lets
     ""
   end
 
+  def line_field_output
+    viewable_output
+  end
+
   def form_show_only_output
-    "<%= #{singular}.#{name} %>"
+    viewable_output
   end
 
-  def line_field_output
-    "<%= #{singular}.#{name} %>"
+  def viewable_output
+    if modify
+      modified_display_output
+    else
+      "<%= #{singular}.#{name} %>"
+    end
+  end
+
+  def modified_display_output
+    if  modify[:cast] && modify[:cast] == "$"
+      "<%= number_to_currency(#{singular}.#{name}) %>"
+    elsif modify[:binary]
+      "<%= #{singular}.#{name} ? '#{modify[:binary][:truthy]}' : '#{modify[:binary][:falsy]}' %>"
+    end
   end
 
   def field_output(type = nil, width )
@@ -85,7 +126,10 @@ class Field
     if lines > 5
       lines = 5
     end
-
     "<%= f.text_area :#{name}, class: 'form-control', autocomplete: 'off', cols: 40, rows: '#{lines}'"  + ( form_placeholder_labels ? ", placeholder: '#{name.to_s.humanize}'" : "") + " %>"
   end
+
+  def modify_binary? # safe
+    !!(modify && modify[:binary])
+  end
 end

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

@@ -5,6 +5,7 @@ class FloatField < Field
 
   end
 
+
   def spec_setup_let_arg
     "#{name}: rand(1)*10000"
   end
@@ -13,8 +14,9 @@ class FloatField < Field
     field_output(nil, 5)
   end
 
-  def line_field_output
-    width = (limit && limit < 40) ? limit : (40)
-    "<%= #{singular}.#{name}%>"
-  end
+  # def line_field_output
+  #   width = (limit && limit < 40) ? limit : (40)
+  #
+  #   "<%= #{singular}.#{name} %>"
+  # end
 end

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

@@ -5,7 +5,7 @@ class UUIDField < AssociationField
 
   def spec_list_view_assertion
     assoc_name = name.to_s.gsub('_id','')
-    association = eval("#{singular_class}.reflect_on_association(:#{assoc_name})")
+    association = eval("#{class_name}.reflect_on_association(:#{assoc_name})")
     "expect(page).to have_content(#{singular}#{1}.#{assoc_name}.#{HotGlue.derrive_reference_name(association.class_name)})"
   end
 end

data/lib/generators/hot_glue/layout/builder.rb

@@ -16,6 +16,7 @@ module HotGlue
 
         @generator = generator
 
+        @modify = generator.modify
         @columns = generator.columns
         @smart_layout = generator.smart_layout
         @stacked_downnesting = generator.stacked_downnesting || false
@@ -39,7 +40,8 @@ module HotGlue
           portals:  {
 
           },
-          buttons: { size: @buttons_width}
+          buttons: { size: @buttons_width},
+          modify: @modify
         }
 
         # downnest_object.each do |child, size|
@@ -68,7 +70,7 @@ module HotGlue
           raise "Cannot build layout -- too few columns"
         end
 
-        # smart layout: bootstrap_column_width columns per field; 4 column for EACH downnested portals, 2 column for buttons
+        # smart layout: bootstrap_column_width columns per field; 4 column for EACH downnested portal, 2 column for buttons
         if smart_layout
           # automatic control
           #

data/lib/generators/hot_glue/nav_template_generator.rb

@@ -0,0 +1,22 @@
+module HotGlue
+  class NavTemplateGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+    class_option :namespace, type: :string, default: nil
+
+    def filepath_prefix
+      # todo: inject the context
+      'spec/dummy/' if $INTERNAL_SPECS
+    end
+
+
+    def initialize(*args) #:nodoc:
+      super
+      @namespace = options['namespace']
+      copy_file "erb/_nav.html.erb", "#{'spec/dummy/' if $INTERNAL_SPECS}app/views/#{@namespace ? @namespace + "/" : ""}_nav.html.erb"
+
+    end
+  end
+end
+
+
+