rails_audit_log 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf000427595792f1a97214b6ad5d6dc7f6875681f315570260760accf4e70ba3
+  data.tar.gz: 8978577023bb75e0832d475b8fcaeaeedb4a02ac3c5b1e1500a6d2187e1c5e5c
+SHA512:
+  metadata.gz: 897e191130a3895876e5ec8328386d5cd8e456b866a348a0c10edbacc4969883a8ca550e2fa2491f68937ed1a9558c5143a49503c9c80b4f1824789bbc40eee1
+  data.tar.gz: d1035cdcfcc8d243fc8cfe43fac0842973e9e0dba78e16f4917c83ec83e6db81b8eb999dc441620d01027984ca4a89cdaafb8fb0501b3b98fa4712571d08a706

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Chuck Smith
+
+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.

data/README.md

@@ -0,0 +1,89 @@
+# RailsAuditLog
+
+[![Gem Version](https://badge.fury.io/rb/rails_audit_log.svg)](https://badge.fury.io/rb/rails_audit_log)
+[![Ruby](https://img.shields.io/badge/ruby-%3E%3D%203.3-ruby)](https://www.ruby-lang.org)
+[![codecov](https://codecov.io/gh/eclectic-coding/rails_audit_log/branch/main/graph/badge.svg)](https://codecov.io/gh/eclectic-coding/rails_audit_log)
+
+A modern, Zeitwerk-native Rails engine for auditing ActiveRecord changes. Tracks `create`, `update`, and `destroy` events with JSON-first storage, whodunnit actor context, and a clean query API.
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem "rails_audit_log"
+```
+
+Run the install generator to create the migration:
+
+```bash
+bin/rails generate rails_audit_log:install
+bin/rails db:migrate
+```
+
+## Usage
+
+### Tracking a model
+
+Include `RailsAuditLog::Auditable` in any ActiveRecord model:
+
+```ruby
+class Article < ApplicationRecord
+  include RailsAuditLog::Auditable
+end
+```
+
+Every `create`, `update`, and `destroy` is now recorded automatically:
+
+```ruby
+article = Article.create!(title: "Hello")
+article.audit_log_entries.count      # => 1
+article.audit_log_entries.first.event # => "create"
+
+article.update!(title: "World")
+article.audit_log_entries.last.object_changes
+# => { "title" => ["Hello", "World"] }
+```
+
+### Recording who made the change
+
+Include `RailsAuditLog::Controller` in your `ApplicationController` and declare the actor source once:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include RailsAuditLog::Controller
+  audit_log_actor { current_user }
+end
+```
+
+The actor is captured automatically on every request and stored on each entry:
+
+```ruby
+entry = article.audit_log_entries.last
+entry.actor       # => #<User id: 42, name: "Alice">
+entry.actor_type  # => "User"
+entry.actor_id    # => 42
+```
+
+### Actor context outside of controllers
+
+Use `RailsAuditLog.with_actor` in background jobs, rake tasks, or seeds:
+
+```ruby
+RailsAuditLog.with_actor(current_user) do
+  article.update!(status: "published")
+end
+```
+
+## Requirements
+
+- Ruby >= 3.3
+- Rails >= 7.2
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/eclectic-coding/rails_audit_log).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,38 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+require "bundler/audit/task"
+require "rubocop/rake_task"
+require "rspec/core/rake_task"
+
+Bundler::Audit::Task.new
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Verify Zeitwerk can eager-load all engine files without errors"
+task :zeitwerk do
+  sh({ "RAILS_ENV" => "test" }, "cd spec/dummy && bundle exec rails runner 'Rails.autoloaders.main.eager_load'")
+end
+
+task default: ["bundle:audit:update", "bundle:audit:check", :rubocop, :zeitwerk, :spec]
+
+# Development database tasks (operate on spec/dummy)
+namespace :dev do
+  dummy_env = { "RAILS_ENV" => "development" }
+  dummy_rake = "cd spec/dummy && bundle exec rake"
+
+  desc "Create and migrate the development database"
+  task :setup do
+    sh dummy_env, "#{dummy_rake} db:create db:migrate"
+  end
+
+  desc "Seed the development database"
+  task :seed do
+    sh dummy_env, "#{dummy_rake} db:seed"
+  end
+
+  desc "Drop, recreate, migrate, and seed the development database"
+  task :reset do
+    sh dummy_env, "#{dummy_rake} db:drop db:create db:migrate db:seed"
+  end
+end

data/app/assets/stylesheets/rails_audit_log/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/concerns/rails_audit_log/auditable.rb

@@ -0,0 +1,43 @@
+module RailsAuditLog
+  module Auditable
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :audit_log_entries,
+               class_name: "RailsAuditLog::AuditLogEntry",
+               as: :item,
+               dependent: :destroy
+
+      after_create  :record_audit_create
+      after_update  :record_audit_update
+      after_destroy :record_audit_destroy
+    end
+
+    private
+
+    def record_audit_create
+      record_audit_entry("create", saved_changes)
+    end
+
+    def record_audit_update
+      record_audit_entry("update", saved_changes)
+    end
+
+    def record_audit_destroy
+      changes = attributes.transform_values { |v| [v, nil] }
+      record_audit_entry("destroy", changes)
+    end
+
+    def record_audit_entry(event, changes)
+      actor = RailsAuditLog.actor
+      RailsAuditLog::AuditLogEntry.create!(
+        event:          event,
+        item_type:      self.class.name,
+        item_id:        id,
+        object_changes: changes,
+        actor_type:     actor&.class&.name,
+        actor_id:       actor.respond_to?(:id) ? actor.id : nil
+      )
+    end
+  end
+end

data/app/concerns/rails_audit_log/controller.rb

@@ -0,0 +1,31 @@
+module RailsAuditLog
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :set_audit_log_actor
+      after_action  :clear_audit_log_actor
+    end
+
+    class_methods do
+      def audit_log_actor(&block)
+        @audit_log_actor_block = block
+      end
+
+      def audit_log_actor_block
+        @audit_log_actor_block
+      end
+    end
+
+    private
+
+    def set_audit_log_actor
+      block = self.class.audit_log_actor_block
+      RailsAuditLog.actor = instance_exec(&block) if block
+    end
+
+    def clear_audit_log_actor
+      RailsAuditLog.actor = nil
+    end
+  end
+end

data/app/controllers/rails_audit_log/application_controller.rb

@@ -0,0 +1,4 @@
+module RailsAuditLog
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/rails_audit_log/application_helper.rb

@@ -0,0 +1,4 @@
+module RailsAuditLog
+  module ApplicationHelper
+  end
+end

data/app/jobs/rails_audit_log/application_job.rb

@@ -0,0 +1,4 @@
+module RailsAuditLog
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/models/rails_audit_log/application_record.rb

@@ -0,0 +1,5 @@
+module RailsAuditLog
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/rails_audit_log/audit_log_entry.rb

@@ -0,0 +1,18 @@
+module RailsAuditLog
+  class AuditLogEntry < ApplicationRecord
+    self.table_name = "audit_log_entries"
+
+    EVENTS = %w[create update destroy].freeze
+
+    belongs_to :item, polymorphic: true, optional: true
+    belongs_to :actor, polymorphic: true, optional: true
+
+    validates :event, presence: true, inclusion: { in: EVENTS }
+    validates :item_type, presence: true
+    validates :item_id, presence: true
+
+    scope :creates,  -> { where(event: "create") }
+    scope :updates,  -> { where(event: "update") }
+    scope :destroys, -> { where(event: "destroy") }
+  end
+end

data/app/views/layouts/rails_audit_log/application.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Rails audit log</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= yield :head %>
+
+  <%= stylesheet_link_tag    "rails_audit_log/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+RailsAuditLog::Engine.routes.draw do
+end

data/lib/generators/rails_audit_log/install/install_generator.rb

@@ -0,0 +1,21 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module RailsAuditLog
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Creates the audit_log_entries migration in your application."
+
+      def create_migration_file
+        migration_template(
+          "create_audit_log_entries.rb",
+          "db/migrate/create_audit_log_entries.rb"
+        )
+      end
+    end
+  end
+end

data/lib/generators/rails_audit_log/install/templates/create_audit_log_entries.rb

@@ -0,0 +1,18 @@
+class CreateAuditLogEntries < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :audit_log_entries do |t|
+      t.string  :event,      null: false
+      t.string  :item_type,  null: false
+      t.bigint  :item_id,    null: false
+      t.json    :object_changes
+      t.string  :actor_type
+      t.bigint  :actor_id
+      t.datetime :created_at, null: false, default: -> { "CURRENT_TIMESTAMP" }
+    end
+
+    add_index :audit_log_entries, [:item_type, :item_id]
+    add_index :audit_log_entries, [:actor_type, :actor_id]
+    add_index :audit_log_entries, :event
+    add_index :audit_log_entries, :created_at
+  end
+end

data/lib/rails_audit_log/engine.rb

@@ -0,0 +1,5 @@
+module RailsAuditLog
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsAuditLog
+  end
+end

data/lib/rails_audit_log/version.rb

@@ -0,0 +1,3 @@
+module RailsAuditLog
+  VERSION = "0.1.0"
+end

data/lib/rails_audit_log.rb

@@ -0,0 +1,20 @@
+require "rails_audit_log/version"
+require "rails_audit_log/engine"
+
+module RailsAuditLog
+  def self.actor
+    Thread.current[:rails_audit_log_actor]
+  end
+
+  def self.actor=(actor)
+    Thread.current[:rails_audit_log_actor] = actor
+  end
+
+  def self.with_actor(actor)
+    previous = self.actor
+    self.actor = actor
+    yield
+  ensure
+    self.actor = previous
+  end
+end

data/lib/tasks/rails_audit_log_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_audit_log do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: rails_audit_log
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chuck Smith
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+description: A modern Rails engine that tracks ActiveRecord create, update, and destroy
+  events with JSON-first storage, whodunnit actor context, and a clean query API.
+  Drop-in replacement for PaperTrail with no legacy baggage.
+email:
+- chuck@eclecticcoding.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/rails_audit_log/application.css
+- app/concerns/rails_audit_log/auditable.rb
+- app/concerns/rails_audit_log/controller.rb
+- app/controllers/rails_audit_log/application_controller.rb
+- app/helpers/rails_audit_log/application_helper.rb
+- app/jobs/rails_audit_log/application_job.rb
+- app/models/rails_audit_log/application_record.rb
+- app/models/rails_audit_log/audit_log_entry.rb
+- app/views/layouts/rails_audit_log/application.html.erb
+- config/routes.rb
+- lib/generators/rails_audit_log/install/install_generator.rb
+- lib/generators/rails_audit_log/install/templates/create_audit_log_entries.rb
+- lib/rails_audit_log.rb
+- lib/rails_audit_log/engine.rb
+- lib/rails_audit_log/version.rb
+- lib/tasks/rails_audit_log_tasks.rake
+homepage: https://github.com/eclectic-coding/rails_audit_log
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/eclectic-coding/rails_audit_log
+  source_code_uri: https://github.com/eclectic-coding/rails_audit_log
+  changelog_uri: https://github.com/eclectic-coding/rails_audit_log/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Zeitwerk-native audit logging for ActiveRecord
+test_files: []