logidze 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f91810e96c04d3ddc2d629c5aa0179c69a232d52
-  data.tar.gz: 633e81904255a8d8186dc3839c59bb8c84623276
+  metadata.gz: 937e0b13769d464f7bb14dc1440951ea6a1462db
+  data.tar.gz: e7d117211dc9e24854b0171158996066aa56ade1
 SHA512:
-  metadata.gz: 039e4e7543e6a9e5415eccd73921fff6a850a25e11b68b437d25356ede09f7c89e713803fdad7c77d8687d22a5ce2fae2809a6765d435f1ffc415c85e6ca33dc
-  data.tar.gz: 0db11276109aa07f6b2350e2acd4034b6cfe4f76325ba97f16ea14306c949fca0362520246454ad65e1becad13411d58ea5d7c7e6c09dd233dceca680a9a7453
+  metadata.gz: fcdfe2828fa0fa360177a7839de761bc91b7e9bb81e9ce0d69482e28b3d2c1194a91e71dca9e13975d7eafc31839db3990f7b082fa37f132c43b51bad3245010
+  data.tar.gz: 3fd4562dd287fdcf8c1321e5ff8e225931cbc9b76913f1c90f9a4566f2610446f86febddfed60407988746a4ad765d397d469bef75eb06591938b2978198866c

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 0.3.0
+- Add `--update` option to install migration generator
+- Add `--only-trigger` option to model migration generator
+- Add [Responsibility](https://github.com/palkan/logidze/issues/4) feature
+
+# 0.2.3
+- Support Ruby >= 2.1
+
 # 0.2.2
 - Add `--backfill` option to model migration
 - Handle legacy data (that doesn't have log data)

data/README.md

@@ -60,6 +60,16 @@ To backfill table data (i.e. create initial snapshots) add `backfill` option:
 rails generate logidze:model Post --backfill
 ```
 
+## Upgrade from previous versions
+
+We try to make upgrade process as simple as possible. For now, the only required action is to create and run a migration:
+
+```ruby
+rails generate logidze:install --update
+```
+
+This updates core `logdize_logger` DB function. No need to update tables or triggers.
+
 ## Usage
 
 Your model now has `log_data` column which stores changes log.
@@ -122,6 +132,49 @@ post.switch_to!(2)
 
 If you update record after `#undo!` or `#switch_to!` you lose all "future" versions and `#redo!` is no longer possible.
 
+## Track responsibility (aka _whodunnit_)
+
+You can store additional information in the version object, which is called _Responsible ID_. There is more likely that you would like to store the `current_user.id` that way.
+
+To provide `responsible_id` you should wrap your code in a block:
+
+```ruby
+Logidze.with_responsible(user.id) do
+  post.save!
+end
+```
+
+And then to retrieve `responsible_id`:
+
+```ruby
+post.log_data.responsible_id
+```
+
+Logidze does not require `responsible_id` to be `SomeModel` ID. It can be anything. Thus Logidze does not provide methods for retrieving the corresponding object. However, you can easy write it yourself:
+
+```ruby
+class Post < ActiveRecord::Base
+  has_logidze
+
+  def whodunnit
+    id = log_data.responsible_id
+    User.find(id) if id.present?
+  end
+end
+```
+
+And in your controller:
+
+```ruby
+class ApplicationController < ActionController::Base
+  around_action :set_logidze_responsible, only: [:create, :update]
+
+  def set_logidze_responsible(&block)
+    Logidze.with_responsible(current_user&.id, &block)
+  end
+end
+```
+
 ## Disable logging temporary
 
 If you want to make update without logging (e.g. mass update), you can turn it off the following way:
@@ -150,7 +203,8 @@ 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)
     ]
 }
 ```

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

@@ -9,14 +9,36 @@ module Logidze
 
       source_root File.expand_path('../templates', __FILE__)
 
+      class_option :update, type: :boolean, optional: true,
+                            desc: "Define whether this is an update migration"
+
       def generate_migration
-        migration_template "migration.rb.erb", "db/migrate/logidze_install.rb"
+        migration_template "migration.rb.erb", "db/migrate/#{migration_name}.rb"
       end
 
       def generate_hstore_migration
+        return if update?
         migration_template "hstore.rb.erb", "db/migrate/enable_hstore.rb"
       end
 
+      no_tasks do
+        def migration_name
+          if update?
+            "logidze_update_#{Logidze::VERSION.delete('.')}"
+          else
+            "logidze_install"
+          end
+        end
+
+        def migration_class_name
+          migration_name.classify
+        end
+
+        def update?
+          options[:update]
+        end
+      end
+
       def self.next_migration_number(dir)
         ::ActiveRecord::Generators::Base.next_migration_number(dir)
       end

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

@@ -4,25 +4,39 @@ class <%= @migration_class_name %> < ActiveRecord::Migration
       DO $$
         BEGIN
         EXECUTE 'ALTER DATABASE ' || current_database() || ' SET logidze.disabled TO off';
+        EXECUTE 'ALTER DATABASE ' || current_database() || ' SET logidze.responsible TO off';
         END;
       $$
       LANGUAGE plpgsql;
     SQL
 
     execute <<-SQL
+      CREATE OR REPLACE FUNCTION logidze_version(v bigint, data jsonb) RETURNS jsonb AS $body$
+        DECLARE
+          buf jsonb;
+        BEGIN
+          buf := jsonb_build_object(
+                   'ts',
+                   (extract(epoch from now()) * 1000)::bigint,
+                   'v',
+                    v,
+                    'c',
+                    logidze_exclude_keys(data, 'log_data')
+                   );
+          IF current_setting('logidze.responsible') <> 'off' THEN
+            buf := jsonb_set(buf, ARRAY['r'], to_jsonb(current_setting('logidze.responsible')));
+          END IF;
+          RETURN buf;
+        END;
+      $body$
+      LANGUAGE plpgsql;
+
       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',
-                     logidze_exclude_keys(item,'log_data')
-                   )
+                   logidze_version(1, item)
                  )
             );
         END;
@@ -57,6 +71,10 @@ class <%= @migration_class_name %> < ActiveRecord::Migration
             (log_data#>'{h,0,c}') || (log_data#>'{h,1,c}')
           );
 
+          IF (log_data#>'{h,1}' ? 'r') THEN
+            merged := jsonb_set(merged, ARRAY['r'], log_data#>'{h,1,r}');
+          END IF;
+
           return jsonb_set(
             log_data,
             '{h}',
@@ -74,7 +92,6 @@ class <%= @migration_class_name %> < ActiveRecord::Migration
         DECLARE
           changes jsonb;
           new_v integer;
-          ts bigint;
           size integer;
           history_limit integer;
           current_version integer;
@@ -101,8 +118,6 @@ 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')
@@ -118,11 +133,8 @@ class <%= @migration_class_name %> < ActiveRecord::Migration
               END LOOP;
             END IF;
 
-            changes := logidze_exclude_keys(
-              hstore_to_jsonb_loose(
-                hstore(NEW.*) - hstore(OLD.*)
-              ),
-              'log_data'
+            changes := hstore_to_jsonb_loose(
+              hstore(NEW.*) - hstore(OLD.*)
             );
 
             new_v := (NEW.log_data#>>'{h,-1,v}')::int + 1;
@@ -132,14 +144,7 @@ class <%= @migration_class_name %> < ActiveRecord::Migration
             NEW.log_data := jsonb_set(
               NEW.log_data,
               ARRAY['h', size::text],
-              jsonb_build_object(
-                'ts',
-                ts,
-                'v',
-                new_v,
-                'c',
-                changes
-              ),
+              logidze_version(new_v, changes),
               true
             );
 
@@ -162,10 +167,13 @@ class <%= @migration_class_name %> < ActiveRecord::Migration
   end
 
   def down
+    <% unless update? %>
     execute <<-SQL
+      DROP FUNCTION logidze_version(bigint, jsonb) CASCADE;
       DROP FUNCTION logidze_compact_history(jsonb) CASCADE;
       DROP FUNCTION logidze_snapshot(jsonb) CASCADE;
       DROP FUNCTION logidze_logger() CASCADE;
     SQL
+    <% end %>
   end
 end

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

@@ -12,6 +12,9 @@ module Logidze
       class_option :backfill, type: :boolean, optional: true,
                               desc: "Add query to backfill existing records history"
 
+      class_option :only_trigger, type: :boolean, optional: true,
+                                  desc: "Create trigger-only migration"
+
       def generate_migration
         migration_template "migration.rb.erb", "db/migrate/#{migration_file_name}"
       end
@@ -35,9 +38,13 @@ module Logidze
           options[:limit]
         end
 
-        def backfill
+        def backfill?
           options[:backfill]
         end
+
+        def only_trigger?
+          options[:only_trigger]
+        end
       end
 
       private

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

@@ -1,6 +1,8 @@
 class <%= @migration_class_name %> < ActiveRecord::Migration
   def up
-    add_column :<%= table_name %>, :log_data, :jsonb, default: {}, null: false
+    <% unless only_trigger? %>
+    add_column :<%= table_name %>, :log_data, :jsonb
+    <% end %>
 
     execute <<-SQL
       CREATE TRIGGER logidze_on_<%= table_name %>
@@ -9,7 +11,7 @@ class <%= @migration_class_name %> < ActiveRecord::Migration
       EXECUTE PROCEDURE logidze_logger(<%= limit || '' %>);
     SQL
 
-    <% if backfill %>
+    <% if backfill? %>
     execute <<-SQL
       UPDATE <%= table_name %> as t
       SET log_data = logidze_snapshot(to_jsonb(t));
@@ -20,6 +22,8 @@ class <%= @migration_class_name %> < ActiveRecord::Migration
   def down
     execute "DROP TRIGGER IF EXISTS logidze_on_<%= table_name %> on <%= table_name %>;"
 
+    <% unless only_trigger? %>
     remove_column :<%= table_name %>, :log_data
+    <% end %>
   end
 end

data/lib/logidze.rb

@@ -7,6 +7,9 @@ module Logidze
   require 'logidze/history'
   require 'logidze/model'
   require 'logidze/has_logidze'
+  require 'logidze/responsible'
+
+  extend Logidze::Responsible
 
   require 'logidze/engine' if defined?(Rails)
 

data/lib/logidze/history.rb

@@ -12,6 +12,7 @@ module Logidze
     attr_reader :data
 
     delegate :size, to: :versions
+    delegate :responsible_id, to: :current_version
 
     ### Rails 4 ###
     def self.dump(object)
@@ -105,6 +106,10 @@ module Logidze
       versions.reverse.find { |v| v.time <= time }
     end
 
+    def dup
+      self.class.new(data.deep_dup)
+    end
+
     def ==(other)
       return super unless other.is_a?(self.class)
       data == other.data

data/lib/logidze/history/version.rb

@@ -7,6 +7,8 @@ module Logidze
       TS = 'ts'
       # Changes key
       CHANGES = 'c'
+      # Responsible ID
+      RESPONSIBLE = 'r'
 
       attr_reader :data
 
@@ -25,6 +27,10 @@ module Logidze
       def time
         data.fetch(TS)
       end
+
+      def responsible_id
+        data[RESPONSIBLE]
+      end
     end
   end
 end

data/lib/logidze/model.rb

@@ -46,8 +46,10 @@ module Logidze
       return nil unless log_data.exists_ts?(ts)
       return self if log_data.current_ts?(ts)
 
+      version = log_data.find_by_time(ts).version
+
       object_at = dup
-      object_at.apply_diff(log_data.changes_to(time: ts))
+      object_at.apply_diff(version, log_data.changes_to(version: version))
     end
 
     # Revert record to the version at specified time (without saving to DB)
@@ -56,7 +58,9 @@ module Logidze
       return self if log_data.current_ts?(ts)
       return false unless log_data.exists_ts?(ts)
 
-      apply_diff(log_data.changes_to(time: ts))
+      version = log_data.find_by_time(ts).version
+
+      apply_diff(version, log_data.changes_to(version: version))
     end
 
     # Return a dirty copy of specified version of record
@@ -65,7 +69,7 @@ module Logidze
       return nil unless log_data.find_by_version(version)
 
       object_at = dup
-      object_at.apply_diff(log_data.changes_to(version: version))
+      object_at.apply_diff(version, log_data.changes_to(version: version))
     end
 
     # Revert record to the specified version (without saving to DB)
@@ -73,7 +77,7 @@ module Logidze
       return self if log_data.version == version
       return false unless log_data.find_by_version(version)
 
-      apply_diff(log_data.changes_to(version: version))
+      apply_diff(version, log_data.changes_to(version: version))
     end
 
     # Return diff object representing changes since specified time.
@@ -107,14 +111,14 @@ module Logidze
     # Return false if version is unknown.
     def switch_to!(version)
       return false unless at_version!(version)
-      log_data.version = version
       self.class.without_logging { save! }
     end
 
     protected
 
-    def apply_diff(diff)
+    def apply_diff(version, diff)
       diff.each { |k, v| send("#{k}=", v) }
+      log_data.version = version
       self
     end
 

data/lib/logidze/responsible.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module Logidze # :nodoc:
+  # Provide methods to work with "responsibility" feature
+  module Responsible
+    def with_responsible(responsible_id)
+      return yield if responsible_id.nil?
+      ActiveRecord::Base.transaction do
+        ActiveRecord::Base.connection.execute(
+          "SET LOCAL logidze.responsible = #{ActiveRecord::Base.connection.quote(responsible_id)};"
+        )
+        res = yield
+        ActiveRecord::Base.connection.execute "SET LOCAL logidze.responsible = DEFAULT;"
+        res
+      end
+    end
+  end
+end

data/lib/logidze/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logidze
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-09 00:00:00.000000000 Z
+date: 2016-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -186,6 +186,7 @@ files:
 - lib/logidze/history/type.rb
 - lib/logidze/history/version.rb
 - lib/logidze/model.rb
+- lib/logidze/responsible.rb
 - lib/logidze/version.rb
 - logidze.gemspec
 homepage: http://github.com/palkan/logidze