logidze 0.9.0 → 0.10.0

data/lib/logidze.rb

@@ -1,40 +1,66 @@
 # frozen_string_literal: true
+
 require "logidze/version"
 
 # Logidze provides tools for adding in-table JSON-based audit to DB tables
 # and ActiveRecord extensions to work with changes history.
 module Logidze
-  require 'logidze/history'
-  require 'logidze/model'
-  require 'logidze/versioned_association'
-  require 'logidze/ignore_log_data'
-  require 'logidze/has_logidze'
-  require 'logidze/meta'
+  require "logidze/history"
+  require "logidze/model"
+  require "logidze/versioned_association"
+  require "logidze/ignore_log_data"
+  require "logidze/has_logidze"
+  require "logidze/meta"
 
   extend Logidze::Meta
 
-  require 'logidze/engine' if defined?(Rails)
+  require "logidze/engine" if defined?(Rails)
 
   class << self
     # Determines if Logidze should append a version to the log after updating an old version.
     attr_accessor :append_on_undo
+
     attr_writer :associations_versioning
 
     def associations_versioning
       @associations_versioning || false
     end
-  end
 
-  # Temporary disable DB triggers.
-  #
-  # @example
-  #   Logidze.without_logging { Post.update_all(active: true) }
-  def self.without_logging
-    ActiveRecord::Base.transaction do
-      ActiveRecord::Base.connection.execute "SET LOCAL logidze.disabled TO on;"
-      res = yield
-      ActiveRecord::Base.connection.execute "SET LOCAL logidze.disabled TO DEFAULT;"
-      res
+    # Determines if Logidze should exclude log data from SELECT statements
+    attr_writer :ignore_log_data_by_default
+
+    def ignore_log_data_by_default
+      @ignore_log_data_by_default || false
+    end
+
+    attr_writer :force_load_log_data
+
+    def force_load_log_data
+      @force_load_log_data || false
+    end
+
+    # Temporary disable DB triggers.
+    #
+    # @example
+    #   Logidze.without_logging { Post.update_all(active: true) }
+    def without_logging
+      ActiveRecord::Base.transaction do
+        ActiveRecord::Base.connection.execute "SET LOCAL logidze.disabled TO on;"
+        res = yield
+        ActiveRecord::Base.connection.execute "SET LOCAL logidze.disabled TO DEFAULT;"
+        res
+      end
+    end
+
+    # Temporary turn off ignore_log_data_by_default config
+    #
+    # @example
+    #   Logidze.with_log_data { Post.update_all(active: true) }
+    def with_log_data
+      Logidze.force_load_log_data = true
+      yield
+    ensure
+      Logidze.force_load_log_data = false
     end
   end
 end

data/lib/logidze/engine.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require 'logidze'
+
+require "logidze"
 
 module Logidze
   class Engine < Rails::Engine # :nodoc:

data/lib/logidze/has_logidze.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require 'active_support'
+
+require "active_support"
 
 module Logidze
   # Add `has_logidze` method to AR::Base
@@ -9,10 +10,19 @@ module Logidze
     module ClassMethods # :nodoc:
       # Include methods to work with history.
       #
-      # rubocop:disable Naming/PredicateName
-      def has_logidze(ignore_log_data: false)
+      def has_logidze(ignore_log_data: nil)
         include Logidze::Model
-        include Logidze::IgnoreLogData if ignore_log_data
+        include Logidze::IgnoreLogData
+
+        @ignore_log_data = ignore_log_data
+      end
+
+      def ignores_log_data?
+        if @ignore_log_data.nil? && Logidze.ignore_log_data_by_default
+          !Logidze.force_load_log_data
+        else
+          @ignore_log_data
+        end
       end
     end
   end

data/lib/logidze/history.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
-require 'active_support/core_ext/module/delegation'
+
+require "active_support/core_ext/module/delegation"
 
 module Logidze
   # Log data wrapper
   class History
-    require 'logidze/history/version'
+    require "logidze/history/version"
 
     # History key
-    HISTORY = 'h'
+    HISTORY = "h"
     # Version key
-    VERSION = 'v'
+    VERSION = "v"
 
     attr_reader :data
 
@@ -128,7 +129,7 @@ module Logidze
 
     def build_changes(a, b)
       b.each_with_object({}) do |(k, v), acc|
-        acc[k] = { "old" => a[k], "new" => v } unless v == a[k]
+        acc[k] = {"old" => a[k], "new" => v} unless v == a[k]
       end
     end
 

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

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
+require "logidze/ignore_log_data/association"
+
 module Logidze
-  # Add `has_logidze` method to AR::Base
-  module IgnoreLogData
+  module IgnoreLogData # :nodoc:
     extend ActiveSupport::Concern
 
     included do
@@ -16,15 +17,41 @@ module Logidze
 
         require "logidze/ignore_log_data/missing_attribute_patch"
         include MissingAttributePatch
+
+        require "logidze/ignore_log_data/default_scope_patch"
+        include DefaultScopePatch
       end
 
       self.ignored_columns += ["log_data"]
+
+      scope :with_log_data, lambda {
+        if ignored_columns == ["log_data"]
+          select("*")
+        else
+          select(column_names + ["log_data"])
+        end
+      }
     end
 
     module ClassMethods # :nodoc:
-      def with_log_data
-        select(column_names + ["log_data"])
+      def self.default_scope
+        ignores_log_data? ? super : super.with_log_data
       end
     end
+
+    def association(name)
+      association = super
+
+      should_load_log_data =
+        attributes["log_data"] &&
+        association.klass.respond_to?(:has_logidze?) &&
+        !association.singleton_class.include?(Logidze::IgnoreLogData::Association)
+
+      return association unless should_load_log_data
+
+      association.singleton_class.prepend(Logidze::IgnoreLogData::Association)
+
+      association
+    end
   end
 end

data/lib/logidze/ignore_log_data/association.rb

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

data/lib/logidze/ignore_log_data/default_scope_patch.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Logidze
+  module IgnoreLogData
+    # Since Rails caches ignored_columns, we have to patch .column_names and
+    # .unscoped methods to make conditional log_data loading possible
+    module DefaultScopePatch
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def column_names
+          ignores_log_data? ? super : super + ["log_data"]
+        end
+
+        def unscoped
+          if ignores_log_data?
+            super
+          else
+            block_given? ? with_log_data.scoping { yield } : with_log_data
+          end
+        end
+      end
+    end
+  end
+end

data/lib/logidze/ignore_log_data/ignored_columns.rb

@@ -16,7 +16,7 @@ module Logidze
         private
 
         def build_select(arel)
-          if select_values.blank? && klass.ignored_columns.any?
+          if select_values.blank? && klass.ignored_columns.any? && ignores_log_data?
             arel.project(*arel_columns(klass.column_names - klass.ignored_columns))
           else
             super

data/lib/logidze/ignore_log_data/missing_attribute_patch.rb

@@ -7,7 +7,9 @@ module Logidze
     # from Rails 4 - raise ActiveModel::MissingAttributeError
     module MissingAttributePatch
       def log_data
-        raise ActiveModel::MissingAttributeError if attributes["log_data"].nil?
+        if self.class.ignores_log_data? && attributes["log_data"].nil?
+          raise ActiveModel::MissingAttributeError
+        end
 
         super
       end

data/lib/logidze/meta.rb

@@ -10,7 +10,7 @@ module Logidze # :nodoc:
     def with_responsible(responsible_id, &block)
       return yield if responsible_id.nil?
 
-      meta = { Logidze::History::Version::META_RESPONSIBLE => responsible_id }
+      meta = {Logidze::History::Version::META_RESPONSIBLE => responsible_id}
       with_meta(meta, &block)
     end
 

data/lib/logidze/migration.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Logidze
   # Contains helpers for handling different PG versions
   module Migration

data/lib/logidze/model.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require 'active_support'
+
+require "active_support"
 
 module Logidze
   module Deprecations # :nodoc:
@@ -12,9 +13,8 @@ module Logidze
   end
 
   # 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" if Rails::VERSION::MAJOR >= 5
 
     extend ActiveSupport::Concern
 
@@ -53,6 +53,11 @@ 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
     end
 
     # Use this to convert Ruby time to milliseconds
@@ -136,7 +141,7 @@ module Logidze
 
       changes.delete_if { |k, _v| deleted_column?(k) }
 
-      { "id" => id, "changes" => changes }
+      {"id" => id, "changes" => changes}
     end
 
     # Restore record to the previous version.
@@ -204,6 +209,11 @@ module Logidze
       self.log_data = self.class.where(self.class.primary_key => id).pluck(: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
+
     protected
 
     def apply_diff(version, diff)

data/lib/logidze/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Logidze
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 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

data/logidze.gemspec

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'logidze/version'
+require "logidze/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "logidze"
@@ -17,17 +18,24 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.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"
+  }
+
   spec.add_dependency "rails", ">= 4.2"
 
   spec.add_development_dependency "ammeter", "~> 1.1.3"
-  spec.add_development_dependency "bundler", "~> 1"
-  spec.add_development_dependency "database_cleaner", "~> 1.5"
-  spec.add_development_dependency "pg", "~>0.18"
-  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "bundler", ">= 1.10"
+  spec.add_development_dependency "pg", ">= 0.18"
   spec.add_development_dependency "rake", ">= 10.0"
   spec.add_development_dependency "rspec-rails", ">= 3.4"
-  spec.add_development_dependency "rubocop", "~> 0.60.0"
   spec.add_development_dependency "rubocop-md", "~> 0.2.0"
-  spec.add_development_dependency "simplecov", ">= 0.3.8"
+  spec.add_development_dependency "standard", "~> 0.0.39"
   spec.add_development_dependency "timecop", "~> 0.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logidze
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-28 00:00:00.000000000 Z
+date: 2019-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -42,58 +42,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-- !ruby/object:Gem::Dependency
-  name: database_cleaner
-  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
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.18'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.18'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
   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
@@ -122,20 +94,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.60.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.60.0
 - !ruby/object:Gem::Dependency
   name: rubocop-md
   requirement: !ruby/object:Gem::Requirement
@@ -151,19 +109,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.2.0
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.8
+        version: 0.0.39
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.8
+        version: 0.0.39
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -185,8 +143,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitattributes"
+- ".github/ISSUE_TEMPLATE.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
-- ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -195,6 +155,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- assets/pg_log_data_chart.png
 - bench/performance/README.md
 - bench/performance/diff_bench.rb
 - bench/performance/insert_bench.rb
@@ -214,6 +175,7 @@ files:
 - gemfiles/rails42.gemfile
 - gemfiles/rails5.gemfile
 - gemfiles/rails52.gemfile
+- gemfiles/rails6.gemfile
 - gemfiles/railsmaster.gemfile
 - lib/generators/logidze/install/USAGE
 - lib/generators/logidze/install/install_generator.rb
@@ -229,7 +191,9 @@ 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/default_scope_patch.rb
 - lib/logidze/ignore_log_data/ignored_columns.rb
 - lib/logidze/ignore_log_data/missing_attribute_patch.rb
 - lib/logidze/meta.rb
@@ -241,7 +205,12 @@ files:
 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:
@@ -250,15 +219,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: PostgreSQL JSON-based auditing