recorder 0.1.20 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9017142368d57513a5b5be3a3def20ffe43c399f
-  data.tar.gz: e58ef82cfb1c2709d8fd96430f9ee74ebac19660
+SHA256:
+  metadata.gz: 4af26e2ed8bedd59ea727cc40967738a53967495d7109401f3698895e4cc394e
+  data.tar.gz: 356249bc613ab922c13deb3d9b8f91fd82fd99984b3e44e258b4d04720ab49c8
 SHA512:
-  metadata.gz: b76edc2c3bb411f7c4d9471894c33a058f751681682c827195b0454116ddfc15ffff72ae89fb420d0f5c8e83708631e80332e490565f593bf920dc777098cb16
-  data.tar.gz: ef682c79e420910a6a90234f126f201ad109b3b52100161d6d87c12d3c00c988a50d7c9e585430fea03f650f3eff9effe7a4e88790e6c6ad79f4e04db346585f
+  metadata.gz: 27b9d07aa2667fefb5d6f5f2acba706a1397da9c37af28bcf8f775753bf183507acbd4a5cf6604c16e5b7017b34a7b1c430d13db0407144038d46807a6ced3aa
+  data.tar.gz: 456c8e4ccffd562f766a732940b1c0378806bd71b18b223de6d3926ef0fafc956856d1bfbdde93ff9287857a5908bc1ac8715218dc88d5fed5b15b3ac6c9c5dc

data/.gitignore

@@ -9,3 +9,7 @@
 /tmp/
 
 /spec/dummy/config/database.yml
+
+# Ignore vim swap files
+*.swp
+*.swo

data/.rubocop.yml

@@ -0,0 +1,27 @@
+inherit_gem:
+  jetrockets-standard: config/gems.yml
+
+AllCops:
+  Exclude:
+    - 'bin/*'
+    - 'tmp/**/*'
+    - 'docs/**/*'
+    - 'Gemfile'
+    - 'vendor/**/*'
+    - 'gemfiles/**/*'
+  DisplayCopNames: true
+  TargetRubyVersion: 2.5
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: no_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: no_comma
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_first_parameter
+
+# See https://github.com/rubocop-hq/rubocop/issues/4222
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*'

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in recorder.gemspec

data/README.md

@@ -20,7 +20,37 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To enable logging on a model you just need to include `Recorder::Observer` into the model and configure logging options for it:
+
+``` ruby
+class Post < ActiveRecord::Base
+  include ::Recorder::Observer
+
+  recorder only: %i[title tags],
+    associations: {
+      author: { only: %i[full_name] },
+      category: { only: %i[name slug] }
+    }
+end
+```
+
+Recorder supports the following options:
+
+ * `ignore: [array]` - attributes that are ignored on logging;
+ * `only: [array]` - only these attributes are logged, other attributes are ingored;
+ * `associations: {hash} (hash)` - allows to set what associations will be logged alongside with the model. For each association you can also set ignore and only options;
+ * `async: bool` - a logging strategy (true - asynchronous, false - synchronous).
+
+There are two strategies for logging: synchronous and asynchronous. When the synchronous strategy is used, a revision record is saved immediately after a model is saved, and the async strategy moves creating of revision records to [Sidekiq](https://github.com/mperham/sidekiq).
+
+To enable storing of such data as user_id and ip, you need to include `Recorder::Rails::ControllerConcern` to `ApplicationController`. Recorder uses [request_store](https://github.com/steveklabnik/request_store) to safely store these data on a thread level.
+
+``` ruby
+  class ApplicationController < ActionController::Base
+    include Recorder::Rails::ControllerConcern
+    ...
+  end
+```
 
 ## Development
 
@@ -34,9 +64,9 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/jetroc
 
 ## Credits
 
-![JetRockets](http://www.jetrockets.ru/jetrockets.png)
+![JetRockets](https://media.jetrockets.pro/jetrockets-white.png)
 
-Recorder is maintained by [JetRockets](http://www.jetrockets.ru).
+Recorder is maintained by [JetRockets](https://www.jetrockets.pro]).
 
 ## License
 

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "recorder"
+require 'bundler/setup'
+require 'recorder'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "recorder"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/generators/recorder/install_generator.rb

@@ -1,48 +1,50 @@
-require "rails/generators"
-require "rails/generators/active_record"
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/active_record'
 
 module Recorder
   # Installs Recorder in a rails app.
   class InstallGenerator < ::Rails::Generators::Base
     include ::Rails::Generators::Migration
 
-    source_root File.expand_path("../templates", __FILE__)
+    source_root File.expand_path('templates', __dir__)
 
     class_option(
       :with_partitions,
       type: :boolean,
       default: false,
-      desc: "Create partitions to `recorder_revisions` table"
+      desc: 'Create partitions to `recorder_revisions` table'
     )
 
     class_option(
       :with_number_column,
       type: :boolean,
       default: false,
-      desc: "Add `number` column to `recorder_revisions` table"
+      desc: 'Add `number` column to `recorder_revisions` table'
     )
 
     class_option(
       :with_index_by_user_id,
       type: :boolean,
       default: false,
-      desc: "Add index by `user_id` column to `recorder_revisions` table"
+      desc: 'Add index by `user_id` column to `recorder_revisions` table'
     )
 
-    desc "Generates (but does not run) a migration to add a `recorder_revisions` table."
+    desc 'Generates (but does not run) a migration to add a `recorder_revisions` table.'
 
     def create_migration_file
-      self.add_or_skip_recorder_migration('create_recorder_revisions')
-      self.add_or_skip_recorder_migration('add_number_column_to_recorder_revisions') if options.with_number_column?
-      self.add_or_skip_recorder_migration('add_index_by_user_id_to_recorder_revisions') if options.with_index_by_user_id?
-      self.add_or_skip_recorder_migration('add_partitions_to_recorder_revisions') if options.with_partitions?
+      add_or_skip_recorder_migration('create_recorder_revisions')
+      add_or_skip_recorder_migration('add_number_column_to_recorder_revisions') if options.with_number_column?
+      add_or_skip_recorder_migration('add_index_by_user_id_to_recorder_revisions') if options.with_index_by_user_id?
+      add_or_skip_recorder_migration('add_partitions_to_recorder_revisions') if options.with_partitions?
     end
 
     def self.next_migration_number(dirname)
       ::ActiveRecord::Generators::Base.next_migration_number(dirname)
     end
 
-  protected
+    protected
 
     def add_or_skip_recorder_migration(template)
       migration_dir = File.expand_path('db/migrate')

data/lib/generators/recorder/templates/add_index_by_user_id_to_recorder_revisions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This migration adds number column to the `revisions` table.
 class AddIndexByUserIdToRecorderRevisions < ActiveRecord::Migration
   def change

data/lib/generators/recorder/templates/add_number_column_to_recorder_revisions.rb

@@ -1,30 +1,32 @@
+# frozen_string_literal: true
+
 # This migration adds number column to the `revisions` table.
 class AddNumberColumnToRecorderRevisions < ActiveRecord::Migration
   def up
-    add_column :recorder_revisions, :number, :integer, :null => false, :default => 0
-
-    execute <<-SQL
-CREATE OR REPLACE FUNCTION get_recorder_revisions_number()
-  RETURNS trigger AS
-$BODY$
-BEGIN
-    SELECT COALESCE(MAX(recorder_revisions.number), 0) + 1
-    INTO NEW.number
-    FROM
-      recorder_revisions
-    WHERE
-      recorder_revisions.item_type = NEW.item_type
-      AND recorder_revisions.item_id = NEW.item_id;
+    add_column :recorder_revisions, :number, :integer, null: false, default: 0
 
-    RETURN NEW;
-END;
-$BODY$ LANGUAGE plpgsql;
+    execute <<~SQL
+            CREATE OR REPLACE FUNCTION get_recorder_revisions_number()
+              RETURNS trigger AS
+            $BODY$
+            BEGIN
+                SELECT COALESCE(MAX(recorder_revisions.number), 0) + 1
+                INTO NEW.number
+                FROM
+                  recorder_revisions
+                WHERE
+                  recorder_revisions.item_type = NEW.item_type
+                  AND recorder_revisions.item_id = NEW.item_id;
+      #{"      "}
+                RETURN NEW;
+            END;
+            $BODY$ LANGUAGE plpgsql;
     SQL
 
-    execute <<-SQL
-CREATE TRIGGER update_recorder_revisions_number
-  BEFORE INSERT ON recorder_revisions FOR EACH ROW
-  EXECUTE PROCEDURE get_recorder_revisions_number();
+    execute <<~SQL
+      CREATE TRIGGER update_recorder_revisions_number
+        BEFORE INSERT ON recorder_revisions FOR EACH ROW
+        EXECUTE PROCEDURE get_recorder_revisions_number();
     SQL
   end
 

data/lib/generators/recorder/templates/create_recorder_revisions.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 # This migration creates the `recorder_revisions` table.
 class CreateRecorderRevisions < ActiveRecord::Migration
   def change
     create_table :recorder_revisions do |t|
       t.string :item_type, null: false
-      t.integer :item_id, null: false
+      t.integer :item_id
       t.string :event, null: false
       t.jsonb :data, null: false
       t.inet :ip
@@ -13,6 +15,6 @@ class CreateRecorderRevisions < ActiveRecord::Migration
       t.datetime :created_at, null: false
     end
 
-    add_index :recorder_revisions, [:item_type, :item_id]
+    add_index :recorder_revisions, %i[item_type item_id]
   end
 end

data/lib/recorder/changeset.rb

@@ -1,34 +1,36 @@
+# frozen_string_literal: true
+
 module Recorder
   class Changeset
     attr_reader :item, :changes
 
     def initialize(item, changes)
-      @item = item;
-      @changes = Hash[changes]
+      @item = item
+      @changes = changes.to_h
     end
 
     def keys
-      self.changes.try(:keys) || []
+      changes.try(:keys) || []
     end
 
     def human_attribute_name(attribute)
-      if defined?(Draper) && self.item.decorated?
-        self.item.source.class.human_attribute_name(attribute.to_s)
+      if defined?(Draper) && item.decorated?
+        item.source.class.human_attribute_name(attribute.to_s)
       else
-        self.item.class.human_attribute_name(attribute.to_s)
+        item.class.human_attribute_name(attribute.to_s)
       end
     end
 
     def previous(attribute)
-      self.try("previous_#{attribute}") || self.previous_version.try(attribute)
+      try("previous_#{attribute}") || previous_version.try(attribute)
     end
 
     def previous_version
       return @previous_version if defined?(@previous_version)
 
-      @previous_version = self.item.dup
+      @previous_version = item.dup
 
-      self.changes.each do |key, change|
+      changes.each do |key, change|
         @previous_version.send("#{key}=", change[0])
       end
 
@@ -36,15 +38,15 @@ module Recorder
     end
 
     def next(attribute)
-      self.try("next_#{attribute}") || self.next_version.send(attribute)
+      try("next_#{attribute}") || next_version.try(attribute)
     end
 
     def next_version
       return @next_version if defined?(@next_version)
 
-      @next_version = self.item.dup
+      @next_version = item.dup
 
-      self.changes.each do |key, change|
+      changes.each do |key, change|
         @next_version.send("#{key}=", change[1])
       end
 

data/lib/recorder/config.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 require 'singleton'
 
 module Recorder
   # Global configuration options
   class Config
     include Singleton
-    attr_accessor :sidekiq_options, :ignore
+    attr_accessor :sidekiq_options
+    attr_reader :ignore, :async
 
     def initialize
       # Variables which affect all threads, whose access is synchronized.
@@ -12,18 +15,23 @@ module Recorder
       @enabled = true
 
       @sidekiq_options = {
-        :queue => 'recorder',
-        :retry => 10,
-        :backtrace => true
+        queue: 'recorder',
+        retry: 10,
+        backtrace: true
       }
 
-      @ignore = Array.new
+      @ignore = []
+      @async = false
     end
 
     def ignore=(value)
       @ignore = Array.wrap(value).map(&:to_sym)
     end
 
+    def async=(value)
+      @async = !!value
+    end
+
     # Indicates whether Recorder is on or off. Default: true.
     def enabled
       @mutex.synchronize { !!@enabled }

data/lib/recorder/manager.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Recorder
+  module Manager
+    def recorder_disabled!
+      Recorder.store.recorder_disabled!
+
+      if block_given?
+        yield
+        Recorder.store.recorder_enabled!
+      end
+    end
+
+    def recorder_enabled!
+      Recorder.store.recorder_enabled!
+    end
+  end
+end

data/lib/recorder/observer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'recorder/tape'
 require 'active_support/concern'
 
@@ -6,22 +8,19 @@ module Recorder
     extend ::ActiveSupport::Concern
 
     included do
-      has_many :revisions, :class_name => '::Recorder::Revision', :inverse_of => :item, :as => :item do
-        def create_async(params)
-          Recorder::Sidekiq::RevisionsWorker.perform_async(
-            proxy_association.owner.class.to_s,
-            proxy_association.owner.id,
-            params
-          )
-        end
-      end
+      has_many :revisions, class_name: '::Recorder::Revision', inverse_of: :item, as: :item
     end
 
     def recorder_dirty?
       return @recorder_dirty if defined?(@recorder_dirty)
+
       true
     end
 
+    def recorder_record?
+      recorder_dirty? && Recorder.store.recorder_enabled?
+    end
+
     module ClassMethods
       def recorder(options = {})
         define_method 'recorder_options' do
@@ -29,21 +28,15 @@ module Recorder
         end
 
         after_create do
-          if self.recorder_dirty?
-            Recorder::Tape.new(self).record_create
-          end
+          Recorder::Tape.new(self).record_create if recorder_record?
         end
 
         after_update do
-          if self.recorder_dirty?
-            Recorder::Tape.new(self).record_update
-          end
+          Recorder::Tape.new(self).record_update if recorder_record?
         end
 
         after_destroy do
-          if self.recorder_dirty?
-            Recorder::Tape.new(self).record_destroy
-          end
+          Recorder::Tape.new(self).record_destroy if recorder_record?
         end
       end
     end