todo_or_die 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b194253e28740bfc137b7ef030efcf8387fe3acf0b91983eb69b961691a1c4eb
-  data.tar.gz: 8566f5e5b156ff958ee22aaca60f663d372cd0bea69ffacc5218c86441ce2a1c
+  metadata.gz: '0491e8c47bb1f59f0b38966bb65a8dbd6d31a18aa9044ca9445cce8962c55e62'
+  data.tar.gz: c82c1ce0e56afbfb197ff4d7a66d7187003ef085b58d7096c510696faca4dbc9
 SHA512:
-  metadata.gz: fe91f1b1b86bb5a7077a8fa5f35bb25d25f598e4f6c40a319c0a771d755d79905191aa9a2b06982cf33cfc5bdcfa1af0553cd798d53d80580d6c5e27be70ae3e
-  data.tar.gz: 75480ce8dbf70cf14db4ba6e9592530ef40ef15fa173f841dc7cba0e1a1be3f1965031472ec7cd6def55b9a00d737994d984c4f41dc916436b267ec004b1349c
+  metadata.gz: 18751ea8ecfeb4e50ddbdc42229b721957a86bd5d6535655264dec37a46f99f68596fd98be14eb2d585395956cf0b1c01712610750664fae8c8bfa910ac4e0b2
+  data.tar.gz: 6fdf682b441ce3edf280f1322cc4a88bf6af9c84057334eef449e894fcd41ff20a3a2164ccd80a13bbe0214787101c0ff38e24cff1f73ae2353853eaf1563c4c

data/.circleci/config.yml

@@ -6,7 +6,9 @@ version: 2
 jobs:
   build:
     docker:
-       - image: circleci/ruby:2.4.1-node-browsers
+       - image: circleci/ruby:2.7-node-browsers
+         environment:
+           RUBYOPT: "-W:no-deprecated -W:no-experimental"
 
     working_directory: ~/repo
 
@@ -16,6 +18,7 @@ jobs:
       - run:
           name: install dependencies
           command: |
+            bundle update --bundler
             bundle install --retry=3
 
       - run:

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2022-06-27
+
+- Add `warn_by` option [#14](https://github.com/searls/todo_or_die/pull/14)
+
+## [0.0.3] - 2019-11-26
+### Added
+- Boolean-returning conditionals or callables (Proc, Block, Lambda) can be passed to the
+new `if` argument. `if` can be used instead of or in conjunction with the `by` argument
+to die on a specific date OR when a specific condition becomes true.
+
+### Changed
+- Date strings can now be parsed parsed internally without calling `Time` or `Date`
+classes explicitely.
+
+## [0.0.2] - 2019-02-15
+### Changed
+- Exclude this gem's backtrace location from exceptions thrown to make it easier to find
+TODOs.
+
+## [0.0.1] - 2019-01-01
+
+[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.3...HEAD
+[0.0.3]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.2...v0.0.3
+[0.0.2]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.0.1...v0.0.2
+[0.0.1]: https://github.com/olivierlacan/keep-a-changelog/releases/tag/v0.0.1

data/Gemfile

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in todo_or_die.gemspec
 gemspec

data/Gemfile.lock

@@ -1,33 +1,36 @@
 PATH
   remote: .
   specs:
-    todo_or_die (0.0.2)
+    todo_or_die (0.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
-    jaro_winkler (1.5.1)
+    jaro_winkler (1.5.4)
     minitest (5.11.3)
-    parallel (1.12.1)
-    parser (2.5.3.0)
+    parallel (1.19.1)
+    parser (2.7.1.2)
       ast (~> 2.4.0)
-    powerpack (0.1.2)
     rainbow (3.0.0)
-    rake (12.3.2)
-    rubocop (0.61.1)
+    rake (13.0.1)
+    rexml (3.2.4)
+    rubocop (0.82.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      rexml
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
-    ruby-progressbar (1.10.0)
-    standard (0.0.23)
-      rubocop (>= 0.60)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    standard (0.4.1)
+      rubocop (~> 0.82.0)
+      rubocop-performance (~> 1.5.2)
     timecop (0.9.1)
-    unicode-display_width (1.4.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -41,4 +44,4 @@ DEPENDENCIES
   todo_or_die!
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

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,22 @@ 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 a callable (e.g. proc/lambda/method) or
+a boolean test:
+
+``` ruby
+class User < ApplicationRecord
+  TodoOrDie("delete after someone wins", if: User.count > 1000000)
+  def is_one_millionth_user?
+    id == 1000000
+  end
+end
+```
+
+You can also pass both `by` and `if` (where both must be met for an error to be
+raised) or, I guess, neither (where an error will be raised as soon as
+`TodoOrDie` is invoked).
+
 ### What kind of error?
 
 It depends on whether you're using [Rails](https://rubyonrails.org) or not.

data/lib/todo_or_die/version.rb

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

data/lib/todo_or_die.rb

@@ -1,13 +1,18 @@
+require "time"
 require "todo_or_die/version"
 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)
@@ -15,6 +20,20 @@ module TodoOrDie
         raise TodoOrDie::OverdueTodo, error_message, TodoOrDie.__clean_backtrace(caller)
       end
     },
+
+    warn: lambda { |message, due_at, warn_at, condition|
+      error_message = [
+        "TODO: \"#{message}\"",
+        (" is due on #{due_at.strftime("%Y-%m-%d")}" if due_at),
+        (" and" if warn_at && condition),
+        (" has met the conditions to be acted upon" if condition),
+        ". Don't forget!"
+      ].compact.join("")
+
+      puts error_message
+
+      Rails.logger.warn(error_message) if defined?(Rails)
+    }
   }.freeze
 
   def self.config(options = {})
@@ -28,15 +47,26 @@ 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, warn_by: warn_by_omitted = true) # rubocop:disable Naming/MethodName
+  due_at = Time.parse(by.to_s) unless by_omitted
+  warn_at = Time.parse(warn_by.to_s) unless warn_by_omitted
+  condition = binding.local_variable_get(:if) unless if_omitted
+
+  should_warn = !warn_by_omitted && Time.now > warn_at
+  is_due = by_omitted || Time.now > due_at
+  die_condition_met = if_omitted || (condition.respond_to?(:call) ? condition.call : condition)
+  should_die = is_due && die_condition_met
 
-  if Time.now >= due_at
-    TodoOrDie.config[:die].call(message, due_at)
+  if should_die
+    die = TodoOrDie.config[:die]
+    die.call(*[message, due_at, condition].take(die.arity.abs))
+  elsif should_warn
+    warn = TodoOrDie.config[:warn]
+    warn.call(*[message, due_at, warn_at, condition].take(warn.arity.abs))
   end
 end

data/todo_or_die.gemspec

@@ -3,15 +3,15 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "todo_or_die"
 
 Gem::Specification.new do |spec|
-  spec.name          = "todo_or_die"
-  spec.version       = TodoOrDie::VERSION
-  spec.authors       = ["Justin Searls"]
-  spec.email         = ["searls@gmail.com"]
+  spec.name = "todo_or_die"
+  spec.version = TodoOrDie::VERSION
+  spec.authors = ["Justin Searls"]
+  spec.email = ["searls@gmail.com"]
 
-  spec.summary       = "Write TO​DOs in code that ensure you actually do them"
-  spec.homepage      = "https://github.com/searls/todo_or_die"
+  spec.summary = "Write TO​DOs in code that ensure you actually do them"
+  spec.homepage = "https://github.com/searls/todo_or_die"
 
-  spec.files         = Dir.chdir(File.expand_path("..", __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.require_paths = ["lib"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: todo_or_die
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Justin Searls
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-02-15 00:00:00.000000000 Z
+date: 2022-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - searls@gmail.com
 executables: []
@@ -89,6 +89,7 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -103,7 +104,7 @@ files:
 homepage: https://github.com/searls/todo_or_die
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -118,8 +119,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Write TO​DOs in code that ensure you actually do them
 test_files: []