hot-glue 0.5.11 → 0.5.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfaa7e5a93bb7693f4f0bd452e3bd76463b30fe05145eadd5cb7e999dcdaf2a5
-  data.tar.gz: 908e35fb0d8657743c214773a11dccbdf8ee3312ee264b35538c1f4c262364f0
+  metadata.gz: c93b089a5dfd19941c88d9b330f0305dee83315bf7b8a6af436321dad842ac0b
+  data.tar.gz: cf17d5a487fdf1ae4230647923b42d344465bf1e81a06eb6eef0caa75282eb2c
 SHA512:
-  metadata.gz: 16ac78ed4e0dc3bb92d5aad3e47063e2907915c2ce4a9ede816c9835b52875c3b7598471ee9a63de10a04e6e4bcb1c00e86a9d751c0b0d570d93f2bad8a2ee0a
-  data.tar.gz: 968ef8a60a992ddb90906a0d2cf2a47df01d786fb4a040bad01bb89e1c0f8d0d0720f91035205d3ed35f11726e0c4d22db91f77b8ce97d5e3e1c799ae99bf929
+  metadata.gz: f9c6f8fdd02d3cd09e7c9e6a46a5a82c7125475b18f11fafa1cc3c609c4e7376c7c2cfcbc3a18483bd2027a69adfff859b62fa5d2405dabf371f4086247b240d
+  data.tar.gz: 51b3736cb2715e6387a13a98a4fe12bf450eee827679d80a6079d3b62546d31db234c4a818e03e801f07881ebd45da289b34b7c61dd5821d25db8084c8de6a61

data/.github/workflows/test.yml

@@ -2,7 +2,7 @@ name: Test
 on: [ push, pull_request ]
 
 jobs:
-  build:
+  internal_tests:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -12,4 +12,19 @@ jobs:
           # Not needed with a .ruby-version file
           # runs 'bundle install' and caches installed gems automatically
           bundler-cache: true
-      - run: script/test
+      - run: bundle install
+      - run: bundle exec rspec
+
+
+  system_tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          # Not needed with a .ruby-version file
+          # runs 'bundle install' and caches installed gems automatically
+          bundler-cache: true
+      - run: bundle install
+      - run: bundle exec script/test

data/README.md

@@ -750,6 +750,10 @@ end
 
 ```
 
+### `--button-icons` (default is no icons)
+You can specify this either as builder flag or as a config setting (in `config/hot_glue.yml`)
+Use `font-awesome` for Font Awesome or `none` for no icons.
+
 
 ### `--specs-only`
 
@@ -783,6 +787,8 @@ Omits delete button & destroy action.
 
 If you do not want inline editing of your list items but instead want to fall back to full page style behavior for your edit views, use `--big-edit`. Turbo still handles the page interactions, but the user is taken to a full-screen edit page instead of an edit-in-place interaction.
 
+When using `--big-edit`, any downnested portals will be displayed on the edit page instead of on the list page. 
+
 ### `--display-list-after-update`
 
 After an update-in-place normally only the edit view is swapped out for the show view of the record you just edited.
@@ -903,9 +909,6 @@ 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.
 
 
-
-
-
 ## Special Features
 
 ### `--attachments`
@@ -1121,9 +1124,29 @@ Thus, your factory object must have a method of the same name as the factory bei
 For example, assuming the example from above, we are going to do the lookup ourselves inside of our own `AgentFactory` object.)
 
 ```
-agent_factory = AgentFactory.new(find_or_create_by_email: agent_company_params[:__lookup_email])
+factory = AgentFactory.new(find_or_create_by_email: agent_company_params[:__lookup_email], 
+                            params: modified_params)
 ```
 
+Here the new AgentFactory will recieve any variables by keyword argument, and since you're specifying the calling code here, Hot Glue does not dictate your factory's setup.
+However, two special variables are in scope which you can use in your calling code.
+
+`*_params` (where * is the name of the thing you are building)
+`modified_params` a variable that has been transmogrified for the timezone aware input
+
+Either one must be recieved by your factory for your factory to create data based off the inputted data. 
+
+Rememebr, `*_params` has the input params passed only the through the sanitizer, and modified_params has it passed through the timezone aware mechanism and other Hot Glue-specific defaults.
+
+Always: 
+• In your factory calling code, assign the variable `factory = ` (do not use a different variable name),
+• Write a factory object with a `new` method that received the paramters you are specifying in your calling code,
+• Be sure your factory has an _instance method_ a method with the **same name** of the built object, which hot glue will call next: 
+
+`@agent = factory.agent`
+
+Don't include this last line in your factory code. 
+
 
 
 ## Automatic Base Controller
@@ -1206,10 +1229,60 @@ def self.status_labels
 
 Now, your labels will show up on the front-end as defined in the `_labels` ("Is currently pending", etc) instead of the database-values.
 
+### Validation Magic
+
+Use ActiveRecord validations or hooks to validate your data. Hot Glue will automatically display the errors in the UI.
+
+TO prevent a record from being destroyed, use a syntax like this:
+
+```
+before_destroy :check_if_allowed_to_destroy
+
+def check_if_allowed_to_destroy
+  if (some_condition)
+    self.errors.add(:base, "Cannot delete")
+    raise ActiveRecord::RecordNotDestroyed("Cannot delete because of some condition")
+  end
+end
+
+```
+
+
+
+
 
 # VERSION HISTORY
-#### 2023-04-19 - renamed previous version to v0.5.11
 
+#### TBR 
+- When using big edit, updating a child will now re-render the parent EDIT record automatically.
+
+For example
+`rails generate hot_glue:scafold LineItem --nested=invioce`
+
+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.
+
+#### 2023-05-14 - v0.5.14 Delete message flash notice and new flash notice partial
+
+- This changes to how flash_notices work.
+- After you upgrade to 0.5.14 from a prior version, please re-install the global flash notice
+- template with:
+
+`rails generate hot_glue:flash_notices_install` 
+
+The newer template will work with old Hot Glue scaffold (generated prior to 0.5.14) and new scaffold moving forward.
+
+If you miss this step, your old Hot Glue flash notices template will not show the model error messages (but will continue to show the global alert & notice messages)
+
+- The destroy action on controllers now produces an "alert" message for successful deletion.
+
+#### 2023-04-24 - v0.5.12
+- adds new option for `bootstrap_column_width` (default is 2) to specify the number of bootstrap columns a visual column should take up
+- You can specify this as a builder option (`--bootstrap-column-width`)
+or in your `config/hot_glue.yml` file. Passing option will override config setting
+- Adds new option for `button_icons` (default to "font-awesome"); use `none` to have no button icons
+- When using big edit with downnested portals, the downnested portals now display on the edit page instead of the list page.
+
+#### 2023-04-19 - renamed previous version to v0.5.11
 
 #### 2023-04-08 - v0.5.9.2
 • This begins a refactor of the field knowledge into properly abstracted Field objects
@@ -1218,8 +1291,6 @@ Now, your labels will show up on the front-end as defined in the `_labels` ("Is
 #### - v0.5.9.1
 • Fixed issue with ownership fields coming through as associations.
 
-
-
 #### 2023-03-17 - v0.5.9
 - Attachments! You can use Hot Glue to seamlessly create an image, file, or video attachment. Please see the docs in new flag `--atachments` under the "Special Features" section
 

data/lib/generators/hot_glue/default_config_loader.rb

@@ -0,0 +1,12 @@
+module DefaultConfigLoader
+
+
+  def default_configs
+    @yaml_from_config ||= YAML.load(File.read("config/hot_glue.yml"))
+  end
+
+
+  def  get_default_from_config(key: )
+    default_configs[key]
+  end
+end

data/lib/generators/hot_glue/field_factory.rb

@@ -45,6 +45,7 @@ class FieldFactory
             end
     @class_name = class_name
 
+
     @field = field_class.new(name: name,
                              hawk_keys: generator.hawk_keys,
                              auth: generator.auth,
@@ -52,6 +53,7 @@ class FieldFactory
                              alt_lookups: generator.alt_lookups,
                              singular: generator.singular,
                              update_show_only: generator.update_show_only,
+                             attachment_data: generator.attachments[name.to_sym],
                              sample_file_path: generator.sample_file_path)
   end
 end

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

@@ -4,7 +4,7 @@ require_relative './field.rb'
 class AssociationField < Field
 
   def initialize(name: , class_name: , alt_lookups: , singular: , update_show_only: ,
-                 hawk_keys: , auth: , sample_file_path: )
+                 hawk_keys: , auth: , sample_file_path:, attachment_data: nil )
     super
     assoc_model = eval("#{class_name}.reflect_on_association(:#{assoc})")
 

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

@@ -1,4 +1,11 @@
 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: )
+    super
+    @attachment_data = attachment_data
+  end
+
   def spec_setup_let_arg
     nil
   end
@@ -6,4 +13,24 @@ class AttachmentField < Field
   def spec_setup_and_change_act(which_partial = nil)
     "      attach_file(\"#{singular}[#{name.to_s}]\", \"#{sample_file_path}\")"
   end
+
+  def thumbnail
+    attachment_data[:thumbnail]
+  end
+
+  def form_field_output
+    direct = attachment_data[:direct_upload]
+    dropzone = attachment_data[:dropzone]
+    field_result = (thumbnail ?   "<%= #{singular}.#{name}.attached? ? image_tag(#{singular}.#{name}.variant(:#{thumbnail})) : '' %>" : "") +
+      "<br />\n" + (update_show_only.include?(name) ? "" : "<%= f.file_field :#{name} #{', direct_upload: true ' if direct}#{', "data-dropzone-target": "input"' if dropzone}%>")
+
+    if dropzone
+      field_result = "<div class=\"dropzone dropzone-default dz-clickable\" data-controller=\"dropzone\" data-dropzone-max-file-size=\"2\" data-dropzone-max-files=\"1\">\n  "+ field_result + "\n</div>"
+    end
+    return field_result
+  end
+
+  def field_error_name
+    name
+  end
 end

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

@@ -10,7 +10,8 @@ class DateTimeField < Field
   end
 
   def spec_make_assertion
-    super
+
+    "expect(page).to have_content(new_#{name}.in_time_zone(current_timezone).strftime('%m/%d/%Y @ %l:%M %p ') + timezonize(current_timezone))"
   end
 
   def spec_setup_let_arg
@@ -18,6 +19,6 @@ 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)  )"].join("\n      ")
+    "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
 end

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

@@ -19,9 +19,9 @@ class EnumField < Field
 
   def spec_list_view_assertion
     if(eval("#{singular_class}.respond_to?(:#{name}_labels)"))
-      "      " + "expect(page).to have_content(#{singular_class}.#{name}_labels[#{singular}#{1}.#{name}])"
+      "expect(page).to have_content(#{singular_class}.#{name}_labels[#{singular}#{1}.#{name}])"
     else
-      "      " + "expect(page).to have_content(#{singular}1.#{name})"
+      "expect(page).to have_content(#{singular}1.#{name})"
     end
   end
 end

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

@@ -6,7 +6,7 @@ class Field
   attr_accessor :hawk_keys, :auth, :sample_file_path
 
   def initialize(name: , class_name: , alt_lookups: , singular: , update_show_only: ,
-                 hawk_keys: , auth: , sample_file_path: nil)
+                 hawk_keys: , auth: , sample_file_path: nil, attachment_data: nil )
     @name = name
     @alt_lookups = alt_lookups
     @singular = singular
@@ -42,7 +42,7 @@ class Field
   end
 
   def spec_list_view_assertion
-    "      " + ["expect(page).to have_content(#{singular}#{1}.#{name})"].join("\n      ")
+    "expect(page).to have_content(#{singular}#{1}.#{name})"
   end
 
   def spec_related_column_lets

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

@@ -21,6 +21,6 @@ class IntegerField < Field
   end
 
   def spec_list_view_assertion
-    "      " + ["expect(page).to have_content(#{singular}#{1}.#{name})"].join("\n      ")
+    "expect(page).to have_content(#{singular}#{1}.#{name})"
   end
 end

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

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

data/lib/generators/hot_glue/flash_notices_install_generator.rb

@@ -0,0 +1,20 @@
+module HotGlue
+  class FlashNoticesInstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    def filepath_prefix
+      # todo: inject the context
+      'spec/dummy/' if Rails.env.test?
+    end
+
+
+    def initialize(*args) #:nodoc:
+      super
+      copy_file "erb/_flash_notices.erb", "#{'spec/dummy/' if Rails.env.test?}app/views/layouts/_flash_notices.erb"
+
+    end
+  end
+end
+
+
+

data/lib/generators/hot_glue/hot_glue.rb

@@ -0,0 +1,5 @@
+
+
+module HotGlue
+
+end

data/lib/generators/hot_glue/install_generator.rb

@@ -27,13 +27,8 @@ module HotGlue
       end
 
 
-      @markup = options['markup']
-      if @markup == "haml"
-        copy_file "haml/_flash_notices.haml", "#{'spec/dummy/' if Rails.env.test?}app/views/layouts/_flash_notices.haml"
-      elsif @markup == "erb"
-        copy_file "erb/_flash_notices.erb", "#{'spec/dummy/' if Rails.env.test?}app/views/layouts/_flash_notices.erb"
-
-      end
+      @markup = options['markup'] || "erb"
+      copy_file "erb/_flash_notices.erb", "#{'spec/dummy/' if Rails.env.test?}app/views/layouts/_flash_notices.erb"
 
       begin
         if Rails.version.split(".")[0].to_i == 6

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

@@ -6,29 +6,34 @@ module HotGlue
       attr_reader :include_setting,
                   :downnest_object,
                   :buttons_width, :columns,
-                  :smart_layout, :specified_grouping_mode, :stacked_downnesting
-
-      def initialize(include_setting: nil,
-                     downnest_object: nil,
-                     buttons_width: nil,
-                     smart_layout: nil,
-                     columns: nil,
-                     stacked_downnesting: false)
+                  :smart_layout, :specified_grouping_mode,
+                  :stacked_downnesting, :bootstrap_column_width
+
+      def initialize(generator: ,
+                     include_setting: ,
+                     buttons_width:    )
+
+
+        @generator = generator
+
+        @columns = generator.columns
+        @smart_layout = generator.smart_layout
+        @stacked_downnesting = generator.stacked_downnesting || false
+        @downnest_object = generator.downnest_object
+
         @include_setting = include_setting
-        @downnest_object = downnest_object
         @buttons_width = buttons_width
-        @columns = columns
-        @smart_layout = smart_layout
 
         @no_buttons = @buttons_width == 0
         @specified_grouping_mode = include_setting.include?(":")
-        @stacked_downnesting = stacked_downnesting
+        @bootstrap_column_width = generator.bootstrap_column_width
+        @big_edit = generator.big_edit
       end
 
       def construct
         layout_object = {
           columns: {
-            size_each: smart_layout ? 2 : (specified_grouping_mode ? nil : 1),
+            size_each: smart_layout ? bootstrap_column_width : (specified_grouping_mode ? nil : 1),
             container: [] # array of arrays
           },
           portals:  {
@@ -41,33 +46,29 @@ module HotGlue
         #   layout_object[:portals][child] = {size: size}
         # end
 
-        # smart layout: 2 columns per field; 4 column for EACH downnested portals, 2 column for buttons
-        how_many_downnest = downnest_object.size
-
         bootstrap_columns = (12 - @buttons_width )
 
-        if(!stacked_downnesting)
-          bootstrap_columns = bootstrap_columns - (downnest_object.collect{|k,v| v}.sum)
-        else
-          bootstrap_columns = bootstrap_columns - 4
-        end
+        unless @big_edit
+          # how_many_downnest = downnest_object.size
+          if(!stacked_downnesting)
+            bootstrap_columns = bootstrap_columns - (downnest_object.collect{|k,v| v}.sum)
+          else
+            bootstrap_columns = bootstrap_columns - 4
+          end
 
-        available_columns = (bootstrap_columns / 2).floor # bascially turns the 12-column grid into a 6-column grid
+          # downnest_children_width = []
+          downnest_object.each do |child, size|
+            layout_object[:portals][child] = {size:  size}
+          end
+        end
+        available_columns = (bootstrap_columns / bootstrap_column_width).floor
 
+        # when set to 2, turns the 12-column grid into a 6-column grid
         if available_columns < 0
-          raise "Cannot build layout with #{how_many_downnest} downnested portals"
-        end
-        #
-        # if !stacked_downnesting
-        #
-        # else
-        #
-        # end
-        downnest_children_width = []
-        downnest_object.each do |child, size|
-          layout_object[:portals][child] = {size:  size}
+          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
         if smart_layout
           # automatic control
           #
@@ -86,20 +87,20 @@ module HotGlue
 
           else
             layout_object[:columns][:container] = (0..available_columns-1).collect { |x|
-              [ columns[x]]
+              [ columns[x] ]
             }
             layout_object[:columns][:container] = (0..available_columns-1).collect { |x|  [columns[x]] }
             layout_object[:columns][:container].reject!{|x| x == [nil]}
-            layout_object[:columns][:size_each] = 2
+            layout_object[:columns][:size_each] = bootstrap_column_width
           end
         elsif ! specified_grouping_mode
           # not smart and no specified grouping
-          layout_object[:columns][:button_columns] = 2
+          layout_object[:columns][:button_columns] = bootstrap_column_width
 
           layout_object[:columns][:container] = columns.collect{|col| [col]}
 
         else # specified grouping mode -- the builder is given control
-          layout_object[:columns][:button_columns] = 2
+          layout_object[:columns][:button_columns] = bootstrap_column_width
 
           (0..available_columns-1).each do |int|
             layout_object[:columns][:container][int] = []
@@ -124,24 +125,6 @@ module HotGlue
           end
         end
 
-        # TODO: do I want this code that expands the downnest portal
-        # maybe refactor into a setting on the --downnest flag itself somehow
-        # if layout_object[:columns][:container].size < available_columns
-        #   available = available_columns - layout_object[:columns][:container].size
-        #   downnest_child_count = 0
-        #
-        #   while(available > 0)
-        #     if (downnest_child_count <= downnest_children.size-1)
-        #       layout_object[:portals][downnest_children[downnest_child_count]][:size] = layout_object[:portals][downnest_children[downnest_child_count]][:size]  + 2
-        #     else
-        #       # leave as-is
-        #     end
-        #     downnest_child_count = downnest_child_count + 1
-        #     available = available - 1
-        #   end
-        #   # give some space back to the downnest
-        # end
-
         puts "*** constructed smart layout columns #{layout_object.inspect}"
         layout_object
       end

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

@@ -8,20 +8,22 @@ module  HotGlue
                   :inline_list_labels, :layout_object,
                   :columns,  :col_identifier, :singular,
                   :form_placeholder_labels, :hawk_keys, :update_show_only,
-                  :alt_lookups, :attachments, :show_only
+                  :alt_lookups, :attachments, :show_only, :columns_map
 
 
-    def initialize(singular:, singular_class: ,
+      def initialize(singular:, singular_class: ,
                    layout_strategy: , magic_buttons: ,
                    small_buttons: , show_only: ,
                    ownership_field: , form_labels_position: ,
                    inline_list_labels: ,
                    form_placeholder_labels:, hawk_keys:,
-                   update_show_only:, alt_lookups: , attachments: )
+                   update_show_only:, alt_lookups: , attachments: , columns_map: )
 
       @singular = singular
       @singular_class = singular_class
 
+      @columns_map = columns_map
+
       @magic_buttons = magic_buttons
       @small_buttons = small_buttons
       @layout_strategy = layout_strategy
@@ -60,7 +62,7 @@ module  HotGlue
 
       columns = layout_object[:columns][:container]
       result = columns.map{ |column|
-        "<div class='#{col_identifier}' heading--#{singular}--#{column.join("-")} " + col_style + ">" +
+        "<div class='#{col_identifier} heading--#{singular}--#{column.join("-")}' " + col_style + ">" +
           column.map(&:to_s).map{|col_name| "#{col_name.humanize}"}.join("<br />")  + "</div>"
       }.join("\n")
       return result
@@ -80,17 +82,9 @@ module  HotGlue
         "  <div class='#{column_classes} cell--#{singular}--#{column.join("-")}' >" +
           column.map { |col|
             if attachments.keys.include?(col)
-              this_attachment  = attachments[col]
-              thumbnail = this_attachment[:thumbnail]
-              direct = this_attachment[:direct_upload]
-              dropzone = this_attachment[:dropzone]
-              field_result = (this_attachment[:thumbnail] ?   "<%= #{singular}.#{col}.attached? ? image_tag(#{singular}.#{col}.variant(:#{thumbnail})) : '' %>" : "") +
-                "<br />\n" + (update_show_only.include?(col) ? "" : "<%= f.file_field :#{col} #{', direct_upload: true ' if direct}#{', "data-dropzone-target": "input"' if dropzone}%>")
-
-              if dropzone
-                field_result = "<div class=\"dropzone dropzone-default dz-clickable\" data-controller=\"dropzone\" data-dropzone-max-file-size=\"2\" data-dropzone-max-files=\"1\">\n  "+ field_result + "\n</div>"
-              end
-              field_error_name = col
+
+              field_result = columns_map[col].form_field_output
+              field_error_name = columns_map[col].field_error_name
             else
 
               type = eval("#{singular_class}.columns_hash['#{col}']").type