rails_audit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 66a9b44197ab98e223cd4fe09d5860dd4754b4b33864667a3f24d26637094ab8
+  data.tar.gz: 9887f80180f32cfd6cc8c7407d8ace12d8135ea1e5fa155e809c0fad0477f2e9
+SHA512:
+  metadata.gz: 1ae57713efafa015a7eee6979adda07943432965912bfbf87531cc3c6b11b059a6ea0ece99a9f1557f75d77e0dd677f8168e7bcd2fb682e3aaacf0144ee8a16e
+  data.tar.gz: 442bda1479c877b53bae748b477f466e4ad85b09f990f79f67000ded8ed7d994ad30293f1f3d1602bc111b96e2e83d63dd4702aed02fd265e7d67821eef0de78

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,45 @@
+# RailsAudit
+
+Unlike [audited](https://github.com/collectiveidea/audited) and [paper_trail](https://github.com/airblade/paper_trail) etc. These model audit tools use model callbacks to record every changes.
+
+`rails_audit` record ActiveRecord Model changes in Controllers, it will record context with model changes:
+
+1. controller
+2. action
+3. request.remote_ip
+4. current_operator
+5. any other info you want to record..
+
+### Model style audit VS controller style audit
+
+| Model Style Audit | Controller style Audit |
+| --- | --- |
+| Record every changes | Record only when you marked |
+| use model callback, can skip by the data persistence not commit callback | No model callback |
+| use thread variables delivery state from controller to model | Just add variables you can get in controller |
+
+## Usage
+
+### in Model
+1. include Auditable
+
+```ruby
+class User < ActiveRecord::Base
+  include Auditable
+  
+end
+
+```
+
+### in Controller
+
+```ruby
+class UsersController < ApplicationController
+  
+  # use after action, will auto record changes by use saved_changes api
+  after_action only: [:update, :create, :destroy] do
+    mark_audites(User, note: 'note something!', extra: { client_headers: request.headers })
+  end
+  
+end
+```

data/Rakefile

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

data/app/controllers/admin/audits_controller.rb

@@ -0,0 +1,12 @@
+class Admin::AuditsController < Admin::BaseController
+
+  def index
+    @audits = Audit.where(auditable_type: params[:auditable_type], auditable_id: params[:auditable_id]).page(params[:page])
+
+    respond_to do |format|
+      format.html
+      format.js
+    end
+  end
+
+end

data/app/models/audit.rb

@@ -0,0 +1,14 @@
+class Audit < ApplicationRecord
+  serialize :audited_changes, Hash
+  serialize :related_changes, Hash
+  serialize :unconfirmed_changes, Hash
+  serialize :extra, Hash
+
+  belongs_to :auditable, polymorphic: true
+  belongs_to :operator, polymorphic: true
+
+  def audited_changes_i18n
+    audited_changes.transform_keys { |key| auditable.class.human_attribute_name(key) }
+  end
+
+end

data/app/models/concerns/auditable.rb

@@ -0,0 +1,59 @@
+module Auditable
+  extend ActiveSupport::Concern
+  IGNORE = ['updated_at']
+
+  included do
+    has_many :audits, as: :auditable
+  end
+
+  # user: {
+  #   id: 1,
+  #   changes: {
+  #     name: ['a', 'b']
+  #   }
+  # }
+
+  def save_audits(operator: current_operator, include: [], **extra_options)
+    audit = self.audits.build
+    audit.audited_changes = self.saved_changes.except(*IGNORE)
+    audit.unconfirmed_changes = self.changes
+
+    if include.present?
+      result = {}
+
+      include.each do |key|
+        targets = self.send(key)
+        result[key] = []
+
+        Array(targets).each do |target|
+          _saved_changes = target.saved_changes.except(*IGNORE)
+          _changes = target.changes
+
+          if _saved_changes.present? || _changes.present?
+            result[key] << {
+              id: target.id,
+              saved_changes: _saved_changes,
+              changes: _changes
+            }
+          end
+        end
+      end
+
+      audit.related_changes = result
+    end
+
+    if self.destroyed?
+      audit.action = 'destroy'
+    end
+
+    audit.operator_type = operator.class.name
+    audit.operator_id = operator.id
+    audit.note = extra_options.delete(:note)
+    audit.controller_path = extra_options.delete(:controller_path)
+    audit.action_name = extra_options.delete(:action_name)
+    audit.remote_ip = extra_options.delete(:remote_ip)
+    audit.extra = extra_options
+    audit.save
+  end
+
+end

data/app/models/history.rb

@@ -0,0 +1,36 @@
+class History < ApplicationRecord
+  paginates_per 10
+
+  belongs_to :wiki
+  belongs_to :knowledge
+  belongs_to :commit, class_name: 'User', foreign_key: 'commit_id'
+  validates :commit_id, presence: true
+  validates :active, uniqueness: { scope: :knowledge_id }
+
+  enum status: [:status_initial, :status_passed]
+
+  default_scope -> { order(id: :desc) }
+  def set_active
+    self.class.where.not(id: self.id).where(knowledge_id: self.knowledge_id).update_all(active: false)
+    self.update(active: true)
+    move_to_wiki
+  end
+
+end
+
+# :item_id, :integer
+# :user_id, :integer
+# :content, :string, limit: 65535
+# :commit_id, :integer
+# :commit_message, :string
+#
+# t.integer  "wiki_id",        limit: 4
+# t.integer  "knowledge_id",   limit: 4
+# t.text     "body",           limit: 65535
+# t.string   "commit_message", limit: 4096
+# t.datetime "created_at"
+# t.datetime "updated_at"
+# t.integer  "commit_id",      limit: 4
+# t.boolean  "active",                       default: false
+# t.integer  "status",         limit: 4,     default: 0
+# t.string   "type",           limit: 255

data/app/models/major_record.rb

@@ -0,0 +1,14 @@
+class MajorRecord < ApplicationRecord
+
+  belongs_to :knowledge, counter_cache: true
+
+  def move_to_wiki
+    wiki = knowledge.major || knowledge.build_major
+    wiki.commit_id = self.commit_id
+    wiki.commit_message = self.commit_message
+    wiki.body = self.body
+    wiki.save
+  end
+
+end
+

data/app/models/minor_record.rb

@@ -0,0 +1,15 @@
+class MinorRecord < ApplicationRecord
+
+  belongs_to :knowledge, counter_cache: true
+
+  def move_to_wiki
+    wiki = knowledge.minor || knowledge.build_minor
+    wiki.commit_id = self.commit_id
+    wiki.commit_message = self.commit_message
+    wiki.body = self.body
+    wiki.save
+  end
+
+end
+
+

data/app/views/admin/audits/_index.html.erb

@@ -0,0 +1,9 @@
+<div class="ui modal" id="audits_index">
+  <i class="close icon"></i>
+  <div class="ui header blue">
+    系统日志
+  </div>
+  <div class="content">
+    <%= render 'table' %>
+  </div>
+</div>

data/app/views/admin/audits/_table.html.erb

@@ -0,0 +1,61 @@
+<table class="ui table">
+  <thead>
+  <tr>
+    <th>Operator</th>
+    <th>Note</th>
+    <th>Changes</th>
+    <th>Related Changes</th>
+  </tr>
+  </thead>
+
+  <tbody>
+  <% @audits.each do |audit| %>
+    <tr id="audit_<%= audit.id %>">
+      <td>
+        <p><%= audit.operator&.name %></p>
+        <p><%= audit.action %></p>
+        <p><time><%= audit.created_at.to_s(:rfc822) %></time></p>
+        <div class="ui labels">
+          <span class="ui label">Action: <%= audit.action %></span>
+          <span class="ui label">Path: <%= audit.controller_path %>/<%= audit.action_name %></span>
+        </div>
+        <p>IP: <%= audit.remote_ip %></p>
+      </td>
+      <td><%= audit.note %></td>
+      <td class="ui list">
+        <% audit.audited_changes_i18n.each do |key, value| %>
+          <div class="item">
+            <div class="ui label">
+              <%= key %>:
+              <div class="detail">
+                <span><%= value[0] %></span>
+                <i class="arrow circle right icon grey"></i>
+                <span><%= value[1] %></span>
+              </div>
+            </div>
+          </div>
+        <% end %>
+      </td>
+      <td>
+        <% audit.related_changes.each do |key, value| %>
+          <% value.each do |relate| %>
+            <div class="ui segment">
+              <span class="ui blue label"><%= key %>: <%= relate[:id] %></span>
+              <div class="ui divider"></div>
+              <% relate[:changes].each do |k, v| %>
+                <div class="ui label"><%= k %>: </div>
+                <%= v[0] %>
+                <i class="arrow circle right icon grey"></i>
+                <%= v[1] %>
+              <% end %>
+            </div>
+          <% end %>
+        <% end %>
+      </td>
+    </tr>
+  <% end %>
+  </tbody>
+</table>
+
+
+

data/app/views/admin/audits/index.html.erb

@@ -0,0 +1,3 @@
+
+
+

data/app/views/admin/audits/index.js.erb

@@ -0,0 +1,8 @@
+if ($('.ui.modals').length === 0) {
+  $('body').append('<%= j(render 'index') %>');
+} else {
+  $('.ui.modals').html('<%= j(render 'index') %>');
+}
+
+
+$('#audits_index').modal('setting', {autofocus: false}).modal('show');

data/config/routes.rb

@@ -0,0 +1,7 @@
+Rails.application.routes.draw do
+
+  scope module: 'admin', path: ':auditable_type/:auditable_id' do
+    resources :audits, only: ['index']
+  end
+
+end

data/db/migrate/20170314035239_create_audits.rb

@@ -0,0 +1,20 @@
+class CreateAudits < ActiveRecord::Migration[5.1]
+  def change
+    
+    create_table :audits do |t|
+      t.references :auditable, polymorphic: true
+      t.references :operator, polymorphic: true
+      t.string :action
+      t.string :audited_changes, limit: 4096
+      t.string :related_changes, limit: 4096
+      t.string :unconfirmed_changes, limit: 4096
+      t.string :note, limit: 1024
+      t.string :remote_ip
+      t.string :controller_path
+      t.string :action_name
+      t.string :extra, limit: 4096
+      t.datetime :created_at, index: true, null: false
+    end
+    
+  end
+end

data/lib/rails_audit/controller_helper.rb

@@ -0,0 +1,39 @@
+module RailsAudit::ControllerHelper
+
+  def mark_audits(**options)
+    record_classes = options.select { |k, _|
+      record_class = k.to_s.safe_constantize
+      record_class && record_class.ancestors.include?(ActiveRecord::Base)
+    }
+
+    record_classes.each do |record_symbol, includes|
+      record_class = record_symbol.to_s.constantize
+      valid_ivars.find do |ivar|
+        record = instance_variable_get(ivar)
+        if record.is_a? record_class
+          record.save_audits current_operator: rails_audit_user,
+                             include: includes,
+                             note: options[:note],
+                             controller_path: controller_path,
+                             action_name: action_name,
+                             remote_ip: request.remote_ip,
+                             extra: options[:extra]
+        end
+      end
+    end
+  end
+
+  def rails_audit_user
+    current_user
+  end
+
+  def valid_ivars
+    _except = self._protected_ivars.to_a + [:@marked_for_same_origin_verification]
+    self.instance_variables - _except
+  end
+
+end
+
+ActiveSupport.on_load :action_controller_base do
+  include RailsAudit::ControllerHelper
+end

data/lib/rails_audit/engine.rb

@@ -0,0 +1,4 @@
+module RailsAudit
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/rails_audit/version.rb

@@ -0,0 +1,3 @@
+module RailsAudit
+  VERSION = "0.0.1"
+end

data/lib/rails_audit.rb

@@ -0,0 +1,3 @@
+require 'rails_audit/engine'
+
+require 'rails_audit/controller_helper'

data/lib/tasks/the_history_tasks.rake

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

data/test/dummy/README.md

@@ -0,0 +1,5 @@
+# dummy
+基础rails 项目 for  engine test
+
+## Notices
+* Used Sqlite MemoryDB, see https://www.sqlite.org/inmemorydb.html

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,2 @@
+//= require yigexiangfa_ui/dist/javascripts/semantic
+//= require_tree .

data/test/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the rails generate channel command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,5 @@
+/*
+*= require yigexiangfa_ui/dist/stylesheets/semantic
+*= require_tree .
+*= require_self
+*/

data/test/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/test/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/test/dummy/app/controllers/admin/base_controller.rb

@@ -0,0 +1,7 @@
+class Admin::BaseController < ApplicationController
+
+  default_form_builder 'AdminBuilder' do |config|
+
+  end
+
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end