hot-glue 0.5.4 → 0.5.6

data/lib/generators/hot_glue/scaffold_generator.rb

@@ -7,11 +7,18 @@ require_relative './markup_templates/erb'
 # require_relative './markup_templates/slim'
 
 require_relative './layout/builder'
+require_relative './layout_strategy/base'
+require_relative './layout_strategy/bootstrap'
+require_relative './layout_strategy/hot_glue'
+require_relative './layout_strategy/tailwind'
+
 
 module HotGlue
   class Error < StandardError
   end
 
+
+
   def self.construct_downnest_object(input)
     res = input.split(",").map { |child|
       child_name = child.gsub("+","")
@@ -21,18 +28,14 @@ module HotGlue
     Hash[*res.collect{|hash| hash.collect{|key,value| [key,value].flatten}.flatten}.flatten]
   end
 
-  def self.optionalized_ternary(params)
-    namespace = params[:namespace] || nil
-    target = params[:target]
-    nested_set = params[:nested_set]
-    modifier = params[:modifier] || ""
-    with_params = params[:with_params] || false
-    top_level = params[:top_level] || false
-
+  def self.optionalized_ternary(namespace: nil,
+                                target:,
+                                nested_set:,
+                                modifier: "",
+                                with_params: false,
+                                top_level: false,
+                                put_form: false)
     instance_sym = top_level ? "@" : ""
-
-    put_form =  params[:put_form] || false
-
     if nested_set.nil? || nested_set.empty?
       return modifier + "#{(namespace + '_') if namespace}#{target}_path" + (("(#{instance_sym}#{target})" if put_form) || "")
     elsif nested_set[0][:optional] == false
@@ -50,17 +53,23 @@ module HotGlue
       nonoptional[:optional] = false
       rest_of_nest = nested_set[1..-1]
 
-      all_params = {namespace: namespace,
-                    target: target,
-                    modifier: modifier,
-                    top_level: top_level,
-                    with_params: with_params,
-                    put_form: put_form}
-      is_present_path = HotGlue.optionalized_ternary(all_params.merge({  nested_set: [nonoptional, *rest_of_nest]})       )
-
-      is_missing_path = HotGlue.optionalized_ternary(all_params.merge({  nested_set: rest_of_nest})       )
-
-
+      is_present_path = HotGlue.optionalized_ternary(
+        namespace: namespace,
+         target: target,
+         modifier: modifier,
+         top_level: top_level,
+         with_params: with_params,
+         put_form: put_form,
+         nested_set: [nonoptional, *rest_of_nest])
+
+      is_missing_path = HotGlue.optionalized_ternary(
+        namespace: namespace,
+        target: target,
+        modifier: modifier,
+        top_level: top_level,
+        with_params: with_params,
+        put_form: put_form,
+        nested_set: rest_of_nest  )
       return "defined?(#{instance_sym + nested_set[0][:singular]}) ? #{is_present_path} : #{is_missing_path}"
     end
   end
@@ -78,8 +87,6 @@ module HotGlue
       display_column = "display_name"
     elsif assoc_class.new.respond_to?("email")
       display_column = "email"
-    # else # SHOULD BE UNREACHABLE
-    #   raise("this should have been caught by the checker in the initializer")
     end
     display_column
   end
@@ -89,6 +96,7 @@ module HotGlue
 
     source_root File.expand_path('templates', __dir__)
     attr_accessor :path, :singular, :plural, :singular_class, :nest_with
+    attr_accessor :columns, :downnest_children, :layout_object
 
     class_option :singular, type: :string, default: nil
     class_option :plural, type: :string, default: nil
@@ -150,6 +158,7 @@ module HotGlue
         raise(HotGlue::Error, message)
       end
 
+      @meta_args = meta_args
 
       if options['specs_only'] && options['no_specs']
         raise(HotGlue::Error,  "*** Oops: You seem to have specified both the --specs-only flag and --no-specs flags. this doesn't make any sense, so I am aborting. Aborting.")
@@ -180,37 +189,43 @@ module HotGlue
       yaml_from_config = YAML.load(File.read("config/hot_glue.yml"))
       @markup =  yaml_from_config[:markup]
 
-      if  @markup == "erb"
-        @template_builder = HotGlue::ErbTemplate.new
-      elsif  @markup == "slim"
-        raise(HotGlue::Error,  "SLIM IS NOT IMPLEMENTED")
-      elsif  @markup == "haml"
-        raise(HotGlue::Error,  "HAML IS NOT IMPLEMENTED")
+      if options['layout']
+        layout = options['layout']
+      else
+        layout = yaml_from_config[:layout]
 
+        if !['hotglue', 'bootstrap', 'tailwind'].include? layout
+          raise "Invalid option #{layout} in Hot glue config (config/hot_glue.yml). You must either use --layout= when generating or have a file config/hotglue.yml; specify layout as either 'hotglue' or 'bootstrap'"
+        end
       end
 
+      @layout_strategy =
+        case layout
+        when 'bootstrap'
+          LayoutStrategy::Bootstrap.new(self)
+        when 'tailwind'
+          LayoutStrategy::Tailwind.new(self)
+        when 'hotglue'
+          LayoutStrategy::HotGlue.new(self)
+        end
 
-      if !options['layout']
-        @layout = yaml_from_config[:layout]
 
-        if !['hotglue', 'bootstrap'].include? @layout
-          raise "Invalid option #{@layout} in Hot glue config (config/hot_glue.yml). You must either use --layout= when generating or have a file config/hotglue.yml; specify layout as either 'hotglue' or 'bootstrap'"
-        end
-      else
-        @layout = options['layout']
+      if  @markup == "erb"
+        @template_builder = HotGlue::ErbTemplate.new(layout_strategy: @layout_strategy)
+      elsif  @markup == "slim"
+        raise(HotGlue::Error,  "SLIM IS NOT IMPLEMENTED")
+      elsif  @markup == "haml"
+        raise(HotGlue::Error,  "HAML IS NOT IMPLEMENTED")
       end
 
       args = meta_args[0]
-
-
       @singular = args.first.tableize.singularize # should be in form hello_world
 
-
       if @singular.include?("/")
         @singular = @singular.split("/").last
       end
 
-      @plural = options['plural'] || @singular + "s" # supply to override; leave blank to use default
+      @plural = options['plural'] || @singular.pluralize # respects what you set in inflections.rb, to override, use plural option
       @namespace = options['namespace'] || nil
 
 
@@ -220,9 +235,9 @@ module HotGlue
       @controller_build_folder = use_controller_name.underscore
       @controller_build_folder_singular = singular
 
-      if ! @controller_build_folder.ends_with?("s")
-        raise HotGlue::Error, "can't build with controller name #{@controller_build_folder} because it doesn't end with an 's'"
-      end
+      # if ! @controller_build_folder.ends_with?("s")
+      #   raise HotGlue::Error, "can't build with controller name #{@controller_build_folder} because it doesn't end with an 's'"
+      # end
 
       @auth = options['auth'] || "current_user"
       @auth_identifier = options['auth_identifier'] || (! @god && @auth.gsub("current_", "")) || nil
@@ -292,8 +307,7 @@ module HotGlue
         raise HotGlue::Error, "You specified both --smart-layout and also specified grouping mode (there is a : character in your field include list); you must remove the colon(s) from your --include tag or remove the --smart-layout option"
       end
 
-
-      @container_name = @layout == "hotglue" ? "scaffold-container" : "container-fluid"
+      @container_name = @layout_strategy.container_name
       @downnest = options['downnest'] || false
 
       @downnest_children = [] # TODO: defactor @downnest_children in favor of downnest_object
@@ -353,7 +367,6 @@ module HotGlue
             plural: arg.pluralize,
             optional: is_optional
           }
-
         }
         puts "NESTING: #{@nested_set}"
       end
@@ -361,7 +374,6 @@ module HotGlue
       # OBJECT OWNERSHIP & NESTING
       @reference_name = HotGlue.derrive_reference_name(singular_class)
       if @auth && @self_auth
-        # byebug
         @object_owner_sym = @auth.gsub("current_", "").to_sym
         @object_owner_eval = @auth
         @object_owner_optional = false
@@ -369,18 +381,15 @@ module HotGlue
 
 
       elsif @auth && ! @self_auth && @nested_set.none? && !@auth.include?(".")
-        # byebug
         @object_owner_sym = @auth.gsub("current_", "").to_sym
         @object_owner_eval = @auth
         @object_owner_optional = false
         @object_owner_name = @auth.gsub("current_", "").to_s
 
       elsif @auth && @auth.include?(".")
-        # byebug
         @object_owner_sym = nil
         @object_owner_eval = @auth
       else
-        # byebug
         if @nested_set.any?
           @object_owner_sym = @nested_set.last[:singular].to_sym
           @object_owner_eval = "@#{@nested_set.last[:singular]}"
@@ -405,13 +414,11 @@ module HotGlue
 
       buttons_width = ((!@no_edit && 1) || 0) + ((!@no_delete && 1) || 0) + @magic_buttons.count
 
-      builder = HotGlue::Layout::Builder.new({
-                                              include_setting: options['include'],
+      builder = HotGlue::Layout::Builder.new(include_setting: options['include'],
                                               downnest_object: @downnest_object,
                                               buttons_width: buttons_width,
                                               columns: @columns,
-                                              smart_layout: @smart_layout
-                                            })
+                                              smart_layout: @smart_layout )
       @layout_object = builder.construct
 
       @menu_file_exists = true if @nested_set.none? && File.exists?("#{Rails.root}/app/views/#{namespace_with_trailing_dash}_menu.#{@markup}")
@@ -433,8 +440,12 @@ module HotGlue
             key = hawk_entry
             hawk_to = @auth
           end
+
           hawk_scope = key.gsub("_id", "").pluralize
-          @hawk_keys[key.to_sym] = [hawk_to, hawk_scope]
+          @hawk_keys[key.to_sym] = [hawk_to]
+          if @use_shorthand # only include the hawk scope if using the shorthand
+            @hawk_keys[key.to_sym] << hawk_scope
+          end
         end
 
         puts "HAWKING: #{@hawk_keys}"
@@ -447,7 +458,6 @@ module HotGlue
       if @object_owner_sym && ! @self_auth
         auth_assoc_field = auth_assoc + "_id" unless @god
         assoc = eval("#{singular_class}.reflect_on_association(:#{@object_owner_sym})")
-        # byebug
         if assoc
           @ownership_field = assoc.name.to_s + "_id"
         elsif ! @nested_set.any?
@@ -586,19 +596,10 @@ module HotGlue
     end
 
     def list_column_headings
-      if @layout == "bootstrap"
-        column_width = @layout_object[:columns][:size_each]
-        col_identifier = "col-md-#{column_width}"
-      elsif @layout == "hotglue"
-        column_width = each_col * @columns.count
-        col_identifier = "scaffold-cell"
-      end
-
       @template_builder.list_column_headings(
         columns: @layout_object[:columns][:container],
-        col_identifier: col_identifier,
-        layout: @layout,
-        column_width: column_width
+        col_identifier: @layout_strategy.column_classes_for_column_headings,
+        column_width: @layout_strategy.column_width
       )
     end
 
@@ -619,6 +620,11 @@ module HotGlue
       }.join(", ")
     end
 
+
+    def regenerate_me_code
+      "rails generate hot_glue:scaffold #{ @meta_args[0][0] } #{@meta_args[1].join(" ")}"
+    end
+
     def object_parent_mapping_as_argument_for_specs
       if @nested_set.any?
         ", " + @nested_set.last[:singular] + ": " + @nested_set.last[:singular]
@@ -899,6 +905,15 @@ module HotGlue
       )
     end
 
+    def nav_template
+      "#{namespace_with_trailing_dash}nav"
+    end
+
+
+    def include_nav_template
+      File.exists?("#{Rails.root}/app/views/#{namespace_with_trailing_dash}_nav.html.#{@markup}")
+    end
+
     def copy_view_files
       return if @specs_only
       all_views.each do |view|
@@ -943,9 +958,10 @@ module HotGlue
 
     def append_model_callbacks
       # somehow the generator invokes this
+
       if options['with_turbo_streams'] == true
         dest_filename = cc_filename_with_extensions("#{singular_class.underscore}", "rb")
-        dest_filepath = File.join("#{'dummy/' if Rails.env.test?}app/models", dest_filename)
+        dest_filepath = File.join("#{'spec/dummy/' if Rails.env.test?}app/models", dest_filename)
 
 
         puts "appending turbo callbacks to #{dest_filepath}"
@@ -1026,24 +1042,19 @@ module HotGlue
     end
 
     def all_form_fields
-      col_identifier = (@layout == "hotglue") ? "scaffold-cell" : "col-md-#{@layout_object[:columns][:size_each]}"
-
       @template_builder.all_form_fields(
         columns: @layout_object[:columns][:container],
         show_only: @show_only,
         singular_class: singular_class,
         singular: singular,
         hawk_keys: @hawk_keys,
-        col_identifier:  col_identifier,
+        col_identifier:  @layout_strategy.column_classes_for_form_fields,
         ownership_field: @ownership_field,
         form_labels_position: @form_labels_position,
         form_placeholder_labels: @form_placeholder_labels
       )
     end
 
-    def column_width
-      @each_col ||= each_col
-    end
 
     def list_label
       if(eval("#{class_name}.class_variable_defined?(:@@table_label_plural)"))
@@ -1061,39 +1072,15 @@ module HotGlue
       end
     end
 
-    def each_col
-      return col_width if @columns.count == 0
-      (col_width/(@columns.count)).to_i
-    end
-
-    def col_width
-      downnest_size = case (@downnest_children.count)
-
-                      when 0
-                        downnest_size = 0
-                      when 1
-                        downnest_size = 40
-
-                      else
-                        downnest_size = 60
-
-                      end
-      100 - downnest_size - 5
-    end
-
     def all_line_fields
-      col_identifier = (@layout == "hotglue") ? "scaffold-cell" : "col-md-#{@layout_object[:columns][:size_each]}"
-
       @template_builder.all_line_fields(
-        perc_width: column_width,
+        perc_width: @layout_strategy.each_col,     #undefined method `each_col'
         columns:  @layout_object[:columns][:container],
         show_only: @show_only,
         singular_class: singular_class,
         singular: singular,
-        layout: @layout,
-        col_identifier: col_identifier,
+        col_identifier: @layout_strategy.column_classes_for_line_fields,
         inline_list_labels: @inline_list_labels
-
       )
     end
 
@@ -1152,15 +1139,6 @@ module HotGlue
      @template_builder.paginate(plural: plural)
     end
 
-    # def delete_confirmation_syntax
-    #   if !@stimulus_syntax
-    #    "{confirm: 'Are you sure?'}"
-    #   else
-    #    "{controller: 'confirmable', 'confirm-message': \"Are you sure you want to delete \#{ #{@singular}.#{ display_class } } \", 'action': 'confirmation#confirm'}"
-    #   end
-    # end
-
-
     def controller_magic_button_update_actions
       @magic_buttons.collect{ |magic_button|
         "    if #{singular}_params[:#{magic_button}]
@@ -1192,7 +1170,6 @@ module HotGlue
       end
     end
 
-
     def n_plus_one_includes
       if @associations.any?
         ".includes(" + @associations.map{|x| ":#{x.to_s}"}.join(", ") + ")"
@@ -1236,6 +1213,3 @@ module HotGlue
     end
   end
 end
-
-
-

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

@@ -1,4 +1,7 @@
 class <%= controller_class_name %> < <%= controller_descends_from %>
+  # regenerate this controller with
+  # <%= regenerate_me_code %>
+
   helper :hot_glue
   include HotGlue::ControllerHelper
 

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

@@ -1,7 +1,7 @@
 <div class="row">
 <%= all_form_fields %>
 
-  <div class="<%= @layout == "hotglue" ? 'scaffold-cell' : 'col-md-2' %>">
+  <div class="<%= @layout_strategy.column_classes_for_form_fields %>">
     <\%= link_to "Cancel", <%= path_helper_plural %>,  {class: "btn btn-secondary"} %><% if @no_field_form %>
     <\%= f.hidden_field "_________" %><% end %>
     <\%= f.submit "Save", class: "btn btn-primary pull-right" %>

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

@@ -1,6 +1,6 @@
 <% if @turbo_streams %><\%= turbo_stream_from <%= singular %>  %>
 <% end %><\%= turbo_frame_tag "<%= @namespace %>__#{ dom_id(<%= singular %>) }" do  %>
-  <div class='row scaffold-row' data-id='<\%= <%= singular  %>.id %>' data-edit='false'>
+  <div class='<%= @layout_strategy.row_classes %>' data-id='<\%= <%= singular  %>.id %>' data-edit='false'>
     <\%= render partial: '<%=  show_path_partial %>', locals: { <%= singular %>: <%= singular %> }<% @nested_set.each do |nest_arg| %>.merge(defined?(<%= nest_arg[:singular] %>) ? {<%= nest_arg[:singular] %>: <%= nest_arg[:singular] %>, nested_for: "<%= nest_arg[:singular] %>-#{<%= nest_arg[:singular] %>.id}"} : {})<% end %> %>
 
   </div>

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

@@ -1,5 +1,5 @@
 <\%= turbo_frame_tag "<%= @namespace %>__<%= plural %>-list" <%= nested_for_turbo_id_list_constructor %>  do %>
-  <div class="<%= @container_name %> scaffold-list">
+  <div class="<%= @container_name %> <%= @layout_strategy.list_classes %>">
     <% unless @no_list  || @no_list_label || (@nested_set.any? && !@nested_set.collect{|x| x[:optional]}.any?)  %>
       <% unless list_label.nil? %><h4>
         <%= list_label %>
@@ -10,14 +10,12 @@
 
     <% unless @no_list %>
       <% unless @no_list_heading %>
-        <div class="row scaffold-heading-row">
+        <div class="<%= @layout_strategy.row_classes %> <%= @layout_strategy.row_heading_classes %>">
           <%= list_column_headings %>
           <% if @downnest_object.any? %>
-            <%# each_downnest_width = @downnest_object.count == 1 ? 40 : (60/@downnest_object.count).floor %>
-            <% downnest_column_style = @layout == "hotglue" ? 'style="flex-basis: ' + each_downnest_width.to_s +  '%;' : "" %>
-
+            <%= @layout_strategy.downnest_column_style  %>
             <% @downnest_object.each do |downnest,i| %>
-              <div class=" scaffold-col-heading<%= " col-sm-#{ @layout_object[:portals][downnest][:size] }" if @layout=="bootstrap" %>" <%= downnest_column_style %>>
+              <div class=" scaffold-col-heading <%= @layout_strategy.downnest_portal_column_width(downnest) %> <%= @layout_strategy.downnest_column_style %>">
                 <strong>
                   <%=  downnest.titleize  %>
                 </strong>
@@ -25,10 +23,7 @@
             <% end %>
           <% end %>
 
-          <% button_column_style = @layout == "hotglue" ? 'style="flex-basis: 150px' : ""  %>
-
-          <div class=' scaffold-col-heading scaffold-col-heading-buttons<%= " col-md-#{ @layout_object[:buttons][:size] }" if @layout=="bootstrap" %>' <%= button_column_style %>>
-
+          <div class=' scaffold-col-heading scaffold-col-heading-buttons <%= @layout_strategy.column_classes_for_column_headings %>' <%= @layout_strategy.button_column_style %>>
           </div>
         </div>
       <% end %>

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

@@ -9,7 +9,7 @@
     <% if downnest_object.nil?; raise "no relationship for downnested portal `#{downnest}` found on `#{singular_class}`; please check relationship for has_many :#{downnest}"; end; %>
     <% downnest_class = downnest_object.class_name %>
     <% downnest_object_name = eval("#{downnest_class}.table_name") %>
-    <% downnest_style =  @layout == "hotglue" ? 'style="flex-basis: ' +  each_downnest_width.to_s + '%"' : "" %>
+    <% downnest_style = @layout_strategy.downnest_style %>
     <div class="<%= " col-md-#{@layout_object[:portals][downnest][:size]}" if @layout == "bootstrap" %> scaffold-downnest" <%= downnest_style  %> >
   <\%= render partial: "<%= namespace_with_trailing_dash %><%= downnest_object_name %>/list", locals: {
         <%= @singular %>: <%= @singular %>,
@@ -22,8 +22,8 @@
   <% end %>
 <% end %>
 
-<% button_style = @layout == "hotglue" ? 'style="flex-basis: ' +  (100 - (column_width * @columns.count)).floor.to_s +  '%;"' : "" %>
-<div class="<%= @col_identifier %> scaffold-line-buttons <%= " col-md-#{ @layout_object[:buttons][:size] }" if @layout == "bootstrap" %>" <%= button_style %>>
+<%= @layout_strategy.button_style %>
+<div class="<%= @col_identifier %> scaffold-line-buttons <%= @layout_strategy.button_classes %>" <%= @layout_strategy.button_style %>>
   <%= magic_button_output %>
 
   <% if destroy_action %>

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

@@ -1,14 +1,11 @@
 <% if @menu_file_exists %><\%= render partial: "<%= namespace_with_trailing_dash %>menu", locals: {active: '<%= plural %>'} %><% end %>
 
 <div class="<%= @container_name %>">
-  <% if @layout == "bootstrap" %><div class="row"> <div class="col-md-12">
-  <% else %>
-    <div class=' scaffold-index-<%= plural %>'>
-  <% end %>
+  <%= @layout_strategy.page_begin %>
+  <% if include_nav_template %><\%= render partial: "<%= nav_template %>", locals: {nav: "<%= @plural %>"} %><% end %>
 
-  <div class="clearfix"></div>
   <\%= render partial: '<%= list_path_partial %>',
     locals: {<%= plural %>: @<%= plural %>}<%= @nested_set.collect{|arg| ".merge(@" + arg[:singular] + " ? {nested_for: \"" + arg[:singular] + "-\#{@" + arg[:singular] + ".id}\"" + ", " + arg[:singular] + ": @" + arg[:singular] + "} : {})"}.join()  %> \%>
 
-  <% if @layout == "bootstrap" %></div></div><% else  %></div><% end %>
+  <%= @layout_strategy.page_end %>
 </div>

data/lib/hot-glue.rb

@@ -1,11 +1,7 @@
 require "hotglue/engine"
 require 'kaminari'
 
-
 module HotGlue
-
-
-
   module TemplateBuilders
 
   end

data/lib/hotglue/engine.rb

@@ -1,6 +1,6 @@
 module HotGlue
   class Engine < ::Rails::Engine
 
-    config.autoload_paths << File.expand_path("lib/helpers/hot_glue_helper.rb", __dir__)
+
   end
 end

data/lib/hotglue/version.rb

@@ -1,5 +1,5 @@
 module HotGlue
   class Version
-    CURRENT = '0.5.4'
+    CURRENT = '0.5.6'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hot-glue
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.6
 platform: ruby
 authors:
 - Jason Fleetwood-Boldt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-27 00:00:00.000000000 Z
+date: 2023-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -75,9 +75,12 @@ files:
 - config/database.yml
 - config/hot_glue.yml
 - db/schema.rb
-- lib/generators/hot_glue/helpers.rb
 - lib/generators/hot_glue/install_generator.rb
 - lib/generators/hot_glue/layout/builder.rb
+- lib/generators/hot_glue/layout_strategy/base.rb
+- lib/generators/hot_glue/layout_strategy/bootstrap.rb
+- lib/generators/hot_glue/layout_strategy/hot_glue.rb
+- lib/generators/hot_glue/layout_strategy/tailwind.rb
 - lib/generators/hot_glue/markup_templates/base.rb
 - lib/generators/hot_glue/markup_templates/erb.rb
 - lib/generators/hot_glue/scaffold_generator.rb

data/lib/generators/hot_glue/helpers.rb

@@ -1,13 +0,0 @@
-class HotGlue::Helpers
-
-
-  def self.open_page( link)
-    if RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
-      system "start #{link}"
-    elsif RbConfig::CONFIG['host_os'] =~ /darwin/
-      system "open #{link}"
-    elsif RbConfig::CONFIG['host_os'] =~ /linux|bsd/
-      system "xdg-open #{link}"
-    end
-  end
-end