active_record-updated_at 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11b3013f3d9c32bc668986d89b880ea877a10bd3
-  data.tar.gz: 085d518fa7940abd8e894604bf60103d00ce3cb2
+  metadata.gz: 395371ee4b162e5c5bf8235811222b4097e6ead7
+  data.tar.gz: d2b3362724771f82de0efb358348025eaf937da7
 SHA512:
-  metadata.gz: 32d49111d8517931ae445b3a36eee57fbc290323377aa357bcc2baba6bf6fb464262a8468f5a125d9b43fd77012efef5d2d7b73cd63ced9079cc2ea9ba2b9c02
-  data.tar.gz: e1004fd0bf6cc3b0794042eadceca4db61ae8f544b2f4d19c8145f2ede0d993c18da5377a23c886f2d80ac2ab1ca7bd9675d40e9e3c40172d4736c3a8cc1b658
+  metadata.gz: b859883939d611983f98be7d5495e0aaad6888f443548ac7a5fb8bf05e17ba9f5b95ef72d7ff7b006eb982b857e0728c71c53a75f2d5b53f290761fdd98d0f0b
+  data.tar.gz: 5d9496e37271d9e5c1e0c1b84a03be46cb4b98bd6c6aaaf519d4e0c07abbdc5b037925d85dbcee7eaaf6702cdafcf6357cc2a34878c05514b6eba88e79fdb81f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_record-updated_at (0.0.0)
+    active_record-updated_at (0.0.1)
       activerecord
 
 GEM

data/README.md

@@ -19,11 +19,11 @@ The default `ActiveRecord` behavior does not touch `updated_at` when the followi
 * `ActiveRecord::Base#update_columns`
 * `ActiveRecord::Relation#update_all`
 
-We **rarely ever have a case to modify data WITHOUT touching `updated_at`** so this gem enables the touching behavior by default. For those rare occassions that we don't want the touching we can call these alternative methods to explicitly disable it:
+We **rarely ever have a case to modify data WITHOUT touching `updated_at`** so this gem enables the touching behavior by default. For those rare occassions that we don't want the touching we can wrap these calls in a `disable` block explicitly:
 
-* `ActiveRecord::Base#update_column_without_updated_at`
-* `ActiveRecord::Base#update_columns_without_updated_at`
-* `ActiveRecord::Relation#update_all_without_updated_at`
+```ruby
+ActiveRecord::UpdatedAt.disable { User.update_all(role: "member") }
+```
 
 **If `updated_at` is explicitly specified then the UPDATE query is not modified**.
 
@@ -38,7 +38,7 @@ User.update_all(role: "member", updated_at: 1.day.ago)
 User.update_all(role: "member", updated_at: nil)
 
 # This doesn't touch `updated_at`
-User.update_all_without_updated_at(role: "member")
+ActiveRecord::UpdatedAt.disable { User.update_all(role: "member") }
 ```
 
 ## Testing

data/active_record-updated_at.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 2.0.0"
   s.summary               = "Touch `updated_at` by default with calls to `update_column(s)` and `update_all`"
   s.test_files            = `git ls-files -- spec/*`.split("\n")
-  s.version               = "0.0.0"
+  s.version               = "0.0.1"
 
   s.add_dependency "activerecord"
 end

data/lib/active_record/updated_at/relation.rb

@@ -1,19 +1,13 @@
 module ActiveRecord
   module UpdatedAt
     module Relation
-      extend ActiveSupport::Concern
-
-      included do
-        alias_method :update_all_without_updated_at, :update_all
-        alias_method :update_all, :update_all_with_updated_at
-      end
-
-      def update_all_with_updated_at(query, *args, &block)
+      def update_all(query, *args, &block)
         attribute_exists = column_names.include?("updated_at")
         already_specified = Array(query).flatten.grep(/\bupdated_at\b/).any?
+        enabled = UpdatedAt.enabled?
         updated_at = Time.current
 
-        if attribute_exists && !already_specified
+        if attribute_exists && !already_specified && enabled
           case query
           when Array
             query.first << ", updated_at = ?"
@@ -25,7 +19,7 @@ module ActiveRecord
           end
         end
 
-        update_all_without_updated_at(query, *args, &block)
+        super
       end
     end
   end

data/lib/active_record-updated_at.rb

@@ -1,9 +1,26 @@
 require "active_record"
-require_relative "active_record/updated_at/model"
 require_relative "active_record/updated_at/relation"
 
 module ActiveRecord
-  Base.send(:include, UpdatedAt::Model)
-  Relation.send(:include, UpdatedAt::Relation)
-  Querying.delegate(:update_all_with_updated_at, :update_all_without_updated_at, to: :all)
+  module UpdatedAt
+    ActiveRecord::Relation.send(:prepend, Relation)
+
+    class << self
+      def disable(state = true)
+        disabled_was = @disabled
+        @disabled = state
+        yield
+      ensure
+        @disabled = disabled_was
+      end
+
+      def enable(&block)
+        disable(false, &block)
+      end
+
+      def enabled?
+        !@disabled
+      end
+    end
+  end
 end

data/spec/active_record-updated_at_spec.rb

@@ -4,6 +4,20 @@ RSpec.describe ActiveRecord::UpdatedAt do
   let!(:user) { User.create!(name: "test") }
   let!(:timestamp) { 1.day.ago }
 
+  describe "#enabled" do
+    it "can be nested with disable blocks" do
+      expect(described_class).to be_enabled
+
+      described_class.disable do
+        expect(described_class).not_to be_enabled
+        described_class.enable { expect(described_class).to be_enabled }
+        expect(described_class).not_to be_enabled
+      end
+
+      expect(described_class).to be_enabled
+    end
+  end
+
   describe "#update_all" do
     context "with an array" do
       it "touches updated_at" do
@@ -19,7 +33,7 @@ RSpec.describe ActiveRecord::UpdatedAt do
       end
 
       it "does not touch updated_at with workaround method" do
-        User.update_all_without_updated_at(["name = ?", "changed"])
+        described_class.disable { User.update_all(["name = ?", "changed"]) }
         expect(reloaded.name).to eq("changed")
         expect(reloaded.updated_at).to eq(user.updated_at)
       end
@@ -39,7 +53,7 @@ RSpec.describe ActiveRecord::UpdatedAt do
       end
 
       it "does not touch updated_at with workaround method" do
-        User.update_all_without_updated_at(name: "changed")
+        described_class.disable { User.update_all(name: "changed") }
         expect(reloaded.name).to eq("changed")
         expect(reloaded.updated_at).to eq(user.updated_at)
       end
@@ -60,7 +74,7 @@ RSpec.describe ActiveRecord::UpdatedAt do
       end
 
       it "does not touch updated_at with workaround method" do
-        User.update_all_without_updated_at("name = 'changed'")
+        described_class.disable { User.update_all("name = 'changed'") }
         expect(reloaded.name).to eq("changed")
         expect(reloaded.updated_at).to eq(user.updated_at)
       end
@@ -80,7 +94,7 @@ RSpec.describe ActiveRecord::UpdatedAt do
     end
 
     it "does not touch updated_at with workaround method" do
-      user.update_column_without_updated_at(:name, "changed")
+      described_class.disable { user.update_column(:name, "changed") }
       expect(reloaded.name).to eq("changed")
       expect(reloaded.updated_at).to eq(user.updated_at)
     end
@@ -100,7 +114,7 @@ RSpec.describe ActiveRecord::UpdatedAt do
     end
 
     it "does not touch updated_at with workaround method" do
-      user.update_columns_without_updated_at(name: "changed")
+      described_class.disable { user.update_columns(name: "changed") }
       expect(reloaded.name).to eq("changed")
       expect(reloaded.updated_at).to eq(user.updated_at)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record-updated_at
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - LendingHome
@@ -45,7 +45,6 @@ files:
 - bin/test
 - docker-compose.yml
 - lib/active_record-updated_at.rb
-- lib/active_record/updated_at/model.rb
 - lib/active_record/updated_at/relation.rb
 - spec/active_record-updated_at_spec.rb
 - spec/internal/app/models/user.rb

data/lib/active_record/updated_at/model.rb

@@ -1,27 +0,0 @@
-module ActiveRecord
-  module UpdatedAt
-    module Model
-      extend ActiveSupport::Concern
-
-      included do
-        alias_method :update_columns_without_updated_at, :update_columns
-        alias_method :update_columns, :update_columns_with_updated_at
-      end
-
-      def update_column_without_updated_at(attribute, value)
-        update_columns_without_updated_at(attribute => value)
-      end
-
-      def update_columns_with_updated_at(attributes)
-        attribute_exists = has_attribute?(:updated_at)
-        already_specified = attributes.with_indifferent_access.key?(:updated_at)
-
-        if attribute_exists && !already_specified
-          attributes[:updated_at] = Time.current
-        end
-
-        update_columns_without_updated_at(attributes)
-      end
-    end
-  end
-end