audited-serialize 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d48590492cd52769b859d9fe98d28d8bdaffa3ba106cf31c600799d3302efa2b
-  data.tar.gz: 98c8038df1e219d2162bfd4cedb6b5bf2a6fe74abbf1dbb0c987673cb36f1239
+  metadata.gz: aa2ae142361013574ee5100ed3edf7da72ffa6a04758a894dfab763a3c37b82e
+  data.tar.gz: cee3114d051d34099d11d9f9f402c7dffa8a0d61c813d472a11f73a5afafabed
 SHA512:
-  metadata.gz: 6a90a9a8bbc607becefdaa2441d94916970af899cb20cbe694c7d24db6cca6fbf1f78de0fedf376baaad2b220fb6eed634ddb8a04ec515afb06aea055de7838f
-  data.tar.gz: 4552d6ee7304c6e0561144f27ea1ec32b9b9647be8822b268179956d91295e3b872026f217a2fe33a0a670958412de0681704ff8e61f3d7fa1a0048fdc724beb
+  metadata.gz: 929cd4a6b8a55c730db3d644755f23cc33bb27f5e39553bd54cf67b8d6bcea0fe80c6b84eb412d7f4c7e3c03851493022d40c3fb177e908c5fb5ea919d6f4d35
+  data.tar.gz: f79cac8c70bddc12ee980194d557d9fb1f7e8d04c45d5083fdecd996015e3df1e9c31f7ed090866560263182251546675380a1050895ec9f8a4229668b2b4eca

data/README.md

@@ -1,6 +1,7 @@
 # Audited Serialize
+[![Gem Version](https://badge.fury.io/rb/audited-serialize.svg)](https://badge.fury.io/rb/audited-serialize)
 
-Гем для сериализации аудит-логов на базе Audited
+Гем для сериализации аудит-логов на базе Audited.
 
 ## Установка
 
@@ -15,3 +16,40 @@ gem 'audited-serialize'
 ```
 bundle
 ```
+
+## Использование
+
+Для вызова сериализованного списка изменений вызовите метод `.changes_list` на экземпляре audit-класса (по умолчанию - `Audited::Audit`)
+
+```
+audit = Audited::Audit.first
+audit.changes_list
+```
+
+## Конфигурация
+
+Изменение настроек сериализации осуществляется путем редактирования стандартного файла конфигурации `Audited`
+
+```
+# config/initializers/audited.rb
+
+Audited.config do |config|
+
+end
+```
+
+### Исключения
+
+Для добавления исключений для полей сущностей, которые не будут отображаться в списке добавьте в конфиг `serialization_exceptions`.
+
+```
+# config/initializers/audited.rb
+
+Audited.config do |config|
+
+  config.serialization_exceptions = {
+    'User' => ['role']
+  }
+
+end
+```

data/lib/audited/original_audit.rb

@@ -0,0 +1,9 @@
+require 'audited/serialization'
+
+module Audited
+  class Audit < ::ActiveRecord::Base
+
+    include Audited::Serialization
+
+  end
+end

data/lib/audited/serialization.rb

@@ -0,0 +1,185 @@
+module Audited
+  module Serialization
+
+    extend ActiveSupport::Concern
+
+    def changes_list
+      model = auditable_type.constantize
+      columns_hash = model.columns_hash
+      @reflections = model.reflections.to_h { |_relation, reflection| [reflection.foreign_key, reflection.klass] }
+
+      audited_changes.map do |column, value|
+        @column = column
+
+        # пропускаем, если колонка в списке исключений
+        next if Audited.serialization_exceptions[auditable_type]&.include?(@column)
+
+        # поле таблицы БД
+        @db_column = columns_hash[column]
+
+        # русскоязычное название поля
+        @field = @db_column.comment
+
+        if action == 'update' && value.is_a?(Array)
+          # значения, измененные во время редактирования
+          @initial, @changed = value
+        else
+          # значения, заданные во время создания
+          @changed = value
+        end
+
+        if related_record_changed?
+          related_record_changes
+        elsif object?
+          json_changes
+        elsif array?
+          array_changes
+        elsif password?
+          password_changes
+        elsif date?
+          date_changes
+        elsif datetime?
+          datetime_changes
+        elsif boolean?
+          boolean_changes
+        elsif enum_changes?
+          enum_changes
+        else
+          common_column_changes
+        end
+
+        next if @from.blank? && @to.blank?
+
+        {
+          field: @field,
+          from: @from,
+          to: @to
+        }
+      end.compact
+    end
+
+    private
+
+    def related_record_changed?
+      @reflections[@column].present?
+    end
+
+    def object?
+      @initial.is_a?(Hash) || @changed.is_a?(Hash)
+    end
+
+    def array?
+      @initial.is_a?(Array) || @changed.is_a?(Array)
+    end
+
+    def password?
+      @column == 'encrypted_password'
+    end
+
+    def datetime?
+      @initial&.to_date&.acts_like?(:date) && @initial.include?(':') rescue false
+      @changed&.to_date&.acts_like?(:date) && @changed.include?(':') rescue false
+    end
+
+    def date?
+      @initial&.to_date&.acts_like?(:date) && @initial.to_s.include?('-') && @initial.to_s.exclude?(':') rescue false
+      @changed&.to_date&.acts_like?(:date) && @changed.to_s.include?('-') && @changed.to_s.exclude?(':') rescue false
+    end
+
+    def boolean?
+      bool_classes = [TrueClass, FalseClass]
+
+      bool_classes.include?(@initial.class) || bool_classes.include?(@changed.class)
+    end
+
+    def enum_changes?
+      @db_column.type == :enum
+    end
+
+    def related_record_changes
+      # модель связанной сущности от колонки
+      related_model = @reflections[@column]
+
+      # заданные/измененные значения
+      @from = related_record_value(related_model, @initial)
+      @to = related_record_value(related_model, @changed)
+    end
+
+    def related_record_value(related_model, value)
+      if value
+        record = related_model.find_by(id: value)
+        auditing_title(record) || "Запись ##{value}"
+      else
+        ''
+      end
+    end
+
+    def auditing_title(record)
+      return unless record
+
+      if record.is_a?(House)
+        record.number
+      elsif record.klass.column_names.include?('name')
+        record.name
+      else
+        "##{record.id}"
+      end
+    end
+
+    def enum_changes
+      enum_type = @db_column.sql_type
+      values = I18n.t("enums.#{enum_type}").stringify_keys
+
+      @from = values[@initial]
+      @to = values[@changed]
+    end
+
+    def json_changes
+      # удаление дубликатов ключей/значений
+      initial = (@initial.to_a - @changed.to_a).to_h
+      changed = (@changed.to_a - @initial.to_a).to_h
+
+      @from = initial.map { |k, v| "#{k.humanize}: #{v}" }
+      @to = changed.map { |k, v| "#{k.humanize}: #{v}" }
+    end
+
+    def array_changes
+      @from = @initial&.join(', ')
+      @to = @changed&.join(', ')
+    end
+
+    def password_changes
+      @field = 'Пароль'
+      @from = nil
+      @to = '<новый>'
+    end
+
+    def date_changes
+      @from = Date.parse(@initial).strftime('%d.%m.%Y') if @initial.present?
+      @to = Date.parse(@changed).strftime('%d.%m.%Y') if @changed.present?
+    end
+
+    def datetime_changes
+      if @initial.present?
+        @from = DateTime.parse(@initial).in_time_zone('Europe/Moscow').strftime('%d.%m.%Y %H:%M')
+      end
+
+      if @changed.present?
+        @to = DateTime.parse(@changed).in_time_zone('Europe/Moscow').strftime('%d.%m.%Y %H:%M')
+      end
+    end
+
+    def boolean_changes
+      values = { true => 'Да', false => 'Нет' }
+
+      @from = values[@initial]
+      @to = values[@changed]
+    end
+
+    def common_column_changes
+      @from = @initial
+      @to = @changed
+    end
+
+  end
+end

data/lib/audited-serialize.rb

@@ -1 +1 @@
-require 'audited_serialize'
+require 'audited_serialize'

data/lib/audited_config.rb

@@ -0,0 +1,11 @@
+module Audited
+
+  class << self
+
+    attr_accessor :serialization_exceptions
+
+  end
+
+  @serialization_exceptions = {}
+
+end

data/lib/audited_serialize.rb

@@ -1,2 +1,5 @@
+require 'audited_config'
+require 'audited/original_audit'
+
 module AuditedSerialize
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: audited-serialize
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Павел Бабин
@@ -32,6 +32,9 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/audited-serialize.rb
+- lib/audited/original_audit.rb
+- lib/audited/serialization.rb
+- lib/audited_config.rb
 - lib/audited_serialize.rb
 homepage:
 licenses: