todo_or_die 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 720068aa6be87b431d7bb5edd809ae84999347b553f8182de6f580bb5bd4b033
-  data.tar.gz: 58f7bff93dcee49e91c0ad7c51a2e0ffd633d77e6057eec380ac80e508f9308b
+  metadata.gz: '0491e8c47bb1f59f0b38966bb65a8dbd6d31a18aa9044ca9445cce8962c55e62'
+  data.tar.gz: c82c1ce0e56afbfb197ff4d7a66d7187003ef085b58d7096c510696faca4dbc9
 SHA512:
-  metadata.gz: 83ad0bedfafe54e42295a2b1f6f414bcd11302062261b87fb4d544037fd36e008b8c5dee3374a66fa8bd3dd03ba2c53978d943d2fd4168bb5eebc3726556d878
-  data.tar.gz: 8608b6a2259e145936a642e8f4d8fb585fa0cba8bcb07ec7a2fe4e9182455cd17c35529bb40070459b321d9d5f6cf7757a68e2ceac89c0dd67220870dc36ca7b
+  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

@@ -4,21 +4,23 @@ 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).
 
-## [Unreleased]
+## [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 
+- 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` 
+- 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 
+- Exclude this gem's backtrace location from exceptions thrown to make it easier to find
 TODOs.
 
 ## [0.0.1] - 2019-01-01

data/Gemfile.lock

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

data/lib/todo_or_die/version.rb

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

data/lib/todo_or_die.rb

@@ -19,6 +19,20 @@ module TodoOrDie
       else
         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
 
@@ -38,14 +52,21 @@ module TodoOrDie
 end
 
 # The main event
-def TodoOrDie(message, by: by_omitted = true, if: if_omitted = true) # rubocop:disable Naming/MethodName
+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
-  is_due = by_omitted || Time.now > due_at
+  warn_at = Time.parse(warn_by.to_s) unless warn_by_omitted
   condition = binding.local_variable_get(:if) unless if_omitted
-  condition_met = if_omitted || (condition.respond_to?(:call) ? condition.call : condition)
 
-  if is_due && condition_met
+  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 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: todo_or_die
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Justin Searls
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-16 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: []
@@ -104,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
@@ -119,8 +119,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-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: []