logidze 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75f1f01b10a1e35d8b656a27f3d71b0e1d2f81c826338fa89d36d76ac03363b9
-  data.tar.gz: 3812d6d4b49d2fe803acc61854b1ca891ec816bbd4a3e05ff60e02bc62393ac0
+  metadata.gz: f13cd8a6226e2595de2a96ecb146e387d2fc2f1d0267e2b9076d822773703b92
+  data.tar.gz: 0f2644d225ec6457bcda305158e60a486cdb71e4a6c3cc0b092db930491f60d3
 SHA512:
-  metadata.gz: 7b38094dd8e8b7de7295b354e0906067641080e90169f0222b163b43a491672921eff25a78062680650e1e8565727d01dcd4694a84fecbeb7ff60a918d2fbe6c
-  data.tar.gz: 7ba5a0605b9b45e63bb6c02b9d18b05f78331369ed4aeb2564434d1e627013e360b1ef0ab2f2fdd94203de6ed341d3136d800e2b8aa838d6fe6c501eecb5d98d
+  metadata.gz: 21cdbd6b6aa0d8a6295813943671f01d617a62cdf63bfd9df3389941cc29232f00edceaf6f25a1812fcd08f205c2f56cb212fc0c417a215628f7d604ec48e8db
+  data.tar.gz: 118d8b66bd7f0f661b6aed153bd08453c21f59afde5f85c712b7278ca19397922cb726dcf96dd5140d0bbe5bf7fb9eecd208bfe7e513b706087c7cdf1bacf850

data/.rubocop.yml

@@ -28,7 +28,7 @@ Style/TrailingCommaInArrayLiteral:
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: no_comma
 
-Layout/AlignParameters:
+Layout/ParameterAlignment:
   EnforcedStyle: with_first_parameter
 
 Lint/Void:

data/.travis.yml

@@ -21,22 +21,26 @@ before_script:
   - psql -U postgres -d logidze -c 'CREATE EXTENSION IF NOT EXISTS hstore;'
   - RAILS_ENV=test bundle exec rake dummy:db:create dummy:db:migrate
 
+before_install:
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v '< 2'
+
 matrix:
   include:
     - rvm: ruby-head
       gemfile: gemfiles/railsmaster.gemfile
-    - rvm: 2.6.2
+    - rvm: 2.7
       gemfile: gemfiles/rails6.gemfile
-    - rvm: 2.6.2
+    - rvm: 2.6
       gemfile: gemfiles/rails5.gemfile
-    - rvm: 2.5.1
+    - rvm: 2.5
       gemfile: gemfiles/rails52.gemfile
-    - rvm: 2.4.1
+    - rvm: 2.4
       gemfile: gemfiles/rails5.gemfile
-    - rvm: 2.4.1
+    - rvm: 2.4
       gemfile: gemfiles/rails42.gemfile
   allow_failures:
     - rvm: ruby-head
       gemfile: gemfiles/railsmaster.gemfile
-    - rvm: 2.5.0
+    - rvm: 2.5
       gemfile: gemfiles/railsmaster.gemfile

data/CHANGELOG.md

@@ -1,7 +1,28 @@
+
 # Change log
 
 ## master (unreleased)
 
+## 0.12.0 (2020-01-02)
+
+- PR [#143](https://github.com/palkan/logidze/pull/143) Add `:transactional` option to `#with_meta` and `#with_responsible` ([@oleg-kiviljov][])
+
+Now it's possible to set meta and responsible without wrapping the block into a DB transaction. For backward compatibility  `:transactional` option by default is set to `true`.
+
+Usage:
+
+```ruby
+Logidze.with_meta({ip: request.ip}, transactional: false) do
+  post.save!
+end
+```
+or
+```ruby
+Logidze.with_responsible(user.id, transactional: false) do
+  post.save!
+end
+```
+
 ## 0.11.0 (2019-08-15)
 
 - **Breaking** Return `nil` when `log_data` is not loaded instead of raising an exception. ([@palkan][])
@@ -284,3 +305,4 @@ This is a quick fix for a more general problem (see [#59](https://github.com/pal
 [@dmitrytsepelev]: https://github.com/DmitryTsepelev
 [@zocoi]: https://github.com/zocoi
 [@duderman]: https://github.com/duderman
+[@oleg-kiviljov]: https://github.com/oleg-kiviljov

data/Gemfile

@@ -11,5 +11,5 @@ local_gemfile = "#{File.dirname(__FILE__)}/Gemfile.local"
 if File.exist?(local_gemfile)
   eval(File.read(local_gemfile)) # rubocop:disable Lint/Eval
 else
-  gem 'activerecord', '~> 5.1.1'
+  gem 'activerecord', '~> 6.0'
 end

data/README.md

@@ -261,6 +261,14 @@ end
 
 Meta expects a hash to be passed so you won't need to encode and decode JSON manually.
 
+By default `.with_meta` wraps the block into a DB transaction. That could lead to an unexpected behavior, especially, when using `.with_meta` within an around_action. To avoid wrapping the block into a DB transaction use `transactional: false` option.
+
+```ruby
+Logidze.with_meta({ip: request.ip}, transactional: false) do
+  post.save!
+end
+```
+
 ## Track responsibility (aka _whodunnit_)
 
 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.
@@ -304,6 +312,13 @@ class ApplicationController < ActionController::Base
 end
 ```
 
+By default `.with_responsible` wraps the block into a DB transaction. That could lead to an unexpected behavior, especially, when using `.with_responsible` within an around_action. To avoid wrapping the block into a DB transaction use `transactional: false` option.
+
+```ruby
+Logidze.with_responsible(user.id, transactional: false) do
+  post.save!
+end
+```
 ## Disable logging temporary
 
 If you want to make update without logging (e.g., mass update), you can turn it off the following way:

data/gemfiles/rails6.gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'rails', '6.0.0.rc1'
+gem 'rails', '~> 6.0'
 gem 'rspec-rails', '>= 3.5'
 
-gemspec path: '..'
+gemspec path: '..'

data/lib/logidze/has_logidze.rb

@@ -11,8 +11,8 @@ module Logidze
       # Include methods to work with history.
       #
       def has_logidze(ignore_log_data: Logidze.ignore_log_data_by_default)
-        include Logidze::Model
         include Logidze::IgnoreLogData
+        include Logidze::Model
 
         @ignore_log_data = ignore_log_data
 

data/lib/logidze/ignore_log_data.rb

@@ -7,6 +7,7 @@ module Logidze
     included do
       if Rails::VERSION::MAJOR == 4
         require "logidze/ignore_log_data/ignored_columns"
+        attribute :log_data, ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Jsonb.new
       elsif Rails::VERSION::MAJOR == 5
         require "logidze/ignore_log_data/cast_attribute_patch"
         include CastAttributePatch

data/lib/logidze/meta.rb

@@ -3,18 +3,19 @@
 module Logidze # :nodoc:
   # Provide methods to attach meta information
   module Meta
-    def with_meta(meta, &block)
-      MetaTransaction.wrap_with(meta, &block)
+    def with_meta(meta, transactional: true, &block)
+      wrapper = transactional ? MetaWithTransaction : MetaWithoutTransaction
+      wrapper.wrap_with(meta, &block)
     end
 
-    def with_responsible(responsible_id, &block)
+    def with_responsible(responsible_id, transactional: true, &block)
       return yield if responsible_id.nil?
 
       meta = {Logidze::History::Version::META_RESPONSIBLE => responsible_id}
-      with_meta(meta, &block)
+      with_meta(meta, transactional: transactional, &block)
     end
 
-    class MetaTransaction # :nodoc:
+    class MetaWrapper # :nodoc:
       def self.wrap_with(meta, &block)
         new(meta, &block).perform
       end
@@ -29,14 +30,12 @@ module Logidze # :nodoc:
       end
 
       def perform
-        return if block.nil?
+        raise ArgumentError, "Block must be given" unless block
         return block.call if meta.nil?
 
-        ActiveRecord::Base.transaction { call_block_in_meta_context }
+        call_block_in_meta_context
       end
 
-      private
-
       def call_block_in_meta_context
         prev_meta = current_meta
 
@@ -44,10 +43,9 @@ module Logidze # :nodoc:
 
         pg_set_meta_param(current_meta)
         result = block.call
-        pg_reset_meta_param(prev_meta)
-
         result
       ensure
+        pg_reset_meta_param(prev_meta)
         meta_stack.pop
       end
 
@@ -60,20 +58,49 @@ module Logidze # :nodoc:
         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};")
+      def encode_meta(value)
+        connection.quote(ActiveSupport::JSON.encode(value))
       end
 
       def pg_reset_meta_param(prev_meta)
         if prev_meta.empty?
-          connection.execute("SET LOCAL logidze.meta TO DEFAULT;")
+          pg_clear_meta_param
         else
           pg_set_meta_param(prev_meta)
         end
       end
     end
 
-    private_constant :MetaTransaction
+    class MetaWithTransaction < MetaWrapper # :nodoc:
+      private
+
+      def call_block_in_meta_context
+        connection.transaction { super }
+      end
+
+      def pg_set_meta_param(value)
+        connection.execute("SET LOCAL logidze.meta = #{encode_meta(value)};")
+      end
+
+      def pg_clear_meta_param
+        connection.execute("SET LOCAL logidze.meta TO DEFAULT;")
+      end
+    end
+
+    class MetaWithoutTransaction < MetaWrapper # :nodoc:
+      private
+
+      def pg_set_meta_param(value)
+        connection.execute("SET logidze.meta = #{encode_meta(value)};")
+      end
+
+      def pg_clear_meta_param
+        connection.execute("SET logidze.meta TO DEFAULT;")
+      end
+    end
+
+    private_constant :MetaWrapper
+    private_constant :MetaWithTransaction
+    private_constant :MetaWithoutTransaction
   end
 end

data/lib/logidze/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Logidze
-  VERSION = "0.11.0"
+  VERSION = "0.12.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logidze
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-15 00:00:00.000000000 Z
+date: 2020-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -191,7 +191,6 @@ files:
 - lib/logidze/history/type.rb
 - lib/logidze/history/version.rb
 - lib/logidze/ignore_log_data.rb
-- lib/logidze/ignore_log_data/association.rb
 - lib/logidze/ignore_log_data/cast_attribute_patch.rb
 - lib/logidze/ignore_log_data/ignored_columns.rb
 - lib/logidze/meta.rb
@@ -224,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: PostgreSQL JSON-based auditing

data/lib/logidze/ignore_log_data/association.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Logidze
-  module IgnoreLogData
-    module Association # :nodoc:
-      def target_scope
-        super.with_log_data
-      end
-    end
-  end
-end