date_as_bool 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2b4fb4fb7506c04047aa82aebe688e26505d5ab
-  data.tar.gz: a3473d477d4a5a47d625f674fb0f3f4fb1c0778f
+  metadata.gz: bdc34c40345621e238b8a0c9a09fc7f74dc6eb0e
+  data.tar.gz: 04b0263600b2144c2a986c86a5d875bd9514fd72
 SHA512:
-  metadata.gz: e6a837110cc0f3b01f8ab4cb2161b2b663f99dfe212b1c3a0bdb37bf43d99b893eac1c829713fe549123a39c10000671ab501279bd7729302a390be1bde696f8
-  data.tar.gz: 1d3584c5e18dcbd8b2c63ccb34f4ebec6730386b4cad4d02a79104b0f3486244cf2f7622d5af76863411f98d34cc02d244eb2119a2f1059b60876023c7186027
+  metadata.gz: 97eb4ed694c678696252be8eb64a06a10bb5adcbef6cf7b66d8419ac5211af4fe2cd53d8795df9cdc35aa0d23f4dd44f8879fc3b671c9a876c749d68e44a2bac
+  data.tar.gz: c85e04a19289a5745bdb3c96e42a56f6405db777db3ff1f9697a31e6142b4b2d739bd4cd2c53e9b7d016afd63597f9677352a9fe1ab3b32e7a9ff289b68f6650

data/README.md

@@ -1,36 +1,23 @@
 # DateAsBool
-A simple Rails Gem to get both a datetime and a boolean behaviour from the same database column. I found myself quite often with the following design pattern:
 
-```ruby
-# == Schema Information
-#
-# Table name: subscriptions
-#
-#  id                           :integer          not null, primary key
-#  paid_at                      :datetime
-#  ...
-#
+DateAsBool is a simple Rails Gem to get both a datetime and a boolean behaviour from the same database column.
 
-class Subscription < ApplicationRecord
-  attr_accessor :paid
-  def paid=(bool)
-    self.paid_at = bool ? Time.now : nil
-  end
-  def paid
-    paid_at.present?
-  end
-  def paid!
-    paid = true
-    save
-  end
-  def paid?
-    paid_at.present?
-  end
-  ...
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'date_as_bool'
 ```
 
-This gem abstracts this behaviour in one line.
+And then execute:
+```bash
+$ bundle
+```
 
+Or install it yourself as:
+```bash
+$ gem install date_as_bool
+```
 
 ## Usage
 Let's say you have a `users` table with column `verified_at:datetime`.
@@ -42,33 +29,70 @@ class User < ApplicationRecord
   ...
 ```
 
-Now you can use `user.verified?` to test for `verified_at` presence, and `user.verified!` as an alias for `user.update(verified_at: Time.now)`.
+Now you can use `user.verified` or `user.verified?` to test for `verified_at` presence, and `user.verified!` as an alias for `user.update(verified_at: Time.now)`.
 
-You can also reset the field or change it dynamically with `user.update(verified: bool)`. If false, it resets `verified_at` to `nil`.
+You can change the field with `user.update(verified: bool)`. If false, it resets `verified_at` to `nil`, if true, it sets it to `Time.now`.
 
+You also get the scopes `User.verified`, equivalent to `User.where.not(verified_at: nil)`, and `User.not_verified` equivalent to `User.where(verified_at: nil)`.
 
-## Advanced Usage
-If you want to give a different name to the boolean method, you can specify it as the second argument: `date_as_bool :verified_at` gets translated to `date_as_bool :verified_at, :verified`.
+### Methods
 
-## Installation
-Add this line to your application's Gemfile:
+* `User.verified == User.where.not(verified_at: nil)`
+* `User.not_verified == User.where(verified_at: nil)`
+* `user.verified == user.verified_at.present?`
+* `user.verified? == user.verified_at.present?`
+* `user.verified! == user.update(verified: true) == user.update(verified_at: Time.now)`
+* `user.update(verified: false) == user.update(verified_at: nil)`
+
+## Motivation
+
+Often, when you need a boolean flag on a model, you can accomplish more by using a datetime attribute instead, that captures the first time the flag turned on. But to recover the simplicity of dealing with a boolean instead of a datetime you have to write some lines of code.
+
+So, I found myself quite often with the following design pattern:
 
 ```ruby
-gem 'date_as_bool'
-```
+# == Schema Information
+#
+# Table name: users
+#
+#  id          :integer          not null, primary key
+#  verified_at :datetime
+#  ...
+#
 
-And then execute:
-```bash
-$ bundle
-```
+class User < ApplicationRecord
+  scope :verified,     -> { where.not(verified_at: nil) }
+  scope :not_verified, -> { where(verified_at: nil) }
 
-Or install it yourself as:
-```bash
-$ gem install date_as_bool
+  def verified=(bool)
+    self.verified_at = bool ? Time.now : nil
+  end
+
+  def verified
+    verified_at.present?
+  end
+  alias verified? verified
+
+  def verified!
+    verified = true
+    save
+  end
+
+  # ...
+end
 ```
 
+This way, I can both use `User.verified` and `User.where(verified_at: 2.days.ago..Time.now)`.
+
+DateAsBool abstracts this behaviour in one line.
+
+## Advanced Usage
+If you want to give a different name to the boolean method, you can specify it as the second argument.
+
+`date_as_bool :verified_at` is just a shortcut for `date_as_bool :verified_at, :verified`.
+
 ## Contributing
-Pull requests are greatly appreciated. This is my first gem, intended mainly for learning purposes. Its only target is to capture a small design pattern which may be safer to implement just by copy&paste.
+Bug reports and pull requests are greatly appreciated.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -14,11 +14,6 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
-
-
-
-
 require 'bundler/gem_tasks'
 
 require 'rake/testtask'
@@ -29,5 +24,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
 task default: :test

data/lib/date_as_bool.rb

@@ -1,7 +1,2 @@
 require "date_as_bool/active_record/as/bool"
 require "date_as_bool/active_record/as/active_record"
-
-# module DateAsBool
-
-
-# end

data/lib/date_as_bool/active_record/as/bool.rb

@@ -1,34 +1,36 @@
 module ActiveRecord
   module As #:nodoc:
     module Bool #:nodoc:
+      module ClassMethods #:nodoc:
+        def date_as_bool(datetime_name, bool_name = nil)
+          bool_name ||= datetime_name.to_s.split('_')[0..-2].join('_').to_sym
 
-      module ClassMethods
-        def date_as_bool datetime_name, bool_name=nil
-          caller_class = self
-
-          if bool_name.nil?
-            bool_name = datetime_name.to_s.split("_")[0..-2].join("_").to_sym
+          singleton_class.class_eval do
+            define_method bool_name do
+              where.not(datetime_name => nil)
+            end
+            define_method "not_#{bool_name}" do
+              where(datetime_name => nil)
+            end
           end
 
-          caller_class.class_eval do
-            attr_accessor bool_name
+          class_eval do
             define_method bool_name do
-              self.send(datetime_name).present?
+              send(datetime_name).present?
+            end
+            define_method :"#{bool_name}?" do
+              send(bool_name)
             end
             define_method :"#{bool_name}=" do |bool|
-              self.send(:"#{datetime_name}=", bool ? Time.now : nil)
+              send(:"#{datetime_name}=", bool ? Time.now : nil)
             end
             define_method :"#{bool_name}!" do
-              self.send(:"#{bool_name}=", true)
-              self.save!
-            end
-            define_method :"#{bool_name}?" do
-              self.send(bool_name)
+              send(:"#{bool_name}=", true)
+              save!
             end
           end
-
         end
       end
     end
   end
-end
+end

data/lib/date_as_bool/version.rb

@@ -1,3 +1,3 @@
 module DateAsBool
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: date_as_bool
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Carlo Martinucci
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-10 00:00:00.000000000 Z
+date: 2018-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,9 +38,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A simple Rails Gem to get both a datetime and a boolean behaviour from
-  the same database column, i.e. have a verified_at:datetime to log times of verification
-  and sort, and also .verified? and .verify! methods.
+description: DateAsBool is a simple Rails Gem to get both a datetime and a boolean
+  behaviour from the same database column. Save verified_at:datetime on DB, use user.verified
+  for instances and User.verified as a scope.
 email:
 - carlo.martinucci@gmail.com
 executables: []
@@ -78,5 +78,5 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: Get both a datetime and a boolean behaviour with only one column.
+summary: Get both a datetime and a boolean behaviour from the same database column.
 test_files: []