bullet_train-super_scaffolding 1.8.2 → 1.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52bd806e1278e3ac3365aa11d8b5d8dc723daa05342e6aba8661dd05522672bd
-  data.tar.gz: b0a9c6b29e04b3bf5683db9cdb9df7d851f3601422083246a1f76e41e8896c34
+  metadata.gz: 9fd34927138c9c4d62670e1cd4db49b074182fdafd559911c7a21614d31d0b99
+  data.tar.gz: e210ebe306a8c89bb453dcb6d5d9c732d8a783432a790c5f48c4cc5fe9a33525
 SHA512:
-  metadata.gz: d421e343cecfe142599857aeeb89d13b69699c6e4ac3bf03391575ab8f664e7641072c9235f299aae5c15bc65181d2165f535ca699e60b51e5cc0800ed1051d5
-  data.tar.gz: 46b0ea1b3621ddaddc77ca8f5aa08777434f796b54f7648dab73ef69860c845e253ec789b0a95721c6f12adb10876885d06d11a59f19ab8d3c2188581734c41b
+  metadata.gz: 7d787a123c710490675403e27c0560627d29c031f297252c8a4f3bd051d4968813c58ad2c8001d214d536cab872ed8058efcd38e16f5cb2a3e875a85787c6622
+  data.tar.gz: 88c909ec4c12c78e15e93257a87b3d03e26782a81125bc4664723154bdb41afa828d6ec193cd29de174516c5ae9083634dcc5a1bc1c8ec73aeacbc6ec0cfc35f

data/lib/bullet_train/super_scaffolding/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module SuperScaffolding
-    VERSION = "1.8.2"
+    VERSION = "1.8.4"
   end
 end

data/lib/bullet_train/super_scaffolding.rb

@@ -22,7 +22,8 @@ module BulletTrain
       "action-models:targets-one" => "BulletTrain::ActionModels::Scaffolders::TargetsOneScaffolder",
       "action-models:targets-one-parent" => "BulletTrain::ActionModels::Scaffolders::TargetsOneParentScaffolder",
       "action-models:performs-export" => "BulletTrain::ActionModels::Scaffolders::PerformsExportScaffolder",
-      "action-models:performs-import" => "BulletTrain::ActionModels::Scaffolders::PerformsImportScaffolder"
+      "action-models:performs-import" => "BulletTrain::ActionModels::Scaffolders::PerformsImportScaffolder",
+      "audit-logs" => "BulletTrain::AuditLogs::Scaffolders::AuditLogScaffolder"
     }
 
     class Runner

data/lib/generators/super_scaffold/audit_logs/USAGE

@@ -0,0 +1,22 @@
+Description:
+  Generate files needed to add an audit log to a model.
+
+Example:
+  E.g. Add audit logs to Posts from a Team.
+    rails generate super_scaffold:audit_logs Post Team name:text_field
+
+  The attributes you specify will be added to the _version partial and used to show different versions of the model.
+
+  This will create:
+    db/migrate/20241115152914_add_project_to_activity_versions.rb
+    app/views/account/projects/_version.html.erb'.
+  And update:
+    app/models/project.rb
+    app/models/activity/version.rb
+    app/views/account/projects/show.html.erb
+    app/models/activity/version.rb
+    config/routes.rb
+    app/controllers/account/projects_controller.rb
+
+🏆 Protip: Commit your other changes before running Super Scaffolding so it's easy to undo if you (or we) make any mistakes.
+If you do that, you can reset to your last commit state by using `git checkout .` and `git clean -d -f`.

data/lib/generators/super_scaffold/audit_logs/audit_logs_generator.rb

@@ -0,0 +1,26 @@
+require_relative "../super_scaffold_base"
+require "scaffolding/routes_file_manipulator"
+
+class AuditLogsGenerator < Rails::Generators::Base
+  include SuperScaffoldBase
+
+  source_root File.expand_path("templates", __dir__)
+
+  namespace "super_scaffold:audit_logs"
+
+  argument :target_model, type: :string
+  argument :parent_model, type: :string
+  argument :attributes, type: :array, banner: "attribute:type attribute:type"
+
+  def generate
+    if defined?(BulletTrain::AuditLogs)
+      # We add the name of the specific super_scaffolding command that we want to
+      # invoke to the beginning of the argument string.
+      ARGV.unshift "audit-logs"
+      BulletTrain::SuperScaffolding::Runner.new.run
+    else
+      puts "You must have AuditLogs installed if you want to use this generator.".red
+      puts "Please refer to the documentation for more information: https://bullettrain.co/docs/audit-logs"
+    end
+  end
+end

data/lib/scaffolding/routes_file_manipulator.rb

@@ -158,6 +158,33 @@ class Scaffolding::RoutesFileManipulator
     namespace_block_start.present? ? {namespace => namespace_block_start} : {}
   end
 
+  def find_last_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 = Scaffolding::FileManipulator.lines_within(lines, within)
+    lines_within.reverse.each_with_index do |line, line_number|
+      reversed_line_number = lines_within.count - line_number - 1
+      # + 2 because line_number starts from 0, and within starts one line after
+      actual_line_number = (within + reversed_line_number + 2)
+
+      # The lines we want to ignore may be a a series of blocks, so we check each Range here.
+      ignore_line = false
+      if ignore.present?
+        ignore.each do |lines_to_ignore|
+          ignore_line = true if lines_to_ignore.include?(actual_line_number)
+        end
+      end
+
+      next if ignore_line
+      return (within + (within ? 1 : 0) + reversed_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)
@@ -187,15 +214,26 @@ class Scaffolding::RoutesFileManipulator
     within = options[:within]
     parts = parts.dup
     resource = parts.pop
+    needle = /resources :#{resource}#{options[:options] ? ", #{options[:options].gsub(/({)(.*)(})/, '{\2}')}" : ""}(,?\s.*)? do(\s.*)?$/
+
     # TODO this doesn't take into account any options like we do in `find_resource`.
-    find_in_namespace(/resources :#{resource}#{options[:options] ? ", #{options[:options].gsub(/({)(.*)(})/, '{\2}')}" : ""}(,?\s.*)? do(\s.*)?$/, parts, within)
+    if options[:find_last]
+      find_last_in_namespace(needle, parts, within)
+    else
+      find_in_namespace(needle, parts, within)
+    end
   end
 
   def find_resource(parts, options = {})
     parts = parts.dup
     resource = parts.pop
     needle = /resources :#{resource}#{options[:options] ? ", #{options[:options].gsub(/({)(.*)(})/, '{\2}')}" : ""}(,?\s.*)?$/
-    find_in_namespace(needle, parts, options[:within], options[:ignore])
+
+    if options[:find_last]
+      find_last_in_namespace(needle, parts, options[:within], options[:ignore])
+    else
+      find_in_namespace(needle, parts, options[:within], options[:ignore])
+    end
   end
 
   def find_or_create_resource(parts, options = {})
@@ -278,17 +316,18 @@ class Scaffolding::RoutesFileManipulator
   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))
-        # convert it.
-        lines[resource_line_number].gsub!("\n", " do\n")
-        insert_after(["end"], resource_line_number)
-      else
-        raise BulletTrain::SuperScaffolding::CannotFindParentResourceException.new("the parent resource (`#{parent_resource}`) doesn't appear to exist in `#{@filename}`.")
+    resource_statement_line = find_resource([parent_resource], options)
+    if resource_statement_line
+      resource_statement = lines[resource_statement_line]
+      if !resource_statement.match?(/ do(\s.*)?$/)
+        lines[resource_statement_line].gsub!("\n", " do\n")
+        insert_after(["end"], resource_statement_line)
       end
+    else
+      raise BulletTrain::SuperScaffolding::CannotFindParentResourceException.new("the parent resource (`#{parent_resource}`) doesn't appear to exist in `#{@filename}`.")
     end
 
-    # update the block of code we're working within.
+    # capture the line number of the block of code we're working within.
     unless (within = find_resource_block([parent_resource], options))
       raise "tried to convert the parent resource to a block, but failed?"
     end
@@ -328,13 +367,18 @@ class Scaffolding::RoutesFileManipulator
       #   end
       # end
 
-      parent_within = find_or_convert_resource_block(parent_resource, within: within)
+      parent_within = find_resource([parent_resource], within: within)
+
+      # With deeply nested namespaces we end up with mutliple resource blocks and some things need
+      # to go into the last block. See this issue for details:
+      # https://github.com/bullet-train-co/bullet_train/issues/1655
+      last_parent_within = find_or_convert_resource_block(parent_resource, within: within, find_last: true)
 
       # add the new resource within that namespace.
       line = "scope module: '#{parent_resource}' do"
       # TODO you haven't tested this yet.
-      unless (scope_within = Scaffolding::FileManipulator.find(lines, /#{line}/, parent_within))
-        scope_within = insert([line, "end"], parent_within)
+      unless (scope_within = Scaffolding::FileManipulator.find(lines, /#{line}/, last_parent_within))
+        scope_within = insert([line, "end"], last_parent_within)
       end
 
       if child_namespaces.size > 1
@@ -361,7 +405,9 @@ class Scaffolding::RoutesFileManipulator
       else
         routing_options = "only: collection_actions"
         routing_options += ", #{formatted_concerns}" if formatted_concerns
-        find_or_create_resource([child_resource], options: routing_options, within: scope_within)
+        # We find last here for this reason:
+        # https://github.com/bullet-train-co/bullet_train/issues/1655
+        find_or_create_resource([child_resource], options: routing_options, within: scope_within, find_last: true)
 
         # namespace :projects do
         #   resources :deliverables, except: collection_actions

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-super_scaffolding
 version: !ruby/object:Gem::Version
-  version: 1.8.2
+  version: 1.8.4
 platform: ruby
 authors:
 - Andrew Culver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-12 00:00:00.000000000 Z
+date: 2024-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard
@@ -174,6 +174,8 @@ files:
 - lib/generators/super_scaffold/action_models/targets_one/targets_one_generator.rb
 - lib/generators/super_scaffold/action_models/targets_one_parent/USAGE
 - lib/generators/super_scaffold/action_models/targets_one_parent/targets_one_parent_generator.rb
+- lib/generators/super_scaffold/audit_logs/USAGE
+- lib/generators/super_scaffold/audit_logs/audit_logs_generator.rb
 - lib/generators/super_scaffold/conversations/USAGE
 - lib/generators/super_scaffold/conversations/conversations_generator.rb
 - lib/generators/super_scaffold/field/USAGE