audited-serialize 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d48590492cd52769b859d9fe98d28d8bdaffa3ba106cf31c600799d3302efa2b
-  data.tar.gz: 98c8038df1e219d2162bfd4cedb6b5bf2a6fe74abbf1dbb0c987673cb36f1239
+  metadata.gz: 49e601e7c12bb7e67d5763e08d8dda00f8ddab573ceb4d58a8ca7f399e88e507
+  data.tar.gz: 6c69689f1e0ab5ebe8ad474b62cb62ee1d6f5c9350629376974b04bd2615f9a2
 SHA512:
-  metadata.gz: 6a90a9a8bbc607becefdaa2441d94916970af899cb20cbe694c7d24db6cca6fbf1f78de0fedf376baaad2b220fb6eed634ddb8a04ec515afb06aea055de7838f
-  data.tar.gz: 4552d6ee7304c6e0561144f27ea1ec32b9b9647be8822b268179956d91295e3b872026f217a2fe33a0a670958412de0681704ff8e61f3d7fa1a0048fdc724beb
+  metadata.gz: d1b9db4eabd0f067f330abbbb8322d1fe30d78b98cea86607c318b03363538c3748b88cab47c231911f42afd0f6a3c1454a6fc9901149c26a9d94aafe173f798
+  data.tar.gz: '0965e44d1a5415d488514b6dccefc0bea10961b299391572359f8b0f60abb7fec434599e1f439036f58fd299c3ebdf2bb452199f00a7b0836914cd05649bd5f8'

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,54 @@ gem 'audited-serialize'
 ```
 bundle
 ```
+
+## Использование
+
+Для вызова сериализованного списка изменений вызовите метод `.changes_list` на экземпляре audit-класса (по умолчанию - `Audited::Audit`)
+
+```
+audit = Audited::Audit.first
+audit.changes_list
+```
+
+## Заголовки связанных записей
+
+При наличии в аудит-логах полей, содержащих ID связанных сущностей, по умолчанию будет отображено название (поле `name`) этой сущности. При отсутствии у сущности поля `name` или необходимости отображения значения другого поля можно задать название этого поля в модели
+
+```
+# app/models/user.rb
+
+class User < ApplicationRecord
+
+  audit title: :email
+
+end
+```
+
+## Конфигурация
+
+Изменение настроек сериализации осуществляется путем редактирования стандартного файла конфигурации `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/audit_extensions.rb

@@ -0,0 +1,25 @@
+require 'audited/serialization'
+require 'audited/serialization_changes/array_module'
+require 'audited/serialization_changes/boolean_module'
+require 'audited/serialization_changes/common_module'
+require 'audited/serialization_changes/date_module'
+require 'audited/serialization_changes/datetime_module'
+require 'audited/serialization_changes/enum_module'
+require 'audited/serialization_changes/object_module'
+require 'audited/serialization_changes/related_record_module'
+
+module Audited
+  class Audit < ::ActiveRecord::Base
+
+    include Audited::Serialization
+    include Audited::SerializationChanges::ArrayModule
+    include Audited::SerializationChanges::BooleanModule
+    include Audited::SerializationChanges::CommonModule
+    include Audited::SerializationChanges::DateModule
+    include Audited::SerializationChanges::DatetimeModule
+    include Audited::SerializationChanges::EnumModule
+    include Audited::SerializationChanges::ObjectModule
+    include Audited::SerializationChanges::RelatedRecordModule
+
+  end
+end

data/lib/audited/serialization.rb

@@ -0,0 +1,80 @@
+module Audited
+  module Serialization
+
+    extend ActiveSupport::Concern
+
+    def changes_list
+      # проверка на наличие модели
+      # в случае ее отсутствия, верятнее всего она была удалена
+      begin
+        model = auditable_type.constantize
+      rescue NameError
+        return
+      end
+
+      columns_hash = model.columns_hash
+      @reflections = model_reflections(model)
+
+      audited_changes.map do |column, value|
+        # пропускаем, если колонка в списке исключений
+        next if Audited.serialization_exceptions[auditable_type]&.include?(column)
+
+        @column = column
+        @db_column = columns_hash[column]
+
+        # пропускаем, если колонка теперь отсутствует в БД
+        next unless @db_column
+
+        # русскоязычное название поля
+        field = password_changes? ? 'Пароль' : @db_column.comment
+
+        if action == 'update' && value.is_a?(Array)
+          # значения, измененные во время редактирования
+          @initial, @changed = value
+        else
+          # значения, заданные во время создания
+          @changed = value
+        end
+
+        # определение изменений было/стало
+        from, to = changes_from_to
+
+        # пропускаем, если изменения не зафиксированы
+        next if from.blank? && to.blank?
+
+        {
+          field:, from:, to:
+        }
+      end.compact
+    end
+
+    private
+
+    def model_reflections(model)
+      model.reflections.to_h { |_rel, reflection| [reflection.foreign_key, reflection.klass] }
+    end
+
+    def changes_from_to
+      if related_record_changes?
+        related_record_changes
+      elsif object_changes?
+        object_changes
+      elsif array_changes?
+        array_changes
+      elsif password_changes?
+        password_changes
+      elsif date_changes?
+        date_changes
+      elsif datetime_changes?
+        datetime_changes
+      elsif boolean_changes?
+        boolean_changes
+      elsif enum_changes?
+        enum_changes
+      else
+        common_column_changes
+      end
+    end
+
+  end
+end

data/lib/audited/serialization_changes/array_module.rb

@@ -0,0 +1,22 @@
+module Audited
+  module SerializationChanges
+    module ArrayModule
+
+      extend ActiveSupport::Concern
+
+      private
+
+      def array_changes?
+        @initial.is_a?(Array) || @changed.is_a?(Array)
+      end
+
+      def array_changes
+        from = @initial&.join(', ')
+        to = @changed&.join(', ')
+
+        return from, to
+      end
+
+    end
+  end
+end

data/lib/audited/serialization_changes/boolean_module.rb

@@ -0,0 +1,23 @@
+module Audited
+  module SerializationChanges
+    module BooleanModule
+
+      extend ActiveSupport::Concern
+
+      private
+
+      def boolean_changes?
+        classes = [TrueClass, FalseClass]
+
+        classes.include?(@initial.class) || classes.include?(@changed.class)
+      end
+
+      def boolean_changes
+        values = { true => 'Да', false => 'Нет' }
+
+        return values[@initial], values[@changed]
+      end
+
+    end
+  end
+end

data/lib/audited/serialization_changes/common_module.rb

@@ -0,0 +1,23 @@
+module Audited
+  module SerializationChanges
+    module CommonModule
+
+      extend ActiveSupport::Concern
+
+      private
+
+      def password_changes?
+        @column == 'encrypted_password'
+      end
+
+      def password_changes
+        return nil, '<новый>'
+      end
+
+      def common_column_changes
+        return @initial, @changed
+      end
+
+    end
+  end
+end

data/lib/audited/serialization_changes/date_module.rb

@@ -0,0 +1,29 @@
+module Audited
+  module SerializationChanges
+    module DateModule
+
+      extend ActiveSupport::Concern
+
+      private
+
+      def date_changes?
+        @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 date_changes
+        from = date_change_formatted(@initial)
+        to = date_change_formatted(@changed)
+
+        return from, to
+      end
+
+      def date_change_formatted(value)
+        return if value.blank?
+
+        Date.parse(value).strftime('%d.%m.%Y')
+      end
+
+    end
+  end
+end

data/lib/audited/serialization_changes/datetime_module.rb

@@ -0,0 +1,29 @@
+module Audited
+  module SerializationChanges
+    module DatetimeModule
+
+      extend ActiveSupport::Concern
+
+      private
+
+      def datetime_changes?
+        @initial&.to_date&.acts_like?(:date) && @initial.include?(':') rescue false
+        @changed&.to_date&.acts_like?(:date) && @changed.include?(':') rescue false
+      end
+
+      def datetime_changes
+        from = datetime_change_formatted(@initial)
+        to = datetime_change_formatted(@changed)
+
+        return from, to
+      end
+
+      def datetime_change_formatted(value)
+        return if value.blank?
+
+        DateTime.parse(value).in_time_zone('Europe/Moscow').strftime('%d.%m.%Y %H:%M')
+      end
+
+    end
+  end
+end

data/lib/audited/serialization_changes/enum_module.rb

@@ -0,0 +1,22 @@
+module Audited
+  module SerializationChanges
+    module EnumModule
+
+      extend ActiveSupport::Concern
+
+      private
+
+      def enum_changes?
+        @db_column.type == :enum
+      end
+
+      def enum_changes
+        type = @db_column.sql_type
+        values = I18n.t("enums.#{type}").stringify_keys
+
+        return values[@initial], values[@changed]
+      end
+
+    end
+  end
+end

data/lib/audited/serialization_changes/object_module.rb

@@ -0,0 +1,29 @@
+module Audited
+  module SerializationChanges
+    module ObjectModule
+
+      extend ActiveSupport::Concern
+
+      private
+
+      def object_changes?
+        @initial.is_a?(Hash) || @changed.is_a?(Hash)
+      end
+
+      def object_changes
+        from = object_change_formatted(@initial, @changed)
+        to = object_change_formatted(@changed, @initial)
+
+        return from, to
+      end
+
+      def object_change_formatted(from, to)
+        # удаление дубликатов ключей/значений
+        hash = (from.to_a - to.to_a).to_h
+
+        hash.map { |key, val| "#{key.humanize}: #{val}" }
+      end
+
+    end
+  end
+end

data/lib/audited/serialization_changes/related_record_module.rb

@@ -0,0 +1,47 @@
+module Audited
+  module SerializationChanges
+    module RelatedRecordModule
+
+      extend ActiveSupport::Concern
+
+      private
+
+      def related_record_changes?
+        @reflections[@column].present?
+      end
+
+      def related_record_changes
+        # модель связанной сущности от колонки
+        related_model = @reflections[@column]
+
+        # заданные/измененные значения
+        from = related_record_value(related_model, @initial)
+        to = related_record_value(related_model, @changed)
+
+        return from, to
+      end
+
+      def related_record_value(related_model, related_record_id)
+        return '' unless related_record_id
+
+        record = related_model.find_by(id: related_record_id)
+        return "Запись ##{related_record_id}" unless record
+
+        related_record_auditing_title(record)
+      end
+
+      def related_record_auditing_title(record)
+        audited_title = record.class.audited_options[:title]
+
+        if audited_title
+          record.send(audited_title)
+        elsif record.class.column_names.include?('name')
+          record.name
+        else
+          "##{record.id}"
+        end
+      end
+
+    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/audit_extensions'
+
 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: 1.0.0
 platform: ruby
 authors:
 - Павел Бабин
@@ -32,6 +32,17 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/audited-serialize.rb
+- lib/audited/audit_extensions.rb
+- lib/audited/serialization.rb
+- lib/audited/serialization_changes/array_module.rb
+- lib/audited/serialization_changes/boolean_module.rb
+- lib/audited/serialization_changes/common_module.rb
+- lib/audited/serialization_changes/date_module.rb
+- lib/audited/serialization_changes/datetime_module.rb
+- lib/audited/serialization_changes/enum_module.rb
+- lib/audited/serialization_changes/object_module.rb
+- lib/audited/serialization_changes/related_record_module.rb
+- lib/audited_config.rb
 - lib/audited_serialize.rb
 homepage:
 licenses:
@@ -53,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Сериализация аудит-логов Audited