audit_loggable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2e4abe618e6c92a3ffe1c0bb77bd209f6daada37a371a4e82f251c403460c7ac
+  data.tar.gz: bce5504334ae400bc74c6b30ba841bd1cfc415797430bd1636c791a2f15bfdcd
+SHA512:
+  metadata.gz: a981ea5a538ed5ace3ce70bec24a0d9c2a664b8fcc00d92ec0adf0386bd06df43677d414af3ca9c0ed344d04339ccdd872940bb2d8afe4f10be833fb32335b1a
+  data.tar.gz: e614a8b7208a4ddaac957b1362fbd63c4ee2ff1a0402c8edf6810a4266c49ef9da1ccd7eb63225e6aa729b9ab612027cf6996db769356eb148075808354d2c01

data/.github/workflows/ruby.yml

@@ -0,0 +1,43 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Build
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.5', '2.6', '2.7', '3.0']
+        activerecord: ['6.0', '6.1']
+        experimental: [false]
+        exclude:
+        - ruby: '3.0'
+          activerecord: '6.0'
+          experimental: false
+        include:
+        # waiting for a release of https://github.com/rails/rails/pull/39697
+        - ruby: '3.0'
+          activerecord: '6.0'
+          experimental: true
+    continue-on-error: ${{ matrix.experimental }}
+    env:
+      APPRAISAL: rails_${{ matrix.activerecord }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: |
+        bundle install
+        bundle exec appraisal $APPRAISAL bundle install
+    - name: Run tests
+      run: bundle exec appraisal $APPRAISAL rake

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/Gemfile.lock
+/gemfiles/*.lock
+/gemfiles/.bundle/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/audits.log

data/.rspec

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

data/Appraisals

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+appraise "rails_6.0" do
+  gem "rails", "~> 6.0.0"
+end
+
+appraise "rails_6.1" do
+  gem "rails", "~> 6.1.0"
+end

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## Unreleased
+
+
+## 1.0.0 (2021-03-30)
+
+* Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at info@vivid-garden.co.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in audit_loggable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 vivid garden Inc.
+
+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,99 @@
+# AuditLoggable
+
+[![Build](https://github.com/vividgarden/audit_loggable/actions/workflows/ruby.yml/badge.svg)](https://github.com/vividgarden/audit_loggable/actions/workflows/ruby.yml)
+
+AuditLoggable is a Rails plugin gem that logs changes to your models. AuditLoggable can also record who made those changes.  
+AuditLoggable is inspired by [Audited](https://github.com/collectiveidea/audited). However AuditLoggable logs to a JSONL file instead of RDB table.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'audit_loggable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install audit_loggable
+
+## Usage
+
+### Configuration
+``` ruby
+# config/initializers/audit_loggable.rb
+AuditLoggable.configure do |config|
+  if Rails.env.test?
+    config.auditing_enabled = false
+  end
+  config.audit_log_path = Rails.root.join("log", "audits.log")
+  config.audit_log_shift_age = "daily"
+end
+```
+
+Options
+| Name                            | Type              | Description                                                        | Default   |
+|:--------------------------------|:------------------|:-------------------------------------------------------------------|:----------|
+| `auditing_enabled`              | Boolean           | Switch to record audit log.                                        | `true`    |
+| `audit_log_path`                | String            | Path of audit log file.                                            | `nil`     |
+| `audit_log_shift_age`           | Integer or String | Same as `shift_age` option of `Logger` class of stdlib.            | `0`       |
+| `audit_log_shift_size`          | Integer           | Same as `shift_size` option of `Logger` class of stdlib.           | `1048576` |
+| `audit_log_shift_period_suffix` | String            | Same as `shift_period_suffix` options of `Logger` class of stdlib. | `%Y%m%d`  |
+
+### Extend your model by `AuditLoggable::Extension`
+``` ruby
+class ApplicationRecord < ActiveRecord::Base
+  extend AuditLoggable::Extension
+end
+```
+
+Active `AuditLoggable` in your model
+``` ruby
+class Post < ApplicationRecord
+  log_audit
+end
+```
+
+if you need to except columns by audit logging, specify `except` option as follow:
+``` ruby
+class Post < ApplicationRecord
+  log_audit except: %w[foo bar]
+end
+```
+
+if you need to record changes but not their values by audit logging, specify `redacted` option as follow:
+``` ruby
+class Post < ApplicationRecord
+  log_audit redacted: %w[foo bar]
+end
+```
+
+### Extend your controller by `AuditLoggable::Sweeper` to track request info (e.g. current user)
+``` ruby
+class ApplicationController < ActionController::Base
+  around_action AuditLoggable::Sweeper.new(current_user_methods: %i[current_user])
+end
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vividgarden/audit_loggable. 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/vividgarden/audit_loggable/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the AuditLoggable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/vividgarden/audit_loggable/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rake/clean"
+CLEAN.include("audits.log")
+
+task default: :spec

data/audit_loggable.gemspec

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "audit_loggable/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "audit_loggable"
+  spec.version       = AuditLoggable::VERSION
+  spec.authors       = ["Yuji Hanamura"]
+  spec.email         = ["yuji.developer@gmail.com"]
+
+  spec.summary       = "Log changes to your models"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/vividgarden/audit_loggable"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    spec.metadata["changelog_uri"] = "https://github.com/vividgarden/audit_loggable/blob/main/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.5"
+
+  spec.add_dependency "activerecord",  ">= 6.0"
+  spec.add_dependency "activesupport", ">= 6.0"
+
+  spec.add_development_dependency "appraisal", ">= 2.3.0"
+  spec.add_development_dependency "bundler",   ">= 1.17"
+  spec.add_development_dependency "rails",     ">= 6.0"
+  spec.add_development_dependency "rake",      ">= 10.0"
+  spec.add_development_dependency "rspec",     "~> 3.10"
+  spec.add_development_dependency "sqlite3",   "~> 1.4"
+end

data/bin/console

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "audit_loggable"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+AuditLoggable.configure do |config|
+  config.audit_log_path = File.expand_path("../audits.log", __dir__)
+end
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/rails_6.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 6.0.0"
+
+gemspec path: "../"

data/gemfiles/rails_6.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 6.1.0"
+
+gemspec path: "../"

data/lib/audit_loggable.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/object/json"
+require "active_support/core_ext/module/attr_internal"
+require "active_support/core_ext/module/delegation"
+
+require "audit_loggable/version"
+require "audit_loggable/configuration"
+require "audit_loggable/logger"
+require "audit_loggable/store"
+require "audit_loggable/change_set"
+require "audit_loggable/audit_record"
+require "audit_loggable/audit_record_set"
+require "audit_loggable/sweeper"
+require "audit_loggable/extension"
+
+module AuditLoggable
+  class << self
+    attr_reader :logger
+
+    delegate :audit_log_path, :audit_log_shift_age, :audit_log_shift_size, :audit_log_shift_period_suffix,
+             :auditing_enabled,
+             to: :configuration
+
+    def configure
+      yield configuration
+      initialize_logger
+
+      self
+    end
+
+    private
+
+    attr_reader :configuration
+
+    def initialize_logger
+      @logger = Logger.new(
+        self.audit_log_path,
+        shift_age:           self.audit_log_shift_age,
+        shift_size:          self.audit_log_shift_size,
+        shift_period_suffix: self.audit_log_shift_period_suffix
+      )
+    end
+  end
+
+  @configuration = Configuration.new
+end

data/lib/audit_loggable/audit_record.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module AuditLoggable
+  class AuditRecord
+    def initialize(auditable, user, action, changeset, remote_address, request_uuid)
+      @auditable = auditable
+      @user = user
+      @action = action
+      @changeset = changeset
+      @remote_address = remote_address
+      @request_uuid = request_uuid
+    end
+
+    def as_json(*)
+      {
+        auditable: { id: auditable.id, type: auditable.class.polymorphic_name },
+        user: user ? { id: user.id, type: user.class.polymorphic_name } : nil,
+        action: action,
+        changes: changeset.to_json, # serialize to JSON string
+        remote_address: remote_address,
+        request_uuid: request_uuid
+      }
+    end
+
+    private
+
+    attr_reader :auditable, :user, :action, :changeset, :remote_address, :request_uuid
+  end
+end

data/lib/audit_loggable/audit_record_set.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module AuditLoggable
+  class AuditRecordSet
+    include ::Enumerable
+
+    delegate :empty?, to: :set
+
+    def initialize
+      clear
+    end
+
+    def <<(audit_record)
+      set << audit_record
+      self
+    end
+
+    def clear
+      @set = []
+      self
+    end
+
+    def each(&block)
+      return to_enum unless block
+
+      set.each(&block)
+      self
+    end
+
+    def flush
+      ::AuditLoggable.logger.log(set)
+      clear
+    end
+
+    private
+
+    attr_reader :set
+  end
+end

data/lib/audit_loggable/change_set.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module AuditLoggable
+  module ChangeSet
+    class AttributesFilter
+      IGNORED_ATTRIBUTES = %w[created_at updated_at created_on updated_on].freeze
+
+      def initialize(klass, ignored_attributes, changes)
+        @klass = klass
+        @ignored_attributes = ignored_attributes
+        @changes = changes
+      end
+
+      def call
+        @changes
+          .except(
+            @klass.primary_key,
+            @klass.inheritance_column,
+            @klass.locking_column,
+            *@ignored_attributes,
+            *IGNORED_ATTRIBUTES
+          )
+      end
+    end
+
+    class EnumAttributesNormalizer
+      def initialize(klass, changes)
+        @klass = klass
+        @changes = changes
+      end
+
+      def call
+        @klass.defined_enums.each_pair.with_object(@changes.dup) do |(name, values), changes|
+          next unless changes.key?(name)
+
+          changes[name] =
+            if changes[name].is_a? ::Array
+              changes[name].map { |v| values[v] }
+            else
+              changes[name] = values[changes[name]]
+            end
+        end
+      end
+    end
+
+    class AttributesRedactor
+      REDACTED_VALUE = "[REDACTED]"
+
+      def initialize(redacted_attributes, changes)
+        @redacted_attributes = redacted_attributes
+        @changes = changes
+      end
+
+      def call
+        @redacted_attributes.each.with_object(@changes.dup) do |name, changes|
+          next unless changes.key?(name)
+
+          changes[name] =
+            if changes[name].is_a? ::Array
+              ::Array.new(changes[name].size, REDACTED_VALUE)
+            else
+              REDACTED_VALUE
+            end
+        end
+      end
+    end
+
+    class Base
+      def initialize(model, changes_method:, ignored_attributes: [], redacted_attributes: [])
+        klass = model.class
+        @changes =
+          model
+            .public_send(changes_method)
+            .yield_self { |changes| AttributesFilter.new(klass, ignored_attributes, changes).call }
+            .yield_self { |changes| EnumAttributesNormalizer.new(klass, changes).call }
+            .yield_self { |changes| AttributesRedactor.new(redacted_attributes, changes).call }
+      end
+
+      delegate :as_json, :empty?, to: :changes
+
+      private
+
+      attr_reader :changes
+    end
+
+    class Create < Base
+      def initialize(*args, **kwargs)
+        super(*args, changes_method: :attributes, **kwargs)
+      end
+    end
+
+    class Update < Base
+      def initialize(*args, **kwargs)
+        super(*args, changes_method: :previous_changes, **kwargs)
+      end
+    end
+
+    class Destroy < Base
+      def initialize(*args, **kwargs)
+        super(*args, changes_method: :attributes, **kwargs)
+      end
+    end
+  end
+end

data/lib/audit_loggable/configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module AuditLoggable
+  class Configuration
+    attr_accessor :audit_log_path, :audit_log_shift_age, :audit_log_shift_size, :audit_log_shift_period_suffix,
+                  :auditing_enabled
+
+    def initialize
+      self.auditing_enabled = true
+      self.audit_log_shift_age = 0
+      self.audit_log_shift_size = 1024 * 1024
+      self.audit_log_shift_period_suffix = "%Y%m%d"
+    end
+  end
+end

data/lib/audit_loggable/extension.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module AuditLoggable
+  module Extension
+    def log_audit(except: [], redacted: [])
+      self.class_eval do
+        attr_internal :audit_loggable_audit_record_set
+
+        callbacks = Callbacks.new(except: except, redacted: redacted)
+        after_create   callbacks
+        after_update   callbacks
+        after_destroy  callbacks
+        after_rollback callbacks
+        after_commit   callbacks
+      end
+    end
+
+    class Callbacks
+      def initialize(except: [], redacted: [])
+        @ignored_attributes = ::Array.wrap(except).map(&:to_s)
+        @redacted_attributes = ::Array.wrap(redacted).map(&:to_s)
+      end
+
+      def after_create(model)
+        changeset = build_changeset_for_create(model)
+
+        audit_record = build_audit_record(model, :create, changeset)
+        add_audit_record(model, audit_record)
+      end
+
+      def after_update(model)
+        changeset = build_changeset_for_update(model)
+        return if changeset.blank?
+
+        audit_record = build_audit_record(model, :update, changeset)
+        add_audit_record(model, audit_record)
+      end
+
+      def after_destroy(model)
+        changeset = build_changeset_for_destroy(model)
+
+        audit_record = build_audit_record(model, :destroy, changeset)
+        add_audit_record(model, audit_record)
+      end
+
+      def after_rollback(model)
+        return if model.audit_loggable_audit_record_set.blank?
+
+        clear_audit_record_set(model)
+      end
+
+      def after_commit(model)
+        return if model.audit_loggable_audit_record_set.blank?
+
+        persist_audit_record_set(model)
+      end
+
+      private
+
+      attr_reader :ignored_attributes, :redacted_attributes
+
+      def build_changeset_for_create(model)
+        ChangeSet::Create.new(model, ignored_attributes: ignored_attributes, redacted_attributes: redacted_attributes)
+      end
+
+      def build_changeset_for_update(model)
+        ChangeSet::Update.new(model, ignored_attributes: ignored_attributes, redacted_attributes: redacted_attributes)
+      end
+
+      def build_changeset_for_destroy(model)
+        ChangeSet::Destroy.new(model, ignored_attributes: ignored_attributes, redacted_attributes: redacted_attributes)
+      end
+
+      def build_audit_record(model, action, changeset)
+        user = Store.current_user
+        address = Store.current_remote_address
+        uuid = Store.current_request_uuid
+
+        AuditRecord.new(model, user, action, changeset, address, uuid)
+      end
+
+      def add_audit_record(model, audit_record)
+        model.audit_loggable_audit_record_set ||= AuditRecordSet.new
+        model.audit_loggable_audit_record_set << audit_record
+      end
+
+      def clear_audit_record_set(model)
+        model.audit_loggable_audit_record_set.clear
+      end
+
+      def persist_audit_record_set(model)
+        model.audit_loggable_audit_record_set.flush
+      end
+    end
+  end
+end

data/lib/audit_loggable/logger.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "logger"
+
+module AuditLoggable
+  class Logger
+    class JSONFormatter < ::Logger::Formatter
+      def call(_severity, time, _progname, message)
+        h = { timestamp: time, record: message }
+        "#{h.to_json}\n"
+      end
+    end
+
+    class NoHeaderLogDevice < ::Logger::LogDevice
+      private
+
+      def add_log_header(*)
+        # Suppress header output when creating a log file
+      end
+    end
+
+    class InternalLogger < ::Logger
+      def initialize(logdev, shift_age:, shift_size:, shift_period_suffix:)
+        super(nil, level: :info, formatter: JSONFormatter.new)
+
+        return unless logdev
+
+        @logdev =
+          NoHeaderLogDevice.new(logdev,
+                                shift_age: shift_age,
+                                shift_size: shift_size,
+                                shift_period_suffix: shift_period_suffix)
+      end
+    end
+
+    def initialize(*args, **kwargs)
+      @logger = InternalLogger.new(*args, **kwargs)
+    end
+
+    def log(audit_record_set)
+      return unless ::AuditLoggable.auditing_enabled
+
+      audit_record_set.each do |audit_record|
+        @logger.info(audit_record)
+      end
+    end
+  end
+end

data/lib/audit_loggable/store.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "active_support/current_attributes"
+
+module AuditLoggable
+  class Store < ::ActiveSupport::CurrentAttributes
+    attribute :current_controller, :current_user, :current_remote_address, :current_request_uuid
+
+    def current_user
+      super&.yield_self do |user|
+        if user.is_a?(::Proc) || user.is_a?(::Method) || user.respond_to?(:call)
+          user.call
+        else
+          user
+        end
+      end
+    end
+  end
+end

data/lib/audit_loggable/sweeper.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module AuditLoggable
+  class Sweeper
+    STORED_DATA = {
+      current_remote_address: :remote_ip,
+      current_request_uuid:   :request_uuid,
+      current_user:           :current_user
+    }.freeze
+
+    def initialize(current_user_methods: %i[current_user])
+      @current_user_methods = ::Array.wrap(current_user_methods).map(&:to_sym)
+    end
+
+    def around(controller, &block)
+      Store.set({ current_controller: controller }) do
+        Store.set(
+          STORED_DATA
+            .each_pair
+            .with_object({}) { |(k, m), h| h[k] = __send__(m) },
+          &block
+        )
+      end
+    end
+
+    private
+
+    attr_reader :current_user_methods
+
+    delegate :request,   to: :controller, private: true, allow_nil: true
+    delegate :remote_ip, to: :request,    private: true, allow_nil: true
+    delegate :uuid,      to: :request,    private: true, allow_nil: true, prefix: true
+
+    def current_user
+      lambda do
+        current_user_methods
+          .lazy.map { |m| controller.__send__(m) if controller.respond_to?(m, true) }
+          .find(&:present?)
+      end
+    end
+
+    def controller
+      Store.current_controller
+    end
+  end
+end

data/lib/audit_loggable/version.rb

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

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: audit_loggable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yuji Hanamura
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Log changes to your models
+email:
+- yuji.developer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- Appraisals
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- audit_loggable.gemspec
+- bin/console
+- bin/setup
+- gemfiles/rails_6.0.gemfile
+- gemfiles/rails_6.1.gemfile
+- lib/audit_loggable.rb
+- lib/audit_loggable/audit_record.rb
+- lib/audit_loggable/audit_record_set.rb
+- lib/audit_loggable/change_set.rb
+- lib/audit_loggable/configuration.rb
+- lib/audit_loggable/extension.rb
+- lib/audit_loggable/logger.rb
+- lib/audit_loggable/store.rb
+- lib/audit_loggable/sweeper.rb
+- lib/audit_loggable/version.rb
+homepage: https://github.com/vividgarden/audit_loggable
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/vividgarden/audit_loggable
+  source_code_uri: https://github.com/vividgarden/audit_loggable
+  changelog_uri: https://github.com/vividgarden/audit_loggable/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Log changes to your models
+test_files: []