paper_trail-rails 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df6b12e02d1b44eabbb7c41961258e502db07a2b7f1078d48f72b56def92f948
-  data.tar.gz: d5eba93e47293263d99c743e280ca385d2773c5752eaff08090f5fbe0d023466
+  metadata.gz: 6aa5868c6142fc4fe53860a3d2419e4f8f564ecc6f885b35a2c2378b414c39ca
+  data.tar.gz: b6ea9745e16cbb603de44aaae7a8f25fd75c3953d7c8a5bb55467dd6d3434008
 SHA512:
-  metadata.gz: 33952094c64fd705018a4b33108c7e398ab5dc624449402e1a95cd4dc70a65544372e41906cb697b326b66fb7dc688c6ca2bfe35d82aecb7d8197a585358b064
-  data.tar.gz: b26c1c50f90b35dddf67291024beeacab8b4d37578f7450cb169f9c83d4794c455d66fadf6dd8d75ed9f9ad51dce589cb29b969818eaf5d6a5a1e71f410d8a97
+  metadata.gz: 6eb0038d9fb7de316971d81955f430fc24c43146f176dc491d6641b5346b4102e2d2ed5150cf85cdcea7a9239485052129f519ffefc5df92e5609a3e779ec5e4
+  data.tar.gz: 9202e8d1e38fe06436a59f0ce2051867517297ed9b91f71aba5b640b74e8214ca18e068e1345e070bffeb908bc5f8e94747981f7aacf80e40408efa47c49382e

data/Changelog.md

@@ -1,13 +1,29 @@
+## 0.6.0 (2023-06-14)
+- Include the rails subcommand (`'rails console'`, etc.) in the `command` metadata, not just `'rails'`
+- When using `rails runner`, include the full Ruby code/file that was run in the `command` metadata.
+
+## 0.5.2 (2022-04-26)
+- Fix: Don't update `PaperTrail.request.controller_info[:reason]` if reason is already present and we didn't even ask for a new reason
+
+## 0.5.1 (2022-04-26)
+- Update due to upstream paper_trail defining `PaperTrail::Railtie` instead of `PaperTrail::Rails::Engine`
+
+## 0.5.0 (2022-04-26)
+- Don't ask for reason if `PaperTrail.request.controller_info[:reason]` is already present.
+
+  For example, if you call a method that programatically sets the reason, then it shouldn't ask you to
+  manually type in a reason.
+
 ## 0.4.0 (2020-04-23)
 - Allow user to be selected by index in addition to id
-- Add config.select_user_inspect
-- Fix: Remove .default_order which may not be defined. Included as config example instead.
-- Fix: Replace respond.id with respond_to?(:id)
-- Fix: Should use require_user rather than require_reason
+- Add `config.select_user_inspect`
+- Fix: Remove `.default_order` which may not be defined. Included as config example instead.
+- Fix: Replace `respond.id` with `respond_to?(:id)`
+- Fix: Should use `require_user` rather than `require_reason`
 
 ## 0.3.0 (2019-09-16)
-- Fix: When running db:migrate:redo, command got recorded as "rails db:migrate:redo VERSION=2019…"
-  instead of as "rails db:migrate: MigrationName (up)" as intended.
+- Fix: When running `db:migrate:redo`, command got recorded as `"rails db:migrate:redo VERSION=2019…"`
+  instead of as `"rails db:migrate: MigrationName (up)"` as intended.
 - Add `config.source_location_filter`
 
 ## 0.2.2 (2019-07-18)

data/lib/paper_trail/rails/console.rb

@@ -42,7 +42,7 @@ module PaperTrail
           end
         end
       end
-    end
+    end # module Console
 
     class Configuration
       def console
@@ -82,8 +82,8 @@ module PaperTrail
 
           if config.console.ask_for_reason && PaperTrail.request.controller_info[:reason].nil?
             @paper_trail_reason ||= PaperTrail::Rails.get_reason(required: config.console.require_reason)
+            PaperTrail.update_metadata reason: @paper_trail_reason
           end
-          PaperTrail.update_metadata reason: @paper_trail_reason
 
           @paper_trail_whodunnit
         }

data/lib/paper_trail/rails/runner_command_extensions.rb

@@ -0,0 +1,46 @@
+# This needs to be required from lib/rails/commands/runner/runner_command.rb. Otherwise the original
+# perform method gets called before we've even had a chance to modify it.
+#
+# To manually test this, run this from a Rails app that has this gem included:
+#   rails runner 'pp PaperTrail.request.controller_info'
+
+require_relative 'railtie'
+
+module PaperTrail
+  module Rails
+    module RunnerCommandExtensions
+      def perform(code_or_file = nil, *command_argv)
+        PaperTrail.request.whodunnit = nil
+        PaperTrail::Rails.set_default_metadata
+        PaperTrail.update_metadata(
+          command: "rails runner: #{code_or_file} #{command_argv.join(' ')}"
+        )
+        super
+      end
+
+      # Rails::Command::Base#create_command creates this alias too, and runner is what actually gets
+      # called so we have to override the alias too.
+      alias runner perform
+    end
+  end
+end
+
+module Rails
+  module Command
+    ( RunnerCommand)
+    class RunnerCommand
+      prepend ::PaperTrail::Rails::RunnerCommandExtensions
+    end
+  end
+end
+
+module PaperTrail
+  module Rails
+    class Railtie
+      runner do |application|
+        # Rails provides this callback that is invoked by RunnerCommand#peform before running the
+        # provided code. But it doesn't pass in the args from perform.
+      end
+    end
+  end
+end

data/lib/paper_trail/rails/version.rb

@@ -1,7 +1,7 @@
 module PaperTrail
   module Rails
     def self.version
-      "0.5.1"
+      "0.6.0"
     end
   end
 end

data/lib/paper_trail/rails.rb

@@ -1,3 +1,7 @@
+require 'rails'
+# When rails/commands/runner/runner_command.rb is invoked, it won't have already loaded
+# active_record, so we need to load it to avoid getting uninitialized constant ActiveRecord.
+require 'active_record'
 require 'paper_trail'
 
 require_relative 'rails/version'
@@ -27,7 +31,7 @@ module PaperTrail
       # Store some metadata about where the change came from
       def set_default_metadata
         PaperTrail.update_metadata(
-          command: "#{File.basename($PROGRAM_NAME)} #{ARGV.join ' '}",
+          command: default_command,
           source_location: caller.find { |line|
             line.starts_with? ::Rails.root.to_s and
             config.source_location_filter.(line)
@@ -35,6 +39,21 @@ module PaperTrail
         )
       end
 
+      def default_command
+        program_name = File.basename($PROGRAM_NAME)
+        returning = program_name
+        returning << " #{rails_subcommand}" if program_name == 'rails'
+        returning << " #{ARGV.join(' ')}" if ARGV.any?
+        returning
+      end
+
+      def rails_subcommand
+        regexp = %r{lib/rails/commands/\w+/(\w+)_command\.rb}
+        if (frame = caller.detect { |f| f =~ regexp })
+          frame.match(regexp)[1]
+        end
+      end
+
       def select_user(required: false)
         other_allowed_values = config.select_user_other_allowed_values
         other_values_prompt = " (or #{other_allowed_values.join(' or ')})" if other_allowed_values.present?

data/lib/rails/commands/runner/runner_command.rb

@@ -0,0 +1,20 @@
+# This file must be at path lib/rails/commands/runner/runner_command.rb so it overrides the file
+# with the same name in the railties gem. This is the only way to modify the class (prepend a
+# module) before perform is called on it.
+
+# pp $LOAD_PATH.index($LOAD_PATH.grep(/railties/).first)
+# pp $LOAD_PATH.index($LOAD_PATH.grep(/paper_trail-rails/).first)
+
+begin
+  require 'paper_trail/rails'
+rescue
+  puts $!
+  puts $!.backtrace
+  raise
+end
+
+railties_lib = Gem.loaded_specs['railties'].full_require_paths[0]
+
+require railties_lib + '/rails/commands/runner/runner_command'
+
+require_relative '../../../paper_trail/rails/runner_command_extensions'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Tyler Rick
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-26 00:00:00.000000000 Z
+date: 2023-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paper_trail
@@ -105,7 +105,9 @@ files:
 - lib/paper_trail/rails/migration_extensions.rb
 - lib/paper_trail/rails/paper_trail_extensions.rb
 - lib/paper_trail/rails/railtie.rb
+- lib/paper_trail/rails/runner_command_extensions.rb
 - lib/paper_trail/rails/version.rb
+- lib/rails/commands/runner/runner_command.rb
 - paper_trail-rails.gemspec
 homepage: https://github.com/TylerRick/paper_trail-rails
 licenses: []
@@ -128,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Integrate with rails console and migrations. In rails console, ask who is