audited-serialize 0.0.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa2ae142361013574ee5100ed3edf7da72ffa6a04758a894dfab763a3c37b82e
-  data.tar.gz: cee3114d051d34099d11d9f9f402c7dffa8a0d61c813d472a11f73a5afafabed
+  metadata.gz: c13c23cc79d29cf37a1c663634909b2f699bb38a7e69722d0d68c71159d01d96
+  data.tar.gz: a65ad64ea718d380b56711155a13dc2bb7f85fb65143ef52079ae584816960a8
 SHA512:
-  metadata.gz: 929cd4a6b8a55c730db3d644755f23cc33bb27f5e39553bd54cf67b8d6bcea0fe80c6b84eb412d7f4c7e3c03851493022d40c3fb177e908c5fb5ea919d6f4d35
-  data.tar.gz: f79cac8c70bddc12ee980194d557d9fb1f7e8d04c45d5083fdecd996015e3df1e9c31f7ed090866560263182251546675380a1050895ec9f8a4229668b2b4eca
+  metadata.gz: c24d1457e9cf4f2103d38ac8f37bde5799b13bc812cea1a3cded11f5743e8b728761ab267bc6578de42ea21c60e890305f35fe7bdf8dca11df9bc5e507fc0e5f
+  data.tar.gz: 9eacbfb7355928d94a0c948d7063fe5d50d2ccb8f695b173b5718a97a3648b85aa49b7f10d8c9ecfc8b6d082520c52ca09877c89684d0980ede7e02d6dc8f2ab

data/README.md

@@ -26,6 +26,31 @@ audit = Audited::Audit.first
 audit.changes_list
 ```
 
+## Заголовки аудит-логов
+
+На экземплярах audit-класса доступен метод `.title` для вывода заголовка c информацией о том, какое действие на какой сущности было совершено
+
+```
+audit = Audited::Audit.first
+audit.title
+
+=> "Изменение пользователя" 
+```
+
+## Заголовки связанных записей
+
+При наличии в аудит-логах полей, содержащих ID связанных сущностей, по умолчанию будет отображено название (поле `name`) этой сущности. При отсутствии у сущности поля `name` или необходимости отображения значения другого поля можно задать название этого поля в модели
+
+```
+# app/models/user.rb
+
+class User < ApplicationRecord
+
+  audit title: :email
+
+end
+```
+
 ## Конфигурация
 
 Изменение настроек сериализации осуществляется путем редактирования стандартного файла конфигурации `Audited`
@@ -38,7 +63,7 @@ Audited.config do |config|
 end
 ```
 
-### Исключения
+## Исключения
 
 Для добавления исключений для полей сущностей, которые не будут отображаться в списке добавьте в конфиг `serialization_exceptions`.
 

data/lib/audited/audit_extensions.rb

@@ -0,0 +1,41 @@
+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
+
+    scope :own_and_associated_for, (lambda do |record|
+      where('
+        (auditable_type = :type AND auditable_id = :id)
+        OR
+        (associated_type = :type AND associated_id = :id)',
+        type: record.class.to_s, id: record.id
+      ).order(id: :desc)
+    end)
+
+    def title
+      operation = I18n.t("audited.actions.#{action}")
+      entity = I18n.t("audited.auditable_types.#{auditable_type}")
+
+      "#{operation} #{entity}"
+    end
+
+  end
+end

data/lib/audited/serialization.rb

@@ -4,21 +4,29 @@ module Audited
     extend ActiveSupport::Concern
 
     def changes_list
-      model = auditable_type.constantize
+      # проверка на наличие модели
+      # в случае ее отсутствия, верятнее всего она была удалена
+      begin
+        model = auditable_type.constantize
+      rescue NameError
+        return
+      end
+
       columns_hash = model.columns_hash
-      @reflections = model.reflections.to_h { |_relation, reflection| [reflection.foreign_key, reflection.klass] }
+      @reflections = model_reflections(model)
 
       audited_changes.map do |column, value|
-        @column = column
-
         # пропускаем, если колонка в списке исключений
-        next if Audited.serialization_exceptions[auditable_type]&.include?(@column)
+        next if Audited.serialization_exceptions[auditable_type]&.include?(column)
 
-        # поле таблицы БД
+        @column = column
         @db_column = columns_hash[column]
 
+        # пропускаем, если колонка теперь отсутствует в БД
+        next unless @db_column
+
         # русскоязычное название поля
-        @field = @db_column.comment
+        field = password_changes? ? 'Пароль' : @db_column.comment
 
         if action == 'update' && value.is_a?(Array)
           # значения, измененные во время редактирования
@@ -28,158 +36,45 @@ module Audited
           @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
+        # определение изменений было/стало
+        from, to = changes_from_to
 
-        next if @from.blank? && @to.blank?
+        # пропускаем, если изменения не зафиксированы
+        next if from.blank? && to.blank?
 
         {
-          field: @field,
-          from: @from,
-          to: @to
+          field:, from:, 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}"
+    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
 
-    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/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,5 +1,5 @@
 require 'audited_config'
-require 'audited/original_audit'
+require 'audited/audit_extensions'
 
 module AuditedSerialize
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: audited-serialize
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.1
 platform: ruby
 authors:
 - Павел Бабин
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-12 00:00:00.000000000 Z
+date: 2024-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: audited
@@ -32,8 +32,16 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/audited-serialize.rb
-- lib/audited/original_audit.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:

data/lib/audited/original_audit.rb

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