logidze 0.9.0 → 0.10.0

data/Rakefile

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require "bundler/gem_tasks"
+
 require "rspec/core/rake_task"
 require "rubocop/rake_task"
 
@@ -25,4 +25,4 @@ RSpec::Core::RakeTask.new("spec:acceptance") do |task|
 end
 
 desc "Run the specs and acceptance tests"
-task default: %w(rubocop spec spec:acceptance)
+task default: %w[rubocop spec spec:acceptance]

data/bench/performance/README.md

@@ -17,14 +17,14 @@ When changeset has 2 fields:
 
 ```
 PaperTrail UPDATE #1    256.651  (±26.5%) i/s -      1.206k in   5.002300s
-   Logidze UPDATE #1    356.932  (±12.6%) i/s -      1.764k in   5.030560s
+Logidze UPDATE #1    356.932  (±12.6%) i/s -      1.764k in   5.030560s
 ```
 
 When changeset has 5 fields:
 
 ```
 PaperTrail UPDATE #2    246.281  (±24.0%) i/s -      1.168k in   5.008234s
-   Logidze UPDATE #2    331.942  (±16.6%) i/s -      1.593k in   5.028135s
+Logidze UPDATE #2    331.942  (±16.6%) i/s -      1.593k in   5.028135s
 ```
 
 ## Getting diff ([source](diff_bench.rb))

data/bench/performance/diff_bench.rb

@@ -1,36 +1,38 @@
-require 'benchmark/ips'
-require './setup'
+# frozen_string_literal: true
+
+require "benchmark/ips"
+require "./setup"
 
 # How many records do you want?
-N = (ENV['N'] || '100').to_i
+N = (ENV["N"] || "100").to_i
 
 # How many version each record has?
-V = (ENV['V'] || '10').to_i
+V = (ENV["V"] || "10").to_i
 
 # Benchmark run time
-BM_TIME = (ENV['BM_TIME'] || 5).to_i
+BM_TIME = (ENV["BM_TIME"] || 5).to_i
 
 BM_WARMUP = [(BM_TIME / 10), 2].max
 
 LogidzeBench.cleanup
 LogidzeBench.populate(N)
 
-ts1 = LogidzeBench.generate_versions(V/2)
+ts1 = LogidzeBench.generate_versions(V / 2)
 
-LogidzeBench.generate_versions(V/2)
+LogidzeBench.generate_versions(V / 2)
 
 Benchmark.ips do |x|
   x.config(time: BM_TIME, warmup: BM_WARMUP)
 
-  x.report('PT DIFF') do
-    User.random(N/2).diff_from(ts1)
+  x.report("PT DIFF") do
+    User.random(N / 2).diff_from(ts1)
   end
 
-  x.report('PT (join) DIFF') do
-    User.random(N/2).diff_from_joined(ts1)
+  x.report("PT (join) DIFF") do
+    User.random(N / 2).diff_from_joined(ts1)
   end
 
-  x.report('Logidze DIFF') do
-    LogidzeUser.random(N/2).diff_from(ts1)
+  x.report("Logidze DIFF") do
+    LogidzeUser.random(N / 2).diff_from(ts1)
   end
 end

data/bench/performance/insert_bench.rb

@@ -1,5 +1,7 @@
-require 'benchmark/ips'
-require './setup'
+# frozen_string_literal: true
+
+require "benchmark/ips"
+require "./setup"
 
 params = {
   email: Faker::Internet.email,
@@ -10,11 +12,11 @@ params = {
 }
 
 Benchmark.ips do |x|
-  x.report('PaperTrail INSERT') do
+  x.report("PaperTrail INSERT") do
     User.create!(params)
   end
 
-  x.report('Logidze INSERT') do
+  x.report("Logidze INSERT") do
     LogidzeUser.create!(params)
   end
 end

data/bench/performance/memory_profile.rb

@@ -1,12 +1,14 @@
-require './setup'
-require 'active_support/core_ext'
-require 'memory_profiler'
+# frozen_string_literal: true
+
+require "./setup"
+require "active_support/core_ext"
+require "memory_profiler"
 
 # How many records do you want?
-N = (ENV['N'] || '10').to_i
+N = (ENV["N"] || "10").to_i
 
 # How many version each record has?
-V = (ENV['V'] || '10').to_i
+V = (ENV["V"] || "10").to_i
 
 LogidzeBench.cleanup
 LogidzeBench.populate(N)
@@ -17,6 +19,7 @@ module MemoryReport
   MEGA_BYTE = 1024 * 1024
 
   module_function
+
   def call(msg, relation)
     buffer = nil
     delta = N / 10
@@ -36,6 +39,7 @@ module MemoryReport
   end
 
   module_function
+
   def to_human_size(size)
     if size > MEGA_BYTE
       "#{(size.to_f / MEGA_BYTE).round(2)} MB"
@@ -47,7 +51,6 @@ module MemoryReport
   end
 end
 
-
-MemoryReport.("PT records", User.all)
-MemoryReport.("PT with versions", User.joins(:versions).all)
-MemoryReport.("Logidze records", LogidzeUser.all)
+MemoryReport.call("PT records", User.all)
+MemoryReport.call("PT with versions", User.joins(:versions).all)
+MemoryReport.call("Logidze records", LogidzeUser.all)

data/bench/performance/setup.rb

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
+
 begin
-  require 'bundler/inline'
+  require "bundler/inline"
 rescue LoadError => e
-  $stderr.puts 'Bundler version 1.10 or later is required. Please update your Bundler'
+  warn "Bundler version 1.10 or later is required. Please update your Bundler"
   raise e
 end
 
 gemfile(true) do
-  source 'https://rubygems.org'
-  gem 'activerecord', '~>4.2'
-  gem 'pg'
-  gem 'paper_trail', '~>4.2', require: false
-  gem 'pry-byebug'
-  gem 'faker'
-  gem 'benchmark-ips'
-  gem 'memory_profiler'
+  source "https://rubygems.org"
+  gem "activerecord", "~>4.2"
+  gem "pg"
+  gem "paper_trail", "~>4.2", require: false
+  gem "pry-byebug"
+  gem "faker"
+  gem "benchmark-ips"
+  gem "memory_profiler"
 end
 
-DB_NAME = ENV['DB_NAME'] || 'logidze_query_bench'
+DB_NAME = ENV["DB_NAME"] || "logidze_query_bench"
 
 begin
   system("createdb #{DB_NAME}")
@@ -24,24 +26,25 @@ rescue
   $stdout.puts "DB already exists"
 end
 
-$LOAD_PATH.unshift File.expand_path('../../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../../lib", __FILE__)
 
-require 'active_record'
-require 'logger'
-require 'logidze'
+require "active_record"
+require "logger"
+require "logidze"
 
 ActiveRecord::Base.send :include, Logidze::HasLogidze
 
-ActiveRecord::Base.establish_connection(adapter: 'postgresql', database: DB_NAME)
+ActiveRecord::Base.establish_connection(adapter: "postgresql", database: DB_NAME)
 
 at_exit do
   ActiveRecord::Base.connection.disconnect!
 end
 
-require 'paper_trail'
+require "paper_trail"
 
 module LogidzeBench
   module_function
+
   def setup_db
     ActiveRecord::Schema.define do
       # PaperTrail setup
@@ -171,7 +174,7 @@ module LogidzeBench
                   jsonb_set(
                     NEW.log_data->'h',
                     '{1}',
-                    merged 
+                    merged
                   ) - 0
                 );
               END IF;
@@ -198,7 +201,7 @@ module LogidzeBench
         t.string :name
         t.text :bio
         t.integer :age
-        t.jsonb :log_data, default: '{}', null: false
+        t.jsonb :log_data, default: "{}", null: false
         t.timestamps
       end
 
@@ -212,6 +215,7 @@ module LogidzeBench
   end
 
   module_function
+
   def populate(n = 1_000)
     n.times do
       params = fake_params
@@ -221,6 +225,7 @@ module LogidzeBench
   end
 
   module_function
+
   def cleanup
     LogidzeUser.delete_all
     User.delete_all
@@ -228,8 +233,9 @@ module LogidzeBench
   end
 
   module_function
+
   def generate_versions(num = 1)
-    num.times do 
+    num.times do
       User.find_each do |u|
         u.update!(fake_params(sample: true))
       end
@@ -245,6 +251,7 @@ module LogidzeBench
   end
 
   module_function
+
   def fake_params(sample: false)
     params = {
       email: Faker::Internet.email,
@@ -254,14 +261,14 @@ module LogidzeBench
       bio: Faker::Lorem.paragraph
     }
 
-    return params.slice(%i(email position name age bio).sample) if sample
+    return params.slice(%i[email position name age bio].sample) if sample
     params
   end
 end
 
 module ARandom
   def random(num = 1)
-    rel = order('random()')
+    rel = order("random()")
     num == 1 ? rel.first : rel.limit(num)
   end
 end
@@ -271,11 +278,11 @@ class User < ActiveRecord::Base
   has_paper_trail
 
   def self.diff_from(ts)
-    includes(:versions).map { |u| { 'id' => u.id, 'changes' => u.diff_from(ts) } }
+    includes(:versions).map { |u| {"id" => u.id, "changes" => u.diff_from(ts)} }
   end
 
   def self.diff_from_joined(ts)
-    eager_load(:versions).map { |u| { 'id' => u.id, 'changes' => u.diff_from(ts) } }
+    eager_load(:versions).map { |u| {"id" => u.id, "changes" => u.diff_from(ts)} }
   end
 
   def diff_from(ts)
@@ -290,11 +297,11 @@ class User < ActiveRecord::Base
   private
 
   def merge_changeset(acc, data)
-    data.each do |k,v|
+    data.each do |k, v|
       unless acc.key?(k)
-        acc[k] = { 'old' => v[0] }
+        acc[k] = {"old" => v[0]}
       end
-      acc[k]['new'] = v[1]
+      acc[k]["new"] = v[1]
     end
   end
 end
@@ -305,4 +312,4 @@ class LogidzeUser < ActiveRecord::Base
 end
 
 # Run migration only if neccessary
-LogidzeBench.setup_db if ENV['FORCE'].present? || !ActiveRecord::Base.connection.tables.include?('logidze_users')
+LogidzeBench.setup_db if ENV["FORCE"].present? || !ActiveRecord::Base.connection.tables.include?("logidze_users")

data/bench/performance/update_bench.rb

@@ -1,5 +1,7 @@
-require 'benchmark/ips'
-require './setup'
+# frozen_string_literal: true
+
+require "benchmark/ips"
+require "./setup"
 
 params = {
   age: Faker::Number.number(2),
@@ -18,19 +20,19 @@ LogidzeBench.cleanup
 LogidzeBench.populate
 
 Benchmark.ips do |x|
-  x.report('PT UPDATE #1') do
+  x.report("PT UPDATE #1") do
     User.random.update!(params)
   end
 
-  x.report('Logidze UPDATE #1') do
+  x.report("Logidze UPDATE #1") do
     LogidzeUser.random.update!(params)
   end
 
-  x.report('PT UPDATE #2') do
+  x.report("PT UPDATE #2") do
     User.random.update!(params2)
   end
 
-  x.report('Logidze UPDATE #2') do
+  x.report("Logidze UPDATE #2") do
     LogidzeUser.random.update!(params2)
   end
 end

data/bin/setup

@@ -5,5 +5,5 @@ set -e
 gem install bundler --conservative
 bundle check || bundle install
 
-bundle exec rake dummy:db:create
-bundle exec rake dummy:db:test:prepare
+RAILS_ENV=test bundle exec rake dummy:db:create
+RAILS_ENV=test bundle exec rake dummy:db:migrate

data/gemfiles/rails42.gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
 gem 'rails', '~> 4.2'
+gem 'pg', '~> 0.18'
 
 gemspec path: '..'

data/gemfiles/rails6.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'rails', '6.0.0.rc1'
+gem 'rspec-rails', '>= 3.5'
+
+gemspec path: '..'

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "rails/generators"
 require "rails/generators/active_record"
 
@@ -7,7 +8,7 @@ module Logidze
     class InstallGenerator < ::Rails::Generators::Base # :nodoc:
       include Rails::Generators::Migration
 
-      source_root File.expand_path('templates', __dir__)
+      source_root File.expand_path("templates", __dir__)
 
       class_option :update, type: :boolean, optional: true,
                             desc: "Define whether this is an update migration"
@@ -25,7 +26,7 @@ module Logidze
       no_tasks do
         def migration_name
           if update?
-            "logidze_update_#{Logidze::VERSION.delete('.')}"
+            "logidze_update_#{Logidze::VERSION.delete(".")}"
           else
             "logidze_install"
           end

data/lib/generators/logidze/model/model_generator.rb

@@ -1,12 +1,12 @@
-# rubocop:disable Metrics/BlockLength
 # frozen_string_literal: true
+
 require "rails/generators"
 require "rails/generators/active_record/migration/migration_generator"
 
 module Logidze
   module Generators
     class ModelGenerator < ::ActiveRecord::Generators::Base # :nodoc:
-      source_root File.expand_path('templates', __dir__)
+      source_root File.expand_path("templates", __dir__)
 
       class_option :limit, type: :numeric, optional: true, desc: "Specify history size limit"
 
@@ -77,17 +77,17 @@ module Logidze
 
         def columns_blacklist
           array = if !options[:whitelist]
-                    options[:blacklist]
-                  else
-                    class_name.constantize.column_names - options[:whitelist]
-                  end
+            options[:blacklist]
+          else
+            class_name.constantize.column_names - options[:whitelist]
+          end
 
           format_pgsql_array(array)
         end
 
         def timestamp_column
-          value = options[:timestamp_column] || 'updated_at'
-          return if %w(nil null false).include?(value)
+          value = options[:timestamp_column] || "updated_at"
+          return if %w[nil null false].include?(value)
 
           escape_pgsql_string(value)
         end
@@ -101,13 +101,13 @@ module Logidze
         end
 
         def logidze_snapshot_parameters
-          format_pgsql_args('to_jsonb(t)', timestamp_column, columns_blacklist)
+          format_pgsql_args("to_jsonb(t)", timestamp_column, columns_blacklist)
         end
 
         def format_pgsql_array(ruby_array)
           return if ruby_array.blank?
 
-          "'{" + ruby_array.join(', ') + "}'"
+          "'{" + ruby_array.join(", ") + "}'"
         end
 
         def escape_pgsql_string(string)
@@ -124,10 +124,10 @@ module Logidze
         def format_pgsql_args(*values)
           args = []
           values.reverse_each do |value|
-            formatted_value = value.presence || (args.any? && 'null')
+            formatted_value = value.presence || (args.any? && "null")
             args << formatted_value if formatted_value
           end
-          args.compact.reverse.join(', ')
+          args.compact.reverse.join(", ")
         end
       end