logidze 0.11.0 → 1.2.0

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,29 +0,0 @@
-<!--
-  First of all, thanks for contributing!
-
-  If it's a typo fix or minor documentation update feel free to skip the rest of this template!
--->
-
-<!--
-  If it's a bug fix, then link it to the issue, for example:
-
-  Fixes #xxx
--->
-
-
-<!--
-  Otherwise, describe the changes: 
-
-### What is the purpose of this pull request?
-
-### What changes did you make? (overview)
-
-### Is there anything you'd like reviewers to focus on?
-
-### Checklist
-
-- [ ] I've added tests for this change
-- [ ] I've added a Changelog entry
-- [ ] I've updated a documentation (Readme)
-
--->

data/.gitignore

@@ -1,40 +0,0 @@
-# Numerous always-ignore extensions
-*.diff
-*.err
-*.orig
-*.log
-*.rej
-*.swo
-*.swp
-*.vi
-*~
-*.sass-cache
-*.iml
-.idea/
-
-# Sublime
-*.sublime-project
-*.sublime-workspace
-
-# OS or Editor folders
-.DS_Store
-.cache
-.project
-.settings
-.tmproj
-Thumbs.db
-
-.bundle/
-log/*.log
-*.gz
-pkg/
-spec/dummy/db/*.sqlite3
-spec/dummy/db/*.sqlite3-journal
-spec/dummy/tmp/
-
-Gemfile.lock
-Gemfile.local
-.rspec
-*.gem
-tmp/
-coverage/

data/.rubocop.yml

@@ -1,55 +0,0 @@
-require:
-  - standard/cop/semantic_blocks
-  - rubocop-md
-
-inherit_gem:
-  standard: config/base.yml
-
-AllCops:
-  Exclude:
-    - 'bin/*'
-    - 'tmp/**/*'
-    - 'docs/**/*'
-    - 'Gemfile'
-    - 'vendor/**/*'
-    - 'gemfiles/**/*'
-  DisplayCopNames: true
-  TargetRubyVersion: 2.4
-
-Standard/SemanticBlocks:
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  Enabled: true
-
-Style/TrailingCommaInArrayLiteral:
-  EnforcedStyleForMultiline: no_comma
-
-Style/TrailingCommaInHashLiteral:
-  EnforcedStyleForMultiline: no_comma
-
-Layout/AlignParameters:
-  EnforcedStyle: with_first_parameter
-
-Lint/Void:
-  Exclude:
-    - '**/*.md'
-
-# See https://github.com/rubocop-hq/rubocop/issues/4222
-Lint/AmbiguousBlockAssociation:
-  Exclude:
-    - 'spec/**/*'
-    - '**/*.md'
-
-Lint/DuplicateMethods:
-  Exclude:
-    - '**/*.md'
-
-Naming/FileName:
-  Exclude:
-    - 'lib/test-prof.rb'
-    - '**/*.md'
-
-Layout/InitialIndentation:
-  Exclude:
-    - 'CHANGELOG.md'

data/.travis.yml

@@ -1,42 +0,0 @@
-language: ruby
-cache: bundler
-
-dist: trusty
-sudo: false
-
-notifications:
-  email: false
-
-addons:
-  postgresql: "9.6"
-
-env:
-  global:
-    - LOGIDZE_DB_USER=postgres
-    - LOGIDZE_DB_NAME=logidze
-
-before_script:
-  - gem update --system
-  - bundle exec rake dummy:db:create
-  - psql -U postgres -d logidze -c 'CREATE EXTENSION IF NOT EXISTS hstore;'
-  - RAILS_ENV=test bundle exec rake dummy:db:create dummy:db:migrate
-
-matrix:
-  include:
-    - rvm: ruby-head
-      gemfile: gemfiles/railsmaster.gemfile
-    - rvm: 2.6.2
-      gemfile: gemfiles/rails6.gemfile
-    - rvm: 2.6.2
-      gemfile: gemfiles/rails5.gemfile
-    - rvm: 2.5.1
-      gemfile: gemfiles/rails52.gemfile
-    - rvm: 2.4.1
-      gemfile: gemfiles/rails5.gemfile
-    - rvm: 2.4.1
-      gemfile: gemfiles/rails42.gemfile
-  allow_failures:
-    - rvm: ruby-head
-      gemfile: gemfiles/railsmaster.gemfile
-    - rvm: 2.5.0
-      gemfile: gemfiles/railsmaster.gemfile

data/Gemfile

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in logidze.gemspec
-gemspec
-
-gem "pry-byebug", platform: :mri
-
-local_gemfile = "#{File.dirname(__FILE__)}/Gemfile.local"
-
-if File.exist?(local_gemfile)
-  eval(File.read(local_gemfile)) # rubocop:disable Lint/Eval
-else
-  gem 'activerecord', '~> 5.1.1'
-end

data/Rakefile

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require "rspec/core/rake_task"
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-RSpec::Core::RakeTask.new(:spec)
-
-namespace :dummy do
-  require_relative "spec/dummy/config/application"
-  Dummy::Application.load_tasks
-end
-
-task(:spec).clear
-desc "Run specs other than spec/acceptance"
-RSpec::Core::RakeTask.new("spec") do |task|
-  task.exclude_pattern = "spec/acceptance/**/*_spec.rb"
-  task.verbose = false
-end
-
-desc "Run acceptance specs in spec/acceptance"
-RSpec::Core::RakeTask.new("spec:acceptance") do |task|
-  task.pattern = "spec/acceptance/**/*_spec.rb"
-  task.verbose = false
-end
-
-desc "Run the specs and acceptance tests"
-task default: %w[rubocop spec spec:acceptance]

data/bench/performance/README.md

@@ -1,109 +0,0 @@
-# Performance benchmarks: PaperTail vs. Logidze
-
-We want to compare Logidze with the most popular versioning library for Rails – PaperTrail.
-
-
-## Insert ([source](insert_bench.rb))
-
-```
-PaperTrail INSERT    213.148  (± 8.9%) i/s -      1.060k in   5.018504s
-   Logidze INSERT    613.387  (±16.3%) i/s -      2.970k in   5.036127s
-```
-
-
-## Update ([source](update_bench.rb))
-
-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
-```
-
-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
-```
-
-## Getting diff ([source](diff_bench.rb))
-
-PaperTrail doesn't have built-in method to calculate diff between not adjacent versions.
-We add `diff_from(ts)` and `diff_from_joined(ts)` (which uses SQL JOIN) methods to calculate diff from specified version using changesets.
-
-When each record has 10 versions:
-
-```
-       PT DIFF     20.874  (± 4.8%) i/s -    106.000  in   5.091402s
-PT (join) DIFF     20.619  (± 4.8%) i/s -    104.000  in   5.070160s
-  Logidze DIFF    109.482  (±24.7%) i/s -    500.000  in   5.103534s
-```
-
-When each record has 100 versions:
-
-```
-       PT DIFF      2.998  (± 0.0%) i/s -     15.000  in   5.019494s
-PT (join) DIFF      3.193  (± 0.0%) i/s -     16.000  in   5.030155s
-  Logidze DIFF     19.627  (±25.5%) i/s -     88.000  in   5.035555s
-```
-
-And, finally, when each record has 1000 versions:
-
-```
-       PT DIFF      0.270  (± 0.0%) i/s -     17.000  in  63.038374s
-PT (join) DIFF      0.235  (± 0.0%) i/s -     14.000  in  60.350886s
-  Logidze DIFF      2.022  (± 0.0%) i/s -    120.000  in  60.142965s
-```
-
-## Select memory usage ([source](memory_profile.rb))
-
-Logidze loads more data (because it stores log in-place). But how much more?
-We consider two cases for PaperTrail: when we want to calculate diff (and thus loading versions) and when we don't need any history related data.
-
-When each record has 10 versions:
-
-```
-PT records
-Total Allocated:                 27.8 KB
-Total Retained:                  16.59 KB
-Retained memory (per record):    2.14 KB
-
-PT with versions
-Total Allocated:                 228.01 KB
-Total Retained:                  170.78 KB
-Retained memory (per record):    143.13 KB
-
-Logidze records
-Total Allocated:                 46.45 KB
-Total Retained:                  34.73 KB
-Retained memory (per record):    4.11 KB
-```
-
-When each record has 100 versions:
-
-```
-PT with versions
-Total Allocated:                 1.92 MB
-Total Retained:                  1.56 MB
-Retained memory (per record):    1.53 MB
-
-Logidze records
-Total Allocated:                 162.48 KB
-Total Retained:                  150.76 KB
-Retained memory (per record):    15.4 KB
-```
-
-When each record has 1000 versions:
-
-```
-PT with versions
-Total Allocated:                 18.23 MB
-Total Retained:                  14.86 MB
-Retained memory (per record):    14.83 MB
-
-Logidze records
-Total Allocated:                 1.32 MB
-Total Retained:                  1.31 MB
-Retained memory (per record):    131.59 KB
-```

data/bench/performance/diff_bench.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require "benchmark/ips"
-require "./setup"
-
-# How many records do you want?
-N = (ENV["N"] || "100").to_i
-
-# How many version each record has?
-V = (ENV["V"] || "10").to_i
-
-# Benchmark run time
-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)
-
-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)
-  end
-
-  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)
-  end
-end

data/bench/performance/insert_bench.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require "benchmark/ips"
-require "./setup"
-
-params = {
-  email: Faker::Internet.email,
-  position: Faker::Number.number(3),
-  name: Faker::Name.name,
-  age: Faker::Number.number(2),
-  bio: Faker::Lorem.paragraph
-}
-
-Benchmark.ips do |x|
-  x.report("PaperTrail INSERT") do
-    User.create!(params)
-  end
-
-  x.report("Logidze INSERT") do
-    LogidzeUser.create!(params)
-  end
-end

data/bench/performance/memory_profile.rb

@@ -1,56 +0,0 @@
-# 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
-
-# How many version each record has?
-V = (ENV["V"] || "10").to_i
-
-LogidzeBench.cleanup
-LogidzeBench.populate(N)
-LogidzeBench.generate_versions(V)
-
-module MemoryReport
-  KILO_BYTE = 1024
-  MEGA_BYTE = 1024 * 1024
-
-  module_function
-
-  def call(msg, relation)
-    buffer = nil
-    delta = N / 10
-    r0 = MemoryProfiler.report do
-      buffer = relation.random(N - delta).to_a
-    end
-
-    buffer = nil
-    r1 = MemoryProfiler.report do
-      buffer = relation.to_a
-    end
-
-    $stdout.puts msg
-    $stdout.puts "Total Allocated:\t\t\t\t#{to_human_size(r1.total_allocated_memsize)}"
-    $stdout.puts "Total Retained:\t\t\t\t\t#{to_human_size(r1.total_retained_memsize)}"
-    $stdout.puts "Retained_memsize memory (per record):\t\t#{to_human_size((r1.total_retained_memsize - r0.total_retained_memsize) / delta)}"
-  end
-
-  module_function
-
-  def to_human_size(size)
-    if size > MEGA_BYTE
-      "#{(size.to_f / MEGA_BYTE).round(2)} MB"
-    elsif size > KILO_BYTE
-      "#{(size.to_f / KILO_BYTE).round(2)} KB"
-    else
-      "#{size} B"
-    end
-  end
-end
-
-MemoryReport.call("PT records", User.all)
-MemoryReport.call("PT with versions", User.joins(:versions).all)
-MemoryReport.call("Logidze records", LogidzeUser.all)