audit_log_vk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df1d9e69ffc1af41bc77961e10bc4b7914f5db29dd283186d0b6dd19e346ff47
+  data.tar.gz: 2ca0bb840d2427ff623275d0bd4c37293080ef4fb04efaeafdabb57c359a784b
+SHA512:
+  metadata.gz: 36e27ef44a58edc2e2f334d943eb4f411f9948fad4e0168df77db0a5ee879f0eca003094d60898e5c9df96ffcaa82276d2139da2e93619007ecd3d74eeeb1b75
+  data.tar.gz: df0979b95450867bd5ed279f4809fdab9d7c613c1d7a78005773bad8a37d902280b0572f6bde7e36c4f8c9e2d0d58bed07a588442b93e6697490610a197e1eea

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-03-28
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at araujo. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 viktor
+
+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,121 @@
+# AuditLog
+
+A lightweight, Rails-friendly audit logging gem to track model changes (`create`, `update`, `destroy`) with contextual metadata like `actor` and `reason`. Perfect for admin panels, SaaS apps, and audit trails.
+
+---
+
+## ✨ Features
+
+- Track `create`, `update`, and `destroy` events on any model  
+- Store changes in an `audit_log_entries` table  
+- Associate logs with the user (or any actor) who made the change  
+- Optional `reason` for change  
+- Configurable `only:` and `except:` fields  
+- Easy to install and integrate
+
+---
+
+## 🔧 Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "audit_log", path: "path/to/your/local/gem" 
+# or gem "audit_log" if published
+```
+Then run:
+```ruby
+bundle install
+```
+Install the initializer and migration:
+```ruby
+bin/rails generate audit_log:install
+bin/rails db:migrate
+```
+
+## 🚀 Usage
+
+### 1. Include the concern in your model:
+
+```ruby
+class Post < ApplicationRecord
+  include AuditLog::Model
+
+  audited
+end
+```
+You can optionally limit or exclude tracked attributes:
+```ruby
+audited only: [:title, :status]         # Only track these fields
+audited except: [:updated_at, :synced]  # Track everything but these
+```
+
+### 2. Set the actor (who made the change):
+In your controller (e.g. ApplicationController):
+```ruby
+before_action do
+  AuditLog::Context.actor = current_user
+end
+```
+You can configure the method name (current_user) in the initializer.
+
+### 3. Optionally set a reason:
+You can set a reason for changes anywhere in your code:
+```ruby
+AuditLog::Context.with(reason: "bulk import") do
+  post.update!(status: "archived")
+end
+```
+
+## ⚙️ Configuration
+Generated initializer at config/initializers/audit_log.rb:
+```ruby
+AuditLog.configure do |config|
+  config.actor_method = :current_user
+  config.ignored_attributes = ["updated_at"]
+end
+```
+
+## 🧪 Testing in your app
+Use AuditLog::Entry to inspect audit logs:
+```ruby
+AuditLog::Entry.for_model(post).order(created_at: :desc)
+```
+
+## 📦 Entry Table Schema
+The install generator includes a migration that creates:
+```ruby
+create_table :audit_log_entries do |t|
+  t.string  :auditable_type
+  t.bigint  :auditable_id
+  t.string  :action
+  t.json    :changed_data
+  t.string  :reason
+  t.string  :actor_type
+  t.bigint  :actor_id
+  t.timestamps
+end
+```
+
+## ✅ Development
+This gem uses rspec and an in-memory SQLite DB to test audit hooks.
+
+Run specs with:
+```ruby
+bundle exec rspec
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/audit_log. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/audit_log/blob/master/CODE_OF_CONDUCT.md).
+
+## 📄 License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 🙌 Credits
+
+Created with by Viktor Araújo.
+
+Inspired by open-source audit trail gems like PaperTrail, Audited, and others — but lighter and more simple.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/audit_log.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/audit_log/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "audit_log_vk"
+  spec.version = AuditLog::VERSION
+  spec.authors = ["viktor"]
+  spec.email = ["araujo"]
+
+  spec.summary     = "Track changes to models with audit logging."
+  spec.description = "AuditLog is a lightweight gem for adding create/update/delete auditing to your Rails models. Tracks changes, actor, and optional reasons."
+  spec.homepage    = "https://github.com/vkaraujo/audit_log"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"]   = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata["homepage_uri"] = "https://github.com/vkaraujo/audit_log"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "rails", ">= 6.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/audit_log/config.rb

@@ -0,0 +1,24 @@
+# lib/audit_log/config.rb
+module AuditLog
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+
+    def reset_configuration!
+      self.configuration = Configuration.new
+    end
+  end
+
+  class Configuration
+    attr_accessor :actor_method, :ignored_attributes
+
+    def initialize
+      @actor_method = :current_user
+      @ignored_attributes = ["updated_at"]
+    end
+  end
+end

data/lib/audit_log/context.rb

@@ -0,0 +1,38 @@
+# lib/audit_log/context.rb
+module AuditLog
+  class Context
+    THREAD_KEY = :audit_log_context
+
+    class << self
+      # Set the current actor (e.g. current_user)
+      def actor=(value)
+        context[:actor] = value
+      end
+
+      def actor
+        context[:actor]
+      end
+
+      # Set a reason for this audit action
+      def reason=(value)
+        context[:reason] = value
+      end
+
+      def reason
+        context[:reason]
+      end
+
+      # Clears the stored context after each request/job
+      def reset!
+        Thread.current[THREAD_KEY] = {}
+      end
+
+      private
+
+      # Lazily initializes the thread-local context hash
+      def context
+        Thread.current[THREAD_KEY] ||= {}
+      end
+    end
+  end
+end

data/lib/audit_log/entry.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require "active_record"
+
+module AuditLog
+  class Entry < ActiveRecord::Base
+    self.table_name = "audit_log_entries"
+
+    belongs_to :auditable, polymorphic: true
+    belongs_to :actor, polymorphic: true, optional: true
+
+    # serialize :changed_data, coder: JSON
+
+    validates :action, presence: true
+    validates :auditable_type, :auditable_id, presence: true
+
+    scope :for_model, ->(model) do
+      where(auditable_type: model.class.name, auditable_id: model.id)
+    end
+  end
+end

data/lib/audit_log/helpers.rb

@@ -0,0 +1,19 @@
+# lib/audit_log/helpers.rb
+module AuditLog
+  module Helpers
+    # Executes a block with the given audit context
+    #
+    # Example:
+    #   AuditLog.with_context(actor: current_user, reason: "Batch update") do
+    #     user.update!(name: "New")
+    #   end
+    #
+    def self.with_context(actor: nil, reason: nil)
+      AuditLog::Context.actor = actor
+      AuditLog::Context.reason = reason
+      yield
+    ensure
+      AuditLog::Context.reset!
+    end
+  end
+end

data/lib/audit_log/model.rb

@@ -0,0 +1,82 @@
+# lib/audit_log/model.rb
+require "active_support/concern"
+
+module AuditLog
+  module Model
+    extend ActiveSupport::Concern
+
+    included do
+      # Stores configuration options passed to the `audited` macro
+      class_attribute :audit_log_options
+    end
+
+    class_methods do
+      # Call this in any model to enable audit logging
+      # Example: `audited only: [:name], except: [:updated_at]`
+      def audited(only: nil, except: [])
+        self.audit_log_options = {
+          only: Array(only).map(&:to_s),
+          except: Array(except).map(&:to_s)
+        }
+
+        # Includes the callback hooks that handle logging
+        include AuditLog::Model::Hooks
+      end
+    end
+
+    module Hooks
+      extend ActiveSupport::Concern
+
+      included do
+        # Add model lifecycle callbacks for auditing
+        after_create  :log_audit_create
+        after_update  :log_audit_update
+        before_destroy :log_audit_destroy
+      end
+
+      private
+
+      # Called after a record is created
+      # Logs all initial attributes
+      def log_audit_create
+        create_audit_entry("create", saved_changes.except(*ignored_audit_attrs))
+      end
+
+      # Called before a record is updated
+      # Skips logging if there are no meaningful changes
+      def log_audit_update
+        return if saved_changes.except(*ignored_audit_attrs).empty?
+
+        create_audit_entry("update", saved_changes.except(*ignored_audit_attrs))
+      end
+
+      # Called before a record is destroyed
+      # Logs the full record state before deletion
+      def log_audit_destroy
+        create_audit_entry("destroy", attributes)
+      end
+
+      # Actually creates the audit log entry
+      def create_audit_entry(action, changed_data)
+        AuditLog::Entry.create!(
+          auditable: self,
+          action: action,
+          actor: AuditLog::Context.actor,
+          reason: AuditLog::Context.reason,
+          changed_data: changed_data
+        )
+      end
+
+      # Builds the list of attributes to ignore when logging
+      def ignored_audit_attrs
+        if audit_log_options[:only].any?
+          # Only track the specified attributes; ignore all others
+          attribute_names - audit_log_options[:only]
+        else
+          # Ignore what's in `except:` + global ignored config
+          Array(audit_log_options[:except]) + AuditLog.configuration.ignored_attributes
+        end
+      end
+    end
+  end
+end

data/lib/audit_log/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AuditLog
+  VERSION = "0.1.0"
+end

data/lib/audit_log.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require_relative "audit_log/version"
+require_relative "audit_log/config"
+require_relative "audit_log/context"
+require_relative "audit_log/entry"
+require_relative "audit_log/model"
+require_relative "audit_log/helpers"
+
+module AuditLog
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/generators/audit_log/install_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module AuditLog
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_initializer
+        template "initializer.rb", "config/initializers/audit_log.rb"
+      end
+
+      def copy_migration
+        timestamp = Time.now.utc.strftime("%Y%m%d%H%M%S")
+        migration_name = "create_audit_log_entries"
+        copy_file "migration.rb", "db/migrate/#{timestamp}_#{migration_name}.rb"
+      end
+    end
+  end
+end

data/lib/generators/audit_log/templates/initializer.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Configure AuditLog defaults
+AuditLog.configure do |config|
+  # Method used to get the actor (e.g. :current_user or :current_admin)
+  config.actor_method = :current_user
+
+  # Attributes to ignore when tracking changes
+  config.ignored_attributes = ["updated_at"]
+end

data/lib/generators/audit_log/templates/migration.rb

@@ -0,0 +1,17 @@
+class CreateAuditLogEntries < ActiveRecord::Migration[6.0]
+  def change
+    create_table :audit_log_entries do |t|
+      t.string  :auditable_type
+      t.bigint  :auditable_id
+      t.string  :action
+      t.json    :changed_data
+      t.string  :reason
+      t.string  :actor_type
+      t.bigint  :actor_id
+      t.timestamps
+    end
+
+    add_index :audit_log_entries, [:auditable_type, :auditable_id]
+    add_index :audit_log_entries, [:actor_type, :actor_id]
+  end
+end

data/sig/audit_log.rbs

@@ -0,0 +1,4 @@
+module AuditLog
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: audit_log_vk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- viktor
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2025-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: AuditLog is a lightweight gem for adding create/update/delete auditing
+  to your Rails models. Tracks changes, actor, and optional reasons.
+email:
+- araujo
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- audit_log.gemspec
+- lib/audit_log.rb
+- lib/audit_log/config.rb
+- lib/audit_log/context.rb
+- lib/audit_log/entry.rb
+- lib/audit_log/helpers.rb
+- lib/audit_log/model.rb
+- lib/audit_log/version.rb
+- lib/generators/audit_log/install_generator.rb
+- lib/generators/audit_log/templates/initializer.rb
+- lib/generators/audit_log/templates/migration.rb
+- sig/audit_log.rbs
+homepage: https://github.com/vkaraujo/audit_log
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/vkaraujo/audit_log
+  changelog_uri: https://github.com/vkaraujo/audit_log/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/vkaraujo/audit_log
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key: 
+specification_version: 4
+summary: Track changes to models with audit logging.
+test_files: []