todo_or_die 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e96cc61c209d86d2cc3c4caddf881ada4c803ab16f20f5184b43fae0542c6032
+  data.tar.gz: 73ae688e244d5ce0b960a5a931f53c98dc94813d38833aab0126168c2ad17ef8
+SHA512:
+  metadata.gz: 8c1775674c7f182cb34633e5f0ddeed7dd2272f041d2ccbd93b3f693382884eea36d06a557bbdc9633f6e29741d291ff09ffb1a8a53e28ba4a4f8ec481666326
+  data.tar.gz: abebfad5178929b2237c88d25a1ee0df15190377b207a99371d6d27314edb74fd1e8f31898628222d424536e19289f70291c42925505e83cfe9ae5e3757cf434

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    todo_or_die (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    jaro_winkler (1.5.1)
+    minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    rubocop (0.61.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    standard (0.0.23)
+      rubocop (>= 0.60)
+    timecop (0.9.1)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  minitest
+  rake
+  standard
+  timecop
+  todo_or_die!
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -0,0 +1,136 @@
+# TODO or Die!
+
+## Usage
+
+Stick this in your Gemfile and bundle it:
+
+```ruby
+gem "todo_or_die"
+```
+
+Once required, you can mark TODOs for yourself anywhere you like:
+
+```ruby
+TodoOrDie("Update after APIv2 goes live", by: Date.civil(2019, 2, 4))
+```
+
+To understand why you would ever call a method to write a comment, read on.
+
+### The awful way you used to procrastinate
+
+In the Bad Old Days™, if you had a bit of code you knew needed to change later,
+you might leave yourself a code comment to remind yourself or some future
+traveler to implement it.
+
+Here's the real world example code comment that inspired this gem:
+
+``` ruby
+class UsersController < ApiController
+  # TODO: remember to delete after JS app has propagated
+  def show
+    redirect_to root_path
+  end
+end
+```
+
+This was bad. The comment did nothing to remind myself or anyone else to
+actually delete the code. Because no one was working on this part of the system
+for a while, the _continued existence of the redirect_ eventually resulted in an
+actual support incident (long story).
+
+### The cool new way you put off coding now
+
+So I did what any programmer would do in the face of an intractable social
+problem: I wrote code in the vain hope of solving it without having to talk to
+anyone.
+
+To use the gem, 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"))
+  def show
+    redirect_to root_path
+  end
+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.
+
+### What kind of error?
+
+It depends on whether `Rails` is defined.
+
+#### When you're writing Real Ruby
+
+If you're not using Rails (i.e. `defined?(Rails)` is false), then the gem will
+raise a `TodoOrDie::OverdueError` whenever a TODO is overdue. The message looks
+like this:
+
+```
+TODO: "Visit Wisconsin" came due on 2016-11-9. Do it!
+```
+
+#### When `Rails` is a thing
+
+If TodoOrDie sees that `Rails` is defined, it'll assume you probably don't want
+this tool to run outside development and test, so it'll log the error message to
+`Rails.logger.warn` in production and raise the error otherwise.
+
+### Wait, won't raising time-based errors throughout my app ruin my weekend?
+
+Sure will! It's TODO or Die, not TODO and Remember to Pace Yourself.
+
+Still, people will probably get mad if you break production because you forgot
+to remove an A/B test, so I'd [strongly recommend you read what the default hook
+actually does](lib/todo_or_die.rb) before you commit any to-do items to your
+codebase.
+
+You can customize the gem's behavior by passing in your own callable
+lambda/proc/thing like this:
+
+```ruby
+TodoOrDie.config(
+  die: ->(message, due_at) {
+    if message.include?("Karen")
+      raise "Hey Karen your code's broke"
+    end
+  }
+)
+```
+
+Now, any `TodoOrDie()` invocations in your codebase (other than Karen's) will be
+ignored. (You can reset this with `TodoOrDie.reset`).
+
+## When is this useful?
+
+Any time you know the code needs to change, but it can't change right now, and
+you lack some other reliable means of ensuring yourself (or your team)
+will actually follow through on making the change later.
+
+However, recall that [LeBlanc's
+Law](https://www.quora.com/What-resources-could-I-read-about-Leblancs-law)
+states that `Later == Never`, countless proofs of which have been demonstrated
+by software teams around the world. Some common examples:
+
+* A feature flag was added to the app, and the old code path is still present,
+  long after all production traffic has been migrated with a useless `TODO:
+  delete` comment to keep it company
+* A failing test is blocking the build and there's an urgent pressure to deploy,
+  and insufficient time to fix the test, so somebody wants to comment the test
+  out "for now"
+* You're a real funny person and you think it'd be hilarious to make a bunch of
+  Jim's tests start failing on Christmas morning
+
+# Pro-tip
+
+Cute Rails date helpers are awesome, but don't think you're going to be able to
+do this and actually accomplish anything:
+
+```ruby
+TodoOrDie("Update after APIv2 goes live", 2.weeks.from_now)
+```
+
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "standard/rake"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: [:test, "standard:fix"]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "todo_or_die"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/todo_or_die.rb

@@ -0,0 +1,37 @@
+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
+
+      if defined?(Rails) && Rails.env.production?
+        Rails.logger.warn(error_message)
+      else
+        raise TodoOrDie::OverdueTodo.new(error_message)
+      end
+    },
+  }.freeze
+
+  def self.config(options = {})
+    @config ||= reset
+    @config.merge!(options)
+  end
+
+  def self.reset
+    @config = DEFAULT_CONFIG.dup
+  end
+end
+
+# The main event
+def TodoOrDie(message, by:) # rubocop:disable Naming/MethodName
+  due_at = by.to_time
+
+  if Time.now >= due_at
+    TodoOrDie.config[:die].call(message, due_at)
+  end
+end

data/lib/todo_or_die/overdue_error.rb

@@ -0,0 +1,4 @@
+module TodoOrDie
+  class OverdueTodo < StandardError
+  end
+end

data/lib/todo_or_die/version.rb

@@ -0,0 +1,3 @@
+module TodoOrDie
+  VERSION = "0.0.1"
+end

data/todo_or_die.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path("../lib", __FILE__)
+$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.summary       = "Write TO​DOs in code that ensure you actually do them"
+  spec.homepage      = "https://github.com/testdouble/todo_or_die"
+
+  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"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "standard"
+  spec.add_development_dependency "timecop"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: todo_or_die
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Justin Searls
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- searls@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/todo_or_die.rb
+- lib/todo_or_die/overdue_error.rb
+- lib/todo_or_die/version.rb
+- todo_or_die.gemspec
+homepage: https://github.com/testdouble/todo_or_die
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Write TO​DOs in code that ensure you actually do them
+test_files: []