logidze 0.6.5 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a022058afd1c2017c10dfa802227b2b88433c5f4d103b2f07b7ce8b404887bdf
-  data.tar.gz: 33f96a549116e7ef695dc83605e3b90edd1eab2a6f1424bebf6310156622233b
+  metadata.gz: bfd80509e728582e7c8b3629a6704d7d2d7b8d4e835974df0bd10dac03333348
+  data.tar.gz: 5f3f386533f330d41d4acaeaf9e724df4a3d1ee3851cd99dbbff4ab5b6573546
 SHA512:
-  metadata.gz: 04c1f2fc5afc500af82dfc1d76399deebc573b7b571cee870ee384cd0816b121ab52b37664706137da4acbd4ec64ce95e1df9a5ccb5766998536f1744c5de582
-  data.tar.gz: '0925a5a4b918581b9d98c26adb5bd3121fa58e4f2037b903026e9e1fcc4f423a71df46491edbbb5892c86db6d6e5136b5649e1e52f410e2fd5c1dbf20f41648d'
+  metadata.gz: a17ac5c2fb65280a3897c5f672d0d0ef719870cd8f019a0d525e314d0c60795e5fda4068ba3fb0b1003f2ec5a848b3a2150237d29256fa8828a8401e775afcb6
+  data.tar.gz: f9023b0b9731f9ddbb28fda06ae07995eb0e0a7cb33778238d582e82d8752632c7ca3fa84bfbe639ce2553fbe9c4b10dbaf0dc92d361f01deb08a2d97aebc447

data/.rubocop.yml

@@ -91,4 +91,4 @@ Layout/IndentHeredoc:
   Enabled: false
 
 Layout/EmptyLineAfterMagicComment:
-  Enabled: false
+  Enabled: false

data/.travis.yml

@@ -26,6 +26,8 @@ matrix:
       gemfile: gemfiles/railsmaster.gemfile
     - rvm: 2.5.0
       gemfile: gemfiles/rails5.gemfile
+    - rvm: 2.5.1
+      gemfile: gemfiles/rails52.gemfile
     - rvm: 2.4.1
       gemfile: gemfiles/rails5.gemfile
     - rvm: 2.3.1

data/CHANGELOG.md

@@ -2,6 +2,29 @@
 
 ## master
 
+## 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][])
+
+- [PR [#79](https://github.com/palkan/logidze/pull/13)] Allow adding meta information to versions using `with_meta` (addressed [Issue [#60]](https://github.com/palkan/logidze/issues/60)). ([@DmitryTsepelev][])
+
+Usage:
+
+```ruby
+Logidze.with_meta(ip: request.ip) { post.save }
+puts post.meta # => { 'ip' => '95.66.157.226' }
+```
+
+How to upgrade.
+
+Please run `rails generate logidze:install --update` to regenerate stored functions.
+
+This feature replaces the implementation of `with_responsible`, now `responsible_id` is stored inside of the meta hash with the key `_r`.
+
+There is fallback to the old data structure (`{ 'r' => 42 }` opposed to `{ 'm' => { '_r' => 42 } }` in the current implementation), so `responsible_id` should work as usual for the existing data.
+
+If you've accessed the value manually (e.g. `post.log_data.current_version.data['r']`), you'll have to add the fallback too.
+
 ## 0.6.5 (2018-08-08)
 
 - Make compatible with Rails 5.2.1 ([@palkan][])
@@ -99,3 +122,5 @@ This is a quick fix for a more general problem (see [#59](https://github.com/pal
 [@charlie-wasp]: https://github.com/charlie-wasp
 [@akxcv]: https://github.com/akxcv
 [@vassilevsky]: https://github.com/vassilevsky
+[@ankursethi-uscis]: https://github.com/ankursethi-uscis
+[@DmitryTsepelev]: https://github.com/DmitryTsepelev

data/README.md

@@ -1,5 +1,5 @@
-[![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) [![Circle CI](https://circleci.com/gh/palkan/logidze/tree/master.svg?style=svg)](https://circleci.com/gh/palkan/logidze/tree/master)
-[![Dependency Status](https://dependencyci.com/github/palkan/logidze/badge)](https://dependencyci.com/github/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
@@ -207,9 +207,21 @@ Logidze.append_on_undo = true
 ```
 
 
+## Track meta information
+
+You can store any meta information you want inside your version (it could be IP address, user agent etc). In order to add it you should wrap your code with a block:
+
+```ruby
+Logidze.with_meta(ip: request.ip) do
+  post.save!
+end
+```
+
+Meta expects a hash to be passed so you won't need to encode and decode JSON manually.
+
 ## 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.
+A special application of meta information is storing the author of the change, 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:
 

data/gemfiles/rails5.gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'rails', '~> 5.0'
+gem 'rails', '~> 5.1.0'
 gem 'rspec-rails', '~> 3.5'
 
 gemspec path: '..'

data/gemfiles/rails52.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.2.1'
+gem 'rspec-rails', '~> 3.5'
+
+gemspec path: '..'

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

@@ -8,7 +8,7 @@ class <%= @migration_class_name %> < ActiveRecord::Migration<%= ActiveRecord::VE
         DO $$
           BEGIN
           EXECUTE 'ALTER DATABASE ' || quote_ident(current_database()) || ' SET logidze.disabled=' || quote_literal('');
-          EXECUTE 'ALTER DATABASE ' || quote_ident(current_database()) || ' SET logidze.responsible=' || quote_literal('');
+          EXECUTE 'ALTER DATABASE ' || quote_ident(current_database()) || ' SET logidze.meta=' || quote_literal('');
           END;
         $$
         LANGUAGE plpgsql;
@@ -37,8 +37,8 @@ class <%= @migration_class_name %> < ActiveRecord::Migration<%= ActiveRecord::VE
                     'c',
                     logidze_exclude_keys(data, VARIADIC array_append(blacklist, 'log_data'))
                    );
-          IF coalesce(#{current_setting('logidze.responsible')}, '') <> '' THEN
-            buf := jsonb_set(buf, ARRAY['r'], to_jsonb(current_setting('logidze.responsible')));
+          IF coalesce(#{current_setting('logidze.meta')}, '') <> '' THEN
+            buf := jsonb_set(buf, ARRAY['m'], current_setting('logidze.meta')::jsonb);
           END IF;
           RETURN buf;
         END;
@@ -92,8 +92,8 @@ class <%= @migration_class_name %> < ActiveRecord::Migration<%= ActiveRecord::VE
             (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}');
+          IF (log_data#>'{h,1}' ? 'm') THEN
+            merged := jsonb_set(merged, ARRAY['m'], log_data#>'{h,1,m}');
           END IF;
 
           return jsonb_set(

data/lib/logidze.rb

@@ -8,9 +8,9 @@ module Logidze
   require 'logidze/model'
   require 'logidze/versioned_association'
   require 'logidze/has_logidze'
-  require 'logidze/responsible'
+  require 'logidze/meta'
 
-  extend Logidze::Responsible
+  extend Logidze::Meta
 
   require 'logidze/engine' if defined?(Rails)
 

data/lib/logidze/history.rb

@@ -14,7 +14,7 @@ module Logidze
     attr_reader :data
 
     delegate :size, to: :versions
-    delegate :responsible_id, to: :current_version
+    delegate :responsible_id, :meta, to: :current_version
 
     ### Rails 4 ###
     def self.dump(object)

data/lib/logidze/history/version.rb

@@ -9,6 +9,10 @@ module Logidze
       CHANGES = 'c'
       # Responsible ID
       RESPONSIBLE = 'r'
+      # Meta Responsible ID
+      META_RESPONSIBLE = '_r'
+      # Meta key
+      META = 'm'
 
       attr_reader :data
 
@@ -29,7 +33,11 @@ module Logidze
       end
 
       def responsible_id
-        data[RESPONSIBLE]
+        meta && meta[META_RESPONSIBLE] || data[RESPONSIBLE]
+      end
+
+      def meta
+        data[META]
       end
     end
   end

data/lib/logidze/meta.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Logidze # :nodoc:
+  # Provide methods to attach meta information
+  module Meta
+    def with_meta(meta, &block)
+      MetaTransaction.wrap_with(meta, &block)
+    end
+
+    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
+
+    class MetaTransaction # :nodoc:
+      def self.wrap_with(meta, &block)
+        new(meta, &block).perform
+      end
+
+      attr_reader :meta, :block
+
+      delegate :connection, to: ActiveRecord::Base
+
+      def initialize(meta, &block)
+        @meta = meta
+        @block = block
+      end
+
+      def perform
+        return if block.nil?
+        return block.call if meta.nil?
+        ActiveRecord::Base.transaction { call_block_in_meta_context }
+      end
+
+      private
+
+      def call_block_in_meta_context
+        prev_meta = current_meta
+
+        meta_stack.push(meta)
+
+        pg_set_meta_param(current_meta)
+        result = block.call
+        pg_reset_meta_param(prev_meta)
+
+        result
+      ensure
+        meta_stack.pop
+      end
+
+      def current_meta
+        meta_stack.reduce(:merge) || {}
+      end
+
+      def meta_stack
+        Thread.current[:meta] ||= []
+        Thread.current[:meta]
+      end
+
+      def pg_set_meta_param(value)
+        encoded_meta = connection.quote(ActiveSupport::JSON.encode(value))
+        connection.execute("SET LOCAL logidze.meta = #{encoded_meta};")
+      end
+
+      def pg_reset_meta_param(prev_meta)
+        if prev_meta.empty?
+          connection.execute("SET LOCAL logidze.meta TO DEFAULT;")
+        else
+          pg_set_meta_param(prev_meta)
+        end
+      end
+    end
+
+    private_constant :MetaTransaction
+  end
+end

data/lib/logidze/version.rb

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

data/lib/logidze/versioned_association.rb

@@ -2,7 +2,7 @@
 
 # `inversed` attr_accessor has been removed in Rails 5.2.1
 # See https://github.com/rails/rails/commit/39e57daffb9ff24726b1e86dfacf76836dd0637b#diff-c47e1c26ae8a3d486119e0cc91f40a30
-unless ::ActiveRecord::Associations::Association.instance_methods.include?(:inveresed)
+unless ::ActiveRecord::Associations::Association.instance_methods.include?(:inversed)
   using(Module.new do
     refine ::ActiveRecord::Associations::Association do
       attr_reader :inversed
@@ -15,7 +15,7 @@ module Logidze # :nodoc: all
     # rubocop: disable Metrics/MethodLength, Metrics/AbcSize
     def load_target
       target = super
-
+      return unless target
       return target if inversed
 
       time = owner.logidze_requested_ts

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logidze
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.7.0
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-08 00:00:00.000000000 Z
+date: 2018-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -211,9 +211,9 @@ files:
 - bench/triggers/keys_trigger_setup.sql
 - bin/console
 - bin/setup
-- circle.yml
 - gemfiles/rails42.gemfile
 - gemfiles/rails5.gemfile
+- gemfiles/rails52.gemfile
 - gemfiles/railsmaster.gemfile
 - lib/generators/logidze/install/USAGE
 - lib/generators/logidze/install/install_generator.rb
@@ -228,9 +228,9 @@ files:
 - lib/logidze/history.rb
 - lib/logidze/history/type.rb
 - lib/logidze/history/version.rb
+- lib/logidze/meta.rb
 - lib/logidze/migration.rb
 - lib/logidze/model.rb
-- lib/logidze/responsible.rb
 - lib/logidze/version.rb
 - lib/logidze/versioned_association.rb
 - logidze.gemspec

data/circle.yml

@@ -1,15 +0,0 @@
-machine:
-  ruby:
-    version: 2.5.0
-
-  environment:
-    DATABASE_URL: postgres://postgres@127.0.0.1:5432/test_database
-
-dependencies:
-  pre:
-    - gem install bundler -v 1.11.2
-
-database:
-  override:
-    - bundle exec rake dummy:db:test:prepare
-  

data/lib/logidze/responsible.rb

@@ -1,17 +0,0 @@
-# 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 TO DEFAULT;"
-        res
-      end
-    end
-  end
-end