bullet_train-super_scaffolding 1.0.32 → 1.0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f51f2db556dd32be5a81cd6fcf0fc54cca58cd662e61da38289a95a8aecb6d64
-  data.tar.gz: '03957b2a34172dabb98a2ef32fdcb16d3be71eb65963546b746826915e74d4be'
+  metadata.gz: 329a1d276e3bc2b2a89c230d35b8ea6613abc957d34de2319455458e88658ca2
+  data.tar.gz: 27994643a5a47719703a204d849732a9c67382fab553a4decad9984b2b5f08d0
 SHA512:
-  metadata.gz: 8f692ccec6f4cebec181c086562d5b1c5bf59a6e2106cd12fff70df47addf7043157de95d89c5c637068826068e90349a5a5f07acac79c85b8a3ed4f1c63c2bc
-  data.tar.gz: ce76ef0471d6f6f7721c70bcf4645a99ecd8866ece6d48ab3809601a162579f5df90cf5042cce74b9f7ba6dc9e3c3dada590013ee9b614132035ef6fc2108479
+  metadata.gz: 4956a720055fb48e9d26dba793a131b12291cc338bfd025743c34d78fd0f6d6c1f36a702f98ce46c49d10930448b6c87faa8c75d3a8b021d47552c95f2aecbf2
+  data.tar.gz: 783996a02a3482d95714a3d66c0b3119b54b3dd0d7cbbcb58b8f44af403be5c4b2f6524c3a8df7ccb5034f1f3a82ba45f8673f49521b206db9164164d7410748

data/app/controllers/api/v1/scaffolding/completely_concrete/tangible_things_endpoint.rb

@@ -16,6 +16,7 @@ class Api::V1::Scaffolding::CompletelyConcrete::TangibleThingsEndpoint < Api::V1
       optional :date_field_value, type: Date, allow_blank: true, desc: Api.heading(:date_field_value)
       optional :date_and_time_field_value, type: DateTime, allow_blank: true, desc: Api.heading(:date_and_time_field_value)
       optional :email_field_value, type: String, allow_blank: true, desc: Api.heading(:email_field_value)
+      optional :file_field_value, type: String, allow_blank: true, desc: Api.heading(:file_field_value)
       optional :password_field_value, type: String, allow_blank: true, desc: Api.heading(:password_field_value)
       optional :phone_field_value, type: String, allow_blank: true, desc: Api.heading(:phone_field_value)
       optional :option_value, type: String, allow_blank: true, desc: Api.heading(:option_value)

data/app/serializers/api/v1/scaffolding/completely_concrete/tangible_thing_serializer.rb

@@ -1,5 +1,6 @@
 class Api::V1::Scaffolding::CompletelyConcrete::TangibleThingSerializer < Api::V1::ApplicationSerializer
   set_type "scaffolding/completely_concrete/tangible_thing"
+  singleton_class.include Rails.application.routes.url_helpers
 
   attributes :id,
     :absolutely_abstract_creative_concept_id,
@@ -25,5 +26,12 @@ class Api::V1::Scaffolding::CompletelyConcrete::TangibleThingSerializer < Api::V
     :created_at,
     :updated_at
 
+  # 🚅 skip this section when scaffolding.
+  attribute :file_field_value do |object|
+    rails_blob_path(object.file_field_value, disposition: "attachment", only_path: true) if object.file_field_value.attached?
+  end
+  # 🚅 stop any skipping we're doing now.
+  # 🚅 super scaffolding will insert file-related logic above this line.
+
   belongs_to :absolutely_abstract_creative_concept, serializer: Api::V1::Scaffolding::AbsolutelyAbstract::CreativeConceptSerializer
 end

data/app/views/account/scaffolding/completely_concrete/tangible_things/_form.html.erb

@@ -17,7 +17,7 @@
       </div>
     </div>
 
-    <%= render 'shared/fields/color_picker', method: :color_picker_value, options: t('scaffolding/completely_concrete/tangible_things.fields.color_picker_value.options') %>
+    <%= render 'shared/fields/color_picker', method: :color_picker_value, options: {color_picker_options: t('scaffolding/completely_concrete/tangible_things.fields.color_picker_value.options')} %>
     <%= render 'shared/fields/cloudinary_image', method: :cloudinary_image_value %>
     <%= render 'shared/fields/date_field', method: :date_field_value %>
     <%= render 'shared/fields/date_and_time_field', method: :date_and_time_field_value %>

data/lib/bullet_train/super_scaffolding/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module SuperScaffolding
-    VERSION = "1.0.32"
+    VERSION = "1.0.35"
   end
 end

data/lib/scaffolding/block_manipulator.rb

@@ -7,16 +7,16 @@ class Scaffolding::BlockManipulator
   end
 
   #
-  # Wrap a block of ruby code inside another block
+  # Wrap a block of ruby code with another block on the outside.
   #
-  # @param [String] starting A string to search for at the start of the block. Eg "<%= updates_for context, collection do"
-  # @param [Array] with An array with two String elements. The text that should wrap the block. Eg ["<%= action_model_select_controller do %>", "<% end %>"]
+  # @param [String] `starting` A string to search for at the start of the block. Eg "<%= updates_for context, collection do"
+  # @param [Array] `with` An array with two String elements. The text that should wrap the block. Eg ["<%= action_model_select_controller do %>", "<% end %>"]
   #
   def wrap_block(starting:, with:)
     with[0] += "\n" unless with[0].match?(/\n$/)
     with[1] += "\n" unless with[1].match?(/\n$/)
     starting_line = find_block_start(starting)
-    end_line = find_block_end(starting_from: starting_line)
+    end_line = find_block_end(starting_from: starting_line, lines: @lines)
 
     final = []
     block_indent = ""
@@ -55,13 +55,13 @@ class Scaffolding::BlockManipulator
     end_line = @lines.count - 1
     if within.present?
       start_line = find_block_start(within)
-      end_line = find_block_end(starting_from: start_line)
+      end_line = find_block_end(starting_from: start_line, lines: @lines)
       # start_line += 1 # ensure we actually insert the content _within_ the given block
       # end_line += 1 if end_line == start_line
     end
     if after_block.present?
       block_start = find_block_start(after_block)
-      block_end = find_block_end(starting_from: block_start)
+      block_end = find_block_end(starting_from: block_start, lines: @lines)
       start_line = block_end
       end_line = @lines.count - 1
     end
@@ -102,15 +102,28 @@ class Scaffolding::BlockManipulator
 
   def insert_block(block_content, after_block:)
     block_start = find_block_start(after_block)
-    block_end = find_block_end(starting_from: block_start)
+    block_end = find_block_end(starting_from: block_start, lines: @lines)
     insert_line(block_content[0], block_end)
     insert_line(block_content[1], block_end + 1)
   end
 
+  # TODO: Delete this because it only really needs to be in the FileManipulator
   def write
     File.write(@filepath, @lines.join)
   end
 
+  def find_block_parent(starting_line_number, lines)
+    return nil unless indentation_of(starting_line_number, lines)
+    cursor = starting_line_number
+    while cursor >= 0
+      unless lines[cursor].match?(/^#{indentation_of(starting_line_number, lines)}/) || !lines[cursor].present?
+        return cursor
+      end
+      cursor -= 1
+    end
+    nil
+  end
+
   def find_block_start(starting_string)
     matcher = Regexp.escape(starting_string)
     starting_line = 0
@@ -124,7 +137,15 @@ class Scaffolding::BlockManipulator
     starting_line
   end
 
-  def find_block_end(starting_from:)
+  def find_block_end(starting_from:, lines:)
+    # This loop was previously in the RoutesFileManipulator.
+    lines.each_with_index do |line, line_number|
+      next unless line_number > starting_from
+      if /^#{indentation_of(starting_from, lines)}end\s+/.match?(line)
+        return line_number
+      end
+    end
+
     depth = 0
     current_line = starting_from
     @lines[starting_from..@lines.count].each_with_index do |line, index|
@@ -138,7 +159,12 @@ class Scaffolding::BlockManipulator
     current_line
   end
 
-  def block_indentation_size(line_number)
-    lines[line_number].scan(/^\s+/).first.size
+  # TODO: We shouldn't need this second argument, but since
+  # we have `lines` here and in the RoutesFileManipulator,
+  # the lines diverge from one another when we edit them individually.
+  def indentation_of(line_number, lines)
+    lines[line_number].match(/^( +)/)[1]
+  rescue
+    nil
   end
 end

data/lib/scaffolding/file_manipulator.rb

@@ -0,0 +1,71 @@
+require "scaffolding/block_manipulator"
+
+# TODO: If we move this and the BlockManipulator into their own gems,
+# we can probably call these methods with something shorter without `Scaffolding::`.
+module Scaffolding::FileManipulator
+  # TODO: The block_manipulator shouldn't be an instance variable.
+  def self.find(lines, needle, within = nil, block_manipulator)
+    lines_within(lines, within, block_manipulator).each_with_index do |line, line_number|
+      return (within + (within ? 1 : 0) + line_number) if line.match?(needle)
+    end
+    nil
+  end
+
+  # TODO: The block_manipulator shouldn't be an instance variable.
+  def self.lines_within(lines, within, block_manipulator)
+    return lines unless within
+    lines[(within + 1)..(block_manipulator.find_block_end(starting_from: within, lines: lines) + 1)]
+  end
+
+  def self.replace_line_in_file(file, content, in_place_of)
+    target_file_content = File.read(file)
+
+    if target_file_content.include?(content)
+      puts "No need to update '#{file}'. It already has '#{content}'."
+    else
+      puts "Updating '#{file}'."
+      target_file_content.gsub!(in_place_of, content)
+      File.write(file, target_file_content)
+    end
+  end
+
+  # Pass in an array where this content should be inserted within the yml file.
+  # For example, to add content to admin.models pass in [:admin, :models]
+  def self.add_line_to_yml_file(file, content, location_array)
+    # First check that the given location array actually exists in the yml file:
+    yml = YAML.safe_load(File.read(file))
+    location_array.map!(&:to_s)
+
+    # TODO: Raise an error if we're returning nil.
+    return nil if yml.dig(*location_array).nil?
+
+    content += "\n" unless content[-1] == "\n"
+    # Find the location in the file where the location_array is
+    lines = File.readlines(file)
+    current_needle = location_array.shift.to_s
+    current_space = ""
+    insert_after = 1
+    lines.each_with_index do |line, index|
+      break if current_needle.nil?
+      if line.strip == current_needle + ":"
+        current_needle = location_array.shift.to_s
+        insert_after = index
+        current_space = line.match(/\s+/).to_s
+      end
+    end
+    new_lines = []
+    current_space += "  "
+    lines.each_with_index do |line, index|
+      new_lines << line
+      new_lines << current_space + content if index == insert_after
+    end
+    File.write(file, new_lines.join)
+  end
+
+  def self.write(file_name, lines)
+    puts "Updating '#{file_name}'."
+    File.open(file_name, "w+") do |file|
+      file.puts(lines.join.strip + "\n")
+    end
+  end
+end

data/lib/scaffolding/routes_file_manipulator.rb

@@ -1,3 +1,5 @@
+require "scaffolding/block_manipulator"
+
 class Scaffolding::RoutesFileManipulator
   attr_accessor :child, :parent, :lines, :transformer_options, :block_manipulator
 
@@ -66,7 +68,7 @@ class Scaffolding::RoutesFileManipulator
   def find_namespaces(namespaces, within = nil)
     namespaces = namespaces.dup
     results = {}
-    block_end = find_block_end(within) if within
+    block_end = block_manipulator.find_block_end(starting_from: within, lines: lines) if within
     lines.each_with_index do |line, line_number|
       if within
         next unless line_number > within
@@ -80,47 +82,20 @@ class Scaffolding::RoutesFileManipulator
     results
   end
 
-  def indentation_of(line_number)
-    lines[line_number].match(/^( +)/)[1]
-  rescue
-    nil
-  end
-
-  def find_block_parent(starting_line_number)
-    return nil unless indentation_of(starting_line_number)
-    cursor = starting_line_number
-    while cursor >= 0
-      unless lines[cursor].match?(/^#{indentation_of(starting_line_number)}/) || !lines[cursor].present?
-        return cursor
-      end
-      cursor -= 1
-    end
-    nil
-  end
-
-  def find_block_end(starting_line_number)
-    return nil unless indentation_of(starting_line_number)
-    lines.each_with_index do |line, line_number|
-      next unless line_number > starting_line_number
-      if /^#{indentation_of(starting_line_number)}end\s+/.match?(line)
-        return line_number
-      end
-    end
-    nil
-  end
-
+  # TODO: Remove this and use the BlockManipulator
   def insert_before(new_lines, line_number, options = {})
     options[:indent] ||= false
     before = lines[0..(line_number - 1)]
-    new_lines = new_lines.map { |line| (indentation_of(line_number) + (options[:indent] ? "  " : "") + line).gsub(/\s+$/, "") + "\n" }
+    new_lines = new_lines.map { |line| (block_manipulator.indentation_of(line_number, lines) + (options[:indent] ? "  " : "") + line).gsub(/\s+$/, "") + "\n" }
     after = lines[line_number..]
     self.lines = before + (options[:prepend_newline] ? ["\n"] : []) + new_lines + after
   end
 
+  # TODO: Remove this and use the BlockManipulator
   def insert_after(new_lines, line_number, options = {})
     options[:indent] ||= false
     before = lines[0..line_number]
-    new_lines = new_lines.map { |line| (indentation_of(line_number) + (options[:indent] ? "  " : "") + line).gsub(/\s+$/, "") + "\n" }
+    new_lines = new_lines.map { |line| (block_manipulator.indentation_of(line_number, lines) + (options[:indent] ? "  " : "") + line).gsub(/\s+$/, "") + "\n" }
     after = lines[(line_number + 1)..]
     self.lines = before + new_lines + (options[:append_newline] ? ["\n"] : []) + after
   end
@@ -129,7 +104,7 @@ class Scaffolding::RoutesFileManipulator
     namespace_lines = find_namespaces(namespaces, within)
     if namespace_lines[namespaces.last]
       block_start = namespace_lines[namespaces.last]
-      insertion_point = find_block_end(block_start)
+      insertion_point = block_manipulator.find_block_end(starting_from: block_start, lines: lines)
       insert_before(new_lines, insertion_point, indent: true, prepend_newline: (insertion_point > block_start + 1))
     else
       raise "we weren't able to insert the following lines into the namespace block for #{namespaces.join(" -> ")}:\n\n#{new_lines.join("\n")}"
@@ -191,21 +166,13 @@ class Scaffolding::RoutesFileManipulator
     namespace_block_start.present? ? {namespace => namespace_block_start} : {}
   end
 
-  def find(needle, within = nil)
-    lines_within(within).each_with_index do |line, line_number|
-      return (within + (within ? 1 : 0) + line_number) if line.match?(needle)
-    end
-
-    nil
-  end
-
   def find_in_namespace(needle, namespaces, within = nil, ignore = nil)
     if namespaces.any?
       namespace_lines = find_namespaces(namespaces, within)
       within = namespace_lines[namespaces.last]
     end
 
-    lines_within(within).each_with_index do |line, line_number|
+    Scaffolding::FileManipulator.lines_within(lines, within, block_manipulator).each_with_index do |line, line_number|
       # + 2 because line_number starts from 0, and within starts one line after
       actual_line_number = (within + line_number + 2)
 
@@ -259,7 +226,7 @@ class Scaffolding::RoutesFileManipulator
   # However, will not find namespace blocks inside namespace blocks.
   def top_level_namespace_block_lines(within)
     local_namespace_blocks = []
-    lines_within(within).each do |line|
+    Scaffolding::FileManipulator.lines_within(lines, within, block_manipulator).each do |line|
       # i.e. - Retrieve "foo" from "namespace :foo do"
       match_data = line.match(/(\s*namespace\s:)(.*)(\sdo$)/)
 
@@ -269,7 +236,7 @@ class Scaffolding::RoutesFileManipulator
         namespace_name = match_data[2]
         local_namespace = find_namespaces([namespace_name], within)
         starting_line_number = local_namespace[namespace_name]
-        local_namespace_block = ((starting_line_number + 1)..(find_block_end(starting_line_number) + 1))
+        local_namespace_block = ((starting_line_number + 1)..(block_manipulator.find_block_end(starting_from: starting_line_number, lines: lines) + 1))
 
         if local_namespace_blocks.empty?
           local_namespace_blocks << local_namespace_block
@@ -296,11 +263,11 @@ class Scaffolding::RoutesFileManipulator
   def namespace_blocks_directly_under_parent(within)
     blocks = []
     if lines[within].match?(/do$/)
-      parent_indentation_size = block_manipulator.block_indentation_size(within)
-      within_block_end = find_block_end(within)
+      parent_indentation_size = block_manipulator.indentation_of(within, lines).length
+      within_block_end = block_manipulator.find_block_end(starting_from: within, lines: lines)
       within.upto(within_block_end) do |line_number|
         if lines[line_number].match?(/^#{" " * (parent_indentation_size + 2)}namespace/)
-          namespace_block_lines = line_number..find_block_end(line_number)
+          namespace_block_lines = line_number..block_manipulator.find_block_end(starting_from: line_number, lines: lines)
           blocks << namespace_block_lines
         end
       end
@@ -313,11 +280,6 @@ class Scaffolding::RoutesFileManipulator
     find_or_convert_resource_block(parts.last, options)
   end
 
-  def lines_within(within)
-    return lines unless within
-    lines[(within + 1)..(find_block_end(within) + 1)]
-  end
-
   def find_or_convert_resource_block(parent_resource, options = {})
     unless find_resource_block([parent_resource], options)
       if (resource_line_number = find_resource([parent_resource], options))
@@ -337,8 +299,9 @@ class Scaffolding::RoutesFileManipulator
     within
   end
 
+  # TODO: Remove this and use the BlockManipulator
   def insert(lines_to_add, within)
-    insertion_line = find_block_end(within)
+    insertion_line = block_manipulator.find_block_end(starting_from: within, lines: lines)
     result_line = insertion_line
     unless insertion_line == within + 1
       # only put the extra space if we're adding this line after a block
@@ -370,7 +333,7 @@ class Scaffolding::RoutesFileManipulator
       # add the new resource within that namespace.
       line = "scope module: '#{parent_resource}' do"
       # TODO you haven't tested this yet.
-      unless (scope_within = find(/#{line}/, parent_within))
+      unless (scope_within = Scaffolding::FileManipulator.find(lines, /#{line}/, parent_within, block_manipulator))
         scope_within = insert([line, "end"], parent_within)
       end
 
@@ -382,7 +345,7 @@ class Scaffolding::RoutesFileManipulator
 
       # We want to see if there are any namespaces one level above the parent itself,
       # because namespaces with the same name as the resource can exist on the same level.
-      parent_block_start = find_block_parent(parent_within)
+      parent_block_start = block_manipulator.find_block_parent(parent_within, lines)
       namespace_line_within = find_or_create_namespaces(child_namespaces, parent_block_start)
       find_or_create_resource([child_resource], options: "except: collection_actions", within: namespace_line_within)
       unless find_namespaces(child_namespaces, within)[child_namespaces.last]
@@ -401,7 +364,7 @@ class Scaffolding::RoutesFileManipulator
       # resources :projects_deliverables, path: 'projects/deliverables' do
       #   resources :objectives
       # end
-      block_parent_within = find_block_parent(top_parent_namespace)
+      block_parent_within = block_manipulator.find_block_parent(top_parent_namespace, lines)
       parent_namespaces_and_resource = (parent_namespaces + [parent_resource]).join("_")
       parent_within = find_or_create_resource_block([parent_namespaces_and_resource], options: "path: '#{parent_namespaces_and_resource.tr("_", "/")}'", within: block_parent_within)
       find_or_create_resource(child_namespaces + [child_resource], within: parent_within)
@@ -426,11 +389,4 @@ class Scaffolding::RoutesFileManipulator
     return if concerns.empty?
     "concerns: #{concerns}"
   end
-
-  def write
-    puts "Updating '#{@filename}'."
-    File.open(@filename, "w+") do |file|
-      file.puts(lines.join.strip + "\n")
-    end
-  end
 end

data/lib/scaffolding/transformer.rb

@@ -1,5 +1,6 @@
 require "indefinite_article"
 require "yaml"
+require "scaffolding/file_manipulator"
 require "scaffolding/class_names_transformer"
 
 class Scaffolding::Transformer
@@ -20,6 +21,7 @@ class Scaffolding::Transformer
   RUBY_NEW_FIELDS_HOOK = "# 🚅 super scaffolding will insert new fields above this line."
   RUBY_ADDITIONAL_NEW_FIELDS_HOOK = "# 🚅 super scaffolding will also insert new fields above this line."
   RUBY_EVEN_MORE_NEW_FIELDS_HOOK = "# 🚅 super scaffolding will additionally insert new fields above this line."
+  RUBY_FILES_HOOK = "# 🚅 super scaffolding will insert file-related logic above this line."
   ENDPOINTS_HOOK = "# 🚅 super scaffolding will mount new endpoints above this line."
   ERB_NEW_FIELDS_HOOK = "<%#{RUBY_NEW_FIELDS_HOOK} %>"
   CONCERNS_HOOK = "# 🚅 add concerns above."
@@ -235,36 +237,6 @@ class Scaffolding::Transformer
     end
   end
 
-  # pass in an array where this content should be inserted within the yml file.  For example, to add content
-  # to admin.models pass in [:admin, :models]
-  def add_line_to_yml_file(file, content, location_array)
-    # First check that the given location array actually exists in the yml file:
-    yml = YAML.safe_load(File.read(file))
-    location_array.map!(&:to_s)
-    return nil if yml.dig(*location_array).nil? # Should we raise an error?
-    content += "\n" unless content[-1] == "\n"
-    # Find the location in the file where the location_array is
-    lines = File.readlines(file)
-    current_needle = location_array.shift.to_s
-    current_space = ""
-    insert_after = 1
-    lines.each_with_index do |line, index|
-      break if current_needle.nil?
-      if line.strip == current_needle + ":"
-        current_needle = location_array.shift.to_s
-        insert_after = index
-        current_space = line.match(/\s+/).to_s
-      end
-    end
-    new_lines = []
-    current_space += "  "
-    lines.each_with_index do |line, index|
-      new_lines << line
-      new_lines << current_space + content if index == insert_after
-    end
-    File.write(file, new_lines.join)
-  end
-
   def add_line_to_file(file, content, hook, options = {})
     increase_indent = options[:increase_indent]
     add_before = options[:add_before]
@@ -346,23 +318,11 @@ class Scaffolding::Transformer
     add_line_to_file(file, content, hook, options)
   end
 
-  def replace_line_in_file(file, content, in_place_of)
-    target_file_content = File.read(file)
-
-    if target_file_content.include?(content)
-      puts "No need to update '#{file}'. It already has '#{content}'."
-    else
-      puts "Updating '#{file}'."
-      target_file_content.gsub!(in_place_of, content)
-      File.write(file, target_file_content)
-    end
-  end
-
   def scaffold_replace_line_in_file(file, content, in_place_of)
     file = transform_string(file)
     # we specifically don't transform the content, we assume a builder function created this content.
     in_place_of = transform_string(in_place_of)
-    replace_line_in_file(file, content, in_place_of)
+    Scaffolding::FileManipulator.replace_line_in_file(file, content, in_place_of)
   end
 
   # if class_name isn't specified, we use `child`.
@@ -451,8 +411,8 @@ class Scaffolding::Transformer
     model_names = class_names || [child]
     role_file = "./config/models/roles.yml"
     model_names.each do |model_name|
-      add_line_to_yml_file(role_file, "#{model_name}: read", [:default, :models])
-      add_line_to_yml_file(role_file, "#{model_name}: manage", [:admin, :models])
+      Scaffolding::FileManipulator.add_line_to_yml_file(role_file, "#{model_name}: read", [:default, :models])
+      Scaffolding::FileManipulator.add_line_to_yml_file(role_file, "#{model_name}: manage", [:admin, :models])
     end
   end
 
@@ -480,7 +440,7 @@ class Scaffolding::Transformer
       current_parent = working_parents.pop
     end
 
-    setup_lines << current_transformer.transform_string("@tangible_thing = create(:scaffolding_completely_concrete_tangible_thing, #{previous_assignment})")
+    setup_lines << current_transformer.transform_string("@tangible_thing = build(:scaffolding_completely_concrete_tangible_thing, #{previous_assignment})")
 
     setup_lines
   end
@@ -615,7 +575,9 @@ class Scaffolding::Transformer
       is_id = name.match?(/_id$/)
       is_ids = name.match?(/_ids$/)
       # if this is the first attribute of a newly scaffolded model, that field is required.
-      is_required = attribute_options[:required] || (scaffolding_options[:type] == :crud && index == 0)
+      unless type == "file_field"
+        is_required = attribute_options[:required] || (scaffolding_options[:type] == :crud && index == 0)
+      end
       is_vanilla = attribute_options&.key?(:vanilla)
       is_belongs_to = is_id && !is_vanilla
       is_has_many = is_ids && !is_vanilla
@@ -653,6 +615,8 @@ class Scaffolding::Transformer
         "date_and_time"
       when "email_field"
         "email"
+      when "emoji_field"
+        "text"
       when "color_picker"
         "code"
       when "text_field"
@@ -660,7 +624,7 @@ class Scaffolding::Transformer
       when "text_area"
         "text"
       when "file_field"
-        "text"
+        "file"
       else
         raise "Invalid attribute type: #{type}."
       end
@@ -765,16 +729,21 @@ class Scaffolding::Transformer
         # field on the form.
         field_attributes = {method: ":#{name}"}
         field_options = {}
+        options = {}
 
         if scaffolding_options[:type] == :crud && index == 0
           field_options[:autofocus] = "true"
         end
 
         if is_id && type == "super_select"
-          field_options[:include_blank] = "t('.fields.#{name}.placeholder')"
+          options[:include_blank] = "t('.fields.#{name}.placeholder')"
           # add_additional_step :yellow, transform_string("We've added a reference to a `placeholder` to the form for the select or super_select field, but unfortunately earlier versions of the scaffolded locales Yaml don't include a reference to `fields: *fields` under `form`. Please add it, otherwise your form won't be able to locate the appropriate placeholder label.")
         end
 
+        if type == "color_picker"
+          field_options[:color_picker_options] = "t('#{child.pluralize.underscore}.fields.color_picker_value.options')"
+        end
+
         # TODO: This feels incorrect.
         # Should we adjust the partials to only use `{multiple: true}` or `html_options: {multiple_true}`?
         if is_multiple
@@ -792,12 +761,19 @@ class Scaffolding::Transformer
         end
 
         # https://stackoverflow.com/questions/21582464/is-there-a-ruby-hashto-s-equivalent-for-the-new-hash-syntax
-        if field_options.any?
+        if field_options.any? || options.any?
           field_options_key = if ["buttons", "super_select", "options"].include?(type)
+            if options.any?
+              field_attributes[:options] = "{" + field_options.map { |key, value| "#{key}: #{value}" }.join(", ") + "}"
+            end
+
             :html_options
           else
+            field_options.merge!(options)
+
             :options
           end
+
           field_attributes[field_options_key] = "{" + field_options.map { |key, value| "#{key}: #{value}" }.join(", ") + "}"
         end
 
@@ -1034,7 +1010,7 @@ class Scaffolding::Transformer
         # TODO The serializers can't handle these `has_rich_text` attributes.
         unless type == "trix_editor"
           scaffold_add_line_to_file("./app/views/account/scaffolding/completely_concrete/tangible_things/_tangible_thing.json.jbuilder", ":#{name},", RUBY_NEW_FIELDS_HOOK, prepend: true, suppress_could_not_find: true)
-          scaffold_add_line_to_file("./app/serializers/api/v1/scaffolding/completely_concrete/tangible_thing_serializer.rb", ":#{name},", RUBY_NEW_FIELDS_HOOK, prepend: true)
+          scaffold_add_line_to_file("./app/serializers/api/v1/scaffolding/completely_concrete/tangible_thing_serializer.rb", ":#{name},", RUBY_NEW_FIELDS_HOOK, prepend: true) unless type == "file_field"
 
           assertion = case type
           when "date_field"
@@ -1043,13 +1019,31 @@ class Scaffolding::Transformer
             "assert_equal DateTime.parse(tangible_thing_data['#{name}']), tangible_thing.#{name}"
           when "file_field"
             # TODO: If we want to use Cloudinary to handle our files, we should make sure we're getting a URL.
-            "assert_equal tangible_thing_data['#{name}']['record']['id'], tangible_thing.#{name}.record.id"
+            "assert tangible_thing_data['#{name}'].match?('foo.txt') unless response.status == 201"
           else
             "assert_equal tangible_thing_data['#{name}'], tangible_thing.#{name}"
           end
           scaffold_add_line_to_file("./test/controllers/api/v1/scaffolding/completely_concrete/tangible_things_endpoint_test.rb", assertion, RUBY_NEW_FIELDS_HOOK, prepend: true)
         end
 
+        # File fields are handled in a specific way when using the jsonapi-serializer.
+        if type == "file_field"
+          file_name = "./app/serializers/api/v1/scaffolding/completely_concrete/tangible_thing_serializer.rb"
+          content = <<~RUBY
+            attribute :#{name} do |object|
+              rails_blob_path(object.#{name}, disposition: "attachment", only_path: true) if object.#{name}.attached?
+            end
+
+          RUBY
+          hook = RUBY_FILES_HOOK
+          scaffold_add_line_to_file(file_name, content, hook, prepend: true)
+
+          # We also want to make sure we attach the dummy file in the endpoint test on setup
+          file_name = "./test/controllers/api/v1/scaffolding/completely_concrete/tangible_things_endpoint_test.rb"
+          content = "@#{child.underscore}.#{name} = Rack::Test::UploadedFile.new(\"test/support/foo.txt\")"
+          scaffold_add_line_to_file(file_name, content, hook, prepend: true)
+        end
+
         # scaffold_add_line_to_file("./test/controllers/api/v1/scaffolding/completely_concrete/tangible_things_controller_test.rb", "assert_equal tangible_thing_attributes['#{name.gsub('_', '-')}'], tangible_thing.#{name}", RUBY_NEW_FIELDS_HOOK, prepend: true)
 
         if attribute_assignment
@@ -1291,15 +1285,6 @@ class Scaffolding::Transformer
 
       add_has_many_association
 
-      # Adds file attachment to factory
-      attributes.each do |attribute|
-        attribute_name, partial_type = attribute.split(":")
-        if partial_type == "file_field"
-          content = "#{attribute_name} { Rack::Test::UploadedFile.new(\"test/support/foo.txt\") }"
-          scaffold_replace_line_in_file("./test/factories/scaffolding/completely_concrete/tangible_things.rb", content, "#{attribute_name} { nil }")
-        end
-      end
-
       if class_names_transformer.belongs_to_needs_class_definition?
         scaffold_replace_line_in_file("./app/models/scaffolding/completely_concrete/tangible_thing.rb", transform_string("belongs_to :absolutely_abstract_creative_concept, class_name: \"Scaffolding::AbsolutelyAbstract::CreativeConcept\"\n"), transform_string("belongs_to :absolutely_abstract_creative_concept\n"))
       end
@@ -1347,7 +1332,7 @@ class Scaffolding::Transformer
       end
 
       unless cli_options["skip-table"]
-        scaffold_replace_line_in_file("./app/views/account/scaffolding/completely_concrete/tangible_things/_index.html.erb", transform_string("<tbody data-reorder=\"<%= url_for [:reorder, :account, context, collection] %>\">"), "<tbody>")
+        scaffold_replace_line_in_file("./app/views/account/scaffolding/completely_concrete/tangible_things/_index.html.erb", transform_string("<tbody data-controller=\"sortable\" data-sortable-reorder-path-value=\"<%= url_for [:reorder, :account, context, collection] %>\">"), "<tbody>")
       end
 
       unless cli_options["skip-controller"]
@@ -1401,7 +1386,7 @@ class Scaffolding::Transformer
         add_additional_step :yellow, "We weren't able to automatically add your `#{routes_namespace}` routes for you. In theory this should be very rare, so if you could reach out on Slack, you could probably provide context that will help us fix whatever the problem was. In the meantime, to add the routes manually, we've got a guide at https://blog.bullettrain.co/nested-namespaced-rails-routing-examples/ ."
       end
 
-      routes_manipulator.write
+      Scaffolding::FileManipulator.write("config/routes.rb", routes_manipulator.lines)
     end
 
     unless cli_options["skip-parent"]
@@ -1412,13 +1397,18 @@ class Scaffolding::Transformer
           icon_name = cli_options["sidebar"]
         else
           puts ""
-          puts "Hey, models that are scoped directly off of a Team (or nothing) are eligible to be added to the sidebar. Do you want to add this resource to the sidebar menu? (y/N)"
+          puts "Hey, models that are scoped directly off of a Team (or nothing) are eligible to be added to the sidebar."
+          puts "Do you want to add this resource to the sidebar menu? (y/N)"
           response = $stdin.gets.chomp
           if response.downcase[0] == "y"
             puts ""
-            puts "OK, great! Let's do this! By default these menu items appear with a puzzle piece, but after you hit enter I'll open two different pages where you can view other icon options. When you find one you like, hover your mouse over it and then come back here and and enter the name of the icon you want to use. (Or hit enter to skip this step.)"
+            puts "OK, great! Let's do this! By default these menu items appear as a #{font_awesome? ? "puzzle piece" : "gift icon"},"
+            puts "but after you hit enter I'll open #{font_awesome? ? "two different pages" : "a page"} where you can view other icon options."
+            puts "When you find one you like, hover your mouse over it and then come back here and"
+            puts "enter the name of the icon you want to use."
+            puts "(Or hit enter when choosing to skip this step.)"
             $stdin.gets.chomp
-            if `which open`.present?
+            if (TerminalCommands.macosx? && `which open`.present?) || TerminalCommands.linux?
               TerminalCommands.open_file_or_link("https://themify.me/themify-icons")
               if font_awesome?
                 TerminalCommands.open_file_or_link("https://fontawesome.com/icons?d=gallery&s=light")
@@ -1433,8 +1423,18 @@ class Scaffolding::Transformer
               puts ""
             end
             puts ""
-            puts "Did you find an icon you wanted to use? Enter the full CSS class here (e.g. 'ti ti-world'#{" or 'fal fa-puzzle-piece'" if font_awesome?}) or hit enter to just use the puzzle piece:"
-            icon_name = $stdin.gets.chomp
+
+            loop do
+              puts "Did you find an icon you wanted to use?"
+              puts "Enter the full CSS class here (e.g. 'ti ti-world'#{" or 'fal fa-puzzle-piece'" if font_awesome?}) or hit enter to just use the #{font_awesome? ? "puzzle piece" : "gift icon"}:"
+              icon_name = $stdin.gets.chomp
+              unless icon_name.match?(/ti\s.*/) || icon_name.match?(/fal\s.*/) || icon_name.strip.empty?
+                puts ""
+                puts "Please enter the full CSS class or hit enter."
+                next
+              end
+              break
+            end
             puts ""
             unless icon_name.length > 0 || icon_name.downcase == "y"
               icon_name = "fal fa-puzzle-piece ti ti-gift"

data/lib/scaffolding.rb

@@ -2,12 +2,13 @@ module Scaffolding
   def self.valid_attribute_type?(type)
     [
       "boolean",
-      "button",
+      "buttons",
       "cloudinary_image",
       "color_picker",
       "date_and_time_field",
       "date_field",
       "email_field",
+      "emoji_field",
       "file_field",
       "options",
       "password_field",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-super_scaffolding
 version: !ruby/object:Gem::Version
-  version: 1.0.32
+  version: 1.0.35
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-02 00:00:00.000000000 Z
+date: 2022-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -166,6 +166,7 @@ files:
 - lib/scaffolding.rb
 - lib/scaffolding/block_manipulator.rb
 - lib/scaffolding/class_names_transformer.rb
+- lib/scaffolding/file_manipulator.rb
 - lib/scaffolding/oauth_providers.rb
 - lib/scaffolding/routes_file_manipulator.rb
 - lib/scaffolding/script.rb