logidze 0.8.1 → 1.0.0.rc1

data/lib/logidze/history/type.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'active_model/type'
+require "active_model/type"
 
 module Logidze
   class History

data/lib/logidze/history/version.rb

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
+
 module Logidze
   class History
     # Represents one log item
     class Version
       # Timestamp key
-      TS = 'ts'
+      TS = "ts"
       # Changes key
-      CHANGES = 'c'
+      CHANGES = "c"
       # Responsible ID
-      RESPONSIBLE = 'r'
+      RESPONSIBLE = "r"
       # Meta Responsible ID
-      META_RESPONSIBLE = '_r'
+      META_RESPONSIBLE = "_r"
       # Meta key
-      META = 'm'
+      META = "m"
 
       attr_reader :data
 

data/lib/logidze/ignore_log_data.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Logidze
+  module IgnoreLogData # :nodoc:
+    extend ActiveSupport::Concern
+
+    included do
+      if Rails::VERSION::MAJOR == 5
+        require "logidze/ignore_log_data/cast_attribute_patch"
+        include CastAttributePatch
+      end
+
+      scope :with_log_data, lambda {
+        if ignored_columns == ["log_data"]
+          select(arel_table[Arel.star])
+        else
+          select(column_names + [arel_table[:log_data]])
+        end
+      }
+    end
+  end
+end

data/lib/logidze/ignore_log_data/cast_attribute_patch.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Logidze
+  module IgnoreLogData
+    # Fixes unexpected behavior (see more https://github.com/rails/rails/pull/34528):
+    # instead of using a type passed to `attribute` call, ignored column uses
+    # a type coming from the DB (in this case `.log_data` would return a plain hash
+    # instead of `Logidze::History`)
+    module CastAttributePatch
+      def log_data
+        return attributes["log_data"] if attributes["log_data"].is_a?(Logidze::History)
+
+        self.log_data = Logidze::History::Type.new.cast_value(super)
+      end
+    end
+  end
+end

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)
+      meta = {Logidze::History::Version::META_RESPONSIBLE => responsible_id}
+      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/model.rb

@@ -1,45 +1,30 @@
 # frozen_string_literal: true
-require 'active_support'
+
+require "active_support"
 
 module Logidze
-  module Deprecations # :nodoc:
-    def self.show_ts_deprecation_for(meth)
-      warn(
-        "[Deprecation] Usage of #{meth}(time) will be removed in the future releases, "\
-        "use #{meth}(time: ts) instead"
-      )
-    end
-  end
+  using RubyNext
 
   # Extends model with methods to browse history
-  # rubocop: disable Metrics/ModuleLength
   module Model
-    require 'logidze/history/type' if Rails::VERSION::MAJOR >= 5
+    require "logidze/history/type"
 
     extend ActiveSupport::Concern
 
     included do
-      if Rails::VERSION::MAJOR < 5
-        serialize :log_data, Logidze::History
-      else
-        attribute :log_data, Logidze::History::Type.new
-      end
+      attribute :log_data, Logidze::History::Type.new
 
       delegate :version, to: :log_data, prefix: "log"
     end
 
     module ClassMethods # :nodoc:
       # Return records reverted to specified time
-      def at(ts = nil, time: nil, version: nil)
-        Deprecations.show_ts_deprecation_for(".at") if ts
-        time ||= ts
-        all.map { |record| record.at(time: time, version: version) }.compact
+      def at(time: nil, version: nil)
+        all.to_a.filter_map { |record| record.at(time: time, version: version) }
       end
 
       # Return changes made to records since specified time
-      def diff_from(ts = nil, time: nil, version: nil)
-        Deprecations.show_ts_deprecation_for(".diff_from") if ts
-        time ||= ts
+      def diff_from(time: nil, version: nil)
         all.map { |record| record.diff_from(time: time, version: version) }
       end
 
@@ -53,6 +38,33 @@ module Logidze
         true
       end
       # rubocop: enable Naming/PredicateName
+
+      # Nullify log_data column for a association
+      def reset_log_data
+        without_logging { update_all(log_data: nil) }
+      end
+
+      # Initialize log_data with the current state if it's null
+      def create_logidze_snapshot(timestamp: nil, only: nil, except: nil)
+        args = ["'null'"]
+
+        args[0] = "'#{timestamp}'" if timestamp
+
+        columns = only || except
+
+        if columns
+          args[1] = "'{#{columns.join(",")}}'"
+          args[2] = only ? "true" : "false"
+        end
+
+        without_logging do
+          where(log_data: nil).update_all(
+            <<~SQL
+              log_data = logidze_snapshot(to_jsonb(#{quoted_table_name}), #{args.join(", ")})
+            SQL
+          )
+        end
+      end
     end
 
     # Use this to convert Ruby time to milliseconds
@@ -64,14 +76,15 @@ module Logidze
     # If time/version is less then the first version, then return nil.
     # If time/version is greater then the last version, then return self.
     # rubocop: disable Metrics/MethodLength
-    def at(ts = nil, time: nil, version: nil)
-      Deprecations.show_ts_deprecation_for("#at") if ts
-
+    def at(time: nil, version: nil)
       return at_version(version) if version
 
-      time ||= ts
       time = parse_time(time)
 
+      unless log_data
+        return Logidze.return_self_if_log_data_is_empty ? self : nil
+      end
+
       return nil unless log_data.exists_ts?(time)
 
       if log_data.current_ts?(time)
@@ -86,12 +99,11 @@ module Logidze
     # rubocop: enable Metrics/MethodLength
 
     # Revert record to the version at specified time (without saving to DB)
-    def at!(ts = nil, time: nil, version: nil)
-      Deprecations.show_ts_deprecation_for("#at!") if ts
-
+    def at!(time: nil, version: nil)
       return at_version!(version) if version
 
-      time ||= ts
+      raise ArgumentError, "#log_data is empty" unless log_data
+
       time = parse_time(time)
 
       return self if log_data.current_ts?(time)
@@ -114,6 +126,8 @@ module Logidze
 
     # Revert record to the specified version (without saving to DB)
     def at_version!(version)
+      raise ArgumentError, "#log_data is empty" unless log_data
+
       return self if log_data.version == version
       return false unless log_data.find_by_version(version)
 
@@ -126,17 +140,15 @@ module Logidze
     #
     #   post.diff_from(time: 2.days.ago) # or post.diff_from(version: 2)
     #   #=> { "id" => 1, "changes" => { "title" => { "old" => "Hello!", "new" => "World" } } }
-    def diff_from(ts = nil, version: nil, time: nil)
-      Deprecations.show_ts_deprecation_for("#diff_from") if ts
-      time ||= ts
+    def diff_from(version: nil, time: nil)
       time = parse_time(time) if time
-      changes = log_data.diff_from(time: time, version: version).tap do |v|
+      changes = log_data&.diff_from(time: time, version: version)&.tap do |v|
         deserialize_changes!(v)
-      end
+      end || {}
 
       changes.delete_if { |k, _v| deleted_column?(k) }
 
-      { "id" => id, "changes" => changes }
+      {"id" => id, "changes" => changes}
     end
 
     # Restore record to the previous version.
@@ -199,6 +211,22 @@ module Logidze
       log_data&.size || 0
     end
 
+    # Loads log_data field from the database, stores to the attributes hash and returns it
+    def reload_log_data
+      self.log_data = self.class.where(self.class.primary_key => id).pluck("#{self.class.table_name}.log_data").first
+    end
+
+    # Nullify log_data column for a single record
+    def reset_log_data
+      self.class.without_logging { update_column(:log_data, nil) }
+    end
+
+    def create_logidze_snapshot!(**opts)
+      self.class.where(self.class.primary_key => id).create_logidze_snapshot(**opts)
+
+      reload_log_data
+    end
+
     protected
 
     def apply_diff(version, diff)

data/lib/logidze/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Logidze
-  VERSION = "0.8.1"
+  VERSION = "1.0.0.rc1"
 end

data/lib/logidze/versioned_association.rb

@@ -12,7 +12,6 @@ end
 
 module Logidze # :nodoc: all
   module VersionedAssociation
-    # rubocop: disable Metrics/MethodLength, Metrics/AbcSize
     def load_target
       target = super
       return unless target

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logidze
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-22 00:00:00.000000000 Z
+date: 2020-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,98 +16,98 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: ammeter
+  name: ruby-next-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.3
-  type: :development
+        version: '0.9'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.3
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: ammeter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 1.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 1.1.3
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: fx
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -122,48 +122,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.4'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.59.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.59.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-md
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.3.8
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.3.8
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -178,66 +136,53 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-description: PostgreSQL JSON-based auditing
+description: PostgreSQL JSONB-based model changes tracking
 email:
 - dementiev.vm@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".hound.yml"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bench/performance/README.md
-- bench/performance/diff_bench.rb
-- bench/performance/insert_bench.rb
-- bench/performance/memory_profile.rb
-- bench/performance/setup.rb
-- bench/performance/update_bench.rb
-- bench/triggers/Makefile
-- bench/triggers/Readme.md
-- bench/triggers/bench.sql
-- bench/triggers/hstore_trigger_setup.sql
-- bench/triggers/jsonb_minus_2_setup.sql
-- bench/triggers/jsonb_minus_setup.sql
-- bench/triggers/keys2_trigger_setup.sql
-- bench/triggers/keys_trigger_setup.sql
-- bin/console
-- bin/setup
-- gemfiles/rails42.gemfile
-- gemfiles/rails5.gemfile
-- gemfiles/rails52.gemfile
-- gemfiles/railsmaster.gemfile
+- lib/generators/logidze/fx_helper.rb
+- lib/generators/logidze/inject_sql.rb
 - lib/generators/logidze/install/USAGE
+- lib/generators/logidze/install/functions/logidze_compact_history.sql
+- lib/generators/logidze/install/functions/logidze_filter_keys.sql
+- lib/generators/logidze/install/functions/logidze_logger.sql
+- lib/generators/logidze/install/functions/logidze_snapshot.sql
+- lib/generators/logidze/install/functions/logidze_version.sql
 - lib/generators/logidze/install/install_generator.rb
 - lib/generators/logidze/install/templates/hstore.rb.erb
 - lib/generators/logidze/install/templates/migration.rb.erb
+- lib/generators/logidze/install/templates/migration_fx.rb.erb
 - lib/generators/logidze/model/USAGE
 - lib/generators/logidze/model/model_generator.rb
 - lib/generators/logidze/model/templates/migration.rb.erb
+- lib/generators/logidze/model/triggers/logidze.sql
 - lib/logidze.rb
 - lib/logidze/engine.rb
 - lib/logidze/has_logidze.rb
 - lib/logidze/history.rb
 - lib/logidze/history/type.rb
 - lib/logidze/history/version.rb
+- lib/logidze/ignore_log_data.rb
+- lib/logidze/ignore_log_data/cast_attribute_patch.rb
 - lib/logidze/meta.rb
-- lib/logidze/migration.rb
 - lib/logidze/model.rb
 - lib/logidze/version.rb
 - lib/logidze/versioned_association.rb
-- logidze.gemspec
 homepage: http://github.com/palkan/logidze
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: http://github.com/palkan/logidze/issues
+  changelog_uri: https://github.com/palkan/logidze/blob/master/CHANGELOG.md
+  documentation_uri: http://github.com/palkan/logidze
+  homepage_uri: http://github.com/palkan/logidze
+  source_code_uri: http://github.com/palkan/logidze
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -246,16 +191,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
-summary: PostgreSQL JSON-based auditing
+summary: PostgreSQL JSONB-based model changes tracking
 test_files: []