logidze 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 571e06644d88083ccf41f25a69c13530436055233406337c7458f8cdbb6d86f0
-  data.tar.gz: f7301fee68a37cfb436a2b3f1ad80ebb8e375b8bc936ee39894f036273edbf35
+  metadata.gz: 0f853c7aed1f6d284150d85530b3fdc0fb8f59b856a4d962e35004507cb8c7f7
+  data.tar.gz: 513c193a93b6ff059a27463ee96ab754cb88d995b74a8c73b2abf16441aad346
 SHA512:
-  metadata.gz: 4430563010f78a5f467fad89a260ba0a299d5ac892d4ca63728f4a0dd1ff2e7cb210fa05c2aba513298fd069fbd951c930aeedfd2f401e9e15af1cde6081a302
-  data.tar.gz: 336576627fc5c4b54fadcc531406579328497bff61b4db47973a442b6b7ae0710d7f0f953da360dbe0f4e22abfeeadfe411c342919d0ab212a73bfae7a2731b5
+  metadata.gz: 54443a9ddd4b9bea05a9f6e8acd5f0549c359f2476e93d6cb11452597ba8d0b2580b4ac3db78a0bc78e0ec01f368e9e8c6c0de08868e4d6e7679641515c22329
+  data.tar.gz: 27f28a1e2b8be8b9eb8095ef8ffd192e4397ff3389298cf290991fc76de7998f9c512fe1d153505dfdd6a69186b06365d5085c71d03472b573ec3c6cb3f523b3

data/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 ## master
 
+## 0.9.0 (2018-11-28)
+
+- PR [#98](https://github.com/palkan/logidze/pull/98) Add `:ignore_log_data` option to `#has_logidze` ([@dmitrytsepelev][])
+
+Usage:
+
+```ruby
+class User < ActiveRecord::Base
+  has_logidze ignore_log_data: true
+end
+
+User.all #=> SELECT id, name FROM users
+
+User.with_log_data #=> SELECT id, name, log_data FROM users
+
+user = User.find(params[:id])
+user.log_data #=> ActiveModel::MissingAttributeError
+user.reload_log_data #=> Logidze::History
+```
+
+## 0.8.1 (2018-10-22)
+
+- [PR #93](https://github.com/palkan/logidze/pull/93)] Return 0 for log size when log_data is nil ([@duderman][])
+
 ## 0.8.0 (2018-10-01)
 
 - [PR [#87](https://github.com/palkan/logidze/pull/87)] Adding debounce time to avoid spamming changelog creation ([@zocoi][])
@@ -211,3 +235,4 @@ This is a quick fix for a more general problem (see [#59](https://github.com/pal
 [@ankursethi-uscis]: https://github.com/ankursethi-uscis
 [@dmitrytsepelev]: https://github.com/DmitryTsepelev
 [@zocoi]: https://github.com/zocoi
+[@duderman]: https://github.com/duderman

data/README.md

@@ -186,6 +186,12 @@ post.redo!
 post.switch_to!(2)
 ```
 
+You can initiate reloading of `log_data` from the DB:
+
+```ruby
+post.reload_log_data # => returns the latest log data value
+```
+
 Normally, if you update record after `#undo!` or `#switch_to!` you lose all "future" versions and `#redo!` is no
 longer possible. However, you can provide an `append: true` option to `#undo!` or `#switch_to!`, which will
 create a new version with old data. Caveat: when switching to a newer version, `append` will have no effect.
@@ -204,6 +210,16 @@ Alternatively, you can configure Logidze to always default to `append: true`.
 Logidze.append_on_undo = true
 ```
 
+If you want to reduce the data loaded from the DB, you can turn off automatic loading of `log_data` column in the following way:
+
+```ruby
+class User < ActiveRecord::Base
+  has_logidze ignore_log_data: true
+end
+```
+
+After that, each time you use `User.all` (or any other relation method) `log_data` won't be loaded from the DB. If you try to call `#log_data` on the model loaded in a 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`.
+
 
 ## Track meta information
 

data/lib/logidze.rb

@@ -7,6 +7,7 @@ module Logidze
   require 'logidze/history'
   require 'logidze/model'
   require 'logidze/versioned_association'
+  require 'logidze/ignore_log_data'
   require 'logidze/has_logidze'
   require 'logidze/meta'
 

data/lib/logidze/has_logidze.rb

@@ -10,8 +10,9 @@ module Logidze
       # Include methods to work with history.
       #
       # rubocop:disable Naming/PredicateName
-      def has_logidze
+      def has_logidze(ignore_log_data: false)
         include Logidze::Model
+        include Logidze::IgnoreLogData if ignore_log_data
       end
     end
   end

data/lib/logidze/ignore_log_data.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Logidze
+  # Add `has_logidze` method to AR::Base
+  module IgnoreLogData
+    extend ActiveSupport::Concern
+
+    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
+      end
+
+      self.ignored_columns += ["log_data"]
+    end
+
+    module ClassMethods # :nodoc:
+      def with_log_data
+        select(column_names + ["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/ignore_log_data/ignored_columns.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Logidze
+  module IgnoreLogData
+    # Backports ignored_columns functionality to Rails < 5
+    module IgnoredColumns
+      module Base # :nodoc:
+        attr_writer :ignored_columns
+
+        def ignored_columns
+          @ignored_columns ||= []
+        end
+      end
+
+      module Relation # :nodoc:
+        private
+
+        def build_select(arel)
+          if select_values.blank? && klass.ignored_columns.any?
+            arel.project(*arel_columns(klass.column_names - klass.ignored_columns))
+          else
+            super
+          end
+        end
+      end
+
+      module Table # :nodoc:
+        def columns
+          super.reject { |column| ignored_columns.include?(column.name) }
+        end
+
+        private
+
+        def ignored_columns
+          node.base_klass.ignored_columns
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.extend(Logidze::IgnoreLogData::IgnoredColumns::Base)
+ActiveRecord::Relation.include(Logidze::IgnoreLogData::IgnoredColumns::Relation)
+ActiveRecord::Associations::JoinDependency::Aliases::Table.prepend(
+  Logidze::IgnoreLogData::IgnoredColumns::Table
+)

data/lib/logidze/ignore_log_data/missing_attribute_patch.rb

@@ -0,0 +1,16 @@
+# 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
+        raise ActiveModel::MissingAttributeError if attributes["log_data"].nil?
+
+        super
+      end
+    end
+  end
+end

data/lib/logidze/model.rb

@@ -199,6 +199,11 @@ 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(:log_data).first
+    end
+
     protected
 
     def apply_diff(version, diff)

data/lib/logidze/version.rb

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

data/logidze.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake", ">= 10.0"
   spec.add_development_dependency "rspec-rails", ">= 3.4"
-  spec.add_development_dependency "rubocop", "~> 0.59.0"
+  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 "timecop", "~> 0.8"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logidze
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - palkan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-22 00:00:00.000000000 Z
+date: 2018-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.0
+        version: 0.60.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.0
+        version: 0.60.0
 - !ruby/object:Gem::Dependency
   name: rubocop-md
   requirement: !ruby/object:Gem::Requirement
@@ -228,6 +228,10 @@ files:
 - 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/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