paper_trail-actor 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5feb0e3bd1d5d354acc67d9da8ce59737cd5f9d2003aac8a06d6d97abe9a964d
+  data.tar.gz: 4c539f383eff32c652da404f3bf8edcc215cf3e1b1357b6d1566d0ad8abc37c0
+SHA512:
+  metadata.gz: 396ac19a6b0ec27b2bddbc46c58e34819d6a1761fc2acee5cff4b3e9143b939c3a0f0dda67c4463d8581d44ef9fbc79ba492326ba8d66ba2c0cb8e5e2ca357ce
+  data.tar.gz: e8077674949aa3d963b543d74c495edb6ccf975fb86821c8dc97ecc9db0527702ca5f412ee28b12849b8edf2701319cf89dee9dc3354415ffc9830ed46cf5912

data/CHANGELOG.md

@@ -0,0 +1,54 @@
+## [Unreleased]
+
+- This gem was forked from [paper_trail-globalid](https://github.com/ankit1910/paper_trail-globalid) where the last release was version 0.2.0.
+
+### Breaking Changes
+
+- None
+
+### Added
+
+- None
+
+### Fixed
+
+- None
+
+## [0.3.0] - 2025-04-11
+
+- Bring fixes in and allow updated gem to be installed from GitHub.
+
+### Breaking Changes
+
+- Only work with PaperTrail >= 9.0.0 as that is the interface that we now use.
+  Not all monkey patched classes exist in earlier versions.
+
+### Added
+
+- None
+
+### Fixed
+
+- [#1](https://github.com/tttffff/paper_trail-actor/pull/1) - Update to modern paper_trail.
+  Update to use the interface of PaperTrail 9.0.0 onwards.
+- [#2](https://github.com/tttffff/paper_trail-actor/pull/2) - Allow for using custom paper trail version classes.
+  Change version mixin to allow for PaperTrail [custom-version-classes](https://github.com/paper-trail-gem/paper_trail#6a-custom-version-classes).
+
+
+## [0.4.0] - 2025-04-20
+
+- Initial release of paper_trail-actor
+
+### Breaking Changes
+
+- Only support PaperTrail >= 11.0.0.
+  While this gem will technically work with versions >= 9.0.0, it is more complex to test for versions less than 11.0.0.
+  As 11.0.0 is from 2020, there is no need to test or support any earlier versions.
+
+### Added
+
+- None
+
+### Fixed
+
+- None

data/LICENSE.txt

@@ -0,0 +1,25 @@
+Copyright (c) 2016 ankit1910
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# Additional Copyright Holders:
+Copyright (c) 2025 tttffff

data/README.md

@@ -0,0 +1,82 @@
+# PaperTrail-Actor
+
+Originally forked from the now unmaintained [paper_trail-globalid](https://github.com/ankit1910/paper_trail-globalid).
+
+This gem is an extension to the [PaperTrail](https://github.com/paper-trail-gem/paper_trail) gem.
+
+- Allows setting an `ActiveRecord` object for the whodunnit field on the PaperTrail request object and version objects.
+- Adds the method `#actor` to the PaperTrail request object which returns the `ActiveRecord` object that will be responsible for subsequent changes.
+- Adds the method `#actor` to PaperTrail version objects which returns the `ActiveRecord` object that was responsible for change.
+
+## Installation
+
+1. Add PaperTrail-Actor to your `Gemfile`.
+  ```ruby
+  gem "paper_trail-actor"
+  ```
+2. And then execute:
+  ```sh
+  bundle install
+  ```
+
+## Basic Usage
+
+This gem works by storing the [globalid](https://github.com/rails/globalid) to the whodunnit field of PaperTrail version tables.
+- It is designed not to hinder or break existing PaperTrail functionalities.
+- PaperTrail versions with and without a globalid can live side by side (e.g. versions created before installing this gem.)
+
+```ruby
+product = Product.find(42)
+admin = Admin.find(1)                                       # <Admin:0x007fa2df9a5590>
+
+PaperTrail.request.whodunnit = admin
+PaperTrail.request.whodunnit                                # "gid://app/Admin/1"
+PaperTrail.request.actor                                    # <Admin:0x007fa2df9a5590> returns the actual object
+
+product.update(name: "Ice cream")
+product.versions.last.whodunnit                             # "gid://app/Admin/1"
+product.versions.last.actor                                 # <Admin:0x007fa2df9a5590> returns the actual object
+```
+
+### Setting whodunnit to something other than an ActiveRecord object
+
+You can continue to set whodunnit to something other than an `ActiveRecord` object.
+- It follows standard PaperTrail functionality and adds the raw value to the whodunnit field.
+- The `#actor` method will return the raw value.
+
+```ruby
+PaperTrail.request.whodunnit = "Alex the admin"
+PaperTrail.request.whodunnit                                # "Alex the admin"
+PaperTrail.request.actor                                    # "Alex the admin"
+
+product.update(name: "99 Flake")
+product.versions.last.whodunnit                             # "Alex the admin"
+product.versions.last.actor                                 # "Alex the admin"
+```
+
+### Updating whodunnit on existing PaperTrail versions
+
+You can retrospectivly update PaperTrail versions to have a new actor.
+
+```ruby
+most_recent_product_version = product.versions.last
+admin_name = most_recent_product_version.actor              # "Alex the admin"
+alex_the_admin = Admin.find_by(name: admin_name)            # Do check for `nil` before updating the whodunit field
+most_recent_product_version.whodunnit = alex_the_admin
+most_recent_product_version.save
+most_recent_product_version.actor                           # <Admin:0x00000120fbb7d0>
+```
+
+### Setting whodunnit with a controller callback
+
+Similar to how you can configure the PaperTrail gem, as described in [Setting Whodunnit with a Controller Callback](https://github.com/paper-trail-gem/paper_trail/?tab=readme-ov-file#setting-whodunnit-with-a-controller-callback), you can now set this to an ActiveRecord object. This allows storing the global ID and retrieving the actor using the `#actor` methods.
+
+Here’s an example in your `ApplicationController`:
+
+```ruby
+class ApplicationController < ActionController::Base
+  def user_for_paper_trail
+    logged_in? ? current_user : "Public user"
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/paper_trail-actor/request.rb

@@ -0,0 +1,15 @@
+module PaperTrailActor
+  module Request
+    def whodunnit=(value)
+      if value.is_a? ActiveRecord::Base
+        super(value.to_gid)
+      else
+        super
+      end
+    end
+
+    def actor
+      ::GlobalID::Locator.locate(store[:whodunnit]) || whodunnit
+    end
+  end
+end

data/lib/paper_trail-actor/version.rb

@@ -0,0 +1,3 @@
+module PaperTrailActor
+  VERSION = "0.4.0"
+end

data/lib/paper_trail-actor/version_concern.rb

@@ -0,0 +1,20 @@
+module PaperTrailActor
+  module VersionConcern
+    def whodunnit=(input_value)
+      whodunnit_value = if input_value.is_a?(ActiveRecord::Base)
+        input_value.to_gid
+      else
+        input_value
+      end
+      _write_attribute("whodunnit", whodunnit_value)
+    end
+
+    # Returns an object which was responsible for a change
+    # you need to store global_id to whodunnit field to make this method return the object(who was responsible)
+    # for example, whodunnit => "gid://app/Order/1" then
+    # whodunnit_user will return Order.find_by(id: 1) in application scope.
+    def actor
+      ::GlobalID::Locator.locate(whodunnit) || whodunnit
+    end
+  end
+end

data/lib/paper_trail-actor.rb

@@ -0,0 +1,17 @@
+require "paper_trail-actor/version"
+require "paper_trail-actor/request"
+require "paper_trail-actor/version_concern"
+
+module ::PaperTrail
+  module Request
+    class << self
+      prepend ::PaperTrailActor::Request
+    end
+  end
+end
+
+module ::PaperTrail
+  module VersionConcern
+    include ::PaperTrailActor::VersionConcern
+  end
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: paper_trail-actor
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- tttffff
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paper_trail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.0.0
+- !ruby/object:Gem::Dependency
+  name: globalid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An extension to PaperTrail. Using this gem, you can fetch the ActiveRecord
+  object that was responsible for changes
+email:
+- tristanfellows@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/paper_trail-actor.rb
+- lib/paper_trail-actor/request.rb
+- lib/paper_trail-actor/version.rb
+- lib/paper_trail-actor/version_concern.rb
+homepage: https://github.com/tttffff/paper_trail-actor
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tttffff/paper_trail-actor
+  source_code_uri: https://github.com/tttffff/paper_trail-actor
+  changelog_uri: https://github.com/tttffff/paper_trail-actor/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: An extension to PaperTrail. Using this gem, you can fetch the ActiveRecord
+  object that was responsible for changes
+test_files: []