paper_trail-rails 0.5.2 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e89af0157d160e6aab5edf01697d9528223a25d583aff72d03452296967adfce
-  data.tar.gz: 3fc1fb341feb826de4b06e78b9dec334dac3ea7d797730eb2851200bdb8ffb92
+  metadata.gz: 9cbd2f0eda94258a20e3a294ed155191773c27af3d91bcbd66c63971084e37e8
+  data.tar.gz: d59ed0df5959182a653556c3583e963ef9df5d2669821f15b4ae06c2deade834
 SHA512:
-  metadata.gz: b8d1e399f0afbcaac11dea522ebe1988c8ab2e079f0704e2f3f8ff465c0fecbac51c14adb324bc37b2329a438b6d00ad175202af049bda6d2d8c588b8102f25a
-  data.tar.gz: 9f372e1d62f07604002833c18ea03f18500c7aaa11679e62260dbe06ac5f700c3ec4fb4e6752b95e15b0296a1b82e6a625fc879871f5e572a5689ab3472d918f
+  metadata.gz: fd93b66499033e9b62bb521bd0870f81fa4a4c4fbe3f4916a5359dbd5fa04279ce5a2ec8396e474062588f70db1170f0e8810293145914dd2f25539451ef298a
+  data.tar.gz: 2b5bd83ee674694032247fec1212dd4ce2a3f49cddaa1ce1380235e4ed3300d3eb0af7ce126942d7beee48c1213e7faf411aff4017565afce8b039206ec1af1d

data/Changelog.md

@@ -1,13 +1,35 @@
+## 0.6.1 (2023-06-15)
+- Add `PaperTrail.metadata`, `PaperTrail.reverse_update_metadata`
+- Change `set_default_metadata` to only set `command` to `default_command` if it hasn't been set yet. This
+  fixes bug where the command set by `RunnerCommandExtensions` got overwritten when the `whodunnit`
+  callback called `set_default_metadata` again.
+
+## 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

data/lib/paper_trail/rails/paper_trail_extensions.rb

@@ -1,5 +1,11 @@
 PaperTrail.class_eval do
 
+  unless methods.include?(:metadata)
+    def self.metadata
+      PaperTrail.request.controller_info
+    end
+  end
+
   unless methods.include?(:with_metadata)
     # Adds additional metadata to versions created within the given block.  This will be merged with
     # (and may override) any metadata already set by your controller's info_for_paper_trail.
@@ -27,4 +33,11 @@ PaperTrail.class_eval do
       PaperTrail.request.controller_info = merged_metadata
     end
   end
+
+  unless methods.include?(:reverse_update_metadata)
+    def self.reverse_update_metadata(metadata)
+      merged_metadata = (::PaperTrail.request.controller_info || {}).reverse_merge(metadata)
+      PaperTrail.request.controller_info = merged_metadata
+    end
+  end
 end

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.2"
+      "0.6.1"
     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'
@@ -26,8 +30,10 @@ module PaperTrail
 
       # Store some metadata about where the change came from
       def set_default_metadata
+        PaperTrail.reverse_update_metadata(
+          command: default_command,
+        )
         PaperTrail.update_metadata(
-          command: "#{File.basename($PROGRAM_NAME)} #{ARGV.join ' '}",
           source_location: caller.find { |line|
             line.starts_with? ::Rails.root.to_s and
             config.source_location_filter.(line)
@@ -35,6 +41,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.2
+  version: 0.6.1
 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