hot-glue 0.5.4 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4770a6dafa96c7d17e2104d7349caf126a7922c660b3055b29c6a7eab6e7d851
-  data.tar.gz: cd730bb99e9d9dad8ca5ee22a504a9e91ace01123ce900e11c7ccffae3e26630
+  metadata.gz: 61b8c21f0bf630a68d9861b8bb70141ce7fe0da0a0f1ae71c3bb4e69da6b081d
+  data.tar.gz: 865d633fe279b4db0b2927801c82ec6de1ab630b4ffb7d24ffc539dfbb56d44d
 SHA512:
-  metadata.gz: 5f59544515a51f85e494bd7a1ec7ee4586ab761919554f53ad751b845906e412a5cd80f65e1447183d79246e295abbb1fe468814ef572cd93888970603aafb7a
-  data.tar.gz: 045115777e9399ddffd06f9b400d44cc1d5e230579ea9d2017213cf74ae786efe2ae42d52639dbc60b496d0628f8a955c0d03807cd7262203de1961e0ecf87c8
+  metadata.gz: 26901af291d1db0f028b14e320ed6c66908c90d94777c559bdba508c4e111b651357531f9fffc468cc419fbe16dda1d9bb6b86777c6e8f840631c4dfb7239e3d
+  data.tar.gz: 69775a6b4a31b142e1683c2017d2b85c1fda1f7350bb4b954948a0b06bfbb990578bed98c0eedce1534e10ad78aa44b87d27deecf027f017184aa731319c62cb

data/.gitignore

@@ -16,11 +16,18 @@ Gemfile.lock
 
 db/*.sqlite3
 
-spec/dummy/app/views/
-spec/dummy/app/controllers/
-spec/dummy/specs/
+dummy/app/views/
+dummy/app/controllers/
+dummy/specs/
+
+dummy/node_modules/
+dummy/log/
+dummy/Gemfile.lock
+dummy/config/hot_glue.yml
 
-spec/dummy/node_modules/
-spec/dummy/log/
 
 coverage/
+
+
+spec/dummy/
+dummy/spec/system/

data/README.md

@@ -29,10 +29,10 @@ How is it different than Rails scaffolding?
 
 Although inspired by the Rails scaffold generators (built-in to Rails), Hot Glue does something similiar but has made opinionated decisions that deviate from the normal Rails scaffold: 
 
-1. The Hot Glue scaffolds are complete packages and pre-optimized for 'edit-in-place.' (the Rails scaffolds still generate views that make you flip between pages to do create/update operations)
-2. Hot Glue does not create your models along with your scaffolding. Instead, create them first using `rails model new`
-3. Hot Glue *reads* the fields on your database and the relationships defined on your models, so unlike the Rails scaffolding you must do that step before building your scaffolding.
-4. Hot Glue has many more features for building layouts quickly, like choosing which fields to include or exclude and how to lay them out on the page, for stiching together related objects (nesting and child portals), and more. 
+1. The Hot Glue scaffolds are complete packages and pre-optimized for 'edit-in-place.' (the Rails scaffolds still generates views that make you flip between pages to do create/update operations)
+2. Hot Glue does not create your models along with your scaffolding. Instead, create them first using `rails generate model X`
+3. Hot Glue *reads* the fields on your database *and* the relationships defined on your models. Unlike the Rails scaffolding you must add relationships and migration your DB before building your scaffolding.
+4. Hot Glue has many more features for building layouts quickly, like choosing which fields to include or exclude and how to lay them out on the page, for stitching together related objects (nesting and child portals), and more. 
 
 Other than the opinionated differences and additional features, Hot Glue produces code that is fundamentally very similiar and works consistent with the Rails 7 ways of working. 
 
@@ -138,7 +138,7 @@ sed -i '' -e 's/, html: { method: :post })/, html: { method: :post, "data-turbo"
 git add . && git commit -m 'devise view fixes' &&
 rails generate model User name:string &&
 rails generate devise User && git add . && git commit -m "adds Users model with devise" && 
-rails db:migrate &&
+&& ./bin/setup && rails db:migrate &&
 git add . && git commit -m "schema file"
 ```
 
@@ -568,17 +568,25 @@ Please note that this example would produce non-functional code, so you would ne
 
 Hawk a foreign key that is not the object's owner to within a specified scope. 
 
-Assuming a Pet belong_to a :human, when building an Appointments scaffold, you can hawk the `pet_id` to the current human's pets. (Whoever is the authentication object.)
+Assuming a Pet belong_to a :human, when building an Appointments scaffold,
+you can hawk the `pet_id` to the current human's pets. (Whoever is the authentication object.)
 
+The hawk has two forms: a short-form (`--hawk=key`) and long form (`--hawk=key{scope})
+
+The short form looks like this. It presumes there is a 'pets' association from `current_user`
 `--hawk=pet_id`
 
+(The long form equivalent of this would be `--hawk=pet_id{current_user.pets}`)
+
 This is covered in [Example #3 in the Hot Glue Tutorial](https://jfb.teachable.com/courses/hot-glue-in-depth-tutorial/lectures/38584014)
 
-To hawk to a scope that is not the currently authenticated user, use curly braces `{...}` to specify the scope.
+To hawk to a scope that is not the currently authenticated user, use the long form with `{...}` 
+to specify the scope. Be sure to note to add the association name itself, like `users`: 
 
-`--hawk=user_id{current_user.family}`
+`--hawk=user_id{current_user.family.users}`
 
-This would hawk the Appointment's `user_id` key to any users who are within the scope of the current_user's family. 
+This would hawk the Appointment's `user_id` key to any users who are within the scope of the 
+current_user's has_many association (so, for any other "my" family, would be `current_user.family.users`). 
 
 This is covered in [Example #4 in the Hot Glue Tutorial](https://jfb.teachable.com/courses/hot-glue-in-depth-tutorial/lectures/38787505)
 
@@ -905,6 +913,39 @@ Child portals have the headings omitted automatically (there is a heading identi
 
 # VERSION HISTORY
 
+#### 2023-01-02 - v0.5.6
+- Changes the long-form of the hawk specifier to require you to use the has_many of the relationship you are hawking (previously, it was assumed). See Hawk for details
+- Adds "Regenerate me" comment to top of all generated controllers
+- Change behavior of pluralization. Now, you can use an `inflections.rb` file and non-standard pluralization will be respected.
+
+
+#### 2022-12-27 - v0.5.5 
+
+- Experimental support for Tailwind. Note I was not able to get Tailwind actually working in my app, and I'm not sure about how to think about the many flavors of Tailwind (all of which seem to be paid?). If anyone can lend a hand, the objects are now cleanly refactored so that the CSS logic is separated.
+
+- Support for UUIDs. Database UUIDs are treated as foreign keys and behave like integers ending with _id (they are treated as foreign keys whether or not they end with _id where as integers are treated as foreign keys only if they end with _id)
+
+- At the namespace level, you can now have a file called `_nav.html.erb` like this example for a two-tab bootstrap nav (you'll need to create this file manually). 
+- Here, our two tabs are called "Domains" and "Widgets"
+
+```
+<ul class="nav nav-tabs">
+  <li class="nav-item">
+    <%= link_to "Domains", domains_path, class: "nav-link #{'active' if nav == 'domains'}" %>
+  </li>
+  <li class="nav-item">
+  	<%= link_to "Widgets", widgets_path, class: "nav-link #{'active' if nav == 'widget'}" %>	
+  </li>
+</ul>
+```
+
+If the file is present, Hot Glue will automatically add this to the top of, for example, the "domains" index page:
+
+```
+<%= render partial: "owner/nav", locals: {nav: "domains"} %>
+```
+Use this to build a Bootstrap nav that correctly turns each tab active when navigated to.
+
 #### 2022-11-27 - v0.5.4 - new flag --with-turbo-streams will append callbacks after_update_commit and after_destroy_commit to the MODEL you are building with to use turbo to target the scaffolding being built and programmatically update it
 
 Adds `--with-turbo-streams`. Use `--with-turbo-streams` to create hot (live reload) interfaces. See docs above.

data/app/helpers/hot_glue/controller_helper.rb

@@ -78,9 +78,9 @@ module HotGlue
       @hawk_alarm = ""
       hawk_schema.each do |hawk_key,hawk_definition|
         hawk_root = hawk_definition[0]
-        hawk_scope = hawk_definition[1]
+        # hawk_scope = hawk_definition[1]
         begin
-          eval("hawk_root.#{hawk_scope}").find(modified_params[hawk_key.to_s])
+          eval("hawk_root").find(modified_params[hawk_key.to_s])
         rescue ActiveRecord::RecordNotFound => e
           @hawk_alarm << "You aren't allowed to set #{hawk_key.to_s} to #{modified_params[hawk_key.to_s]}. "
           modified_params.tap { |hs| hs.delete(hawk_key.to_s) }

data/lib/generators/hot_glue/install_generator.rb

@@ -1,5 +1,5 @@
 require 'rails/generators/erb/scaffold/scaffold_generator'
-require_relative './helpers'
+
 require 'ffaker'
 
 module HotGlue
@@ -15,15 +15,15 @@ module HotGlue
 
     def initialize(*args) #:nodoc:
       super
-      @layout = options['layout'] || "hotglue"
+      layout = options['layout'] || "hotglue"
       @theme =  options['theme']
-      if @layout == "hotglue" && options['theme'].nil?
+      if layout == "hotglue" && options['theme'].nil?
         puts "You have selected to install Hot Glue without a theme. You can either use the --layout=bootstrap to install NO HOT GLUE THEME, or to use a Hot Glue theme please choose: like_boostrap, like_menlo_park, like_cupertino, like_mountain_view, dark_knight"
         return
       end
 
-      if @layout == 'boostrap'
-        puts "IMPORTANT: You have selected to install Hot Glue with Bootstrap layout (legacy). Be sure to always use ``--layout=bootstrap` when building your scaffold. No Hot Glue theme will be installed at this time.` "
+      if layout == 'boostrap'
+        puts "IMPORTANT: You have selected to install Hot Glue with Bootstrap layout.` "
       end
 
 
@@ -56,7 +56,7 @@ module HotGlue
 
 
       begin
-        rails_helper_contents = File.read("spec/rails_helper.rb")
+        rails_helper_contents = File.read("#{'spec/dummy/' if Rails.env.test?}spec/rails_helper.rb")
         if !rails_helper_contents.include?("Capybara.default_driver =")
           rails_helper_contents << "\nCapybara.default_driver = :selenium_chrome_headless "
           puts "  HOTGLUE --> added to spec/rails_helper.rb: `Capybara.default_driver = :selenium_chrome_headless`  "
@@ -66,14 +66,14 @@ module HotGlue
           rails_helper_contents.gsub!("RSpec.configure do |config|", "RSpec.configure do |config| \n
     config.include FactoryBot::Syntax::Methods
   ")
-          puts "  HOTGLUE --> added to spec/rails_helper.rb: `config.include FactoryBot::Syntax::Methods`  "
+          puts "  HOTGLUE --> added to #{'spec/dummy/' if Rails.env.test?}spec/rails_helper.rb: `config.include FactoryBot::Syntax::Methods`  "
         end
 
         if ! rails_helper_contents.include?("require 'support/capybara_login.rb'")
           rails_helper_contents.gsub!("require 'rspec/rails'","require 'rspec/rails' \nrequire 'support/capybara_login.rb'")
           puts "  HOTGLUE --> added to spec/rails_helper.rb: `require 'support/capybara_login.rb'`  "
         end
-        File.write("spec/rails_helper.rb", rails_helper_contents)
+        File.write("#{'spec/dummy/' if Rails.env.test?}spec/rails_helper.rb", rails_helper_contents)
 
       rescue StandardError => e
         puts "WARNING: error writing to spec/rails_helper --- #{e.message}"
@@ -96,7 +96,7 @@ module HotGlue
 
 
       begin
-        if @layout == "hotglue"
+        if layout == "hotglue"
           theme_location = "themes/hotglue_scaffold_#{@theme}.scss"
           theme_file = "hotglue_scaffold_#{@theme}.scss"
 
@@ -119,8 +119,8 @@ module HotGlue
 
 
       begin
-        if !File.exists?("config/hot_glue.yml")
-          yaml = {layout: @layout,
+        if !File.exists?("#{'spec/dummy/' if Rails.env.test?}config/hot_glue.yml")
+          yaml = {layout: layout,
                   markup: @markup}.to_yaml
           File.write("#{'spec/dummy/' if Rails.env.test?}config/hot_glue.yml", yaml)
 
@@ -131,11 +131,11 @@ module HotGlue
 
 
       begin
-        if !File.exists?("spec/support/capybara_login.rb")
+        if !File.exists?("#{'spec/dummy/' if Rails.env.test?}spec/support/capybara_login.rb")
           copy_file "capybara_login.rb", "#{'spec/dummy/' if Rails.env.test?}spec/support/capybara_login.rb"
         end
       rescue StandardError => e
-        puts "WARNING: error writing to spec/support/capybara_login.rb --- #{e.message}"
+        puts "WARNING: error writing to #{Rails.env.test? ? 'spec/dummmy/' : ''}spec/support/capybara_login.rb --- #{e.message}"
       end
     end
   end

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

@@ -8,15 +8,18 @@ module HotGlue
                   :buttons_width, :columns,
                   :smart_layout, :specified_grouping_mode
 
-      def initialize(params)
-        @include_setting = params[:include_setting]
-        @downnest_object = params[:downnest_object]
-
-        @buttons_width = params[:buttons_width]
+      def initialize(include_setting: nil,
+                     downnest_object: nil,
+                     buttons_width: nil,
+                     smart_layout: nil,
+                     columns: nil)
+        @include_setting = include_setting
+        @downnest_object = downnest_object
+        @buttons_width = buttons_width
+        @columns = columns
+        @smart_layout = smart_layout
 
         @no_buttons = @buttons_width == 0
-        @columns = params[:columns]
-        @smart_layout = params[:smart_layout]
         @specified_grouping_mode = include_setting.include?(":")
       end
 
@@ -132,4 +135,4 @@ module HotGlue
 
     end
   end
-end
+end

data/lib/generators/hot_glue/layout_strategy/base.rb

@@ -0,0 +1,31 @@
+module LayoutStrategy
+  class Base
+    attr_accessor :builder
+    def initialize(scaffold_builder)
+      @builder = scaffold_builder
+    end
+
+    def button_classes; ""; end
+    def button_column_style; "" ; end
+    def button_style ; ""; end
+    def column_headings_col_style; "" ; end
+    def column_width; ""; end
+    def column_classes_for_line_fields; ""; end
+    def column_classes_for_form_fields; ""; end
+    def column_classes_for_column_headings; ""; end
+    def col_width; 100; end
+    def container_name; ""; end
+    def downnest_style ; ""; end
+    def downnest_column_style ; "" ; end
+    def each_col
+      return col_width if builder.columns.count == 0
+      (col_width/(builder.columns.count)).to_i
+    end
+    def list_classes; ""; end
+    def row_classes; ""; end
+    def row_heading_classes; ""; end
+    def page_begin; '<div> '; end
+    def page_end ; '</div> '; end
+    def style_with_flex_basis(x); "" ; end
+  end
+end

data/lib/generators/hot_glue/layout_strategy/bootstrap.rb

@@ -0,0 +1,41 @@
+class LayoutStrategy::Bootstrap < LayoutStrategy::Base
+  def button_classes
+    " " + column_classes_for_line_fields
+  end
+
+  def column_classes_for_form_fields
+    "col-md-#{builder.layout_object[:columns][:size_each]}"
+  end
+
+  def column_classes_for_column_headings
+    column_classes_for_line_fields
+  end
+
+  def container_name
+    "container-fluid"
+  end
+
+  def column_classes_for_line_fields
+    "col-sm-#{builder.layout_object[:columns][:size_each]}"
+  end
+
+  def column_width
+    builder.layout_object[:columns][:size_each]
+  end
+
+  def downnest_portal_column_width(downnest)
+    "col-sm-#{ builder.layout_object[:portals][downnest][:size] }"
+  end
+
+  def page_begin
+    '<div class="row"> <div class="col-md-12">'
+  end
+
+  def row_classes
+    "row"
+  end
+
+  def page_end
+    '</div> </div>'
+  end
+end

data/lib/generators/hot_glue/layout_strategy/hot_glue.rb

@@ -0,0 +1,82 @@
+class LayoutStrategy::HotGlue < LayoutStrategy::Base
+  def button_column_style
+    'style="flex-basis: 150px'
+  end
+
+  def button_style
+    'style="flex-basis: ' +  (100 - (column_width * builder.columns.count)).floor.to_s +  '%;"'
+  end
+
+  def column_width
+    each_col * builder.columns.count
+  end
+
+  def column_headings_col_style
+    " style='flex-basis: #{column_width}%'"
+  end
+
+  def container_name
+    "scaffold-container"
+  end
+
+  def downnest_column_style
+    'style="flex-basis: ' + each_downnest_width.to_s +  '%;'
+  end
+
+  def downnest_style
+    'style="flex-basis: ' +  each_downnest_width.to_s + '%"'
+  end
+
+  def each_downnest_width
+    builder.downnest_children.count == 1 ? 33 : (53/builder.downnest_children.count).floor
+  end
+
+  def list_classes
+    "scaffold-list"
+  end
+
+  def row_classes
+    "scaffold-row"
+  end
+
+  def column_classes_for_form_fields
+    "scaffold-cell"
+  end
+
+  def row_heading_classes
+    "scaffold-heading-row"
+  end
+  def column_classes_for_line_fields
+    "scaffold-cell"
+  end
+
+  def column_classes_for_column_headings
+    "scaffold-cell"
+  end
+
+  def col_width
+    downnest_size = case (builder.downnest_children.count)
+        when 0
+          downnest_size = 0
+        when 1
+          downnest_size = 40
+
+        else
+          downnest_size = 60
+
+        end
+    100 - downnest_size - 5
+  end
+
+  def page_begin
+    '<div class=" scaffold-index-<%= plural %>">'
+  end
+
+  def page_end
+    '</div>'
+  end
+
+  def style_with_flex_basis(perc_width)
+    " style='flex-basis: #{perc_width}%'"
+  end
+end

data/lib/generators/hot_glue/layout_strategy/tailwind.rb

@@ -0,0 +1,28 @@
+
+
+class LayoutStrategy::Tailwind < LayoutStrategy::Base
+  def button_classes; ""; end
+  def button_column_style; "" ; end
+  def button_style ; ""; end
+  def column_headings_col_style; "" ; end
+  def column_width; ""; end
+  def column_classes_for_line_fields; ""; end
+  def column_classes_for_form_fields; ""; end
+  def column_classes_for_column_headings; ""; end
+  def col_width; 100; end
+  def container_name; ""; end
+  def downnest_style ; ""; end
+  def downnest_column_style ; "" ; end
+  def each_col
+    return col_width if builder.columns.count == 0
+    (col_width/(builder.columns.count)).to_i
+  end
+
+  def list_classes; "overflow-x-auto w-full"; end
+  def row_classes; "grid grid-cols-4 gap-x-16 py-5 px-4 text-sm text-gray-700 border-b border-gray-200 dark:border-gray-700"; end
+  def row_heading_classes; "grid grid-cols-4 gap-x-16 p-4 text-sm font-medium text-gray-900 bg-gray-100 border-t border-b border-gray-200 dark:bg-gray-800 dark:border-gray-700 dark:text-white"; end
+  def page_begin; '<div class="overflow-hidden min-w-max"> '; end
+  def page_end ; '</div> '; end
+  def style_with_flex_basis(x); "" ; end
+
+end

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

@@ -1,7 +1,7 @@
 module  HotGlue
   class TemplateBase
-    def initialize()
+    def initialize(layout_strategy: )
+      @layout_strategy = layout_strategy
     end
-
   end
-end
+end