bullet_train-super_scaffolding 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b401a89cc8733d82b955c7a8364fd8d4f5baf0db63ab606dcbcf60686c5ba33
-  data.tar.gz: 8368208e9fb8fb26726b09baaf5dccc9990f6791c143ceedac03e82d846e2615
+  metadata.gz: deba742f563b6d3def090a3b04a3a8efdcac8750bc2828575cd6cc0804ae5390
+  data.tar.gz: 5d15eae1ce2d7770ee8ef10cd49022974fd2dd746a10cee22dc032b7bea38b74
 SHA512:
-  metadata.gz: 11500e4a8fd203a0f84d3ba2235293c4195be193920f4c646c4cd72a9bd01972bb23c3f3b07b5c9798c5a9db98b8460c9f8637e348f45608a512acfcbc7258fe
-  data.tar.gz: da6529b8e728292c20192119a374693b5b9c9d2603d41c75014e30a91eaeda172ddefe48287d56abbb7a8344247e01e62cab6e394332a414cf62baad93ef6777
+  metadata.gz: 601210d754a40a9d0d62555ba661a1ba35463e68aef0b2adbac930cd215def4bed94288783343bb68232a987980b8f6bc816e2ac4399469cecf4300e03928b12
+  data.tar.gz: c1b8e0cc87d2a648b589fc00eb3eaba87699591f04e9e4daf47b1cff0356cc9bb8a207aecbf10ac28135882e853ebaa3e26dd8d66e371ea0332dd581f0acb4a9

data/lib/bullet_train/super_scaffolding/scaffolders/crud_scaffolder.rb

@@ -51,6 +51,11 @@ module BulletTrain
             end
           end
 
+          # get all the attributes.
+          attributes = argv[2..]
+
+          check_required_options_for_attributes("crud", attributes, child, parent)
+
           # `tr` here compensates for namespaced models (i.e. - `Projects::Deliverable` to `projects/deliverable`).
           parent_reference = parent_without_namespace.tableize.singularize.tr("/", "_")
           tableized_child = child.tableize.tr("/", "_")
@@ -82,11 +87,6 @@ module BulletTrain
               "bin/super-scaffold crud Section Page,Site,Team title:text body:text\n"
           end
 
-          # get all the attributes.
-          attributes = argv[2..]
-
-          check_required_options_for_attributes("crud", attributes, child, parent)
-
           transformer = Scaffolding::Transformer.new(child, parents, @options)
           transformer.scaffold_crud(attributes)
 

data/lib/bullet_train/super_scaffolding/scaffolders/join_model_scaffolder.rb

@@ -44,6 +44,16 @@ module BulletTrain
           # There should only be two attributes.
           attributes = [argv[1], argv[2]]
 
+          unless @options["skip-migration-generation"]
+            attributes_without_options = attributes.map { |attribute| attribute.gsub(/{.*}$/, "") }
+            attributes_without_id = attributes_without_options.map { |attribute| attribute.gsub(/_id$/, "") }
+            attributes_with_references = attributes_without_id.map { |attribute| attribute + ":references" }
+
+            generation_command = "bin/rails generate model #{child} #{attributes_with_references.join(" ")}"
+            puts "Generating model with '#{generation_command}'".green
+            `#{generation_command}`
+          end
+
           # Pretend we're doing a `super_select` scaffolding because it will do the correct thing.
           attributes = attributes.map { |attribute| attribute.gsub("{", ":super_select{") }
           attributes = attributes.map { |attribute| attribute.gsub("}", ",required}") }

data/lib/bullet_train/super_scaffolding/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module SuperScaffolding
-    VERSION = "1.5.1"
+    VERSION = "1.6.0"
   end
 end

data/lib/scaffolding/attribute.rb

@@ -167,6 +167,8 @@ class Scaffolding::Attribute
       "text"
     when "number_field"
       "number"
+    when "address_field"
+      "address"
     else
       raise "Invalid field type: #{type}."
     end

data/lib/scaffolding/script.rb

@@ -7,6 +7,28 @@ require "scaffolding/routes_file_manipulator"
 
 require_relative "../bullet_train/terminal_commands"
 
+FIELD_PARTIALS = {
+  address_field: nil,
+  boolean: "boolean",
+  buttons: "string",
+  cloudinary_image: "string",
+  color_picker: "string",
+  date_and_time_field: "datetime",
+  date_field: "date",
+  email_field: "string",
+  emoji_field: "string",
+  file_field: "attachment",
+  image: "attachment",
+  options: "string",
+  password_field: "string",
+  phone_field: "string",
+  super_select: "string",
+  text_area: "text",
+  text_field: "string",
+  number_field: "integer",
+  trix_editor: "text"
+}
+
 # filter out options.
 argv = []
 @options = {}
@@ -29,10 +51,49 @@ def standard_protip
 end
 
 def check_required_options_for_attributes(scaffolding_type, attributes, child, parent = nil)
+  tableized_parent = nil
+
+  # Ensure the parent attribute name has the proper namespacing for adding as a foreign key.
+  if parent.present?
+    if child.include?("::") && parent.include?("::")
+      child_parts = child.split("::")
+      parent_parts = parent.split("::")
+      child_parts_dup = child_parts.dup
+      parent_parts_dup = parent_parts.dup
+
+      # Pop off however many spaces match.
+      child_parts_dup.each.with_index do |child_part, idx|
+        if child_part == parent_parts_dup[idx]
+          child_parts.shift
+          parent_parts.shift
+        else
+          tableized_parent = parent_parts.map(&:downcase).join("_")
+          break
+        end
+      end
+    end
+    # In case we're not working with namespaces, just tableize the parent as is.
+    tableized_parent ||= parent.tableize.singularize.tr("/", "_") if parent.present?
+  end
+
+  generation_command = case scaffolding_type
+  when "crud"
+    "bin/rails generate model #{child} #{tableized_parent}:references"
+  when "crud-field"
+    "" # This is blank so we can create the proper migration name first after we get the attributes.
+  end
+
+  # Even if there are attributes passed to the scaffolder,
+  # They may already exist in previous migrations, so we
+  # only register ones that need to be generated.
+  # i.e. - *_ids attributes in the join-model scaffolder.
+  attributes_to_generate = []
+
   attributes.each do |attribute|
     parts = attribute.split(":")
     name = parts.shift
     type = parts.join(":")
+    type_without_option = type.gsub(/{.*}/, "")
 
     unless Scaffolding.valid_attribute_type?(type)
       raise "You have entered an invalid attribute type: #{type}. General data types are used when creating new models, but Bullet Train " \
@@ -53,6 +114,19 @@ def check_required_options_for_attributes(scaffolding_type, attributes, child, p
       {}
     end
 
+    data_type = if type == "image" && cloudinary_enabled?
+      "string"
+    elsif attribute_options[:multiple]
+      case type
+      when "file"
+        "attachments"
+      else
+        "jsonb"
+      end
+    else
+      FIELD_PARTIALS[type_without_option.to_sym]
+    end
+
     if name.match?(/_id$/) || name.match?(/_ids$/)
       attribute_options ||= {}
       unless attribute_options[:vanilla]
@@ -85,6 +159,31 @@ def check_required_options_for_attributes(scaffolding_type, attributes, child, p
         end
       end
     end
+
+    # TODO: Is there ever a case that we want this to be a string?
+    data_type = "references" if name.match?(/_id$/)
+
+    # For join models, we don't want to generate a migration when
+    # running the crud-field scaffolder in the last step, so we skip *_ids.
+    # Addresses belong_to :addressable, so they don't hae to be represented in a migration.
+    unless name.match?(/_ids$/) || data_type.nil?
+      generation_command += " #{name_without_id || name}:#{data_type}"
+      attributes_to_generate << name
+    end
+  end
+
+  # Generate the models/migrations with the attributes passed.
+  if attributes_to_generate.any?
+    case scaffolding_type
+    # "join-model" is not here because the `rails g` command is written inline in its own scaffolder.
+    when "crud"
+      puts "Generating #{child} model with '#{generation_command}'".green
+    when "crud-field"
+      generation_command = "bin/rails generate migration add_#{attributes_to_generate.join("_and_")}_to_#{child.tableize.tr("/", "_")}#{generation_command}"
+      puts "Adding new fields to #{child} with '#{generation_command}'".green
+    end
+    puts ""
+    `#{generation_command}` unless @options["skip-migration-generation"]
   end
 end
 
@@ -120,35 +219,16 @@ elsif ARGV.first.present?
   when "--field-partials"
     puts "Bullet Train uses the following field partials for Super Scaffolding".blue
     puts ""
-    field_partials = {
-      boolean: "boolean",
-      buttons: "string",
-      cloudinary_image: "string",
-      color_picker: "string",
-      date_and_time_field: "datetime",
-      date_field: "date_field",
-      email_field: "string",
-      emoji_field: "string",
-      file_field: "attachment",
-      options: "string",
-      password_field: "string",
-      phone_field: "string",
-      super_select: "string",
-      text_area: "text",
-      text_field: "string",
-      number_field: "integer",
-      trix_editor: "text"
-    }
 
     max_name_length = 0
-    field_partials.each do |key, value|
+    FIELD_PARTIALS.each do |key, value|
       if key.to_s.length > max_name_length
         max_name_length = key.to_s.length
       end
     end
 
     printf "\t%#{max_name_length}s:Data Type\n".bold, "Field Partial Name"
-    field_partials.each { |key, value| printf "\t%#{max_name_length}s:#{value}\n", key }
+    FIELD_PARTIALS.each { |key, value| printf "\t%#{max_name_length}s:#{value}\n", key }
 
     puts ""
     puts "For more details, check out the documentation:"

data/lib/scaffolding/transformer.rb

@@ -102,7 +102,7 @@ class Scaffolding::Transformer
       "absolutely_abstract/creative_concepts",
       "completely_concrete/tangible_things",
       "absolutely-abstract-creative-concepts",
-      "completely-concrete-tangible-things",
+      "completely-concrete-tangible-things"
     ]
 
     class_name = [
@@ -115,7 +115,7 @@ class Scaffolding::Transformer
       "Creative concepts",
       "Tangible things",
       "creative concepts",
-      "tangible things",
+      "tangible things"
     ]
 
     (
@@ -870,8 +870,11 @@ class Scaffolding::Transformer
           <td#{cell_attributes}><%= render 'shared/attributes/#{attribute.partial_name}', attribute: :#{attribute.is_vanilla? ? attribute.name : attribute.name_without_id_suffix}#{", #{table_cell_options.join(", ")}" if table_cell_options.any?} %></td>
         ERB
 
-        if attribute.type == "password_field"
+        case attribute.type
+        when "password_field"
           field_content.gsub!(/\s%>/, ", options: { password: true } %>")
+        when "address_field"
+          field_content.gsub!(/\s%>/, ", one_line: true %>")
         end
 
         unless ["Team", "User"].include?(child)
@@ -958,6 +961,20 @@ class Scaffolding::Transformer
             if attribute.type == "file_field"
               scaffold_add_line_to_file(file, "#{attribute.name}_removal: [],", RUBY_NEW_ARRAYS_HOOK, prepend: true)
             end
+          elsif attribute.type == "address_field"
+            address_strong_params = <<~RUBY
+              #{attribute.name}_attributes: [
+                :id,
+                :_destroy,
+                :address_one,
+                :address_two,
+                :city,
+                :country_id,
+                :region_id,
+                :postal_code
+              ],
+            RUBY
+            scaffold_add_line_to_file(file, address_strong_params, RUBY_NEW_ARRAYS_HOOK, prepend: true)
           else
             scaffold_add_line_to_file(file, ":#{attribute.name},", RUBY_NEW_FIELDS_HOOK, prepend: true)
             if attribute.type == "file_field"
@@ -969,6 +986,28 @@ class Scaffolding::Transformer
         scaffold_add_line_to_file("./app/controllers/account/scaffolding/completely_concrete/tangible_things_controller.rb", attribute.special_processing, RUBY_NEW_FIELDS_PROCESSING_HOOK, prepend: true) if attribute.special_processing
       end
 
+      #
+      # ASSOCIATED MODELS
+      #
+
+      unless cli_options["skip-form"] || attribute.options[:readonly]
+
+        # set default values for associated models.
+        case attribute.type
+        when "address_field"
+          scaffold_add_line_to_file("./app/controllers/account/scaffolding/completely_concrete/tangible_things_controller.rb", "before_action :set_default_#{attribute.name}, except: :index", "ApplicationController", increase_indent: true)
+
+          method_content = <<~RUBY
+
+            def set_default_#{attribute.name}
+              @tangible_thing.#{attribute.name} ||= Address.new
+            end
+          RUBY
+          scaffold_add_line_to_file("./app/controllers/account/scaffolding/completely_concrete/tangible_things_controller.rb", method_content, "end", prepend: true, increase_indent: true, exact_match: true)
+        end
+
+      end
+
       #
       # API SERIALIZER
       #
@@ -1246,6 +1285,9 @@ class Scaffolding::Transformer
           scaffold_add_line_to_file("./app/models/scaffolding/completely_concrete/tangible_thing.rb", "after_validation :remove_#{attribute.name}, if: :#{attribute.name}_removal?", CALLBACKS_HOOK, prepend: true)
         when "trix_editor"
           scaffold_add_line_to_file("./app/models/scaffolding/completely_concrete/tangible_thing.rb", "has_rich_text :#{attribute.name}", HAS_ONE_HOOK, prepend: true)
+        when "address_field"
+          scaffold_add_line_to_file("./app/models/scaffolding/completely_concrete/tangible_thing.rb", "has_one :#{attribute.name}, class_name: \"Address\", as: :addressable", HAS_ONE_HOOK, prepend: true)
+          scaffold_add_line_to_file("./app/models/scaffolding/completely_concrete/tangible_thing.rb", "accepts_nested_attributes_for :#{attribute.name}", HAS_ONE_HOOK, prepend: true)
         when "buttons"
           if attribute.is_boolean?
             scaffold_add_line_to_file("./app/models/scaffolding/completely_concrete/tangible_thing.rb", "validates :#{attribute.name}, inclusion: [true, false]", VALIDATIONS_HOOK, prepend: true)

data/lib/scaffolding.rb

@@ -7,6 +7,7 @@ module Scaffolding
 
   def self.valid_attribute_type?(type)
     [
+      "address_field",
       "boolean",
       "buttons",
       # TODO: We're leaving cloudinary_image here for now for backwards compatibility.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-super_scaffolding
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Andrew Culver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-02 00:00:00.000000000 Z
+date: 2023-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: masamune-ast
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: indefinite_article
   requirement: !ruby/object:Gem::Requirement