audit-log 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd049092e7b9e427a66e776f4248c42a74b19fb667a12fec8aa5ecf9abaf08f3
-  data.tar.gz: 2d7e6e61ddf78747fbf9dbb1b2b427c16fa6c0015405eaf3222e23839afdf691
+  metadata.gz: 613411720c743b51ce59f552b9264cddfc19a7b4443ebb886f4bed80f42622ff
+  data.tar.gz: f17b916a8898fc3b48b9010f5b9bf39dd4a4e246a245d79b500e8cdd7ca36353
 SHA512:
-  metadata.gz: a3c21ee0a6658f309188e1fffb17c906cf0005eb0c67ed337e65f6c0ba901e17ec1238e49e796abb7bb173e70dd61385b28d7af7fcc64d8fefd8cd06c829fa82
-  data.tar.gz: 3faacb77c43e1af56395c4aa515c67e536a1a96c719baa313051bd6995aa17d949c67454a0234b3bbf35329fa0b7eecc2a29b4d13bbc0105773f2dbfef9da755
+  metadata.gz: 2c4ec193452b1ef7ba92e699c3043f8f83fdf5a8e3eacc69ac0ada22816583706894a20d2b0788e573a3a8dff4710b4ee00819b332b1849b744ec271ca8b5a06
+  data.tar.gz: 4d0dc7efb373289ffb6cabfd806ad1105259b8e9d0e2a399e694fa2ffc91071dd85004a01684f70925e8b05c7b7afa1b18dbb5980b686c5b80a4e9627eb71d1d

data/README.md

@@ -6,6 +6,8 @@ Trail audit logs (Operation logs) into the database for user behaviors, includin
 
 > We used audit-log in our production environment more than 1 year, until now (2020.5.21), it's inserted about **20 million** log in our system.
 
+[中文介绍与使用说明](https://ruby-china.org/topics/39890)
+
 ## Demo UI
 
 Audit log list:

data/Rakefile

@@ -1,34 +1,34 @@
 # frozen_string_literal: true
 
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-require 'rdoc/task'
+require "rdoc/task"
 
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'AuditLog'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "AuditLog"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
-APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
-load 'rails/tasks/engine.rake'
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
 
-load 'rails/tasks/statistics.rake'
+load "rails/tasks/statistics.rake"
 
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = false
 end
 

data/app/controllers/audit_log/logs_controller.rb

@@ -2,12 +2,12 @@
 
 module AuditLog
   class LogsController < ActionController::Base
-    layout 'audit-log/application'
+    layout "audit-log/application"
     before_action :set_log, only: %i[show destroy]
 
     def index
-      @logs = Log.order('id desc').includes(:user)
-      @logs = @logs.where('action like ?', "%#{params[:q]}%") if params[:q].present?
+      @logs = Log.order("id desc").includes(:user)
+      @logs = @logs.where("action like ?", "%#{params[:q]}%") if params[:q].present?
       @logs = @logs.where("action = ?", params[:action_type]) if params[:action_type].present?
       @logs = @logs.where("created_at >= ?", Time.parse(params[:start_time])) if params[:start_time].present?
       @logs = @logs.where("created_at < ?", Time.parse(params[:end_time])) if params[:end_time].present?

data/config/routes.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 AuditLog::Engine.routes.draw do
-  resources :logs, path: ''
+  resources :logs, path: ""
 end

data/db/migrate/20190527035005_create_audit_logs.rb

@@ -1,17 +1,19 @@
-class CreateAuditLogs < ActiveRecord::Migration[5.0]
+# frozen_string_literal: true
+
+class CreateAuditLogs < ActiveRecord::Migration[5.2]
   def change
-    create_table 'audit_logs', force: :cascade do |t|
-      t.string 'action', null: false
-      t.integer 'user_id'
-      t.integer 'record_id'
-      t.string 'record_type'
-      t.text 'payload'
-      t.text 'request'
-      t.datetime 'created_at'
-      t.datetime 'updated_at'
+    create_table "audit_logs", force: :cascade do |t|
+      t.string "action", null: false
+      t.bigint "user_id"
+      t.bigint "record_id"
+      t.string "record_type"
+      t.text "payload"
+      t.text "request"
+      t.datetime "created_at"
+      t.datetime "updated_at"
       t.index %w[record_type record_id], using: :btree
       t.index %w[user_id action], using: :btree
-      t.index ['action'], using: :btree
+      t.index ["action"], using: :btree
     end
   end
 end

data/lib/audit-log/configuration.rb

@@ -10,5 +10,8 @@ module AuditLog
 
     # user name method, default: "name"
     attr_accessor :user_name_method
+
+    # set a speicla table_name for AuditLog Model, default: 'audit_logs'
+    attr_accessor :table_name
   end
 end

data/lib/audit-log/controller_helper.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module AuditLog
   module ControllerHelper
     # Create an audit log
     #
     # audit!(:edit_account, @account, payload: account_params)
     def audit!(action, record = nil, payload: nil, user: nil)
-      user ||= self.send(AuditLog.config.current_user_method.to_sym)
+      user ||= send(AuditLog.config.current_user_method.to_sym)
       AuditLog.audit!(action, record, payload: payload, request: request, user: user)
     end
   end

data/lib/audit-log/engine.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './controller_helper'
+require_relative "./controller_helper"
 
 module AuditLog
   class Engine < Rails::Engine
@@ -12,7 +12,7 @@ module AuditLog
 
     AuditLog::LogSubscriber.attach_to :audit_log
 
-    initializer 'audit-log.assets.precompile', group: :all do |app|
+    initializer "audit-log.assets.precompile", group: :all do |app|
       app.config.assets.precompile += %w[audit-log/application.css]
     end
   end

data/lib/audit-log/log_subscriber.rb

@@ -4,7 +4,7 @@ module AuditLog
   class LogSubscriber < ActiveSupport::LogSubscriber
     # ActiveSupport::Notifications.instrument('audit.audit_log', action: action)
     def audit(event)
-      prefix = color('AuditLog', CYAN)
+      prefix = color("AuditLog", CYAN)
       action = color(event.payload[:action], BLUE)
       debug "  #{prefix} #{action} (#{event.duration.round(1)}ms)"
     end

data/lib/audit-log/model.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module AuditLog
   module Model
     extend ActiveSupport::Concern
 
     included do
-      self.table_name = 'audit_logs'
+      self.table_name = AuditLog.config.table_name
 
       serialize :payload, JSON
       serialize :request, JSON
@@ -22,13 +24,13 @@ module AuditLog
     end
 
     def user_name
-      return 'none' if self.user.blank?
+      return "none" if user.blank?
 
-      self.user.send(AuditLog.config.user_name_method)
+      user.send(AuditLog.config.user_name_method)
     end
 
     def action_name
-      I18n.t("audit_log.action.#{self.action}", default: self.action)
+      I18n.t("audit_log.action.#{action}", default: action)
     end
   end
 end

data/lib/audit-log/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AuditLog
-  VERSION = '1.0.0'
+  VERSION = "1.2.0"
 end

data/lib/audit-log.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require_relative './audit-log/version'
-require_relative './audit-log/configuration'
-require_relative './audit-log/model'
-require_relative './audit-log/log_subscriber'
-require_relative './audit-log/engine'
-require 'kaminari'
+require_relative "./audit-log/version"
+require_relative "./audit-log/configuration"
+require_relative "./audit-log/model"
+require_relative "./audit-log/log_subscriber"
+require_relative "./audit-log/engine"
+require "kaminari"
 
 module AuditLog
   class << self
@@ -13,9 +13,10 @@ module AuditLog
       return @config if defined?(@config)
 
       @config = Configuration.new
-      @config.user_class = 'User'
-      @config.current_user_method = 'current_user'
-      @config.user_name_method = 'name'
+      @config.user_class = "User"
+      @config.current_user_method = "current_user"
+      @config.user_name_method = "name"
+      @config.table_name = "audit_logs"
       @config
     end
 
@@ -27,7 +28,7 @@ module AuditLog
     #
     # AuditLog.audit!(:edit_account, @account, payload: account_params, user: current_user)
     def audit!(action, record = nil, payload: nil, user: nil, request: nil)
-      ActiveSupport::Notifications.instrument('audit.audit_log', action: action) do
+      ActiveSupport::Notifications.instrument("audit.audit_log", action: action) do
         request_info = {}
         if request
           request_info = {
@@ -55,7 +56,7 @@ module AuditLog
 
     # Get I18n action name options for select
     def action_options
-      I18n.t('audit_log.action').map { |k, v| [v, k.to_s] }
+      I18n.t("audit_log.action").map { |k, v| [v, k.to_s] }
     end
   end
 end

data/lib/generators/audit_log/install_generator.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
 
-require 'rails/generators'
+require "rails/generators"
 module AuditLog
   module Generators
     class InstallGenerator < Rails::Generators::Base
       desc "Create AuditLog's base files"
-      source_root File.expand_path('../../..', __dir__)
+      source_root File.expand_path("../../..", __dir__)
 
       def add_initializer
-        template 'config/initializers/audit-log.rb', 'config/initializers/audit-log.rb'
-        template 'config/locales/audit-log.yml', 'config/locales/audit-log.yml'
+        template "config/initializers/audit-log.rb", "config/initializers/audit-log.rb"
+        template "config/locales/audit-log.yml", "config/locales/audit-log.yml"
       end
 
       def add_migrations
-        exec('rake audit_log:install:migrations')
+        exec("rake audit_log:install:migrations")
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: audit-log
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jason Lee
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-21 00:00:00.000000000 Z
+date: 2022-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kaminari
@@ -30,28 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: mysql2
-  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'
+        version: '5.2'
 description: Trail audit logs (Operation logs) into the database for user behaviors,
   including a web UI to query logs.
 email:
@@ -85,7 +71,7 @@ homepage: https://github.com/rails-engine/audit-log
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -100,8 +86,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.12
+signing_key:
 specification_version: 4
 summary: Trail audit logs (Operation logs) into the database for user behaviors, including
   a web UI to query logs