time_for_a_boolean 0.0.4 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 277793114b162bb1a4753e9400c14ae68708e217
-  data.tar.gz: 5eae5941a38459c5a383dd8eb4561a8d839eb7e2
+SHA256:
+  metadata.gz: af337b26f0dc5ce70747c5146b92e0a115d987ed835cd3131e42aca5611bb58c
+  data.tar.gz: 59329bac85be78bad931c35fd629278d5676419f2ae8aeaba13c1e7312f55695
 SHA512:
-  metadata.gz: d084a3437da16608c2539cd5b8d9f11e6b0e5f1d0956c6d77c84aa15ee3f7cfde0bb3934ebf3d96ea3d70cd072e6deef1ffb781b225a2b29e3a668a575f77228
-  data.tar.gz: dfdc83188a96c03337bd9dbcef49700c2e15772703dfdbdb61087d193e59889965768fb184c217dd041a029248b309bc03ad1c062d2c8c45bb53e8b5989dbebb
+  metadata.gz: 4a78da81585e4c74ec3a3560308020390b3a089726d9461796a9a9b0481f38f9f5de88710e276a9a08d241059942542e8bfa0630d317e8a55be18ef1a800d2eb
+  data.tar.gz: e9ae065b1573973fc993ec6a918a770261383baa36b41cd0b09dbc77cab9cf40e917bd3c2fffb032c58246585e109e22f379997826d1457150e6901b502164b3

data/README.md

@@ -1,9 +1,9 @@
 Time for A Boolean
 ==================
 
-[![Build Status](https://travis-ci.org/calebthompson/time_for_a_boolean.png)](https://travis-ci.org/calebthompson/time_for_a_boolean)
-[![Code Climate](https://codeclimate.com/github/calebthompson/time_for_a_boolean.png)](https://codeclimate.com/github/calebthompson/time_for_a_boolean)
-[![Coverage Status](https://coveralls.io/repos/calebthompson/time_for_a_boolean/badge.png)](https://coveralls.io/r/calebthompson/time_for_a_boolean)
+[![Build Status](https://api.travis-ci.org/calebthompson/time_for_a_boolean.svg?branch=master)](https://travis-ci.org/calebthompson/time_for_a_boolean)
+[![Code Climate](https://codeclimate.com/github/calebthompson/time_for_a_boolean.svg)](https://codeclimate.com/github/calebthompson/time_for_a_boolean)
+[![Coverage Status](https://coveralls.io/repos/calebthompson/time_for_a_boolean/badge.svg)](https://coveralls.io/r/calebthompson/time_for_a_boolean)
 
 
 > Sally: Hey, we need to add a flag to Post
@@ -63,9 +63,9 @@ methods are defined:
 
 | Method          | Description
 | --------------- | -----------
-| `Post#deleted`  | `true` if `Post#deleted_at` is set, `false` otherwise
+| `Post#deleted`  | `true` if `Post#deleted_at` is set to a time before `Time.current`, `false` otherwise
 | `Post#deleted?` | Alias for `Post#deleted`
-| `Post#deleted=` | Sets the timestamp to `DateTime.now` if the new value is true, and `nil` otherwise
+| `Post#deleted=` | Sets the timestamp to `Time.current` if the new value is true, and `nil` otherwise
 
 These methods allow you to use a timestamp as you would a boolean value in your
 application.
@@ -77,3 +77,17 @@ Okay... why?
 * `COUNT(posts.deleted_at)` gives you the count of deleted posts, which is
   useful when writing a report. Define and use `Post.deleted.count` when you
   have Ruby available.
+
+Other Options
+-------------
+
+If you have a date or time column that does not follow the `attribute_at` convention,
+you can specify the attribute name:
+
+```
+class User < ActiveRecord::Base
+  time_for_a_boolean :expires, :expires_on
+end
+```
+
+This is especially useful when using date only columns.

data/lib/time_for_a_boolean.rb

@@ -1,20 +1,28 @@
-require 'active_record/connection_adapters/column'
-require 'time_for_a_boolean/version'
-require 'time_for_a_boolean/railtie'
+require "active_support/core_ext/module/delegation"
+require "active_support/core_ext/time/calculations"
+require "active_model/type"
+require "time_for_a_boolean/version"
+require "time_for_a_boolean/railtie"
 
 module TimeForABoolean
-  def time_for_a_boolean(attribute)
+  def time_for_a_boolean(attribute, field=:"#{attribute}_at")
     define_method(attribute) do
-      !send("#{attribute}_at").nil? &&
-        send("#{attribute}_at") <= -> { DateTime.current }.()
+      !send(field).nil? && send(field) <= -> { Time.current }.()
     end
-    alias_method "#{attribute}?", attribute
-    define_method("#{attribute}=") do |value|
-      if ActiveRecord::ConnectionAdapters::Column::TRUE_VALUES.include?(value)
-        send("#{attribute}_at=", -> { DateTime.current }.())
+
+    alias_method :"#{attribute}?", attribute
+
+    setter_attribute = :"#{field}="
+    define_method(:"#{attribute}=") do |value|
+      if ActiveModel::Type::Boolean::FALSE_VALUES.include?(value)
+        send(setter_attribute, nil)
       else
-        send("#{attribute}_at=", nil)
+        send(setter_attribute, -> { Time.current }.())
       end
     end
+
+    define_method(:"#{attribute}!") do
+      send(:"#{attribute}=", true)
+    end
   end
 end

data/lib/time_for_a_boolean/version.rb

@@ -1,3 +1,3 @@
 module TimeForABoolean
-  VERSION = '0.0.4'
+  VERSION = '0.2.1'
 end

data/spec/time_for_a_boolean_spec.rb

@@ -22,6 +22,12 @@ describe TimeForABoolean do
     expect(klass.new).to respond_to :attribute=
   end
 
+  it 'defines the bangable method to act as an implicit writer' do
+    klass.time_for_a_boolean :attribute
+
+    expect(klass.new).to respond_to :attribute!
+  end
+
   describe 'attribute method' do
     it 'calls nil? on the backing timestamp' do
       klass.time_for_a_boolean :attribute
@@ -35,7 +41,7 @@ describe TimeForABoolean do
 
     it 'is true if the attribute is not nil' do
       klass.time_for_a_boolean :attribute
-      allow(object).to receive(:attribute_at).and_return(DateTime.now - 10)
+      allow(object).to receive(:attribute_at).and_return(Time.now - 10)
 
       expect(object.attribute).to be_truthy
     end
@@ -53,6 +59,39 @@ describe TimeForABoolean do
 
       expect(object.attribute).to be_falsey
     end
+
+    context 'when the user has defined their own attribute name' do
+      it 'calls nil? on the backing value' do
+        klass.time_for_a_boolean :attribute, :attribute_on
+        date = double(nil?: true)
+        allow(object).to receive(:attribute_on).and_return(date)
+
+        object.attribute
+
+        expect(date).to have_received(:nil?)
+      end
+
+      it 'is true if the attribute is not nil' do
+        klass.time_for_a_boolean :attribute, :attribute_on
+        allow(object).to receive(:attribute_on).and_return(Date.current - 10)
+
+        expect(object.attribute).to be_truthy
+      end
+
+      it 'is false if the attribute is nil' do
+        klass.time_for_a_boolean :attribute, :attribute_on
+        allow(object).to receive(:attribute_on)
+
+        expect(object.attribute).to be_falsey
+      end
+
+      it 'is false if the attribute date is in the future' do
+        klass.time_for_a_boolean :attribute, :attribute_on
+        allow(object).to receive(:attribute_on).and_return(Date.current + 1)
+
+        expect(object.attribute).to be_falsey
+      end
+    end
   end
 
   describe 'the query method' do
@@ -70,14 +109,14 @@ describe TimeForABoolean do
 
       object.attribute = true
 
-      expect(object.attribute_at).to be_kind_of(DateTime)
+      expect(object.attribute_at).to be_kind_of(Time)
     end
 
     it 'sets the timestamp to nil if value is false' do
       klass.time_for_a_boolean :attribute
       klass.send(:attr_accessor, :attribute_at)
 
-      object.attribute_at = DateTime.now
+      object.attribute_at = Time.now
       object.attribute = false
 
       expect(object.attribute_at).to be_nil
@@ -89,20 +128,31 @@ describe TimeForABoolean do
 
       object.attribute = '1'
 
-      expect(object.attribute_at).to be_kind_of(DateTime)
+      expect(object.attribute_at).to be_kind_of(Time)
     end
 
     it 'works with other representations of false' do
       klass.time_for_a_boolean :attribute
       klass.send(:attr_accessor, :attribute_at)
 
-      object.attribute_at = DateTime.now
+      object.attribute_at = Time.now
       object.attribute = '0'
 
       expect(object.attribute_at).to be_nil
     end
   end
 
+  describe 'the bangable method' do
+    it 'sets the timestamp to now' do
+      klass.time_for_a_boolean :attribute
+      klass.send(:attr_accessor, :attribute_at)
+
+      object.attribute!
+
+      expect(object.attribute_at).to be_kind_of(Time)
+    end
+  end
+
   def klass
     @klass ||= Class.new do
       extend TimeForABoolean

data/time_for_a_boolean.gemspec

@@ -1,29 +1,30 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'time_for_a_boolean/version'
+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.name = "time_for_a_boolean"
+  spec.version = TimeForABoolean::VERSION
+  spec.authors = ["Caleb Thompson"]
+  spec.email = ["caleb@calebthompson.io"]
   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.license       = 'MIT'
+  spec.summary = "Back boolean values with timestamps"
+  spec.homepage = "https://github.com/calebthompson/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.files = `git ls-files`.split($/)
+  spec.test_files = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
 
-  spec.add_dependency 'rails'
+  spec.add_dependency "activerecord"
+  spec.add_dependency "railties"
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'coveralls'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: time_for_a_boolean
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.2.1
 platform: ruby
 authors:
 - Caleb Thompson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-07-31 00:00:00.000000000 Z
+date: 2020-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -28,16 +42,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -91,7 +105,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".ruby-gemset"
-- ".ruby-version"
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
@@ -106,7 +119,7 @@ homepage: https://github.com/calebthompson/time_for_a_boolean
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -121,9 +134,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Back boolean values with timestamps
 test_files:

data/.ruby-version

@@ -1 +0,0 @@
-2.1.2