logidze 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 437f0707fbb215fbfb5655156b0f2f8450f2aa20
-  data.tar.gz: 533a010cbc9d240c5c70d565621ace20d571579a
+  metadata.gz: fcb9249498ac35c0236653c1209d6395679c4d41
+  data.tar.gz: efd95cb463680a5e000f5e2b96dae8d7d1bc7c0a
 SHA512:
-  metadata.gz: 419c21e03ba9196ff236bb7d8ea1bc897eaa1e7b8573bff1e1196008113641975341712e2f55d0ea8abb887820c18e0f32b654ee673ea379ef263cdae63ce875
-  data.tar.gz: 8a885b62f97e4492001ef11a1961556faa0810d976f95fdb44dcb3071a5506622edc798f87aa6dd8fb27e40b46d605dd6adced7aa16e19278d2feb40f20beeb8
+  metadata.gz: 9e51780490e139a4a475367527480edd0e3530f7c6bda2ef92d0da2591ac8a4e6f8177d2131b7b4f9563e2db3d4ceb6878e1b3574a6ce14206f7b1e9105ba641
+  data.tar.gz: 9922f8494d288bb0fd520abaae87872c3f1f8ceeaa0613689eee7637d8d9c423549a4aa545b09d9ef743213ca3503a2303bdce2ad4f1cb733bef817a19bddb2e

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.2.2
+- Add `--backfill` option to model migration
+- Handle legacy data (that doesn't have log data)
+
 # 0.2.1
 - Support both Rails 4 and 5
 

data/README.md

@@ -46,13 +46,19 @@ rails generate logidze:model Post
 rake db:migrate
 ```
 
+This also adds `has_logidze` line to your model, which adds methods for working with logs.
+
 You can provide `limit` option to `generate` to limit the size of the log (by default it's unlimited):
 
 ```ruby
 rails generate logidze:model Post --limit=10
 ```
 
-This also adds `has_logidze` line to your model, which adds methods for working with logs.
+To backfill table data (i.e. create initial snapshots) add `backfill` option:
+
+```ruby
+rails generate logidze:model Post --backfill
+```
 
 ## Usage
 

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

@@ -10,6 +10,51 @@ class <%= @migration_class_name %> < ActiveRecord::Migration
     SQL
 
     execute <<~SQL
+      CREATE OR REPLACE FUNCTION logidze_snapshot(item jsonb) RETURNS jsonb AS $body$
+        BEGIN
+          return json_build_object(
+            'v', 1,
+            'h', jsonb_build_array(
+                   jsonb_build_object(
+                     'ts',
+                     (extract(epoch from now()) * 1000)::bigint,
+                     'v',
+                     1,
+                     'c',
+                     item - 'log_data'
+                   )
+                 )
+            );
+        END;
+      $body$
+      LANGUAGE plpgsql;
+
+      CREATE OR REPLACE FUNCTION logidze_compact_history(log_data jsonb) RETURNS jsonb AS $body$
+        DECLARE
+          merged jsonb;
+        BEGIN
+          merged := jsonb_build_object(
+            'ts',
+            log_data#>'{h,1,ts}',
+            'v',
+            log_data#>'{h,1,v}',
+            'c',
+            (log_data#>'{h,0,c}') || (log_data#>'{h,1,c}')
+          );
+
+          return jsonb_set(
+            log_data,
+            '{h}',
+            jsonb_set(
+              log_data->'h',
+              '{1}',
+              merged 
+            ) - 0
+          );
+        END;
+      $body$
+      LANGUAGE plpgsql;
+
       CREATE OR REPLACE FUNCTION logidze_logger() RETURNS TRIGGER AS $body$
         DECLARE
           changes jsonb;
@@ -22,28 +67,18 @@ class <%= @migration_class_name %> < ActiveRecord::Migration
           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
-                )
-              )
-            );
+
+            NEW.log_data := logidze_snapshot(to_jsonb(NEW.*));
+          
           ELSIF TG_OP = 'UPDATE' THEN
+          
+            IF OLD.log_data is NULL OR OLD.log_data = '{}'::jsonb THEN
+              NEW.log_data := logidze_snapshot(to_jsonb(NEW.*));
+              RETURN NEW;
+            END IF;
+
             history_limit := TG_ARGV[0];
             current_version := (NEW.log_data->>'v')::int;
 
@@ -51,6 +86,8 @@ class <%= @migration_class_name %> < ActiveRecord::Migration
               RETURN NEW;
             END IF;
 
+            ts := (extract(epoch from now()) * 1000)::bigint;
+
             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')
@@ -95,24 +132,7 @@ class <%= @migration_class_name %> < ActiveRecord::Migration
             );
 
             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
-              );
+              NEW.log_data := logidze_compact_history(NEW.log_data);
             END IF;
           END IF;
 
@@ -125,6 +145,8 @@ class <%= @migration_class_name %> < ActiveRecord::Migration
 
   def down
     execute <<~SQL
+      DROP FUNCTION logidze_compact_history(jsonb) CASCADE;
+      DROP FUNCTION logidze_snapshot(jsonb) CASCADE;
       DROP FUNCTION logidze_logger() CASCADE;
     SQL
   end

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

@@ -9,6 +9,9 @@ module Logidze
 
       class_option :limit, type: :numeric, optional: true, desc: "Specify history size limit"
 
+      class_option :backfill, type: :boolean, optional: true,
+                              desc: "Add query to backfill existing records history"
+
       def generate_migration
         migration_template "migration.rb.erb", "db/migrate/#{migration_file_name}"
       end
@@ -31,6 +34,10 @@ module Logidze
         def limit
           options[:limit]
         end
+
+        def backfill
+          options[:backfill]
+        end
       end
 
       private

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

@@ -1,6 +1,6 @@
 class <%= @migration_class_name %> < ActiveRecord::Migration
   def up
-    add_column :<%= table_name %>, :log_data, :jsonb, default: '{}', null: false
+    add_column :<%= table_name %>, :log_data, :jsonb, default: {}, null: false
 
     execute <<-SQL
       CREATE TRIGGER logidze_on_<%= table_name %>
@@ -8,6 +8,13 @@ class <%= @migration_class_name %> < ActiveRecord::Migration
       WHEN (current_setting('logidze.disabled') <> 'on')
       EXECUTE PROCEDURE logidze_logger(<%= limit || '' %>);
     SQL
+
+    <% if backfill %>
+    execute <<-SQL
+      UPDATE <%= table_name %> as t
+      SET log_data = logidze_snapshot(to_jsonb(t));
+    SQL
+    <% end %>
   end
 
   def down

data/lib/logidze/history.rb

@@ -19,11 +19,9 @@ module Logidze
     end
 
     def self.load(json)
-      new(json) unless json.nil?
+      new(json) if json.present?
     end
 
-    ### Rails 4 ###
-
     def initialize(data)
       @data = data
     end

data/lib/logidze/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Logidze
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logidze
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-02 00:00:00.000000000 Z
+date: 2016-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails