Run rails generate commands automatically when Super Scaffolding

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

@@ -51,6 +51,11 @@ def run
             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 @@ def run
               "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)
 

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

@@ -44,6 +44,16 @@ def run
           # 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}") }

bullet_train-super_scaffolding/lib/scaffolding/script.rb

@@ -7,6 +7,28 @@
 
 require_relative "../bullet_train/terminal_commands"
 
+FIELD_PARTIALS = {
+  address_field: "string",
+  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,30 @@ 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.
+    unless name.match?(/_ids$/)
+      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,36 +218,16 @@ def show_usage
   when "--field-partials"
     puts "Bullet Train uses the following field partials for Super Scaffolding".blue
     puts ""
-    field_partials = {
-      address_field: "string",
-      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:"

bullet_train/docs/action-models.md

@@ -73,7 +73,6 @@ bin/super-scaffold action-model:targets-one-parent
 ### 1. Generate and scaffold an example `Project` model.
 
 ```
-rails g model Project team:references name:string
 bin/super-scaffold crud Project Team name:text_field
 ```
 
@@ -104,7 +103,6 @@ Because Action Models are just regular models, you can add new fields to them wi
 For example:
 
 ```
-rails g migration add_notify_users_to_projects_archive_actions notify_users:boolean
 # side quest: update the generated migration with `default: false` on the new boolean field.
 bin/super-scaffold crud-field Projects::ArchiveAction notify_users:boolean
 ```

bullet_train/docs/field-partials.md

@@ -147,12 +147,15 @@ Certain form field partials like `buttons` and `super_select` can also have thei
 For Cloudinary you should use `string`, and for ActiveStorage you should use `attachment`.
 
 ## A Note On Data Types
-Set the data type to `jsonb` whenever passing the `multiple` option to a new attribute.
+When creating a `multiple` option attribute, Bullet Train generates these values as a `jsonb`.
 ```
-> rails generate model Project team:references multiple_buttons:jsonb
-> bin/super-scaffold crud Project Team multiple_buttons:buttons{multiple}
+bin/super-scaffold crud Project Team multiple_buttons:buttons{multiple}
 ```
 
+This will run the following rails command.
+```
+rails generate model Project team:references multiple_buttons:jsonb
+```
 ## Formating `date` and `date_and_time`
 After Super Scaffolding a `date` or `date_and_time` field, you can pass a format for the object like so:
 

bullet_train/docs/field-partials/file-field.md

@@ -47,6 +47,5 @@ Run the following command to generate the scaffolding for the `documents` field
 If you're starting fresh, and don't have an existing model you can do something like this:
 
 ```
-rails g model Project team:references name:string specification:attachment documents:attachments
 bin/super-scaffold crud Project Team name:text_field specification:file_field documents:file_field{multiple}
 ```

bullet_train/docs/getting-started.md

@@ -8,16 +8,15 @@ Whether you want to build a new application with Bullet Train or contribute to B
 
 If you're using Bullet Train for the first time, begin by learning these five important techniques:
 
-1. Use `rails g model` to create and `bin/super-scaffold crud` to scaffold a new model:
+1. Use `bin/super-scaffold crud` to scaffold a new model:
 
     ```
-    rails g model Project team:references name:string
     bin/super-scaffold crud Project Team name:text_field
     ```
 
     In this example, `Team` refers to the immediate parent of the `Project` resource. For more details, just run `bin/super-scaffold` or [read the documentation](/docs/super-scaffolding.md).
 
-2. Use `rails g migration` and `bin/super-scaffold crud-field` to add a new field to a model you've already scaffolded:
+2. Use `bin/super-scaffold crud-field` to add a new field to a model you've already scaffolded:
 
     ```
     rails g migration add_description_to_projects description:text

bullet_train/docs/modeling.md

@@ -68,7 +68,7 @@ Even if you know there's an attribute or model that you're going to want to poli
 
 ## A Systematic Approach
 
-### 1. Write `rails g` and `bin/super-scaffold` commands in a scratch file.
+### 1. Write `bin/super-scaffold` commands in a scratch file.
 
 See the [Super Scaffolding documentation](/docs/super-scaffolding.md) for more specific guidance. Leave plenty of comments in your scratch file describing anything that isn't obvious and providing examples of values that might populate attributes.