todo_or_die 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b194253e28740bfc137b7ef030efcf8387fe3acf0b91983eb69b961691a1c4eb
-  data.tar.gz: 8566f5e5b156ff958ee22aaca60f663d372cd0bea69ffacc5218c86441ce2a1c
+  metadata.gz: 96c320c1ac97e6cffb75fb2a62e882c2f7380aab8e38a562a584ab8c167b05b0
+  data.tar.gz: ac069f4dac6b8282328c521b9f9dc28ea4121d4ddd071ebc838db81a11e946b3
 SHA512:
-  metadata.gz: fe91f1b1b86bb5a7077a8fa5f35bb25d25f598e4f6c40a319c0a771d755d79905191aa9a2b06982cf33cfc5bdcfa1af0553cd798d53d80580d6c5e27be70ae3e
-  data.tar.gz: 75480ce8dbf70cf14db4ba6e9592530ef40ef15fa173f841dc7cba0e1a1be3f1965031472ec7cd6def55b9a00d737994d984c4f41dc916436b267ec004b1349c
+  metadata.gz: 4b2336159eb6e740866bbbf452979c3f55970a0dd77017880e3c40213511f47acd139d0be43cca0cae5d2c3fbff2b3671ae4929f43843e3c2cbd84f72717ba70
+  data.tar.gz: 4aed5f65010ef315704714d9acd608c9bb356ed0b07bb187c89a57c692f1efcbc6f14c9761edff0391ac538cf1ca2ded76f81295718ce75581c5baf6901df492

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    todo_or_die (0.0.2)
+    todo_or_die (0.0.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -50,7 +50,7 @@ To use it, try replacing one of your TODO comments with something like this:
 
 ``` ruby
 class UsersController < ApiController
-  TodoOrDie("delete after JS app has propagated", by: Time.parse("2019-02-04"))
+  TodoOrDie("delete after JS app has propagated", by: "2019-02-04")
   def show
     redirect_to root_path
   end
@@ -60,6 +60,20 @@ end
 Nothing will happen at all until February 4th, at which point the gem will
 raise an error whenever this class is loaded until someone deals with it.
 
+You may also pass a condition, either as boolean or in proc/lambda form:
+
+``` ruby
+class User < ApplicationRecord
+  TodoOrDie(
+    "delete after 1 million users",
+    if: User.size > 1000000,
+  )
+  def is_one_millionth_user?
+    id == 1000000
+  end
+end
+```
+
 ### What kind of error?
 
 It depends on whether you're using [Rails](https://rubyonrails.org) or not.

data/lib/todo_or_die.rb

@@ -4,10 +4,14 @@ require "todo_or_die/overdue_error"
 # The namespace
 module TodoOrDie
   DEFAULT_CONFIG = {
-    die: ->(message, due_at) {
-      error_message = <<~MSG
-        TODO: "#{message}" came due on #{due_at.strftime("%Y-%m-%d")}. Do it!
-      MSG
+    die: ->(message, due_at, condition) {
+      error_message = [
+        "TODO: \"#{message}\"",
+        (" came due on #{due_at.strftime("%Y-%m-%d")}" if due_at),
+        (" and" if due_at && condition),
+        (" has met the conditions to be acted upon" if condition),
+        ". Do it!",
+      ].compact.join("")
 
       if defined?(Rails) && Rails.env.production?
         Rails.logger.warn(error_message)
@@ -28,15 +32,19 @@ module TodoOrDie
 
   FILE_PATH_REGEX = Regexp.new(Regexp.quote(__dir__)).freeze
   def self.__clean_backtrace(stack)
-    stack.delete_if {|line| line =~ FILE_PATH_REGEX }
+    stack.delete_if { |line| line =~ FILE_PATH_REGEX }
   end
 end
 
 # The main event
-def TodoOrDie(message, by:) # rubocop:disable Naming/MethodName
-  due_at = by.to_time
+def TodoOrDie(message, by: by_omitted = true, if: if_omitted = true) # rubocop:disable Naming/MethodName
+  due_at = Time.parse(by.to_s) unless by_omitted
+  is_due = by_omitted || Time.now > due_at
+  condition = binding.local_variable_get(:if) unless if_omitted
+  condition_met = if_omitted || (condition.respond_to?(:call) ? condition.call : condition)
 
-  if Time.now >= due_at
-    TodoOrDie.config[:die].call(message, due_at)
+  if is_due && condition_met
+    die = TodoOrDie.config[:die]
+    die.call(*[message, due_at, condition].take(die.arity.abs))
   end
 end

data/lib/todo_or_die/version.rb

@@ -1,3 +1,3 @@
 module TodoOrDie
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: todo_or_die
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Justin Searls
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-15 00:00:00.000000000 Z
+date: 2019-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Write TO​DOs in code that ensure you actually do them