logidze 0.0.1 → 0.1.0

data/bench/jsonb_minus_2_setup.sql

@@ -0,0 +1,47 @@
+CREATE OR REPLACE FUNCTION jsonb_minus(arg1 jsonb, arg2 jsonb) RETURNS jsonb
+AS $$
+
+SELECT 
+  COALESCE(json_object_agg(key, value), '{}')::jsonb
+FROM 
+  jsonb_each(arg1)
+WHERE NOT jsonb_build_object(key, value) <@ arg2;
+
+$$ LANGUAGE SQL;
+
+CREATE OR REPLACE FUNCTION jsonb_minus_2_logger() RETURNS TRIGGER AS $body$
+  DECLARE
+    changes_h jsonb;
+    size integer;
+    buffer jsonb;
+  BEGIN
+    size := jsonb_array_length(NEW.log);
+    
+    changes_h := jsonb_minus(row_to_json(OLD)::jsonb, row_to_json(NEW)::jsonb);
+
+    NEW.log := jsonb_set(
+      NEW.log,
+      ARRAY[size::text],
+      jsonb_build_object(
+        'ts',
+        extract(epoch from now())::int,
+        'i',
+        (NEW.log#>>ARRAY[(size - 1)::text, 'i'])::int + 1,
+        'd',
+        changes_h
+      ),
+      true
+    );
+    return NEW;
+  END;
+  $body$
+  LANGUAGE plpgsql;
+
+
+ALTER TABLE pgbench_accounts ADD COLUMN log jsonb DEFAULT '[]' NOT NULL;
+
+UPDATE pgbench_accounts SET log = to_jsonb(ARRAY[json_build_object('i', 0)])::jsonb;
+
+CREATE TRIGGER hstore_log_accounts
+BEFORE UPDATE ON pgbench_accounts FOR EACH ROW
+EXECUTE PROCEDURE jsonb_minus_2_logger();

data/bench/jsonb_minus_setup.sql

@@ -0,0 +1,49 @@
+CREATE OR REPLACE FUNCTION jsonb_minus(arg1 jsonb, arg2 jsonb) RETURNS jsonb
+AS $$
+
+SELECT 
+  COALESCE(json_object_agg(key, value), '{}')::jsonb
+FROM 
+  jsonb_each(arg1)
+WHERE 
+  arg1 -> key <> arg2 -> key 
+  OR arg2 -> key IS NULL;
+
+$$ LANGUAGE SQL;
+
+CREATE OR REPLACE FUNCTION jsonb_minus_logger() RETURNS TRIGGER AS $body$
+  DECLARE
+    changes_h jsonb;
+    size integer;
+    buffer jsonb;
+  BEGIN
+    size := jsonb_array_length(NEW.log);
+    
+    changes_h := jsonb_minus(row_to_json(OLD)::jsonb, row_to_json(NEW)::jsonb);
+
+    NEW.log := jsonb_set(
+      NEW.log,
+      ARRAY[size::text],
+      jsonb_build_object(
+        'ts',
+        extract(epoch from now())::int,
+        'i',
+        (NEW.log#>>ARRAY[(size - 1)::text, 'i'])::int + 1,
+        'd',
+        changes_h
+      ),
+      true
+    );
+    return NEW;
+  END;
+  $body$
+  LANGUAGE plpgsql;
+
+
+ALTER TABLE pgbench_accounts ADD COLUMN log jsonb DEFAULT '[]' NOT NULL;
+
+UPDATE pgbench_accounts SET log = to_jsonb(ARRAY[json_build_object('i', 0)])::jsonb;
+
+CREATE TRIGGER hstore_log_accounts
+BEFORE UPDATE ON pgbench_accounts FOR EACH ROW
+EXECUTE PROCEDURE jsonb_minus_logger();

data/bench/keys2_trigger_setup.sql

@@ -0,0 +1,44 @@
+CREATE OR REPLACE FUNCTION keys_2_logger() RETURNS TRIGGER AS $body$
+  DECLARE
+    size integer;
+    old_j jsonb;
+    changes_j jsonb;
+    item record;
+  BEGIN
+    size := jsonb_array_length(NEW.log);
+    old_j := to_jsonb(OLD);
+    changes_j := to_jsonb(NEW);
+
+    FOR item in SELECT key as k, value as v FROM jsonb_each(old_j)
+    LOOP
+      IF changes_j->item.k = item.v THEN
+        changes_j := changes_j - item.k;
+      END IF;
+    END LOOP;
+
+    NEW.log := jsonb_set(
+      NEW.log,
+      ARRAY[size::text],
+      jsonb_build_object(
+        'ts',
+        extract(epoch from now())::int,
+        'i',
+        (NEW.log#>>ARRAY[(size - 1)::text, 'i'])::int + 1,
+        'd',
+        changes_j
+      ),
+      true
+    );
+    return NEW;
+  END;
+  $body$
+  LANGUAGE plpgsql;
+
+
+ALTER TABLE pgbench_accounts ADD COLUMN log jsonb DEFAULT '[]' NOT NULL;
+
+UPDATE pgbench_accounts SET log = to_jsonb(ARRAY[json_build_object('i', 0)])::jsonb;
+
+CREATE TRIGGER keys_log_accounts
+BEFORE UPDATE ON pgbench_accounts FOR EACH ROW
+EXECUTE PROCEDURE keys_2_logger();

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "logidze"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+set -e
+
+gem install bundler --conservative
+bundle check || bundle install
+
+bundle exec rake dummy:db:create
+bundle exec rake dummy:db:test:prepare

data/circle.yml

@@ -0,0 +1,17 @@
+machine:
+  ruby:
+    version: 2.3.0
+
+  environment:
+    DATABASE_URL: postgres://postgres@127.0.0.1:5433/test_database
+
+dependencies:
+  pre:
+    - gem install bundler -v 1.11.2
+    - sudo service postgresql stop 9.4
+    - sudo cp -v /etc/postgresql/9.{4,5}/main/pg_hba.conf && sudo service postgresql restart 9.5
+
+database:
+  override:
+    - bundle exec rake dummy:db:test:prepare
+  

data/gemfiles/rails42.gemfile

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

data/gemfiles/rails5.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'rails', '5.0.0.rc1'
+
+gemspec path: '..'

data/lib/generators/logidze/install/USAGE

@@ -0,0 +1,7 @@
+Description:
+  Generates the necessary files to get you up and running with Logidze gem
+  
+Examples:
+  rails generate logidze:install
+
+    This will generate the core migration file with trigger function defined.

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+require "rails/generators"
+require "rails/generators/active_record"
+
+module Logidze
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base # :nodoc:
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def generate_migration
+        migration_template "migration.rb.erb", "db/migrate/logidze_install.rb"
+      end
+
+      def generate_hstore_migration
+        migration_template "hstore.rb.erb", "db/migrate/enable_hstore.rb"
+      end
+
+      def self.next_migration_number(dir)
+        ::ActiveRecord::Generators::Base.next_migration_number(dir)
+      end
+    end
+  end
+end

data/lib/generators/logidze/install/templates/hstore.rb.erb

@@ -0,0 +1,5 @@
+class <%= @migration_class_name %> < ActiveRecord::Migration
+	def change
+		enable_extension :hstore
+	end
+end

data/lib/generators/logidze/install/templates/migration.rb.erb

@@ -0,0 +1,131 @@
+class <%= @migration_class_name %> < ActiveRecord::Migration
+  def up
+    execute <<~SQL
+      DO $$
+        BEGIN
+        EXECUTE 'ALTER DATABASE ' || current_database() || ' SET logidze.disabled TO off';
+        END;
+      $$
+      LANGUAGE plpgsql;
+    SQL
+
+    execute <<~SQL
+      CREATE OR REPLACE FUNCTION logidze_logger() RETURNS TRIGGER AS $body$
+        DECLARE
+          changes jsonb;
+          new_v integer;
+          ts bigint;
+          size integer;
+          history_limit integer;
+          current_version integer;
+          merged jsonb;
+          iterator integer;
+          item record;
+        BEGIN
+          ts := (extract(epoch from now()) * 1000)::bigint;
+
+          IF TG_OP = 'INSERT' THEN
+            changes := to_jsonb(NEW.*) - 'log_data';
+            new_v := 1;
+
+            NEW.log_data := json_build_object(
+              'v',
+              1,
+              'h',
+              jsonb_build_array(
+                jsonb_build_object(
+                  'ts',
+                  ts,
+                  'v',
+                  new_v,
+                  'c',
+                  changes
+                )
+              )
+            );
+          ELSIF TG_OP = 'UPDATE' THEN
+            history_limit := TG_ARGV[0];
+            current_version := (NEW.log_data->>'v')::int;
+
+            IF NEW = OLD THEN
+              RETURN NEW;
+            END IF;
+
+            IF current_version < (NEW.log_data#>>'{h,-1,v}')::int THEN
+              iterator := 0;
+              FOR item in SELECT * FROM jsonb_array_elements(NEW.log_data->'h')
+              LOOP
+                IF (item.value->>'v')::int > current_version THEN
+                  NEW.log_data := jsonb_set(
+                    NEW.log_data,
+                    '{h}',
+                    (NEW.log_data->'h') - iterator
+                  );
+                END IF;
+                iterator := iterator + 1;
+              END LOOP;
+            END IF;
+
+            changes := hstore_to_jsonb_loose(
+              hstore(NEW.*) - hstore(OLD.*)
+            ) - 'log_data';
+
+            new_v := (NEW.log_data#>>'{h,-1,v}')::int + 1;
+
+            size := jsonb_array_length(NEW.log_data->'h');
+
+            NEW.log_data := jsonb_set(
+              NEW.log_data,
+              ARRAY['h', size::text],
+              jsonb_build_object(
+                'ts',
+                ts,
+                'v',
+                new_v,
+                'c',
+                changes
+              ),
+              true
+            );
+
+            NEW.log_data := jsonb_set(
+              NEW.log_data,
+              '{v}',
+              to_jsonb(new_v)
+            );
+
+            IF history_limit IS NOT NULL AND history_limit = size THEN
+              merged := jsonb_build_object(
+                'ts',
+                NEW.log_data#>'{h,1,ts}',
+                'v',
+                NEW.log_data#>'{h,1,v}',
+                'c',
+                (NEW.log_data#>'{h,0,c}') || (NEW.log_data#>'{h,1,c}')
+              );
+
+              NEW.log_data := jsonb_set(
+                NEW.log_data,
+                '{h}',
+                jsonb_set(
+                  NEW.log_data->'h',
+                  '{1}',
+                  merged 
+                ) - 0
+              );
+            END IF;
+          END IF;
+
+          return NEW;
+        END;
+        $body$
+        LANGUAGE plpgsql;
+    SQL
+  end
+
+  def down
+    execute <<~SQL
+      DROP FUNCTION logidze_logger() CASCADE;
+    SQL
+  end
+end

data/lib/generators/logidze/model/USAGE

@@ -0,0 +1,8 @@
+Description:
+  Generates the necessary migration to enable logging for model
+  
+Examples:
+  rails generate logidze:model User
+
+    This will generate the migration to add log column and trigger.
+    This will also add `has_logidze` to model.

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

@@ -0,0 +1,43 @@
+# 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', __FILE__)
+
+      class_option :limit, type: :numeric, optional: true, desc: "Specify history size limit"
+
+      def generate_migration
+        migration_template "migration.rb.erb", "db/migrate/#{migration_file_name}"
+      end
+
+      def inject_logidze_to_model
+        indents = "  " * (class_name.scan("::").count + 1)
+
+        inject_into_class(model_file_path, class_name.demodulize, "#{indents}has_logidze\n")
+      end
+
+      no_tasks do
+        def migration_name
+          "add_logidze_to_#{plural_table_name}"
+        end
+
+        def migration_file_name
+          "#{migration_name}.rb"
+        end
+
+        def limit
+          options[:limit]
+        end
+      end
+
+      private
+
+      def model_file_path
+        File.join("app", "models", "#{file_path}.rb")
+      end
+    end
+  end
+end

data/lib/generators/logidze/model/templates/migration.rb.erb

@@ -0,0 +1,18 @@
+class <%= @migration_class_name %> < ActiveRecord::Migration
+  def up
+    add_column :<%= table_name %>, :log_data, :jsonb, default: '{}', null: false
+
+    execute <<-SQL
+      CREATE TRIGGER logidze_on_<%= table_name %>
+      BEFORE UPDATE OR INSERT ON <%= table_name %> FOR EACH ROW
+      WHEN (current_setting('logidze.disabled') <> 'on')
+      EXECUTE PROCEDURE logidze_logger(<%= limit || '' %>);
+    SQL
+  end
+
+  def down
+    execute "DROP TRIGGER IF EXISTS logidze_on_<%= table_name %> on <%= table_name %>;"
+
+    remove_column :<%= table_name %>, :log_data
+  end
+end