time_for_a_boolean 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0901b7d1345001ec725cbb1b9a8611d8014f611f539631f6a71bfdf03c6bbc3a'
-  data.tar.gz: 9a202da422fad3672d96941d6d5c7b3578f742ec0c5253ef42617217d65013e5
+  metadata.gz: 701b2822fe90c9d2a06985ff8db6d8c46501bf57921c47f741f0bee56e6c52d3
+  data.tar.gz: 473ee35b769e3c8a422e03647d51ab93a962a9ed3acb61d538e470184d610061
 SHA512:
-  metadata.gz: 17bb87c43aa0d9b10e83001f206105bf89ca36f4ce62569ad6eb2d8f9bdc9c51b06c3824f5700c3d5dabb91431908a819d8138b65cc400685732418ee985586d
-  data.tar.gz: 83f9c14b99d5c6c432708a67f155b65a641cfff762e94e2f6757e53fb8240abef572e6ccf98a0141cd2847a3123d4c9ee03ca7594dd3a68b8fc38bf0355a66dc
+  metadata.gz: 0b410a85f621d1df5c9830d3449290621d88d28b59178ccec0fc31a53b985106113e504883e925e1d2f32c4a93ad24047903cdb0805a83e0a361d6e3b1632d74
+  data.tar.gz: ac178e46e85b90df61b2cbbb83f4219a4a3ba2ac5dc61ac28899938bbbd73cacf72266d117b15688286a7ca1d0e2267cb02e8d229ed64f1e507a58ba8afa1223

data/README.md

@@ -81,6 +81,8 @@ Okay... why?
 Other Options
 -------------
 
+### Using a different attribute name
+
 If you have a date or time column that does not follow the `attribute_at` convention,
 you can specify the attribute name:
 
@@ -91,3 +93,23 @@ end
 ```
 
 This is especially useful when using date only columns.
+
+### Scopes to filter records
+
+[ActiveRecord Scopes](https://guides.rubyonrails.org/active_record_querying.html#scopes)
+can be used to filter records based on the attribute.  These are not defined by
+default, but can be added by passing the `scopes: true` option:
+
+```ruby
+class Post < ActiveRecord::Base
+  time_for_a_boolean :deleted, scopes: true
+  ...
+end
+```
+
+This will define the following scopes:
+
+| Scope                | Description |
+| -------------------- | ----------- |
+| `Post.deleted`       | Returns all posts where `deleted_at` is set to a time before `Time.current`
+| `Post.not_deleted`   | Returns all posts where `deleted_at` is unset or in the future

data/lib/time_for_a_boolean/version.rb

@@ -1,3 +1,3 @@
 module TimeForABoolean
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/lib/time_for_a_boolean.rb

@@ -6,7 +6,7 @@ require "time_for_a_boolean/version"
 require "time_for_a_boolean/railtie"
 
 module TimeForABoolean
-  def time_for_a_boolean(attribute, field=:"#{attribute}_at")
+  def time_for_a_boolean(attribute, field=:"#{attribute}_at", scopes: false)
     define_method(attribute) do
       !send(field).nil? && send(field) <= -> { Time.current }.()
     end
@@ -25,5 +25,17 @@ module TimeForABoolean
     define_method(:"#{attribute}!") do
       send(:"#{attribute}=", true)
     end
+
+    if scopes && respond_to?(:where)
+      singleton_class.instance_eval do
+        define_method(:"#{attribute}") do
+          where(field => ..Time.current)
+        end
+
+        define_method(:"not_#{attribute}") do
+          where(field => [nil, Time.current...])
+        end
+      end
+    end
   end
 end

data/spec/time_for_a_boolean_spec.rb

@@ -153,12 +153,42 @@ describe TimeForABoolean do
     end
   end
 
+  describe 'scopes' do
+    it 'does not define the scopes by default' do
+      klass.time_for_a_boolean :attribute
+
+      expect(klass).not_to respond_to :attribute
+    end
+
+    it 'does not define the scopes if the class does not respond to where' do
+      klass.time_for_a_boolean :attribute, scopes: true
+
+      expect(klass).not_to respond_to :attribute
+      expect(klass).not_to respond_to :not_attribute
+    end
+
+    it 'defines the scopes if the class has a where method' do
+      klass_with_where.time_for_a_boolean :attribute, scopes: true
+
+      expect(klass_with_where).to respond_to :attribute
+      expect(klass_with_where).to respond_to :not_attribute
+    end
+  end
   def klass
     @klass ||= Class.new do
       extend TimeForABoolean
     end
   end
 
+  def klass_with_where
+    @klass ||= Class.new do
+      extend TimeForABoolean
+
+      def self.where(...)
+      end
+    end
+  end
+
   def object
     @object ||= klass.new
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: time_for_a_boolean
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Caleb Hearth
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-21 00:00:00.000000000 Z
+date: 2026-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord