audit_loggable 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e4abe618e6c92a3ffe1c0bb77bd209f6daada37a371a4e82f251c403460c7ac
-  data.tar.gz: bce5504334ae400bc74c6b30ba841bd1cfc415797430bd1636c791a2f15bfdcd
+  metadata.gz: ec0a5517dd3f92ad8be7051785176487c7e7fdec36762421469224bf9461eaaf
+  data.tar.gz: fd8d3fd6157d0b74b74df9d73d6ee8cf55fbb3be30c717b8ac2264ff5b959970
 SHA512:
-  metadata.gz: a981ea5a538ed5ace3ce70bec24a0d9c2a664b8fcc00d92ec0adf0386bd06df43677d414af3ca9c0ed344d04339ccdd872940bb2d8afe4f10be833fb32335b1a
-  data.tar.gz: e614a8b7208a4ddaac957b1362fbd63c4ee2ff1a0402c8edf6810a4266c49ef9da1ccd7eb63225e6aa729b9ab612027cf6996db769356eb148075808354d2c01
+  metadata.gz: dd8ff1bcf4cfb1ea6a80d7992f13c7bc387bbf43de128b32bf6f97e35e424ad24646828648a2aacc9699db519b14d289a577cc5cce724e7a12b81860d668b60e
+  data.tar.gz: 3122c66ac200a2cc7d4720516596d6f4a81d3ff855f6503119cf2ad26da11c29ee8e8984a3eb508a9bfd547291afaf19c0c9b03d8c450bed16f6674ab1c2c7a5

data/.github/workflows/ruby.yml

@@ -14,18 +14,13 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: ['2.5', '2.6', '2.7', '3.0']
-        activerecord: ['6.0', '6.1']
+        ruby: ['2.7', '3.0', '3.1']
+        activerecord: ['6.0', '6.1', '7.0']
         experimental: [false]
         exclude:
-        - ruby: '3.0'
+        - ruby: '3.1'
           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 }}
@@ -40,4 +35,6 @@ jobs:
         bundle install
         bundle exec appraisal $APPRAISAL bundle install
     - name: Run tests
+      env:
+        TZ: "Asia/Tokyo"
       run: bundle exec appraisal $APPRAISAL rake

data/Appraisals

@@ -7,3 +7,7 @@ end
 appraise "rails_6.1" do
   gem "rails", "~> 6.1.0"
 end
+
+appraise "rails_7.0" do
+  gem "rails", "~> 7.0.1"
+end

data/CHANGELOG.md

@@ -1,6 +1,21 @@
 ## Unreleased
 
 
+## 1.1.0 (2022-09-23)
+
+### Changes
+
+* Make configurable timezone of timestamp
+* Change `AuditRecord#as_json` to accept the options of `Hash#as_json`
+
+### Misc
+
+* CI against for Rails 7.0
+* CI against for Ruby 3.1
+* Require MFA to release gem
+* Drop support for Ruby 2.5/2.6
+
+
 ## 1.0.0 (2021-03-30)
 
 * Initial release

data/README.md

@@ -1,5 +1,6 @@
 # AuditLoggable
 
+[![Gem Version](https://badge.fury.io/rb/audit_loggable.svg)](https://badge.fury.io/rb/audit_loggable)
 [![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.  
@@ -43,6 +44,7 @@ Options
 | `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`  |
+| `audit_log_timezone`            | Enum              | The timezone of timestamp. Any value of `:local` or `:utc`.        | `local`  |
 
 ### Extend your model by `AuditLoggable::Extension`
 ``` ruby

data/audit_loggable.gemspec

@@ -23,6 +23,8 @@ Gem::Specification.new do |spec|
     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"
+
+    spec.metadata["rubygems_mfa_required"] = "true"
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
       "public gem pushes."
@@ -37,7 +39,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.5"
+  spec.required_ruby_version = ">= 2.7"
 
   spec.add_dependency "activerecord",  ">= 6.0"
   spec.add_dependency "activesupport", ">= 6.0"

data/gemfiles/rails_7.0.gemfile

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

data/lib/audit_loggable/audit_record.rb

@@ -11,7 +11,7 @@ module AuditLoggable
       @request_uuid = request_uuid
     end
 
-    def as_json(*)
+    def as_json(options = nil)
       {
         auditable: { id: auditable.id, type: auditable.class.polymorphic_name },
         user: user ? { id: user.id, type: user.class.polymorphic_name } : nil,
@@ -19,7 +19,7 @@ module AuditLoggable
         changes: changeset.to_json, # serialize to JSON string
         remote_address: remote_address,
         request_uuid: request_uuid
-      }
+      }.as_json(options)
     end
 
     private

data/lib/audit_loggable/configuration.rb

@@ -3,13 +3,14 @@
 module AuditLoggable
   class Configuration
     attr_accessor :audit_log_path, :audit_log_shift_age, :audit_log_shift_size, :audit_log_shift_period_suffix,
-                  :auditing_enabled
+                  :auditing_enabled, :audit_log_timezone
 
     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"
+      self.audit_log_timezone = :local
     end
   end
 end

data/lib/audit_loggable/logger.rb

@@ -5,8 +5,22 @@ require "logger"
 module AuditLoggable
   class Logger
     class JSONFormatter < ::Logger::Formatter
+      attr_reader :timezone
+
+      def initialize(timezone:)
+        raise ArgumentError unless %i[utc local].include? timezone
+
+        @timezone = timezone
+      end
+
       def call(_severity, time, _progname, message)
-        h = { timestamp: time, record: message }
+        timestamp =
+          case timezone
+          when :utc then time.getutc
+          when :local then time.getlocal
+          end
+
+        h = { timestamp: timestamp, record: message }
         "#{h.to_json}\n"
       end
     end
@@ -20,8 +34,8 @@ module AuditLoggable
     end
 
     class InternalLogger < ::Logger
-      def initialize(logdev, shift_age:, shift_size:, shift_period_suffix:)
-        super(nil, level: :info, formatter: JSONFormatter.new)
+      def initialize(logdev, shift_age:, shift_size:, shift_period_suffix:, timezone:)
+        super(nil, level: :info, formatter: JSONFormatter.new(timezone: timezone))
 
         return unless logdev
 

data/lib/audit_loggable/version.rb

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

data/lib/audit_loggable.rb

@@ -21,7 +21,7 @@ module AuditLoggable
     attr_reader :logger
 
     delegate :audit_log_path, :audit_log_shift_age, :audit_log_shift_size, :audit_log_shift_period_suffix,
-             :auditing_enabled,
+             :auditing_enabled, :audit_log_timezone,
              to: :configuration
 
     def configure
@@ -40,7 +40,8 @@ module AuditLoggable
         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
+        shift_period_suffix: self.audit_log_shift_period_suffix,
+        timezone:            self.audit_log_timezone
       )
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: audit_loggable
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Yuji Hanamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-29 00:00:00.000000000 Z
+date: 2022-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -144,6 +144,7 @@ files:
 - bin/setup
 - gemfiles/rails_6.0.gemfile
 - gemfiles/rails_6.1.gemfile
+- gemfiles/rails_7.0.gemfile
 - lib/audit_loggable.rb
 - lib/audit_loggable/audit_record.rb
 - lib/audit_loggable/audit_record_set.rb
@@ -162,6 +163,7 @@ metadata:
   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
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -170,14 +172,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Log changes to your models