audited-serialize 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c13c23cc79d29cf37a1c663634909b2f699bb38a7e69722d0d68c71159d01d96
-  data.tar.gz: a65ad64ea718d380b56711155a13dc2bb7f85fb65143ef52079ae584816960a8
+  metadata.gz: 9831becf62c15330c967bfb39d7de664d35f927399d49d990588c5e84ae5db3c
+  data.tar.gz: db7ef7657110c4c0af5460c4d9a548e72caea9eaefd56c717b35de623630b7fe
 SHA512:
-  metadata.gz: c24d1457e9cf4f2103d38ac8f37bde5799b13bc812cea1a3cded11f5743e8b728761ab267bc6578de42ea21c60e890305f35fe7bdf8dca11df9bc5e507fc0e5f
-  data.tar.gz: 9eacbfb7355928d94a0c948d7063fe5d50d2ccb8f695b173b5718a97a3648b85aa49b7f10d8c9ecfc8b6d082520c52ca09877c89684d0980ede7e02d6dc8f2ab
+  metadata.gz: 6e933f808d43686f17615b55748f1d3fca883e7ec79caf74a480a0cda8d136dc9eba4cb865a430950b831a509ebe965ad648307b9f36605396fc0750cbffc0cc
+  data.tar.gz: '0219e93533c1844bf0992a606bcbb99fa209f3803e59fb39be8644fda11e6213844b7f61796a6fa1514486fe39fe0cfc84390d930c8735db3cfe1a1788e55eab'

data/README.md

@@ -7,13 +7,13 @@
 
 Добавить в Gemfile
 
-```
+```ruby
 gem 'audited-serialize'
 ```
 
 И выполнить:
 
-```
+```bash
 bundle
 ```
 
@@ -21,27 +21,41 @@ bundle
 
 Для вызова сериализованного списка изменений вызовите метод `.changes_list` на экземпляре audit-класса (по умолчанию - `Audited::Audit`)
 
-```
+```ruby
 audit = Audited::Audit.first
 audit.changes_list
+
+=>
+[
+  { field: "ФИО", from: nil, to: "Test" },
+  { field: "Роль", from: nil, to: "Пользователь" },
+  { field: "Email", from: nil, to: "user@example.com" },
+  { field: "Пароль", from: nil, to: "<новый>" }
+]
 ```
 
 ## Заголовки аудит-логов
 
 На экземплярах audit-класса доступен метод `.title` для вывода заголовка c информацией о том, какое действие на какой сущности было совершено
 
-```
+```ruby
 audit = Audited::Audit.first
 audit.title
 
 => "Изменение пользователя" 
 ```
 
+Названия сущностей (`пользователя` из примера выше) должны быть описаны в YAML-файле с переводами. Для генерации файла со списком текущих моделей, на которых предусмотрен audit-трекинг воспользуйтесь командой:
+
+```bash
+rails g audited:translations
+```
+
 ## Заголовки связанных записей
 
 При наличии в аудит-логах полей, содержащих ID связанных сущностей, по умолчанию будет отображено название (поле `name`) этой сущности. При отсутствии у сущности поля `name` или необходимости отображения значения другого поля можно задать название этого поля в модели
 
-```
+```ruby
 # app/models/user.rb
 
 class User < ApplicationRecord
@@ -55,7 +69,7 @@ end
 
 Изменение настроек сериализации осуществляется путем редактирования стандартного файла конфигурации `Audited`
 
-```
+```ruby
 # config/initializers/audited.rb
 
 Audited.config do |config|
@@ -67,7 +81,7 @@ end
 
 Для добавления исключений для полей сущностей, которые не будут отображаться в списке добавьте в конфиг `serialization_exceptions`.
 
-```
+```ruby
 # config/initializers/audited.rb
 
 Audited.config do |config|

data/lib/audited/audit_extensions.rb

@@ -31,11 +31,21 @@ module Audited
     end)
 
     def title
-      operation = I18n.t("audited.actions.#{action}")
-      entity = I18n.t("audited.auditable_types.#{auditable_type}")
+      operation = I18n.t("audited_serialize.actions.#{action}")
+      entity = I18n.t("audited_serialize.auditable_types.#{auditable_type}")
 
       "#{operation} #{entity}"
     end
 
   end
+
+  @ignored_attributes = %w[
+    lock_version
+    created_at
+    updated_at
+    created_on
+    updated_on
+    deleted_at
+  ]
+
 end

data/lib/audited/locale/ru.yml

@@ -0,0 +1,8 @@
+ru:
+  audited_serialize:
+    actions:
+      actions:
+      create: "Создание"
+      restore: "Восстановление"
+      update: "Изменение"
+      destroy: "Удаление"

data/lib/audited_serialize.rb

@@ -1,5 +1,7 @@
 require 'audited_config'
 require 'audited/audit_extensions'
 
+I18n.load_path << File.expand_path('audited/locale/ru.yml', __dir__)
+
 module AuditedSerialize
 end

data/lib/generators/audited/templates/locale.rb.tt

@@ -0,0 +1,7 @@
+ru:
+  audited_serialize:
+    auditable_types:
+      # в ед. числе, в родительном падеже c маленькой буквы
+      <%- models.each do |model| -%>
+      <%= model %>: ""
+      <%- end -%>

data/lib/generators/audited/translations_generator.rb

@@ -0,0 +1,25 @@
+module Audited
+  module Generators
+    class TranslationsGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_locales_file
+        template 'locale.rb', File.join('config/locales/audited_serialize.ru.yml')
+      end
+
+      private
+
+      def models
+        Rails.application.eager_load!
+
+        ActiveRecord::Base.descendants.map do |model|
+          if model.respond_to?(:auditing_enabled)
+            model.to_s
+          end
+        end.compact.sort
+      end
+
+    end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: audited-serialize
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Павел Бабин
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-13 00:00:00.000000000 Z
+date: 2024-04-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: audited
   requirement: !ruby/object:Gem::Requirement
@@ -33,6 +47,7 @@ files:
 - README.md
 - lib/audited-serialize.rb
 - lib/audited/audit_extensions.rb
+- lib/audited/locale/ru.yml
 - lib/audited/serialization.rb
 - lib/audited/serialization_changes/array_module.rb
 - lib/audited/serialization_changes/boolean_module.rb
@@ -44,6 +59,8 @@ files:
 - lib/audited/serialization_changes/related_record_module.rb
 - lib/audited_config.rb
 - lib/audited_serialize.rb
+- lib/generators/audited/templates/locale.rb.tt
+- lib/generators/audited/translations_generator.rb
 homepage:
 licenses:
 - MIT