rails_audit 1.0.0 → 1.0.4

data/app/models/auditor/model/approving.rb

@@ -0,0 +1,65 @@
+module Auditor
+  module Model::Approving
+    extend ActiveSupport::Concern
+
+    included do
+      attribute :unapproved_approvals_count, :integer, default: 0
+
+      has_one :approval, ->{ where(approved: false).order(id: :desc) }, as: :approving
+      has_many :approvals, as: :approving, autosave: true, dependent: :delete_all  # to test why autosave not works well
+      has_many :unapproved_approvals, ->{ where(approved: false) }, class_name: 'Approval', as: :approving
+    end
+
+    # user: {
+    #   id: 1,
+    #   changes: {
+    #     name: ['a', 'b']
+    #   }
+    # }
+    # params same as as_json
+    def save_with_approvals(only: [], except: [], include: [])
+      for_changes = {}
+
+      if only.present?
+        for_changes[:pending_changes] = self.changes.slice(*only)
+        self.assign_attributes self.changed_attributes.slice(*only)
+      else
+        for_changes[:pending_changes] = self.changes.except(*except)
+        self.assign_attributes self.changed_attributes.except(*except)
+      end
+
+      result = {}
+      include.each do |key|
+        targets = self.public_send(key)
+        attr_key = "#{key}_attributes"
+        result[attr_key] = []
+
+        Array(targets).each do |target|
+          if target.changes.present?
+            result[attr_key] << { id: target.id }.merge!(target.changes)
+            target.clear_changes_information
+          end
+        end
+      end
+      for_changes[:related_changes] = result
+
+      if for_changes[:pending_changes].present? || for_changes[:related_changes].present?
+        approval = self.approvals.build(for_changes)
+        self.class.transaction do
+          approval.save!
+          self.save!
+        end
+      else
+        self.save
+      end
+    end
+
+    def temp_apply_changes
+      if approval
+        assign_attributes approval.apply_attributes
+      end
+      self
+    end
+
+  end
+end

data/app/models/auditor/model/audit.rb

@@ -0,0 +1,25 @@
+module Auditor
+  module Model::Audit
+    extend ActiveSupport::Concern
+
+    included do
+      attribute :action, :string, default: 'update'
+      attribute :audited_changes, :json, default: {}
+      attribute :related_changes, :json, default: {}
+      attribute :extra, :json, default: {}
+      attribute :note, :string, limit: 1024
+      attribute :remote_ip, :string
+      attribute :controller_path, :string
+      attribute :action_name, :string
+      attribute :created_at, :datetime, index: true, null: false
+
+      belongs_to :audited, polymorphic: true
+      belongs_to :operator, polymorphic: true
+    end
+
+    def audited_changes_i18n
+      audited_changes.transform_keys { |key| audited.class.human_attribute_name(key) }
+    end
+
+  end
+end

data/app/models/auditor/model/verification.rb

@@ -0,0 +1,32 @@
+module Auditor
+  module Model::Verification
+    extend ActiveSupport::Concern
+
+    included do
+      attribute :state, :string
+      attribute :note, :string
+      attribute :position, :integer
+      attribute :confirmed, :boolean, default: false
+
+      belongs_to :member, class_name: 'Org::Member'
+      belongs_to :job_title, class_name: 'Org::JobTitle'
+
+      belongs_to :verified, polymorphic: true
+      belongs_to :verifier
+
+      after_initialize if: :new_record? do
+        self.job_title ||= verifier.job_title
+        self.member ||= verifier.member
+      end
+      after_create_commit :checking_trigger
+    end
+
+    def checking_trigger
+      if self.confirmed
+        verified.do_trigger state: self.state
+      end
+    end
+
+
+  end
+end

data/app/models/auditor/model/verifier.rb

@@ -0,0 +1,20 @@
+module Auditor
+  module Model::Verifier
+    extend ActiveSupport::Concern
+
+    included do
+      attribute :name, :string
+      attribute :position, :integer
+
+      belongs_to :member, class_name: 'Org::Member', optional: true
+      belongs_to :job_title, class_name: 'Org::JobTitle', optional: true
+
+      belongs_to :verifiable, polymorphic: true
+      has_many :verifications, dependent: :destroy_async, inverse_of: :verifier
+
+      acts_as_list
+    end
+
+
+  end
+end

data/app/models/auditor/verification.rb

@@ -0,0 +1,5 @@
+module Auditor
+  class Verification < ApplicationRecord
+    include Model::Verification
+  end
+end

data/app/models/auditor/verifier.rb

@@ -0,0 +1,5 @@
+module Auditor
+  class Verifier < ApplicationRecord
+    include Model::Verifier
+  end
+end

data/app/models/auditor.rb

@@ -0,0 +1,11 @@
+module Auditor
+
+  def self.use_relative_model_naming?
+    true
+  end
+
+  def self.table_name_prefix
+    'auditor_'
+  end
+
+end

data/app/views/auditor/_approvals.html.erb

@@ -0,0 +1,14 @@
+<td class="ui labels">
+  <span class="ui label"><%= approval.state_i18n %></span>
+  <% if expense.can_operate?(current_member) %>
+    <div class="ui mini buttons">
+      <%= link_to t('.approve'), new_check_path('Expense', expense.id, state: expense.next_state_state), class: 'ui mini positive button' %>
+      <div class="or"></div>
+      <%= link_to Expense.enum_i18n(:state, 'rejected'), new_check_path('Expense', expense.id, state: 'rejected'), class: 'ui mini negative button' %>
+      <% if ['pending_om', 'pending_cfo'].include?(expense.state) %>
+        <div class="or"></div>
+        <%= link_to Expense.enum_i18n(:state, 'pending_md'), new_check_path('Expense', expense.id, state: 'pending_md'), class: 'ui mini positive button' %>
+      <% end %>
+    </div>
+  <% end %>
+</td>

data/app/views/auditor/_checks.html.erb

@@ -0,0 +1,16 @@
+<table class="ui very basic table">
+  <% target.checks.each do |check| %>
+  <tr>
+    <td>
+      <span class="ui label"><%= target.class.enum_i18n(:state, check.state) %></span>
+      <% if check.confirmed? %>
+        <i class="green check icon"></i>
+      <% else %>
+        <i class="red question icon"></i>
+      <% end %>
+    </td>
+    <td><%= check.comment %></td>
+    <td><%= check.operator.name %></td>
+  </tr>
+  <% end %>
+</table>

data/app/views/auditor/admin/approvals/_filter.html.erb

@@ -0,0 +1,7 @@
+<%= form_with theme: 'search', model: Approval.new do |f| %>
+  <div class="fields">
+    <%= f.text_field :name %>
+    <%= f.submit %>
+    <%= link_to t('.clear'), filter_params(except: [:name]), class: 'ui button' %>
+  </div>
+<% end %>

data/app/views/auditor/admin/approvals/_form.html.erb

@@ -0,0 +1,6 @@
+<%= form_with model: @approval do |f| %>
+  <%= render 'error_messages', target: @approval %>
+  <%= f.text_field :comment %>
+  <%= f.text_field :state %>
+  <%= f.submit %>
+<% end %>

data/app/views/auditor/admin/approvals/_index.html.erb

@@ -0,0 +1,10 @@
+<div class="ui modal" id="modal">
+  <i class="fas fa-times close"></i>
+  <div class="ui header">
+    <%= t('.title') %>
+  </div>
+  
+  <div class="content">
+    <%= render 'table' %>
+  </div>
+</div>

data/app/views/auditor/admin/approvals/_show_table.html.erb

@@ -0,0 +1,28 @@
+<table class="table is-hoverable is-fullwidth">
+  <thead>
+    <tr>
+      <th class="six wide">
+        <%= link_to t('.edit'), edit_admin_approval_path(@approval), class: 'ui mini blue right floated button' %>
+      </th>
+      <th class="ten wide"></th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td class="has-text-right"><%= Approval.human_attribute_name(:pending_changes) %></td>
+      <td><%= @approval.pending_changes %></td>
+    </tr>
+    <tr>
+      <td class="has-text-right"><%= Approval.human_attribute_name(:comment) %></td>
+      <td><%= @approval.note %></td>
+    </tr>
+    <tr>
+      <td class="has-text-right"><%= Approval.human_attribute_name(:state) %></td>
+      <td><%= @approval.state %></td>
+    </tr>
+    <tr>
+      <td class="has-text-right"><%= Approval.human_attribute_name(:approved_at) %></td>
+      <td><%= @approval.approved_at %></td>
+    </tr>
+  </tbody>
+</table>

data/app/views/auditor/admin/approvals/_table.html.erb

@@ -0,0 +1,28 @@
+<table class="ui table">
+  <thead>
+    <tr>
+      <th><%= Approval.human_attribute_name(:pending_changes) %></th>
+      <th><%= Approval.human_attribute_name(:related_changes) %></th>
+      <th><%= Approval.human_attribute_name(:comment) %></th>
+      <th><%= Approval.human_attribute_name(:approved_at) %></th>
+      <th></th>
+    </tr>
+  </thead>
+  <tbody>
+  <% @approvals.each do |approval| %>
+    <tr>
+      <td><%= simple_format approval.pending_changes_i18n %></td>
+      <td><%= simple_format approval.related_changes %></td>
+      <td><%= approval.comment %></td>
+      <td><%= approval.approved_at %></td>
+      <td>
+        <div class="ui toggle checkbox">
+          <%= check_box_tag '[approval]approved', nil, approval.approved, data: { method: :patch, url: admin_approval_path(approval), submit: true }, id: nil %>
+        </div>
+      </td>
+    </tr>
+  <% end %>
+  </tbody>
+</table>
+
+<%= paginate @approvals %>

data/app/views/auditor/admin/approvals/index.js.erb

@@ -0,0 +1,3 @@
+$('#modal').replaceWith('<%= j(render 'index') %>')
+$('#modal').modal('show')
+remote_js_load('<%= raw remote_js_load %>')

data/app/views/auditor/admin/audits/_index_tbody.html.erb

@@ -0,0 +1,38 @@
+<td>
+  <p><%= model.operator&.name %></p>
+  <p><time data-controller="time"><%= model.created_at.to_s(:rfc822) %></time></p>
+  <p><%= model.action %></p>
+  <p><%= model.controller_path %>/<%= model.action_name %></p>
+  <p><%= model.remote_ip %></p>
+</td>
+<td><%= model.note %></td>
+<td class="ui list">
+  <% model.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>
+  <% model.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>

data/app/views/auditor/admin/audits/_index_thead.html.erb

@@ -0,0 +1,4 @@
+<th><%= Auditor::Audit.human_attribute_name(:operator) %></th>
+<th><%= Auditor::Audit.human_attribute_name(:note) %></th>
+<th><%= Auditor::Audit.human_attribute_name(:audited_changes) %></th>
+<th><%= Auditor::Audit.human_attribute_name(:related_changes) %></th>

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

@@ -0,0 +1,7 @@
+<turbo-frame id="modal">
+  <%= render layout: 'index_table', locals: { cache_key: Auditor::Audit.column_names.hash } do %>
+    <%= render partial: 'index_tbody', collection: @audits, as: :model %>
+  <% end %>
+
+  <%= paginate @audits %>
+</turbo-frame>

data/app/views/auditor/admin/verifications/_edit_form.html.erb

@@ -0,0 +1,7 @@
+<%= form_with model: @verification, url: { action: 'update' } do |f| %>
+  <%= render 'error_messages', target: f.object %>
+  <%= f.number_field :member_id %>
+  <%= f.text_area :note %>
+  <%= f.check_box :confirmed %>
+  <%= f.submit %>
+<% end %>

data/app/views/auditor/admin/verifications/_filter_form.html.erb

@@ -0,0 +1,5 @@
+<%= form_with theme: 'search' do |f| %>
+  <div class="fields">
+    <%= f.submit %>
+  </div>
+<% end %>

data/app/views/auditor/admin/verifications/_index_tbody.html.erb

@@ -0,0 +1,4 @@
+<td><%= model.member_id %></td>
+<td><%= model.note %></td>
+<td><%= model.verified %></td>
+<td><%= model.position %></td>

data/app/views/auditor/admin/verifications/_index_thead.html.erb

@@ -0,0 +1,5 @@
+<th><%= Auditor::Verification.human_attribute_name(:member_id) %></th>
+<th><%= Auditor::Verification.human_attribute_name(:note) %></th>
+<th><%= Auditor::Verification.human_attribute_name(:verified) %></th>
+<th><%= Auditor::Verification.human_attribute_name(:position) %></th>
+<th></th>

data/app/views/auditor/admin/verifications/_new_form.html.erb

@@ -0,0 +1,7 @@
+<%= form_with model: @verification, url: { action: 'create' } do |f| %>
+  <%= render 'error_messages', target: f.object %>
+  <%= f.hidden_field :state %>
+  <%= f.text_area :note %>
+  <%= f.check_box :confirmed %>
+  <%= f.submit %>
+<% end %>

data/app/views/auditor/admin/verifications/_show_table.html.erb

@@ -0,0 +1,16 @@
+<tr>
+  <td class="has-text-right"><%= Auditor::Verification.human_attribute_name(:member_id) %></td>
+  <td><%= @verification.member_id %></td>
+</tr>
+<tr>
+  <td class="has-text-right"><%= Auditor::Verification.human_attribute_name(:comment) %></td>
+  <td><%= @verification.comment %></td>
+</tr>
+<tr>
+  <td class="has-text-right"><%= Auditor::Verification.human_attribute_name(:approved) %></td>
+  <td><%= @verification.approved %></td>
+</tr>
+<tr>
+  <td class="has-text-right"><%= Auditor::Verification.human_attribute_name(:position) %></td>
+  <td><%= @verification.position %></td>
+</tr>

data/app/views/auditor/admin/verifiers/_edit_form.html.erb

@@ -0,0 +1,3 @@
+<%= form_with model: @verifier, url: { action: 'update' } do |f| %>
+  <%= render partial: 'form', locals: { f: f } %>
+<% end %>

data/app/views/auditor/admin/verifiers/_filter_form.html.erb

@@ -0,0 +1,9 @@
+<%= form_with theme: 'search', model: Auditor::Verifier.new do |f| %>
+  <div class="field-body">
+    <%= f.text_field :name %>
+    <div class="field is-narrow">
+      <%= f.submit %>
+      <%= link_to t('.clear'), filter_params(except: [:name]), class: 'button is-light' %>
+    </div>
+  </div>
+<% end %>

data/app/views/auditor/admin/verifiers/_form.html.erb

@@ -0,0 +1,5 @@
+<%= render 'error_messages', target: f.object %>
+<%= f.text_field :name %>
+<%= f.collection_select :job_title_id, @job_titles, :id, :name, { include_blank: true }, { data: { action: 'input#filter', url: members_admin_verifiers_path(params[:verifiable_type], params[:verifiable_id]) } } %>
+<%= f.select :member_id, options_for_select([]) %>
+<%= f.submit %>

data/app/views/auditor/admin/verifiers/_index_tbody.html.erb

@@ -0,0 +1,3 @@
+<td><%= model.name %></td>
+<td><%= model.job_title_id %></td>
+<td><%= model.member_id %></td>

data/app/views/auditor/admin/verifiers/_index_thead.html.erb

@@ -0,0 +1,4 @@
+<th><%= Auditor::Verifier.human_attribute_name(:name) %></th>
+<th><%= Auditor::Verifier.human_attribute_name(:job_title_id) %></th>
+<th><%= Auditor::Verifier.human_attribute_name(:member_id) %></th>
+<th></th>

data/app/views/auditor/admin/verifiers/_member_field.html.erb

@@ -0,0 +1 @@
+<%= f.collection_select :member_id, @members, :id, :name %>

data/app/views/auditor/admin/verifiers/_new_form.html.erb

@@ -0,0 +1,3 @@
+<%= form_with model: @verifier, url: { action: 'create', verifiable_type: params[:verifiable_type], verifiable_id: params[:verifiable_id] }, data: { controller: 'input' } do |f| %>
+  <%= render partial: 'form', locals: { f: f } %>
+<% end %>

data/app/views/auditor/admin/verifiers/_show_table.html.erb

@@ -0,0 +1,24 @@
+<table class="table is-fullwidth">
+  <thead>
+    <tr>
+      <th>
+        <%= link_to t('.edit'), edit_admin_verifier_path(@verifier), class: 'button is-small is-link' %>
+      </th>
+      <th></th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td class="has-text-right"><%= Verifier.human_attribute_name(:name) %></td>
+      <td><%= @verifier.name %></td>
+    </tr>
+    <tr>
+      <td class="has-text-right"><%= Verifier.human_attribute_name(:job_title_id) %></td>
+      <td><%= @verifier.job_title_id %></td>
+    </tr>
+    <tr>
+      <td class="has-text-right"><%= Verifier.human_attribute_name(:member_id) %></td>
+      <td><%= @verifier.member_id %></td>
+    </tr>
+  </tbody>
+</table>

data/app/views/auditor/admin/verifiers/members.turbo_stream.erb

@@ -0,0 +1,3 @@
+<% form_object = form_object(@verifier, theme: nil) %>
+
+document.getElementById('verifier_member_id').parentNode.innerHTML = '<%= j(render partial: 'member_field', locals: { f: form_object }) %>'

data/config/locales/en.yml

@@ -0,0 +1,12 @@
+en:
+  audit/admin:
+    checks:
+      new:
+        check: 审核
+  activerecord:
+    models:
+      check: 审核
+    attributes:
+      check:
+        confirmed: 确认？
+        comment: 备注

data/config/locales/zh.controller.yml

@@ -0,0 +1,13 @@
+zh:
+  auditor:
+    title: 操作审计
+    admin:
+      approvals:
+        index:
+          title: 待审核
+      audits:
+        index:
+          title: 操作日志
+      verifications:
+        new:
+          title: 审核

data/config/locales/zh.enum.yml

@@ -0,0 +1,7 @@
+zh:
+  activerecord:
+    enum:
+      verification:
+        confirmed:
+          true: 已同意
+          false: 未同意

data/config/locales/zh.yml

@@ -0,0 +1,21 @@
+zh:
+  activerecord:
+    models:
+      verification: 审核
+    attributes:
+      verification:
+        confirmed: 同意
+        comment: 备注
+      approval:
+        pending_changes: 待审核修改
+        comment: 备注
+        approved_at: 审核时间
+      audit:
+        action: 操作
+        controller_path: API
+        operator: 操作人
+        audited_changes: 修改历史
+        related_changes: 关联修改历史
+      verifier:
+        job_title_id: 职务
+        member_id: 责任人

data/config/routes.rb

@@ -1,7 +1,27 @@
 Rails.application.routes.draw do
 
-  scope module: 'admin', path: ':auditable_type/:auditable_id' do
-    resources :audits, only: ['index']
+  namespace :auditor, defaults: { business: 'auditor' } do
+    scope ':audited_type/:audited_id', module: 'admin', defaults: { namespace: 'admin' } do
+      resources :audits, only: [:index]
+    end
+
+    scope ':approving_type/:approving_id', module: 'admin', defaults: { namespace: 'admin' } do
+      resources :approvals, only: [:index]
+    end
+
+    namespace :admin, defaults: { namespace: 'admin' } do
+      resources :approvals, except: [:index, :new, :create]
+      scope path: ':verifiable_type/:verifiable_id' do
+        resources :verifiers do
+          collection do
+            get :members
+          end
+        end
+      end
+      scope path: ':verified_type/:verified_id' do
+        resources :verifications
+      end
+    end
   end
 
 end

data/lib/rails_audit/config.rb

@@ -0,0 +1,14 @@
+require 'active_support/configurable'
+
+module RailsAudit #:nodoc:
+  include ActiveSupport::Configurable
+
+  configure do |config|
+    config.default_except = [
+      'updated_at'
+    ]
+  end
+
+end
+
+

data/lib/rails_audit/engine.rb

@@ -1,10 +1,19 @@
+require 'rails_com'
 module RailsAudit
   class Engine < ::Rails::Engine
-
-    config.eager_load_paths += Dir[
-      "#{config.root}/app/models/rails_audit",
-      "#{config.root}/app/models/rails_audit/concerns"
-    ]
-
+    
+    config.generators do |g|
+      g.rails = {
+        assets: false,
+        stylesheets: false,
+        helper: false
+      }
+      g.test_unit = {
+        fixture: true,
+        fixture_replacement: :factory_girl
+      }
+      g.templates.unshift File.expand_path('lib/templates', RailsCom::Engine.root)
+    end
+    
   end
 end

data/lib/rails_audit.rb

@@ -1,3 +1,4 @@
-require 'rails_audit/engine'
+# frozen_string_literal: true
 
-require 'rails_audit/controller_helper'
+require 'rails_audit/engine'
+require 'rails_audit/config'