models_auditor 0.1.0

data/lib/generators/models_auditor/db_config/db_config_generator.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+module ModelsAuditor
+  class DbConfigGenerator < Rails::Generators::Base
+    def add_db_config
+      if (nmsps = ModelsAuditor.config.connection_namespace).present?
+        inject_into_file 'config/database.yml', before: /\z/ do
+          "\n#{nmsps}_development: &#{nmsps}_development\n" +
+            "  adapter:    postgresql\n" +
+            "  encoding:   unicode\n" +
+            "  database:   audit_database\n" +
+            "  pool:       5\n" +
+            "  host:       localhost\n" +
+            "  username:   audit_user\n" +
+            "  password:   \n" +
+            "#{nmsps}_production:     *#{nmsps}_development\n" +
+            "#{nmsps}_staging:        *#{nmsps}_development\n" +
+            "#{nmsps}_test:           *#{nmsps}_development\n"
+        end
+      end
+    end
+
+  end
+end

data/lib/generators/models_auditor/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Create a ModelsAuditor initializer'
+
+Example:
+    rails generate models_auditor:install
+
+    This will create:
+        config/initializers/models_auditor.rb

data/lib/generators/models_auditor/install/install_generator.rb

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+module ModelsAuditor
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def descriptions
+      @descriptions ||= YAML.load_file(File.expand_path('../../../../../config/config_option_descriptions.yml', __FILE__))
+    end
+
+    def copy_initializer
+      template 'initializer.rb.erb', 'config/initializers/models_auditor.rb'
+    end
+
+    # def mount_routes
+    #   [
+    #     'Rails.application.routes.draw do',
+    #     'Application.routes.draw do'
+    #   ].each do |after_str|
+    #     inject_into_file 'config/routes.rb', :after => after_str do
+    #       "\n  mount GlobalStore::Engine, at: '/global_store'\n"
+    #     end
+    #   end
+    # end
+  end
+end

data/lib/generators/models_auditor/install/templates/initializer.rb.erb

@@ -0,0 +1,13 @@
+# Настройки аудитора моделей
+
+ModelsAuditor.configure do |config|
+<%
+  (ModelsAuditor::Config::CONFIG_OPTIONS).each do |option_sym|
+    descr = descriptions[option_sym.to_s].try(:split, "\n").try(:join, "\n  # ")
+    concat "  # #{descr.force_encoding('ASCII-8BIT')}\n" if descr.present?
+    concat "  # config.#{option_sym} = "
+    concat (ModelsAuditor.config.default[option_sym].try(:[], :config) || 'nil').force_encoding('ASCII-8BIT')
+    concat "\n\n"
+  end
+%>
+end

data/lib/generators/models_auditor/migrations/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Create migrations for your audit database
+
+Example:
+    rails generate models_auditor:migrations
+
+    This will create:
+        db/<audit_migrate_dir>/create_audit_records.rb

data/lib/generators/models_auditor/migrations/migrations_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators/base'
+require 'generators/models_auditor/migrations_helper'
+
+module ModelsAuditor
+  class MigrationsGenerator < Rails::Generators::Base
+    include MigrationsHelper
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_migration_file
+      @migration_postfix = SecureRandom.hex
+      copy_migration 'create_audit_records', "create_audit_records_n#{@migration_postfix}"
+      copy_migration 'create_audit_requests', "create_audit_requests_n#{@migration_postfix}"
+    end
+  end
+end

data/lib/generators/models_auditor/migrations/templates/create_audit_records.rb.erb

@@ -0,0 +1,18 @@
+class CreateAuditRecordsN<%= @migration_postfix %> < ActiveRecord::Migration
+  def change
+    <% audit_tbn = ModelsAuditor.config.audit_records_table_name %>
+    create_table :<%= audit_tbn %>, comment: 'Журнал изменений данных в моделях' do |t|
+      t.integer   :request_id,    null: true,   unsigned: true, comment: 'зафиксированные изменения'
+      t.integer   :action,        null: false,  unsigned: true, comment: 'действие'
+      t.json      :content,       null: false,  default: {},    comment: 'зафиксированные изменения'
+      t.string    :object_type,   null: false,                  comment: 'класс логируемого объекта'
+      t.integer   :object_id,     null: false,  unsigned: true, comment: 'id логируемого объекта'
+      t.json      :bridge,        null: true,                   comment: 'данные внешних ключей связующей таблицы'
+      t.datetime  :created_at,    null: false,                  comment: 'дата и время зафиксированных изменений'
+    end
+    add_index :<%= audit_tbn %>, :id
+    add_index :<%= audit_tbn %>, :request_id
+    add_index :<%= audit_tbn %>, :created_at
+    add_index :<%= audit_tbn %>, [:object_id, :object_type]
+  end
+end

data/lib/generators/models_auditor/migrations/templates/create_audit_requests.rb.erb

@@ -0,0 +1,12 @@
+class CreateAuditRequestsN<%= @migration_postfix %> < ActiveRecord::Migration
+  def change
+    <% audit_tbn = ModelsAuditor.config.audit_requests_table_name %>
+    create_table :<%= audit_tbn %>, comment: 'Журнал изменений данных в моделях' do |t|
+      t.integer   :user_id,       null: true,   unsigned: true,             comment: 'id ответственного'
+      t.json      :request_info,  null: false,  default: {},                comment: 'Информация о запросе'
+      t.datetime  :created_at,    null: false,                              comment: 'дата и время запроса'
+    end
+    add_index :<%= audit_tbn %>, :id
+    add_index :<%= audit_tbn %>, :created_at
+  end
+end

data/lib/generators/models_auditor/migrations_helper.rb

@@ -0,0 +1,24 @@
+module ModelsAuditor
+  module MigrationsHelper
+    extend  ActiveSupport::Concern
+
+    included do
+      include Rails::Generators::Migration
+
+      def self.next_migration_number(dirname)
+        next_migration_number = current_migration_number(dirname) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+    end
+
+    def copy_migration(filename, destination)
+      migrations_dir = File.join('db', ModelsAuditor.config.audit_migrations_dir)
+
+      if self.class.migration_exists?(migrations_dir, "#{destination}.rb")
+        say_status('skipped', "Migration #{destination}.rb already exists in #{migrations_dir}")
+      else
+        migration_template "#{filename}.rb.erb", File.join(migrations_dir, "#{destination}.rb")
+      end
+    end
+  end
+end

data/lib/models_auditor.rb

@@ -0,0 +1,37 @@
+require 'request_store'
+require 'models_auditor/engine'
+require 'models_auditor/config'
+require 'models_auditor/audit'
+require 'models_auditor/controller'
+
+module ModelsAuditor
+  module_function
+  def log_error(*args)
+    if (logger = ModelsAuditor.config.logger)
+      logger.error(*args)
+    end
+    puts *args
+  end
+
+  def log_info(*args)
+    if (logger = ModelsAuditor.config.logger)
+      logger.info(*args)
+    end
+    puts *args
+  end
+
+  def log_warn(*args)
+    if (logger = ModelsAuditor.config.logger)
+      logger.warn(*args)
+    end
+    puts *args
+  end
+
+  def store
+    RequestStore.store[:models_auditor_store] ||= {}
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include ModelsAuditor::Audit
+end

data/lib/models_auditor/audit.rb

@@ -0,0 +1,202 @@
+module ModelsAuditor
+  module Audit
+    # Сбор данных через метод #as_json
+    #   @example enable_audit ModelsAuditor::Audit::AUDIT_MODE_JSON, only: [:title, :subtitle, :published_at]
+    AUDIT_MODE_JSON         = 1
+    # Сбор данных через сериалайзер
+    #   @example enable_audit ModelsAuditor::Audit::AUDIT_MODE_SERIALIZER, serializer: AuditPostSerializer
+    AUDIT_MODE_SERIALIZER   = 2
+    # Сбор данных через назначенный метод
+    #  @example enable_audit ModelsAuditor::Audit::AUDIT_MODE_SERIALIZER, method: :logged_data
+    AUDIT_MODE_METHOD       = 3
+    # Сбор данных через #previous_changes
+    #  @example enable_audit ModelsAuditor::Audit::AUDIT_MODE_CHANGES_ONLY
+    AUDIT_MODE_CHANGES_ONLY = 4
+
+    AUDIT_SNAPSHOT_MODES = [AUDIT_MODE_JSON, AUDIT_MODE_SERIALIZER, AUDIT_MODE_METHOD]
+    AUDIT_CHANGES_MODES  = [AUDIT_MODE_CHANGES_ONLY]
+
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    module InstanceMethods
+      def do_audit_init_snapshot
+        return unless ModelsAuditor.config.audit_enabled
+        mode = self.class.instance_variable_get(:@audit_mode)
+        return unless self.class.instance_variable_get(:@audit_enabled) && AUDIT_SNAPSHOT_MODES.include?(mode)
+        ma_store_initial_state(ModelsAuditor.store)
+      end
+
+      def do_audit_process
+        return unless ModelsAuditor.config.audit_enabled
+        return unless self.class.instance_variable_get(:@audit_enabled)
+        mode    = self.class.instance_variable_get(:@audit_mode)
+        options = self.class.instance_variable_get(:@audit_settings) || {}
+        store   = ModelsAuditor.store
+
+        initial_data = ma_get_initial_state(store)
+        current_data = ma_auditor_get_data
+
+        action =
+          case
+            when transaction_include_any_action?([:create])
+              ModelsAuditor::AuditRecord::ACTION_CREATE
+            when transaction_include_any_action?([:update])
+              ModelsAuditor::AuditRecord::ACTION_UPDATE
+            when transaction_include_any_action?([:destroy])
+              ModelsAuditor::AuditRecord::ACTION_DESTROY
+          end
+
+        bridge =
+          if options[:bridge]
+            options[:bridge].each_with_object({}) { |(model_name, key), o| o[model_name] = {key => __send__(key)} }
+          end
+
+        Thread.new do
+          begin
+            log_anyway = !ModelsAuditor.config.audit_request_changes_only
+            if (request = store[:audit_request]) || log_anyway
+              body =
+                case
+                  when AUDIT_SNAPSHOT_MODES.include?(mode)
+                    ma_eliminate_not_changed_keys(initial_data, current_data)
+                  when AUDIT_CHANGES_MODES.include?(mode)
+                    current_data
+                  else
+                    raise ArgumentError.new('Incorrect value of argument audit_type')
+                end
+
+              if request.try(:new_record?) && !request.save
+                ModelsAuditor.log_error("Couldn't save request record")
+                ModelsAuditor.log_error(request.errors.full_messages)
+                return
+              end
+              record =
+                ModelsAuditor::AuditRecord.new(
+                  request:   request,
+                  auditable: self,
+                  content:   body,
+                  action:    action,
+                  bridge:    bridge
+                )
+              unless record.save
+                ModelsAuditor.log_error("Couldn't logged changes of #{self.class.name} id: #{self.try(:id)}")
+                ModelsAuditor.log_error(record.errors.full_messages)
+              end
+            end
+          rescue Exception => e
+            ModelsAuditor.log_error("Couldn't logged changes of #{self.class.name} id: #{self.try(:id)}")
+            ModelsAuditor.log_error(e.message)
+            ModelsAuditor.log_error(e.backtrace.take(100).join("\n"))
+          end
+        # TODO To remove the #join call from the thread block after debugging
+        end.join
+      end
+
+      private
+
+      # Сравнивает два хэша, оставляя только отличающиеся по значению ключи
+      # @return [Hash] filtered result with different attributes only
+      def ma_eliminate_not_changed_keys(old_hash, new_hash)
+        case
+          # Равны или оба nil
+          when old_hash == new_hash
+            {}
+          # Один из них nil
+          when (old_hash && new_hash).nil?
+            (old_hash || new_hash).keys.each_with_object({}) do |key, o|
+              if (was = old_hash.try(:[], key)) != (now = new_hash.try(:[], key))
+                o[key] = [was, now]
+              end
+            end
+          else # Оба не nil
+            (old_hash.keys | new_hash.keys).each_with_object({}) do |key, o|
+              if (was = old_hash[key]) != (now = new_hash[key])
+                o[key] = [was, now]
+              end
+            end
+        end
+      end
+
+      # Запоминает сериализованные данные для аудита
+      #   Вызывать данный метод следует в коллбэке after_initialize
+      #   Или в любом другом месте до изменения значений аттрибутов
+      def ma_store_initial_state(store)
+        store[:initial_states]    ||= {}
+        states_of_mclass          = (store[:initial_states][self.class.name] ||= {})
+        states_of_mclass[self.id] ||= ma_auditor_get_data
+      end
+
+      # Получает сериализованные данные для аудита подготовленные при инициализации сущности
+      # @return [Hash|nil] Начальные данные
+      def ma_get_initial_state(store)
+        store[:initial_states].try(:[], self.class.name).try(:[], self.id)
+      end
+
+      # Получает сериализованные данные для аудита
+      def ma_auditor_get_data
+        options      = self.class.instance_variable_get(:@audit_settings) || {}
+        audit_params = options[:params]
+        mode         = self.class.instance_variable_get(:@audit_mode)
+        case mode
+          when AUDIT_MODE_JSON
+            self.as_json(audit_params)
+          when AUDIT_MODE_SERIALIZER
+            if (serializer = options[:serializer]).blank?
+              raise ArgumentError.new('Required option :serializer for AUDIT_MODE_SERIALIZER was not passed')
+            end
+            serializer.new(self, audit_params || {}).as_json
+          when AUDIT_MODE_METHOD
+            if (method = options[:serializer]).blank?
+              raise ArgumentError.new('Required option :method for AUDIT_MODE_METHOD was not passed')
+            end
+            unless self.respond_to?(method)
+              raise ArgumentError.new("Passed method '#{method}' is undefined")
+            end
+            self.__send__(method)
+          when AUDIT_MODE_CHANGES_ONLY
+            self.previous_changes
+          else
+            raise ArgumentError.new('Incorrect value of argument audit_type')
+        end
+      end
+    end
+
+
+    module ClassMethods
+      # Активирует аудит изменений данных модели
+      # @param [Integer] audit_mode Способ логирования
+      #   возможные значения: AUDIT_MODE_JSON | AUDIT_MODE_SERIALIZER | AUDIT_MODE_METHOD | AUDIT_MODE_CHANGES_ONLY
+      #   AUDIT_MODE_JSON         - Сериализация путем вызова метода as_json
+      #   AUDIT_MODE_SERIALIZER   - Сериализация через использование сериалайзера, указанного в опции :serializer
+      #   AUDIT_MODE_METHOD       - Сериализация данных формируемых в методе, указанном в опции :method
+      #   AUDIT_MODE_CHANGES_ONLY - Сериализация данных модели, которые были изменены
+      # @param [Hash] options Настройки логирования
+      # @option options [params] Параметры сериализации данных.
+      #   Для AUDIT_MODE_JSON         значение передается в метод #as_json
+      #     @example enable_audit ModelsAuditor::Audit::AUDIT_MODE_JSON, only: [:title, :subtitle, :published_at]
+      #   Для AUDIT_MODE_SERIALIZER   значение передается в сериалайзер в качестве опций
+      #     @example enable_audit ModelsAuditor::Audit::AUDIT_MODE_SERIALIZER, serializer: AuditPostSerializer
+      #   Для AUDIT_MODE_METHOD       значение игнорируется
+      #     @example enable_audit ModelsAuditor::Audit::AUDIT_MODE_SERIALIZER, method: :logged_data
+      #   Для AUDIT_MODE_CHANGES_ONLY значение игнорируется
+      #     @example enable_audit ModelsAuditor::Audit::AUDIT_MODE_CHANGES_ONLY
+      def enable_audit(audit_mode, options = {})
+        @audit_enabled  = true
+        @audit_mode     = audit_mode
+        @audit_settings = options
+        # Lazily include the instance methods so we don't clutter up
+        # any more ActiveRecord models than we have to.
+        send :include, InstanceMethods
+        after_initialize :do_audit_init_snapshot
+        after_commit :do_audit_process
+      end
+
+      # Дезактивирует аудит изменений данных модели
+      def disable_audit
+        @audit_enabled = false
+      end
+    end
+  end
+end

data/lib/models_auditor/config.rb

@@ -0,0 +1,118 @@
+module ModelsAuditor
+  class Config
+    CONFIG_OPTIONS = %i(
+      audit_enabled
+      connection_namespace
+      audit_records_table_name
+      audit_requests_table_name
+      audit_migrations_dir
+      audit_request_changes_only
+      logger
+      records_per_page
+      fake_total_count
+      audit_controller_base
+      respond_to_json_enabled
+      respond_to_html_enabled
+      json_response_data_key
+      json_response_meta_key
+    )
+
+    def initialize
+      @indexed_relations = []
+    end
+
+    def default
+      @default ||= {
+        audit_enabled:              {
+          config: 'true',
+          val:    true
+        },
+        connection_namespace:       {
+          config: "'audit'",
+          val:    'audit'
+        },
+        audit_records_table_name:   {
+          config: "'audit_records'",
+          val:    'audit_records'
+        },
+        audit_requests_table_name:  {
+          config: "'audit_requests'",
+          val:    'audit_requests'
+        },
+        audit_migrations_dir:       {
+          config: "'audit_migrate'",
+          val:    'audit_migrate'
+        },
+        logger:                     {
+          config: "Logger.new(Rails.root.join('log', 'models_auditor.log'))",
+          val:    Logger.new(Rails.root.join('log', 'models_auditor.log'))
+        },
+        audit_request_changes_only: {
+          config: 'true',
+          val:    true
+        },
+        records_per_page:           {
+          config: '10',
+          val:    10
+        },
+        fake_total_count:           {
+          config: 'true',
+          val:    true
+        },
+        audit_controller_base:      {
+          config: "'ModelsAuditor::AuditBaseController'",
+          val:    'ModelsAuditor::AuditBaseController'
+        },
+        respond_to_json_enabled:    {
+          config: 'true',
+          val:    true
+        },
+        respond_to_html_enabled:    {
+          config: 'false',
+          val:    false
+        },
+        json_response_data_key:     {
+          config: "'entries'",
+          val:    'entries'
+        },
+        json_response_meta_key:     {
+          config: "'meta'",
+          val:    'meta'
+        },
+      }
+    end
+
+    def method_missing(method_sym, *args)
+      method_name = method_sym.to_s
+      option_name = method_name.tr('=', '')
+      super if CONFIG_OPTIONS.exclude?(option_name.to_sym)
+      if method_name =~ /^.*=$/
+        raise ArgumentError.new('Incorrect number of arguments') if args.size != 1
+        instance_variable_set("@#{option_name}", args[0]) unless ModelsAuditor.configured?
+      else
+        var_name = "@#{option_name}"
+        instance_variable_defined?(var_name) ?
+          instance_variable_get(var_name) :
+          default[option_name.to_sym].try(:[], :val)
+      end
+    end
+
+  end
+
+  module_function
+
+  def configure(&block)
+    Rails.application.config.after_initialize do
+      block.call(config)
+      @configured = true
+    end
+  end
+
+  def configured?
+    @configured
+  end
+
+  def config
+    @config ||= Config.new
+  end
+end