active_record-events 4.1.0 → 4.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1eace6bdc4fb78e2ac6c90a8521c976f8b707caeed3e035da39d0218e0724ad7
-  data.tar.gz: 8e9754766994b37d29dd29a9a44963fa9c90b1d4f90418e8e06bf3863f32ea02
+  metadata.gz: fdd9b91dd64522db4ca3d1d4da95870d2118d948b88f77f2c2e4ab729b1ab49f
+  data.tar.gz: 2a05bbc38a682f65f40dab0d55b1bf070d0f9905f543df2c7de1c5bd563704f8
 SHA512:
-  metadata.gz: 1260729b2209565867c7824850be4450b45565da6fc1d7864d247ff6fcc659b89f1969ef2f9530e2bfc7d8de934a90f3eab585c18fb2c0d8ec3809f8242a864f
-  data.tar.gz: b876227c57657edb00198bda46eb42e2b2aebdb39379cd61261c9586805a5e736575515b2ddbbd336ed7e1612b603b0f6c30982b3c8e721da9ef849a93f41a2f
+  metadata.gz: bce05e0ddc66b433962d60210d4924d80b78e91aba9571932f3cdcad9a1d0df339c0b4e201e7ef366684661e40b1d1c791a61438ed96225a33b58500cff68a40
+  data.tar.gz: e9cf9e1afe72c52c77736eae172b6d05dfd831c067d9f854ab18d7eb3727f21794bb11dc61ae5ccae974c26b32fac67111b99f774ecef634909976ba5cb9cb0f

data/README.md

@@ -1,4 +1,4 @@
-# ActiveRecord::Events [![Gem version](https://img.shields.io/gem/v/active_record-events)](https://rubygems.org/gems/active_record-events) [![Build status](https://img.shields.io/github/workflow/status/pienkowb/active_record-events/Test/develop)](https://github.com/pienkowb/active_record-events/actions/workflows/test.yml?query=branch%3Adevelop) [![Coverage status](https://img.shields.io/coveralls/github/pienkowb/active_record-events/develop)](https://coveralls.io/github/pienkowb/active_record-events) [![Maintainability status](https://img.shields.io/codeclimate/maintainability/pienkowb/active_record-events)](https://codeclimate.com/github/pienkowb/active_record-events)
+# ActiveRecord::Events [![Gem version](https://img.shields.io/gem/v/active_record-events)](https://rubygems.org/gems/active_record-events) [![Build status](https://img.shields.io/github/actions/workflow/status/pienkowb/active_record-events/test.yml?branch=develop)](https://github.com/pienkowb/active_record-events/actions/workflows/test.yml?query=branch%3Adevelop) [![Coverage status](https://img.shields.io/coveralls/github/pienkowb/active_record-events/develop)](https://coveralls.io/github/pienkowb/active_record-events) [![Maintainability status](https://img.shields.io/codeclimate/maintainability/pienkowb/active_record-events)](https://codeclimate.com/github/pienkowb/active_record-events)
 
 An ActiveRecord extension providing convenience methods for timestamp management.
 
@@ -229,6 +229,7 @@ end
 - [Oskar Janusz](https://github.com/oskaror)
 - [Mike Rogers](https://github.com/MikeRogers0)
 - [Spencer Rogers](https://github.com/serogers)
+- [Benno Bielmeier](https://github.com/bbenno)
 
 ## See also
 

data/lib/active_record/events/method_factory.rb

@@ -7,6 +7,7 @@ module ActiveRecord
         @options = options
         @naming = Naming.new(event_name, options)
         @strategy = options[:strategy].try(:to_sym)
+        @field_type = options[:field_type].try(:to_sym)
       end
 
       def instance_methods
@@ -21,11 +22,13 @@ module ActiveRecord
 
       def class_methods
         Module.new.tap do |module_|
-          define_collective_action_method(module_, naming)
+          time_class = field_type == :date ? Date : Time
+
+          define_collective_action_method(module_, naming, time_class)
 
           unless options[:skip_scopes]
-            define_scope_method(module_, naming, strategy)
-            define_inverse_scope_method(module_, naming, strategy)
+            define_scope_method(module_, naming, strategy, time_class)
+            define_inverse_scope_method(module_, naming, strategy, time_class)
           end
         end
       end
@@ -35,11 +38,12 @@ module ActiveRecord
       attr_reader :options
       attr_reader :naming
       attr_reader :strategy
+      attr_reader :field_type
 
       def define_predicate_method(module_, naming, strategy)
         module_.send(:define_method, naming.predicate) do
           if strategy == :time_comparison
-            self[naming.field].present? && self[naming.field].past?
+            self[naming.field].present? && !self[naming.field].future?
           else
             self[naming.field].present?
           end
@@ -68,32 +72,32 @@ module ActiveRecord
         end
       end
 
-      def define_collective_action_method(module_, naming)
+      def define_collective_action_method(module_, naming, time_class)
         module_.send(:define_method, naming.collective_action) do
           if respond_to?(:touch_all)
             touch_all(naming.field)
           else
-            update_all(naming.field => Time.current)
+            update_all(naming.field => time_class.current)
           end
         end
       end
 
-      def define_scope_method(module_, naming, strategy)
+      def define_scope_method(module_, naming, strategy, time_class)
         module_.send(:define_method, naming.scope) do
           if strategy == :time_comparison
-            where(arel_table[naming.field].lteq(Time.current))
+            where(arel_table[naming.field].lteq(time_class.current))
           else
             where(arel_table[naming.field].not_eq(nil))
           end
         end
       end
 
-      def define_inverse_scope_method(module_, naming, strategy)
+      def define_inverse_scope_method(module_, naming, strategy, time_class)
         module_.send(:define_method, naming.inverse_scope) do
           arel_field = arel_table[naming.field]
 
           if strategy == :time_comparison
-            where(arel_field.eq(nil).or(arel_field.gt(Time.current)))
+            where(arel_field.eq(nil).or(arel_field.gt(time_class.current)))
           else
             where(arel_field.eq(nil))
           end

data/lib/active_record/events/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Events
-    VERSION = '4.1.0'.freeze
+    VERSION = '4.1.2'.freeze
   end
 end

data/spec/active_record/events_spec.rb

@@ -74,47 +74,105 @@ RSpec.describe ActiveRecord::Events do
 
   describe 'time comparison strategy' do
     it 'defines a predicate method comparing against current time' do
-      task.update_columns(expired_at: 1.hour.from_now)
+      task.update!(expired_at: 1.hour.from_now)
       expect(task.expired?).to eq(false)
 
-      task.update_columns(expired_at: 1.hour.ago)
+      task.update!(expired_at: 1.hour.ago)
       expect(task.expired?).to eq(true)
 
-      task.update_columns(expired_at: nil)
+      task.update!(expired_at: nil)
       expect(task.expired?).to eq(false)
     end
 
     it 'defines an inverse predicate method comparing against current time' do
-      task.update_columns(expired_at: 1.hour.from_now)
+      task.update!(expired_at: 1.hour.from_now)
       expect(task.not_expired?).to eq(true)
 
-      task.update_columns(expired_at: 1.hour.ago)
+      task.update!(expired_at: 1.hour.ago)
       expect(task.not_expired?).to eq(false)
 
-      task.update_columns(expired_at: nil)
+      task.update!(expired_at: nil)
       expect(task.not_expired?).to eq(true)
     end
 
     it 'defines a scope comparing against current time' do
-      task.update_columns(expired_at: 1.hour.from_now)
+      task.update!(expired_at: 1.hour.from_now)
       expect(Task.expired).not_to include(task)
 
-      task.update_columns(expired_at: 1.hour.ago)
+      task.update!(expired_at: 1.hour.ago)
       expect(Task.expired).to include(task)
 
-      task.update_columns(expired_at: nil)
+      task.update!(expired_at: nil)
       expect(Task.expired).not_to include(task)
     end
 
     it 'defines an inverse scope comparing against current time' do
-      task.update_columns(expired_at: 1.hour.from_now)
+      task.update!(expired_at: 1.hour.from_now)
       expect(Task.not_expired).to include(task)
 
-      task.update_columns(expired_at: 1.hour.ago)
+      task.update!(expired_at: 1.hour.ago)
       expect(Task.not_expired).not_to include(task)
 
-      task.update_columns(expired_at: nil)
+      task.update!(expired_at: nil)
       expect(Task.not_expired).to include(task)
     end
+
+    context 'with a date field' do
+      it 'defines a predicate method comparing against current date' do
+        task.update!(notified_on: Date.yesterday)
+        expect(task.notified?).to eq(true)
+
+        task.update!(notified_on: Date.current)
+        expect(task.notified?).to eq(true)
+
+        task.update!(notified_on: Date.tomorrow)
+        expect(task.notified?).to eq(false)
+
+        task.update!(notified_on: nil)
+        expect(task.notified?).to eq(false)
+      end
+
+      it 'defines an inverse predicate method comparing against current date' do
+        task.update!(notified_on: Date.yesterday)
+        expect(task.not_notified?).to eq(false)
+
+        task.update!(notified_on: Date.current)
+        expect(task.not_notified?).to eq(false)
+
+        task.update!(notified_on: Date.tomorrow)
+        expect(task.not_notified?).to eq(true)
+
+        task.update!(notified_on: nil)
+        expect(task.not_notified?).to eq(true)
+      end
+
+      it 'defines a scope comparing against current date' do
+        task.update!(notified_on: Date.yesterday)
+        expect(Task.notified).to include(task)
+
+        task.update!(notified_on: Date.current)
+        expect(Task.notified).to include(task)
+
+        task.update!(notified_on: Date.tomorrow)
+        expect(Task.notified).not_to include(task)
+
+        task.update!(notified_on: nil)
+        expect(Task.notified).not_to include(task)
+      end
+
+      it 'defines an inverse scope comparing against current date' do
+        task.update!(notified_on: Date.yesterday)
+        expect(Task.not_notified).not_to include(task)
+
+        task.update!(notified_on: Date.current)
+        expect(Task.not_notified).not_to include(task)
+
+        task.update!(notified_on: Date.tomorrow)
+        expect(Task.not_notified).to include(task)
+
+        task.update!(notified_on: nil)
+        expect(Task.not_notified).to include(task)
+      end
+    end
   end
 end

data/spec/dummy/app/models/task.rb

@@ -1,7 +1,8 @@
 class Task < ActiveRecord::Base
   has_event :complete
   has_event :archive, skip_scopes: true
-  has_events :expire, strategy: :time_comparison
+  has_event :expire, strategy: :time_comparison
+  has_event :notify, field_type: :date, strategy: :time_comparison
 
   def complete!
     super

data/spec/dummy/db/migrate/20230308160359_add_notified_on_to_tasks.rb

@@ -0,0 +1,5 @@
+class AddNotifiedOnToTasks < ACTIVE_RECORD_MIGRATION_CLASS
+  def change
+    add_column :tasks, :notified_on, :date
+  end
+end

data/spec/dummy/db/schema.rb

@@ -10,13 +10,14 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2022_06_09_015338) do
+ActiveRecord::Schema.define(version: 2023_03_08_160359) do
 
   create_table "tasks", force: :cascade do |t|
     t.datetime "completed_at"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
     t.datetime "expired_at"
+    t.date "notified_on"
   end
 
 end

data/spec/spec_helper.rb

@@ -22,10 +22,20 @@ require 'factory_girl'
 require 'generator_spec'
 require 'timecop'
 require 'zonebie/rspec'
+require 'database_cleaner'
 
 Dir["#{__dir__}/support/**/*.rb"].each { |f| require f }
 
 RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning { example.run }
+  end
+
   config.include FactoryGirl::Syntax::Methods
   config.include GeneratorHelpers, type: :generator
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record-events
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.1.2
 platform: ruby
 authors:
 - Bartosz Pieńkowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-11 00:00:00.000000000 Z
+date: 2023-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -52,6 +52,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.99'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.99'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +226,7 @@ files:
 - spec/dummy/config/environment.rb
 - spec/dummy/db/migrate/20150813132804_create_tasks.rb
 - spec/dummy/db/migrate/20220609015338_add_expired_at_to_tasks.rb
+- spec/dummy/db/migrate/20230308160359_add_notified_on_to_tasks.rb
 - spec/dummy/db/schema.rb
 - spec/generators/active_record/event/event_generator_spec.rb
 - spec/spec_helper.rb
@@ -244,6 +265,7 @@ test_files:
 - spec/dummy/db/schema.rb
 - spec/dummy/db/migrate/20150813132804_create_tasks.rb
 - spec/dummy/db/migrate/20220609015338_add_expired_at_to_tasks.rb
+- spec/dummy/db/migrate/20230308160359_add_notified_on_to_tasks.rb
 - spec/active_record/events/method_factory_spec.rb
 - spec/active_record/events/naming_spec.rb
 - spec/active_record/events/macro_spec.rb