logidze 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56aa14f81cc160897376ed2b226664fc3a93c5f4becedb7d5a45abd197d03388
-  data.tar.gz: 5e196a2ef847e0e1d6069e793fb726f35166f05be007d9c4e4cfde2318b2cd3a
+  metadata.gz: 75f1f01b10a1e35d8b656a27f3d71b0e1d2f81c826338fa89d36d76ac03363b9
+  data.tar.gz: 3812d6d4b49d2fe803acc61854b1ca891ec816bbd4a3e05ff60e02bc62393ac0
 SHA512:
-  metadata.gz: f8871956c3f1439fdd5cc3bb810e612a75145a49cf7f43a039b92915a2edc2ab57bb49a7bd5a4a14a48863696f37d8afcce4f052b2c620b01ffd5a179398fc30
-  data.tar.gz: 15440ace63434523644340155bd26bdb55acb906993b4b6014d1dd8d0f0e498d4e34709bc144bb3da260c8e509f336dc68c9100cc37568d3354d025a9d88cf39
+  metadata.gz: 7b38094dd8e8b7de7295b354e0906067641080e90169f0222b163b43a491672921eff25a78062680650e1e8565727d01dcd4694a84fecbeb7ff60a918d2fbe6c
+  data.tar.gz: 7ba5a0605b9b45e63bb6c02b9d18b05f78331369ed4aeb2564434d1e627013e360b1ef0ab2f2fdd94203de6ed341d3136d800e2b8aa838d6fe6c501eecb5d98d

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 ## master (unreleased)
 
+## 0.11.0 (2019-08-15)
+
+- **Breaking** Return `nil` when `log_data` is not loaded instead of raising an exception. ([@palkan][])
+
+We cannot distinguish between not loaded `log_data` and not-yet-created (i.e. for new records).
+The latter could be used in frameworks/gems ([example](https://github.com/palkan/logidze/issues/127#issuecomment-518798640)).
+
+- **Breaking** Only allow specifying `ignore_log_data` at boot time without runtime modifications. ([@palkan][])
+
+Playing with ActiveRecord default scopes wasn't a good idea. We fallback to a more explicit way of _telling_ AR
+when to load or ignore the `log_data` column.
+
+This change removes `Logidze.with_log_data` method.
+
 ## 0.10.0 (2019-05-15)
 
 - **Ruby >= 2.4 is required**

data/README.md

@@ -13,6 +13,7 @@ Currently, only PostgreSQL 9.5+ is supported (for PostgreSQL 9.4 try [jsonbx](ht
 [How is Logidze pronounced?](https://github.com/palkan/logidze/issues/73)
 
 Other requirements:
+
 - Ruby ~> 2.1
 - Rails >= 4.2 (**Rails 6 is supported**)
 
@@ -73,9 +74,9 @@ You can log only particular columns changes. There are mutually exclusive `black
 
 ```sh
 # track all columns, except `created_at` and `active`
-rails generate logidze:model Post --blacklist=created_at active
+rails generate logidze:model Post --blacklist=created_at,active
 # track only `title` and `body` columns
-rails generate logidze:model Post --whitelist=title body
+rails generate logidze:model Post --whitelist=title,body
 ```
 
 By default, Logidze tries to infer the path to the model file from the model name and may fail, for example, if you have unconventional project structure. In that case, you should specify the path explicitly:
@@ -98,7 +99,7 @@ rails generate logidze:model Post --timestamp_column nil # "null" and "false" wi
 If you want to update Logidze settings for the model, run migration with `--update` flag:
 
 ```sh
-rails generate logidze:model Post --update --whitelist=title body rating
+rails generate logidze:model Post --update --whitelist=title,body,rating
 ```
 
 Logidze also supports associations versioning. It is an experimental feature and disabled by default. You can learn more
@@ -115,7 +116,6 @@ Here is a quick and straightforward [workaround](https://github.com/palkan/logid
 
 Nevertheless, you still need super-user privileges to enable `hstore` extension (or you can use [PostgreSQL Extension Whitelisting](https://github.com/dimitri/pgextwlist)).
 
-
 ## Upgrade from previous versions
 
 We try to make an upgrade process as simple as possible. For now, the only required action is to create and run a migration:
@@ -198,8 +198,8 @@ create a new version with old data. Caveat: when switching to a newer version, `
 
 ```ruby
 post = Post.create!(title: "first post") # v1
-post.update!(title: "new title")         # v2
-post.undo!(append: true)                 # v3 (with same attributes as v1)
+post.update!(title: "new title") # v2
+post.undo!(append: true) # v3 (with same attributes as v1)
 ```
 
 Note that `redo!` will not work after `undo!(append: true)` because the latter will create a new version
@@ -227,29 +227,27 @@ class User < ActiveRecord::Base
 end
 ```
 
-If you want Logidze always to behave this way - you can set up a global configuration option:
+If you want Logidze to behave this way by default, configure the global option:
 
 ```ruby
-Rails.application.config.logidze.ignore_log_data_by_default = true
-```
+# config/initializers/logidze.rb
+Logidze.ignore_log_data_by_default = true
 
-However, you can override it by explicitly passing `ignore_log_data: false` to the `ignore_log_data`. Also, it's possible to change it temporary inside the block:
+# or
 
-```ruby
-Logidze.with_log_data do
-  Post.find(params[:id]).log_data
-end
+# config/application.rb
+config.logidze.ignore_log_data_by_default = true
 ```
 
-When `ignore_log_data` is turned on, each time you use `User.all` (or any other Relation method) `log_data` won't be loaded from the DB.
+However, you can override it by explicitly passing `ignore_log_data: false` to the `ignore_log_data`.
+You can also enforce loading `log_data` in-place by using the `.with_log_data` scope, e.g. `User.all.with_log_data` loads all
+the _users_ with `log_data` included.
 
 The chart below shows the difference in PG query time before and after turning `ignore_log_data` on. (Special thanks to [@aderyabin](https://github.com/aderyabin) for sharing it.)
 
 ![](./assets/pg_log_data_chart.png)
 
-If you try to call `#log_data` on the model loaded in such way, you'll get `ActiveModel::MissingAttributeError`, but if you really need it (e.g., during the console debugging) - use **`user.reload_log_data`**, which forces loading the column from the DB.
-
-If you need to select `log_data` during the initial load-use a special scope `User.with_log_data`.
+If you try to call `#log_data` on the model loaded in such way, you'll get `nil`. If you want to fetch log data (e.g., during the console debugging)–use **`user.reload_log_data`**, which forces loading this column from the DB.
 
 ## Track meta information
 

data/lib/logidze.rb

@@ -33,12 +33,6 @@ module Logidze
       @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
@@ -51,16 +45,5 @@ module Logidze
         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

@@ -4,6 +4,8 @@ require "logidze"
 
 module Logidze
   class Engine < Rails::Engine # :nodoc:
+    config.logidze = Logidze
+
     initializer "extend ActiveRecord with Logidze" do |_app|
       ActiveSupport.on_load(:active_record) do
         ActiveRecord::Base.send :include, Logidze::HasLogidze

data/lib/logidze/has_logidze.rb

@@ -10,19 +10,17 @@ module Logidze
     module ClassMethods # :nodoc:
       # Include methods to work with history.
       #
-      def has_logidze(ignore_log_data: nil)
+      def has_logidze(ignore_log_data: Logidze.ignore_log_data_by_default)
         include Logidze::Model
         include Logidze::IgnoreLogData
 
         @ignore_log_data = ignore_log_data
+
+        self.ignored_columns += ["log_data"] if @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
+        @ignore_log_data
       end
     end
   end

data/lib/logidze/ignore_log_data.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "logidze/ignore_log_data/association"
-
 module Logidze
   module IgnoreLogData # :nodoc:
     extend ActiveSupport::Concern
@@ -9,49 +7,18 @@ module Logidze
     included do
       if Rails::VERSION::MAJOR == 4
         require "logidze/ignore_log_data/ignored_columns"
-      else
-        if Rails::VERSION::MAJOR == 5
-          require "logidze/ignore_log_data/cast_attribute_patch"
-          include CastAttributePatch
-        end
-
-        require "logidze/ignore_log_data/missing_attribute_patch"
-        include MissingAttributePatch
-
-        require "logidze/ignore_log_data/default_scope_patch"
-        include DefaultScopePatch
+      elsif Rails::VERSION::MAJOR == 5
+        require "logidze/ignore_log_data/cast_attribute_patch"
+        include CastAttributePatch
       end
 
-      self.ignored_columns += ["log_data"]
-
       scope :with_log_data, lambda {
         if ignored_columns == ["log_data"]
-          select("*")
+          select(arel_table[Arel.star])
         else
-          select(column_names + ["log_data"])
+          select(column_names + [arel_table[:log_data]])
         end
       }
     end
-
-    module ClassMethods # :nodoc:
-      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/version.rb

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

data/logidze.gemspec

@@ -5,17 +5,17 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "logidze/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "logidze"
-  spec.version       = Logidze::VERSION
-  spec.authors       = ["palkan"]
-  spec.email         = ["dementiev.vm@gmail.com"]
+  spec.name = "logidze"
+  spec.version = Logidze::VERSION
+  spec.authors = ["palkan"]
+  spec.email = ["dementiev.vm@gmail.com"]
 
-  spec.summary       = "PostgreSQL JSON-based auditing"
-  spec.description   = "PostgreSQL JSON-based auditing"
-  spec.homepage      = "http://github.com/palkan/logidze"
-  spec.license       = "MIT"
+  spec.summary = "PostgreSQL JSON-based auditing"
+  spec.description = "PostgreSQL JSON-based auditing"
+  spec.homepage = "http://github.com/palkan/logidze"
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  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"
@@ -36,6 +36,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", ">= 10.0"
   spec.add_development_dependency "rspec-rails", ">= 3.4"
   spec.add_development_dependency "rubocop-md", "~> 0.2.0"
-  spec.add_development_dependency "standard", "~> 0.0.39"
+  spec.add_development_dependency "standard", "~> 0.1.2"
   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.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-15 00:00:00.000000000 Z
+date: 2019-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.39
+        version: 0.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.39
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -193,9 +193,7 @@ files:
 - 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
 - lib/logidze/migration.rb
 - lib/logidze/model.rb
@@ -226,7 +224,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: PostgreSQL JSON-based auditing

data/lib/logidze/ignore_log_data/default_scope_patch.rb

@@ -1,25 +0,0 @@
-# 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/missing_attribute_patch.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Logidze
-  module IgnoreLogData
-    # Rails attribute API defines attributes in a way, that it returns nil
-    # when data has not been loaded from the DB. We want it to imitate the behavior
-    # from Rails 4 - raise ActiveModel::MissingAttributeError
-    module MissingAttributePatch
-      def log_data
-        if self.class.ignores_log_data? && attributes["log_data"].nil?
-          raise ActiveModel::MissingAttributeError
-        end
-
-        super
-      end
-    end
-  end
-end