active_record-events 4.0.1 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18d2fc6a8788d3190b5da3dd8dc45fbf307bb55344a6072ba24db67ff9b0e6cb
-  data.tar.gz: 17767f7e00810c9717cc5fa4bd92d49303b22427eb5da06a3f27ea39f8a4fbf8
+  metadata.gz: 7ec4cd90a44c6c550a55b4fed0e50686380441cb86a4089a9716d8d5db350984
+  data.tar.gz: bf03cc5c153173f2bf842d240374e00e7a94957fcdd4b855dab0a00fc4999a12
 SHA512:
-  metadata.gz: d39a25b8c5695aa8c81b9780744f0639ab2b0bac74296486721ec1c28cad0c67f801441b78c3faa48162d60938297a33638dada9e597a84a7c8c888c94cc86b2
-  data.tar.gz: afb5395aba7821776ff9aa3790d0f04f625daa1a4de6495e9069cf210a4ea3023b7449bb6cce58e9eb158887a541da6f927b9ba03e61df0974b6cd473a6beacf
+  metadata.gz: 7c567f576431e641cd39dad28b71c033093b8cd51e368003ec93b1a44ff1177ac0272a257d1b73b2398072aeb4d962d568865bbd110e2116085d76b513c5da3a
+  data.tar.gz: 1b83157999bf3ad63a76475fcf4b011f0f95cd19d83792f1db2a9f5eaedcca178a69fcfccb01898f7d9452ed06d2ba1c28cac3bb0fe657f5e6ed7304b2db4dd2

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/travis/pienkowb/active_record-events/develop)](https://travis-ci.org/pienkowb/active_record-events) [![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.
 
@@ -119,6 +119,26 @@ has_event :complete, field_name: :completion_time
 
 Note that the `field_name` option takes precedence over the `field_type` option.
 
+### Comparison strategy
+
+By default the timestamp's presence will dictate the behavior. However in some cases you may want to check against the current time.
+
+You can do this with the `strategy` option, which can be either `presence` or `time_comparison`:
+
+```ruby
+has_event :complete, strategy: :time_comparison
+```
+
+**Example:**
+
+```ruby
+task.completed_at = 1.hour.ago
+task.completed? # => true
+
+task.completed_at = 1.hour.from_now
+task.completed? # => false
+```
+
 ### Specifying an object
 
 There are events which do not relate to a model itself but to one of its attributes – take the `User` model with the `email_confirmed_at` field as an example.
@@ -208,6 +228,8 @@ end
 - [Tomasz Skupiński](https://github.com/tskupinski)
 - [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

@@ -6,11 +6,13 @@ module ActiveRecord
       def initialize(event_name, options)
         @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
         Module.new.tap do |module_|
-          define_predicate_method(module_, naming)
+          define_predicate_method(module_, naming, strategy)
           define_inverse_predicate_method(module_, naming)
 
           define_action_method(module_, naming)
@@ -20,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)
-            define_inverse_scope_method(module_, naming)
+            define_scope_method(module_, naming, strategy, time_class)
+            define_inverse_scope_method(module_, naming, strategy, time_class)
           end
         end
       end
@@ -33,10 +37,16 @@ module ActiveRecord
 
       attr_reader :options
       attr_reader :naming
+      attr_reader :strategy
+      attr_reader :field_type
 
-      def define_predicate_method(module_, naming)
+      def define_predicate_method(module_, naming, strategy)
         module_.send(:define_method, naming.predicate) do
-          self[naming.field].present?
+          if strategy == :time_comparison
+            self[naming.field].present? && !self[naming.field].future?
+          else
+            self[naming.field].present?
+          end
         end
       end
 
@@ -62,25 +72,35 @@ 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)
+      def define_scope_method(module_, naming, strategy, time_class)
         module_.send(:define_method, naming.scope) do
-          where(arel_table[naming.field].not_eq(nil))
+          if strategy == :time_comparison
+            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)
+      def define_inverse_scope_method(module_, naming, strategy, time_class)
         module_.send(:define_method, naming.inverse_scope) do
-          where(arel_table[naming.field].eq(nil))
+          arel_field = arel_table[naming.field]
+
+          if strategy == :time_comparison
+            where(arel_field.eq(nil).or(arel_field.gt(time_class.current)))
+          else
+            where(arel_field.eq(nil))
+          end
         end
       end
     end

data/lib/active_record/events/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module Events
-    VERSION = '4.0.1'.freeze
+    VERSION = '4.1.1'.freeze
   end
 end

data/lib/generators/active_record/event/event_generator.rb

@@ -6,7 +6,7 @@ require 'active_record/events/macro'
 module ActiveRecord
   module Generators
     class EventGenerator < Rails::Generators::Base
-      MACRO_OPTIONS = %w[object field_type skip_scopes].freeze
+      MACRO_OPTIONS = %w[object field_type skip_scopes strategy].freeze
 
       argument :model_name, type: :string
       argument :event_name, type: :string
@@ -17,6 +17,8 @@ module ActiveRecord
         desc: 'The field type (datetime or date)'
       class_option :object, type: :string,
         desc: 'The name of the object'
+      class_option :strategy, type: :string,
+        desc: 'The comparison strategy (presence or time_comparison)'
 
       source_root File.expand_path('templates', __dir__)
 
@@ -38,8 +40,9 @@ module ActiveRecord
 
         macro_options = options.slice(*MACRO_OPTIONS)
         macro = ActiveRecord::Events::Macro.new(event_name, macro_options)
+        pattern = /^\s*class\s.+\n/
 
-        inject_into_file model_file_path, "\s\s#{macro}\n", after: /class.+\n/
+        inject_into_file model_file_path, "\s\s#{macro}\n", after: pattern
       end
 
       private

data/spec/active_record/events_spec.rb

@@ -71,4 +71,108 @@ RSpec.describe ActiveRecord::Events do
 
     expect(task.reload).to be_completed
   end
+
+  describe 'time comparison strategy' do
+    it 'defines a predicate method comparing against current time' do
+      task.update!(expired_at: 1.hour.from_now)
+      expect(task.expired?).to eq(false)
+
+      task.update!(expired_at: 1.hour.ago)
+      expect(task.expired?).to eq(true)
+
+      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!(expired_at: 1.hour.from_now)
+      expect(task.not_expired?).to eq(true)
+
+      task.update!(expired_at: 1.hour.ago)
+      expect(task.not_expired?).to eq(false)
+
+      task.update!(expired_at: nil)
+      expect(task.not_expired?).to eq(true)
+    end
+
+    it 'defines a scope comparing against current time' do
+      task.update!(expired_at: 1.hour.from_now)
+      expect(Task.expired).not_to include(task)
+
+      task.update!(expired_at: 1.hour.ago)
+      expect(Task.expired).to include(task)
+
+      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!(expired_at: 1.hour.from_now)
+      expect(Task.not_expired).to include(task)
+
+      task.update!(expired_at: 1.hour.ago)
+      expect(Task.not_expired).not_to include(task)
+
+      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.today)
+        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.today)
+        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.today)
+        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.today)
+        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,6 +1,8 @@
 class Task < ActiveRecord::Base
   has_event :complete
-  has_events :archive, skip_scopes: true
+  has_event :archive, skip_scopes: true
+  has_event :expire, strategy: :time_comparison
+  has_event :notify, field_type: :date, strategy: :time_comparison
 
   def complete!
     super

data/spec/dummy/db/migrate/20220609015338_add_expired_at_to_tasks.rb

@@ -0,0 +1,5 @@
+class AddExpiredAtToTasks < ACTIVE_RECORD_MIGRATION_CLASS
+  def change
+    add_column :tasks, :expired_at, :datetime
+  end
+end

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

@@ -2,20 +2,22 @@
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.
 #
-# Note that this schema.rb definition is the authoritative source for your
-# database schema. If you need to create the application database on another
-# system, you should be using db:schema:load, not running all the migrations
-# from scratch. The latter is a flawed and unsustainable approach (the more migrations
-# you'll amass, the slower it'll run and the greater likelihood for issues).
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2015_08_13_132804) 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/generators/active_record/event/event_generator_spec.rb

@@ -2,7 +2,13 @@ require 'spec_helper'
 require 'generators/active_record/event/event_generator'
 
 RSpec.describe ActiveRecord::Generators::EventGenerator, type: :generator do
-  arguments %w[task complete --field-type=date --skip-scopes]
+  arguments %w[
+    task complete
+    --field-type=date
+    --skip-scopes
+    --strategy=time_comparison
+  ]
+
   destination File.expand_path('../../../../tmp', __dir__)
 
   before { prepare_destination }
@@ -30,7 +36,7 @@ RSpec.describe ActiveRecord::Generators::EventGenerator, type: :generator do
 
       assert_file 'app/models/task.rb', <<-RUBY.strip_heredoc
         class Task < ActiveRecord::Base
-          has_event :complete, field_type: :date, skip_scopes: true
+          has_event :complete, field_type: :date, skip_scopes: true, strategy: :time_comparison
         end
       RUBY
     end

data/spec/spec_helper.rb

@@ -1,9 +1,20 @@
 ENV['RAILS_ENV'] ||= 'test'
 
 require 'bundler/setup'
-require 'coveralls'
+require 'simplecov'
 
-Coveralls.wear!
+SimpleCov.start do
+  if ENV['CI']
+    require 'simplecov-lcov'
+
+    SimpleCov::Formatter::LcovFormatter.config do |config|
+      config.report_with_single_file = true
+      config.single_report_path = 'coverage/lcov.info'
+    end
+
+    formatter SimpleCov::Formatter::LcovFormatter
+  end
+end
 
 require File.expand_path('dummy/config/environment.rb', __dir__)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record-events
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.1
 platform: ruby
 authors:
 - Bartosz Pieńkowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-15 00:00:00.000000000 Z
+date: 2023-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +108,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.50.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -191,6 +205,8 @@ files:
 - spec/dummy/config/database.yml
 - 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
@@ -216,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Manage timestamps in ActiveRecord models
@@ -228,6 +244,8 @@ test_files:
 - spec/dummy/config/boot.rb
 - 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