bullet_train-super_scaffolding 1.2.10 → 1.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a6b8531f537d4602893ec912e8b2a5d4c0098418d247273d0bd3b06f6bc6b52
-  data.tar.gz: 2df15d02e422183c0ff5120e886081cde75396ec444fce92c5ec3e0c28c20f81
+  metadata.gz: 175742fbb3b9512721c4250562fc533f6c43cf630f3c277345d59d61538a3364
+  data.tar.gz: 83933564920e87dc260767af664fcba01894f1484d76ed93c8288742705071f1
 SHA512:
-  metadata.gz: fe62bc608b0af044613a6a6d6ef2653f8143a76ef3f0e261df8d77ccdc98460f78349267624791c261b8c9be0b223c75e53179e189b7c4343b821bc0c5719cf6
-  data.tar.gz: 1191a1288797016d937ba7d8af3a466dda7050545d65a3bc3b58ebf28eca98792554f65280ea94f8e30d559cd478bd215beb0c7f307ec3ab66241e874fc9b532
+  metadata.gz: 5e9a5613d412175f70bd8cdedd9a2aa91cee42a96fefdf0b16ec5862276ef09f0f0f664062b0968d197a5a1b986b7b7f25e154422736f1c3fd5d4026cafe1784
+  data.tar.gz: 1d004de2a792cdd6d0d39f65842aa5ef161c4018d681beb5579737c1191b95411bcea4b2adeeb3561c14b34b69b389bcf8dc01025d2f6612b96d6f300445871a

data/app/controllers/account/scaffolding/completely_concrete/tangible_things_controller.rb

@@ -26,7 +26,7 @@ class Account::Scaffolding::CompletelyConcrete::TangibleThingsController < Accou
   def create
     respond_to do |format|
       if @tangible_thing.save
-        format.html { redirect_to [:account, @absolutely_abstract_creative_concept, :completely_concrete_tangible_things], notice: I18n.t("scaffolding/completely_concrete/tangible_things.notifications.created") }
+        format.html { redirect_to [:account, @tangible_thing], notice: I18n.t("scaffolding/completely_concrete/tangible_things.notifications.created") }
         format.json { render :show, status: :created, location: [:account, @tangible_thing] }
       else
         format.html { render :new, status: :unprocessable_entity }

data/lib/bullet_train/super_scaffolding/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module SuperScaffolding
-    VERSION = "1.2.10"
+    VERSION = "1.2.11"
   end
 end

data/lib/scaffolding/block_manipulator.rb

@@ -214,7 +214,7 @@ module Scaffolding
             # If we're shifting a block to the left, we want to safeguard
             # the String so it doesn't delete any excess characters.
             if direction == :left
-              amount.times { line = line.gsub(/^\s/, "") }
+              amount.times { line = line.gsub(/^ /, "") }
             elsif direction == :right
               line = "\s" * amount + line
             end

data/lib/scaffolding/file_manipulator.rb

@@ -3,7 +3,7 @@ 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
-  def self.find(lines, needle, within = nil)
+  def self.find(lines, needle, within = 0)
     lines_within(lines, within).each_with_index do |line, line_number|
       return (within + (within ? 1 : 0) + line_number) if line.match?(needle)
     end
@@ -15,11 +15,6 @@ module Scaffolding::FileManipulator
     lines[(within + 1)..(Scaffolding::BlockManipulator.find_block_end(starting_from: within, lines: lines) + 1)]
   end
 
-  # TODO I was running into an error in a downstream application where it couldn't find silence_logs? We should implement it in this package.
-  def self.silence_logs?
-    ENV["SILENCE_LOGS"].present?
-  end
-
   def self.replace_line_in_file(file, content, in_place_of, options = {})
     begin
       target_file_content = File.read(file)

data/lib/scaffolding/oauth_providers.rb

@@ -10,11 +10,6 @@ def legacy_resolve_template_path(file)
   end.compact.first || raise("Couldn't find the Super Scaffolding template for `#{file}` in any of the following locations:\n\n#{BulletTrain::SuperScaffolding.template_paths.join("\n")}")
 end
 
-# TODO I was running into an error in a downstream application where it couldn't find silence_logs? We should implement it in this package.
-def silence_logs?
-  ENV["SILENCE_LOGS"].present?
-end
-
 def legacy_replace_in_file(file, before, after)
   puts "Replacing in '#{file}'." unless silence_logs?
   target_file_content = File.read(file)

data/lib/scaffolding/routes_file_manipulator.rb

@@ -1,9 +1,10 @@
 require "scaffolding/block_manipulator"
 
 class Scaffolding::RoutesFileManipulator
-  attr_accessor :child, :parent, :lines, :transformer_options
+  attr_accessor :child, :parent, :lines, :transformer_options, :concerns
 
   def initialize(filename, child, parent, transformer_options = {})
+    @concerns = []
     self.child = child
     self.parent = parent
     @filename = filename
@@ -375,17 +376,34 @@ class Scaffolding::RoutesFileManipulator
         within = find_or_convert_resource_block(parent_resource, options: "except: collection_actions", within: within)
       end
 
-      find_or_create_resource(child_namespaces + [child_resource], options: define_concerns, within: within)
+      add_concern(:sortable) if transformer_options["sortable"]
+      find_or_create_resource(child_namespaces + [child_resource], options: formatted_concerns, within: within)
 
     end
   end
 
-  # Pushing custom concerns here will add them to the routes file when Super Scaffolding.
-  def define_concerns
-    concerns = []
-    concerns.push(:sortable) if transformer_options["sortable"]
+  def add_concern(concern)
+    @concerns.push(concern)
+  end
+
+  def formatted_concerns
+    return if @concerns.empty?
+    "concerns: #{@concerns}"
+  end
 
-    return if concerns.empty?
-    "concerns: #{concerns}"
+  # Adds a concern to an existing resource at the given line number. (used by the audit logs gem)
+  def add_concern_at_line(concern, line_number)
+    line = lines[line_number]
+    existing_concerns = line.match(/concerns: \[(.*)\]/).to_a[1].to_s.split(",")
+    existing_concerns.map! { |e| e.tr(":", "").tr("\"", "").squish&.to_sym }
+    existing_concerns.filter! { |e| e.present? }
+    existing_concerns << concern
+    if line.include?("concerns:")
+      lines[line_number].gsub!(/concerns: \[(.*)\]/, "concerns: [#{existing_concerns.map { |e| ":#{e}" }.join(", ")}]")
+    elsif line.ends_with?(" do")
+      lines[line_number].gsub!(/ do$/, " concerns: [#{existing_concerns.map { |e| ":#{e}" }.join(", ")}] do")
+    else
+      lines[line_number].gsub!(/resources :(.*)$/, "resources :\\1, concerns: [#{existing_concerns.map { |e| ":#{e}" }.join(", ")}]")
+    end
   end
 end

data/lib/scaffolding/transformer.rb

@@ -23,6 +23,16 @@ class Scaffolding::Transformer
     "Team"
   end
 
+  def top_level_model?
+    parent == "Team" || no_parent?
+  end
+
+  # We write an explicit method here so we know we
+  # aren't handling `parent` in this situation as `nil`.
+  def no_parent?
+    parent == "None"
+  end
+
   def update_action_models_abstract_class(targets_n)
   end
 
@@ -41,7 +51,9 @@ 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_NEW_API_VERSION_HOOK = "# 🚅 super scaffolding will insert new api versions above this line."
   RUBY_FILES_HOOK = "# 🚅 super scaffolding will insert file-related logic above this line."
+  RUBY_FACTORY_SETUP_HOOK = "# 🚅 super scaffolding will insert factory setup in place of this line."
   ERB_NEW_FIELDS_HOOK = "<%#{RUBY_NEW_FIELDS_HOOK} %>"
   CONCERNS_HOOK = "# 🚅 add concerns above."
   ATTR_ACCESSORS_HOOK = "# 🚅 add attribute accessors above."
@@ -251,11 +263,6 @@ class Scaffolding::Transformer
     transformed_file_content.join
   end
 
-  # TODO I was running into an error in a downstream application where it couldn't find silence_logs? We should implement it in this package.
-  def silence_logs?
-    ENV["SILENCE_LOGS"].present?
-  end
-
   def scaffold_file(file, overrides: false)
     transformed_file_content = get_transformed_file_content(file)
     transformed_file_name = transform_string(file)
@@ -290,6 +297,9 @@ class Scaffolding::Transformer
 
     Dir.foreach(resolve_template_path(directory)) do |file|
       file = "#{directory}/#{file}"
+
+      next if file.match?("/_menu_item.html.erb") && !top_level_model?
+
       unless File.directory?(resolve_template_path(file))
         scaffold_file(file)
       end
@@ -305,6 +315,9 @@ class Scaffolding::Transformer
     if override_path
       Dir.foreach(override_path) do |file|
         file = "#{directory}_overrides/#{file}"
+
+        next if file.match?("/_menu_item.html.erb") && !top_level_model?
+
         unless File.directory?(resolve_template_path(file))
           scaffold_file(file, overrides: true)
         end
@@ -571,15 +584,15 @@ class Scaffolding::Transformer
   def add_has_many_association
     has_many_line = ["has_many :completely_concrete_tangible_things"]
 
-    # TODO I _think_ this is the right way to check for whether we need `class_name` to specify the name of the model.
-    unless transform_string("completely_concrete_tangible_things").classify == child
+    # Specify the class name if the model is namespaced.
+    if child.match?("::")
       has_many_line << "class_name: \"Scaffolding::CompletelyConcrete::TangibleThing\""
     end
 
     has_many_line << "dependent: :destroy"
 
-    # TODO I _think_ this is the right way to check for whether we need `foreign_key` to specify the name of the model.
-    unless transform_string("absolutely_abstract_creative_concept_id") == "#{parent.underscore}_id"
+    # Specify the foreign key if the parent is namespaced.
+    if parent.match?("::")
       has_many_line << "foreign_key: :absolutely_abstract_creative_concept_id"
 
       # And if we need `foreign_key`, we should also specify `inverse_of`.
@@ -914,7 +927,8 @@ class Scaffolding::Transformer
           field_content.gsub!(/\s%>/, ", options: { password: true } %>")
         end
 
-        scaffold_add_line_to_file("./app/views/account/scaffolding/completely_concrete/tangible_things/show.html.erb", field_content.strip, ERB_NEW_FIELDS_HOOK, prepend: true)
+        show_page_doesnt_exist = child == "User"
+        scaffold_add_line_to_file("./app/views/account/scaffolding/completely_concrete/tangible_things/show.html.erb", field_content.strip, ERB_NEW_FIELDS_HOOK, prepend: true, suppress_could_not_find: show_page_doesnt_exist)
 
       end
 
@@ -931,6 +945,20 @@ class Scaffolding::Transformer
           scaffold_add_line_to_file("./app/views/account/scaffolding/completely_concrete/tangible_things/_index.html.erb", field_content, "<%# 🚅 super scaffolding will insert new field headers above this line. %>", prepend: true)
         end
 
+        # If these strings are the same, we get duplicate variable names in the _index.html.erb partial,
+        # so we account for that here. Run the Super Scaffolding test setup script and check the index partial
+        # of models with namespaced parents for reference (i.e. - Objective, Projects::Step).
+        transformed_abstract_str = transform_string("absolutely_abstract_creative_concept")
+        transformed_concept_str = transform_string("creative_concept")
+        transformed_file_name = transform_string("./app/views/account/scaffolding/completely_concrete/tangible_things/_index.html.erb")
+        if (transformed_abstract_str == transformed_concept_str) && File.exist?(transformed_file_name)
+          replace_in_file(
+            transformed_file_name,
+            "#{transformed_abstract_str} = @#{transformed_abstract_str} || @#{transformed_concept_str}",
+            "#{transformed_abstract_str} = @#{transformed_concept_str}"
+          )
+        end
+
         table_cell_options = []
 
         if first_table_cell
@@ -1393,8 +1421,21 @@ class Scaffolding::Transformer
       add_ability_line_to_roles_yml
     end
 
+    # Add factory setup in API controller test.
     unless cli_options["skip-api"]
-      scaffold_replace_line_in_file("./test/controllers/api/v1/scaffolding/completely_concrete/tangible_things_controller_test.rb", build_factory_setup.join("\n"), "# 🚅 super scaffolding will insert factory setup in place of this line.")
+      test_name = transform_string("./test/controllers/api/v1/scaffolding/completely_concrete/tangible_things_controller_test.rb")
+      test_lines = File.open(test_name).readlines
+
+      # Shift contents of controller test after skipping `unless scaffolding_things_disabled?` block.
+      class_block_index = Scaffolding::FileManipulator.find(test_lines, "class #{transform_string("Api::V1::Scaffolding::CompletelyConcrete::TangibleThingsControllerTest")}")
+      new_lines = Scaffolding::BlockManipulator.shift_block(lines: test_lines, block_start: test_lines[class_block_index], shift_contents_only: true)
+      Scaffolding::FileManipulator.write(test_name, new_lines)
+
+      # Ensure variables built with factories are indented properly.
+      factory_hook_index = Scaffolding::FileManipulator.find(new_lines, RUBY_FACTORY_SETUP_HOOK)
+      factory_hook_indentation = Scaffolding::BlockManipulator.indentation_of(factory_hook_index, new_lines)
+      indented_factory_lines = build_factory_setup.map { |line| "#{factory_hook_indentation}#{line}\n" }
+      scaffold_replace_line_in_file(test_name, indented_factory_lines.join, new_lines[factory_hook_index])
     end
 
     # add children to the show page of their parent.
@@ -1490,7 +1531,7 @@ class Scaffolding::Transformer
           collection_actions = [:index, :new, :create]
 
           # 🚅 Don't remove this block, it will break Super Scaffolding.
-          begin do
+          begin
             namespace :#{routes_namespace} do
               shallow do
                 resources :teams do
@@ -1505,11 +1546,35 @@ class Scaffolding::Transformer
 
       begin
         routes_manipulator.apply([routes_namespace])
-        Scaffolding::FileManipulator.write("config/routes.rb", routes_manipulator.lines)
+        Scaffolding::FileManipulator.write(routes_path, routes_manipulator.lines)
       rescue => _
         add_additional_step :red, "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
 
+      # If we're using a custom namespace, we have to make sure the newly
+      # scaffolded routes are drawn in the `config/routes.rb` and API routes files.
+      if cli_options["namespace"]
+        draw_line = "draw \"#{routes_namespace}\""
+
+        [
+          "config/routes.rb",
+          "config/routes/api/#{BulletTrain::Api.current_version}.rb"
+        ].each do |routes_file|
+          original_lines = File.readlines(routes_file)
+
+          # Define which line we want to place the draw line under in the original routes files.
+          insert_line = if routes_file.match?("api")
+            draw_line = "  #{draw_line}" # Add necessary indentation.
+            "namespace :v1 do"
+          else
+            "draw \"sidekiq\""
+          end
+
+          new_lines = Scaffolding::BlockManipulator.insert(draw_line, lines: original_lines, within: insert_line)
+          Scaffolding::FileManipulator.write(routes_file, new_lines)
+        end
+      end
+
       unless cli_options["skip-api"]
         begin
           api_routes_manipulator = Scaffolding::RoutesFileManipulator.new("config/routes/api/#{BulletTrain::Api.current_version}.rb", child, parent, cli_options)
@@ -1523,7 +1588,7 @@ class Scaffolding::Transformer
 
     unless cli_options["skip-parent"]
 
-      if parent == "Team" || parent == "None"
+      if top_level_model?
         icon_name = nil
         if cli_options["sidebar"].present?
           icon_name = cli_options["sidebar"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-super_scaffolding
 version: !ruby/object:Gem::Version
-  version: 1.2.10
+  version: 1.2.11
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-31 00:00:00.000000000 Z
+date: 2023-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -101,27 +101,21 @@ files:
 - app/models/scaffolding/completely_concrete/tangible_things/assignment.rb
 - app/views/account/scaffolding/absolutely_abstract/creative_concepts/_breadcrumbs.html.erb
 - app/views/account/scaffolding/absolutely_abstract/creative_concepts/_creative_concept.html.erb
-- app/views/account/scaffolding/absolutely_abstract/creative_concepts/_creative_concept.json.jbuilder
 - app/views/account/scaffolding/absolutely_abstract/creative_concepts/_form.html.erb
 - app/views/account/scaffolding/absolutely_abstract/creative_concepts/_index.html.erb
 - app/views/account/scaffolding/absolutely_abstract/creative_concepts/_menu_item.html.erb
 - app/views/account/scaffolding/absolutely_abstract/creative_concepts/collaborators/_breadcrumbs.html.erb
-- app/views/account/scaffolding/absolutely_abstract/creative_concepts/collaborators/_collaborator.json.jbuilder
 - app/views/account/scaffolding/absolutely_abstract/creative_concepts/collaborators/_form.html.erb
 - app/views/account/scaffolding/absolutely_abstract/creative_concepts/collaborators/_index.html.erb
 - app/views/account/scaffolding/absolutely_abstract/creative_concepts/collaborators/_menu_item.html.erb
 - app/views/account/scaffolding/absolutely_abstract/creative_concepts/collaborators/edit.html.erb
 - app/views/account/scaffolding/absolutely_abstract/creative_concepts/collaborators/index.html.erb
-- app/views/account/scaffolding/absolutely_abstract/creative_concepts/collaborators/index.json.jbuilder
 - app/views/account/scaffolding/absolutely_abstract/creative_concepts/collaborators/new.html.erb
 - app/views/account/scaffolding/absolutely_abstract/creative_concepts/collaborators/show.html.erb
-- app/views/account/scaffolding/absolutely_abstract/creative_concepts/collaborators/show.json.jbuilder
 - app/views/account/scaffolding/absolutely_abstract/creative_concepts/edit.html.erb
 - app/views/account/scaffolding/absolutely_abstract/creative_concepts/index.html.erb
-- app/views/account/scaffolding/absolutely_abstract/creative_concepts/index.json.jbuilder
 - app/views/account/scaffolding/absolutely_abstract/creative_concepts/new.html.erb
 - app/views/account/scaffolding/absolutely_abstract/creative_concepts/show.html.erb
-- app/views/account/scaffolding/absolutely_abstract/creative_concepts/show.json.jbuilder
 - app/views/account/scaffolding/completely_concrete/tangible_things/_breadcrumbs.html.erb
 - app/views/account/scaffolding/completely_concrete/tangible_things/_form.html.erb
 - app/views/account/scaffolding/completely_concrete/tangible_things/_index.html.erb

data/app/views/account/scaffolding/absolutely_abstract/creative_concepts/_creative_concept.json.jbuilder

@@ -1,8 +0,0 @@
-json.extract! creative_concept,
-  :id,
-  :name,
-  :description,
-  # 🚅 super scaffolding will insert new fields above this line.
-  :created_at,
-  :updated_at
-json.url account_scaffolding_absolutely_abstract_creative_concept_url(creative_concept, format: :json)

data/app/views/account/scaffolding/absolutely_abstract/creative_concepts/collaborators/_collaborator.json.jbuilder

@@ -1,9 +0,0 @@
-json.extract! collaborator,
-  :id,
-  :creative_concept_id,
-  :membership_id,
-  :roles,
-  # 🚅 super scaffolding will insert new fields above this line.
-  :created_at,
-  :updated_at
-json.url account_scaffolding_absolutely_abstract_creative_concepts_collaborator_url(collaborator, format: :json)

data/app/views/account/scaffolding/absolutely_abstract/creative_concepts/collaborators/index.json.jbuilder

@@ -1 +0,0 @@
-json.array! @collaborators, partial: "scaffolding/absolutely_abstract/creative_concepts/collaborators/collaborator", as: :collaborator

data/app/views/account/scaffolding/absolutely_abstract/creative_concepts/collaborators/show.json.jbuilder

@@ -1 +0,0 @@
-json.partial! "scaffolding/absolutely_abstract/creative_concepts/collaborators/collaborator", collaborator: @collaborator

data/app/views/account/scaffolding/absolutely_abstract/creative_concepts/index.json.jbuilder

@@ -1 +0,0 @@
-json.array! @creative_concepts, partial: "scaffolding/absolutely_abstract/creative_concepts/creative_concept", as: :creative_concept

data/app/views/account/scaffolding/absolutely_abstract/creative_concepts/show.json.jbuilder

@@ -1 +0,0 @@
-json.partial! "scaffolding/absolutely_abstract/creative_concepts/creative_concept", creative_concept: @creative_concept