logidze 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfd80509e728582e7c8b3629a6704d7d2d7b8d4e835974df0bd10dac03333348
-  data.tar.gz: 5f3f386533f330d41d4acaeaf9e724df4a3d1ee3851cd99dbbff4ab5b6573546
+  metadata.gz: cd2ab4ea5c739000052b48f4288a45056741b99f2e698c7960e5a0eda32b29ea
+  data.tar.gz: 2ec438f29345455137bfedab7dcaf4e01b1d9d84d903b92ac4517753b10db5eb
 SHA512:
-  metadata.gz: a17ac5c2fb65280a3897c5f672d0d0ef719870cd8f019a0d525e314d0c60795e5fda4068ba3fb0b1003f2ec5a848b3a2150237d29256fa8828a8401e775afcb6
-  data.tar.gz: f9023b0b9731f9ddbb28fda06ae07995eb0e0a7cb33778238d582e82d8752632c7ca3fa84bfbe639ce2553fbe9c4b10dbaf0dc92d361f01deb08a2d97aebc447
+  metadata.gz: '0527218328332350cf799e746956b6b4ff7bb6503df1ae2d9fbf32feae01813eb81edbad7b90dc1dfd96c8fef34d079e646b66f1d0e0329ac12d99fdb6a79f4f'
+  data.tar.gz: 44b70aaaae2f7c9bf3f32a58c2891c4e0c5dda61387367b79406681580fc9667bf85ebb0255c6c74fe8827829230015a94a086555f6ffe223ace709c0a01a8c1

data/CHANGELOG.md

@@ -2,6 +2,92 @@
 
 ## master
 
+## 0.8.0 (2018-10-01)
+
+- [PR [#87](https://github.com/palkan/logidze/pull/87)] Adding debounce time to avoid spamming changelog creation ([@zocoi][])
+
+Usage:
+
+```shell
+# 5000ms
+rails generate logidze:model story --debounce_time=5000
+```
+
+You see the following in generated migration
+
+```sql
+CREATE TRIGGER logidze_on_stories
+      BEFORE UPDATE OR INSERT ON stories FOR EACH ROW
+      WHEN (coalesce(#{current_setting('logidze.disabled')}, '') <> 'on')
+      EXECUTE PROCEDURE logidze_logger(null, 'updated_at', null, 5000);
+```
+
+How to upgrade.
+
+Please run `rails generate logidze:install --update` to regenerate stored functions.
+
+This feature checks if several logs came in within a debounce time period then only keep the latest one
+by merging the latest in previous others.
+
+The concept is similar to https://underscorejs.org/#debounce
+
+without `debounce_time`
+
+```js
+{
+    "h": [
+        {
+            "c": {
+                "content": "Content 1"
+            },
+            "v": 1,
+            "ts": 0
+        },
+        {
+            "c": {
+                "content": "content 2",
+                "active": true
+            },
+            "v": 2,
+            "ts": 100
+        },
+        {
+            "c": {
+                "content": "content 3",
+            },
+            "v": 3,
+            "ts": 101
+        }
+    ],
+    "v": 3
+}
+```
+
+with `debounce_time` of `10ms`
+
+```js
+{
+    "h": [
+        {
+            "c": {
+                "content": "Content 1"
+            },
+            "v": 1,
+            "ts": 0
+        },
+        {
+            "c": {
+                "content": "content 3",
+                "active": true
+            },
+            "v": 2,
+            "ts": 101
+        }
+    ],
+    "v": 3
+}
+```
+
 ## 0.7.0 (2018-08-29)
 
 - [Fixes [#75](https://github.com/palkan/logidze/issues/70)] Fix association versioning with an optional belongs to ([@ankursethi-uscis][])
@@ -72,7 +158,7 @@ This is a quick fix for a more general problem (see [#59](https://github.com/pal
 
 ## 0.5.1 (2017-06-15)
 
-- _(Fix)_ Drop *all* created functions upon rolling back (https://github.com/palkan/logidze/commit/b8e150cc18b3316a8cf0c78f7117339481fb49c6). ([@vassilevsky][])
+- _(Fix)_ Drop _all_ created functions upon rolling back (https://github.com/palkan/logidze/commit/b8e150cc18b3316a8cf0c78f7117339481fb49c6). ([@vassilevsky][])
 
 ## 0.5.0 (2017-03-28)
 
@@ -123,4 +209,5 @@ This is a quick fix for a more general problem (see [#59](https://github.com/pal
 [@akxcv]: https://github.com/akxcv
 [@vassilevsky]: https://github.com/vassilevsky
 [@ankursethi-uscis]: https://github.com/ankursethi-uscis
-[@DmitryTsepelev]: https://github.com/DmitryTsepelev
+[@dmitrytsepelev]: https://github.com/DmitryTsepelev
+[@zocoi]: https://github.com/zocoi

data/README.md

@@ -1,6 +1,4 @@
-[![Cult Of Martians](http://cultofmartians.com/assets/badges/badge.svg)](http://cultofmartians.com)
-[![Gem Version](https://badge.fury.io/rb/logidze.svg)](https://rubygems.org/gems/logidze) [![Build Status](https://travis-ci.org/palkan/logidze.svg?branch=master)](https://travis-ci.org/palkan/logidze) 
-[![Open Source Helpers](https://www.codetriage.com/palkan/logidze/badges/users.svg)](https://www.codetriage.com/palkan/logidze)
+[![Cult Of Martians](http://cultofmartians.com/assets/badges/badge.svg)](http://cultofmartians.com) [![Gem Version](https://badge.fury.io/rb/logidze.svg)](https://rubygems.org/gems/logidze) [![Build Status](https://travis-ci.org/palkan/logidze.svg?branch=master)](https://travis-ci.org/palkan/logidze) [![Open Source Helpers](https://www.codetriage.com/palkan/logidze/badges/users.svg)](https://www.codetriage.com/palkan/logidze)
 
 # Logidze
 
@@ -290,7 +288,11 @@ The `log_data` column has the following format:
             "attr": "new value",  // updated fields with new values
             "attr2": "new value"
             },
-        "r": 42 // Resposibility ID (if provided)
+        "r": 42, // Resposibility ID (if provided), not in use since 0.7.0
+        "m": {
+          "_r": 42 // Resposibility ID (if provided), in use since 0.7.0
+          // any other meta information provided, please see Track meta information section for the details
+        }
       }
     ]
 }

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

@@ -18,6 +18,7 @@ module Logidze
 
       def generate_hstore_migration
         return if update?
+
         migration_template "hstore.rb.erb", "db/migrate/enable_hstore.rb"
       end
 

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

@@ -117,6 +117,7 @@ class <%= @migration_class_name %> < ActiveRecord::Migration<%= ActiveRecord::VE
           new_v integer;
           size integer;
           history_limit integer;
+          debounce_time integer;
           current_version integer;
           merged jsonb;
           iterator integer;
@@ -126,7 +127,7 @@ class <%= @migration_class_name %> < ActiveRecord::Migration<%= ActiveRecord::VE
           ts_column text;
         BEGIN
           ts_column := NULLIF(TG_ARGV[1], 'null');
-          columns_blacklist := TG_ARGV[2];
+          columns_blacklist := COALESCE(NULLIF(TG_ARGV[2], 'null'), '{}');
 
           IF TG_OP = 'INSERT' THEN
             snapshot = logidze_snapshot(to_jsonb(NEW.*), ts_column, columns_blacklist);
@@ -146,6 +147,8 @@ class <%= @migration_class_name %> < ActiveRecord::Migration<%= ActiveRecord::VE
             END IF;
 
             history_limit := NULLIF(TG_ARGV[0], 'null');
+            debounce_time := NULLIF(TG_ARGV[3], 'null');
+
             current_version := (NEW.log_data->>'v')::int;
 
             IF ts_column IS NULL THEN
@@ -189,6 +192,21 @@ class <%= @migration_class_name %> < ActiveRecord::Migration<%= ActiveRecord::VE
               RETURN NEW;
             END IF;
 
+            IF (
+              debounce_time IS NOT NULL AND
+              (version->>'ts')::bigint - (NEW.log_data#>'{h,-1,ts}')::text::bigint <= debounce_time
+            ) THEN
+              -- merge new version with the previous one
+              new_v := (NEW.log_data#>>'{h,-1,v}')::int;
+              version := logidze_version(new_v, (NEW.log_data#>'{h,-1,c}')::jsonb || changes, ts, columns_blacklist);
+              -- remove the previous version from log
+              NEW.log_data := jsonb_set(
+                NEW.log_data,
+                '{h}',
+                (NEW.log_data->'h') - (size - 1)
+              );
+            END IF;
+
             NEW.log_data := jsonb_set(
               NEW.log_data,
               ARRAY['h', size::text],

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

@@ -10,6 +10,9 @@ module Logidze
 
       class_option :limit, type: :numeric, optional: true, desc: "Specify history size limit"
 
+      class_option :debounce_time, type: :numeric, optional: true,
+                                   desc: "Specify debounce time in millisecond"
+
       class_option :backfill, type: :boolean, optional: true,
                               desc: "Add query to backfill existing records history"
 
@@ -37,6 +40,7 @@ module Logidze
 
       def inject_logidze_to_model
         return if update?
+
         indents = "  " * (class_name.scan("::").count + 1)
 
         inject_into_class(model_file_path, class_name.demodulize, "#{indents}has_logidze\n")
@@ -84,11 +88,16 @@ module Logidze
         def timestamp_column
           value = options[:timestamp_column] || 'updated_at'
           return if %w(nil null false).include?(value)
+
           escape_pgsql_string(value)
         end
 
+        def debounce_time
+          options[:debounce_time]
+        end
+
         def logidze_logger_parameters
-          format_pgsql_args(limit, timestamp_column, columns_blacklist)
+          format_pgsql_args(limit, timestamp_column, columns_blacklist, debounce_time)
         end
 
         def logidze_snapshot_parameters
@@ -97,11 +106,13 @@ module Logidze
 
         def format_pgsql_array(ruby_array)
           return if ruby_array.blank?
+
           "'{" + ruby_array.join(', ') + "}'"
         end
 
         def escape_pgsql_string(string)
           return if string.blank?
+
           "'#{string}'"
         end
 

data/lib/logidze/history.rb

@@ -59,10 +59,12 @@ module Logidze
     # Optional `data` paramater can be used as initial diff state.
     def changes_to(time: nil, version: nil, data: {}, from: 0)
       raise ArgumentError, "Time or version must be specified" if time.nil? && version.nil?
+
       filter = time.nil? ? method(:version_filter) : method(:time_filter)
       versions.each_with_object(data.dup) do |v, acc|
         next if v.version < from
         break acc if filter.call(v, version, time)
+
         acc.merge!(v.changes)
       end
     end
@@ -114,6 +116,7 @@ module Logidze
 
     def ==(other)
       return super unless other.is_a?(self.class)
+
       data == other.data
     end
 

data/lib/logidze/meta.rb

@@ -9,6 +9,7 @@ module Logidze # :nodoc:
 
     def with_responsible(responsible_id, &block)
       return yield if responsible_id.nil?
+
       meta = { Logidze::History::Version::META_RESPONSIBLE => responsible_id }
       with_meta(meta, &block)
     end
@@ -30,6 +31,7 @@ module Logidze # :nodoc:
       def perform
         return if block.nil?
         return block.call if meta.nil?
+
         ActiveRecord::Base.transaction { call_block_in_meta_context }
       end
 

data/lib/logidze/model.rb

@@ -144,6 +144,7 @@ module Logidze
     def undo!(append: Logidze.append_on_undo)
       version = log_data.previous_version
       return false if version.nil?
+
       switch_to!(version.version, append: append)
     end
 
@@ -152,6 +153,7 @@ module Logidze
     def redo!
       version = log_data.next_version
       return false if version.nil?
+
       switch_to!(version.version)
     end
 
@@ -206,6 +208,7 @@ module Logidze
 
     def apply_column_diff(column, value)
       return if deleted_column?(column)
+
       write_attribute column, deserialize_value(column, value)
     end
 

data/lib/logidze/version.rb

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

data/logidze.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake", ">= 10.0"
   spec.add_development_dependency "rspec-rails", ">= 3.4"
-  spec.add_development_dependency "rubocop", "~> 0.58.0"
+  spec.add_development_dependency "rubocop", "~> 0.59.0"
   spec.add_development_dependency "rubocop-md", "~> 0.2.0"
   spec.add_development_dependency "simplecov", ">= 0.3.8"
   spec.add_development_dependency "timecop", "~> 0.8"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logidze
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-29 00:00:00.000000000 Z
+date: 2018-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.58.0
+        version: 0.59.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.58.0
+        version: 0.59.0
 - !ruby/object:Gem::Dependency
   name: rubocop-md
   requirement: !ruby/object:Gem::Requirement
@@ -254,7 +254,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: PostgreSQL JSON-based auditing