time_for_a_boolean 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af337b26f0dc5ce70747c5146b92e0a115d987ed835cd3131e42aca5611bb58c
-  data.tar.gz: 59329bac85be78bad931c35fd629278d5676419f2ae8aeaba13c1e7312f55695
+  metadata.gz: 701b2822fe90c9d2a06985ff8db6d8c46501bf57921c47f741f0bee56e6c52d3
+  data.tar.gz: 473ee35b769e3c8a422e03647d51ab93a962a9ed3acb61d538e470184d610061
 SHA512:
-  metadata.gz: 4a78da81585e4c74ec3a3560308020390b3a089726d9461796a9a9b0481f38f9f5de88710e276a9a08d241059942542e8bfa0630d317e8a55be18ef1a800d2eb
-  data.tar.gz: e9ae065b1573973fc993ec6a918a770261383baa36b41cd0b09dbc77cab9cf40e917bd3c2fffb032c58246585e109e22f379997826d1457150e6901b502164b3
+  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.1'
+  VERSION = '0.3.0'
 end

data/lib/time_for_a_boolean.rb

@@ -1,3 +1,4 @@
+require "active_support"
 require "active_support/core_ext/module/delegation"
 require "active_support/core_ext/time/calculations"
 require "active_model/type"
@@ -5,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
@@ -24,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

data/time_for_a_boolean.gemspec

@@ -6,20 +6,24 @@ require "time_for_a_boolean/version"
 Gem::Specification.new do |spec|
   spec.name = "time_for_a_boolean"
   spec.version = TimeForABoolean::VERSION
-  spec.authors = ["Caleb Thompson"]
-  spec.email = ["caleb@calebthompson.io"]
+  spec.authors = ["Caleb Hearth"]
+  spec.email = ["caleb@calebhearth.com"]
   spec.description = <<-DESCRIPTION
     Use timestamp values to represent boolean data such as deleted, published,
     or subscribed.
   DESCRIPTION
   spec.summary = "Back boolean values with timestamps"
-  spec.homepage = "https://github.com/calebthompson/time_for_a_boolean"
+  spec.homepage = "https://github.com/calebhearth/time_for_a_boolean"
   spec.license = "MIT"
 
   spec.files = `git ls-files`.split($/)
   spec.test_files = spec.files.grep(%r{^spec/})
   spec.require_paths = ["lib"]
 
+  spec.metadata = {
+    "funding-uri" => "https://github.com/sponsors/calebhearth"
+  }
+
   spec.add_dependency "activerecord"
   spec.add_dependency "railties"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: time_for_a_boolean
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
-- Caleb Thompson
+- Caleb Hearth
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-15 00:00:00.000000000 Z
+date: 2026-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -98,7 +98,7 @@ description: |2
       Use timestamp values to represent boolean data such as deleted, published,
       or subscribed.
 email:
-- caleb@calebthompson.io
+- caleb@calebhearth.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -115,10 +115,11 @@ files:
 - lib/time_for_a_boolean/version.rb
 - spec/time_for_a_boolean_spec.rb
 - time_for_a_boolean.gemspec
-homepage: https://github.com/calebthompson/time_for_a_boolean
+homepage: https://github.com/calebhearth/time_for_a_boolean
 licenses:
 - MIT
-metadata: {}
+metadata:
+  funding-uri: https://github.com/sponsors/calebhearth
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -134,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Back boolean values with timestamps