todo_or_die 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e96cc61c209d86d2cc3c4caddf881ada4c803ab16f20f5184b43fae0542c6032
-  data.tar.gz: 73ae688e244d5ce0b960a5a931f53c98dc94813d38833aab0126168c2ad17ef8
+  metadata.gz: b194253e28740bfc137b7ef030efcf8387fe3acf0b91983eb69b961691a1c4eb
+  data.tar.gz: 8566f5e5b156ff958ee22aaca60f663d372cd0bea69ffacc5218c86441ce2a1c
 SHA512:
-  metadata.gz: 8c1775674c7f182cb34633e5f0ddeed7dd2272f041d2ccbd93b3f693382884eea36d06a557bbdc9633f6e29741d291ff09ffb1a8a53e28ba4a4f8ec481666326
-  data.tar.gz: abebfad5178929b2237c88d25a1ee0df15190377b207a99371d6d27314edb74fd1e8f31898628222d424536e19289f70291c42925505e83cfe9ae5e3757cf434
+  metadata.gz: fe91f1b1b86bb5a7077a8fa5f35bb25d25f598e4f6c40a319c0a771d755d79905191aa9a2b06982cf33cfc5bdcfa1af0553cd798d53d80580d6c5e27be70ae3e
+  data.tar.gz: 75480ce8dbf70cf14db4ba6e9592530ef40ef15fa173f841dc7cba0e1a1be3f1965031472ec7cd6def55b9a00d737994d984c4f41dc916436b267ec004b1349c

data/.circleci/config.yml

@@ -0,0 +1,24 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+       - image: circleci/ruby:2.4.1-node-browsers
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --retry=3
+
+      - run:
+          name: run tests
+          command: bundle exec rake
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    todo_or_die (0.0.1)
+    todo_or_die (0.0.2)
 
 GEM
   remote: https://rubygems.org/
@@ -41,4 +41,4 @@ DEPENDENCIES
   todo_or_die!
 
 BUNDLED WITH
-   1.17.2
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2019 Justin Searls
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,5 +1,9 @@
 # TODO or Die!
 
+<img src="https://user-images.githubusercontent.com/79303/50570550-f41a6180-0d5d-11e9-8033-7ea4dfb7261c.jpg" height="360"  alt="TODO or Die NES cart"/>
+
+[![CircleCI](https://circleci.com/gh/searls/todo_or_die/tree/master.svg?style=svg)](https://circleci.com/gh/searls/todo_or_die/tree/master)
+
 ## Usage
 
 Stick this in your Gemfile and bundle it:
@@ -18,11 +22,9 @@ 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:
+In the Bad Old Days™, if you had a bit of code you knew you needed to change
+later, you might leave yourself a code comment to remind yourself to change it.
+For example, here's the real world code comment that inspired this gem:
 
 ``` ruby
 class UsersController < ApiController
@@ -41,11 +43,10 @@ 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.
+problem: I wrote code in the vain hope of solving things without needing to talk
+to anyone. And now this gem exists.
 
-To use the gem, try replacing one of your TODO comments with something like
-this:
+To use it, try replacing one of your TODO comments with something like this:
 
 ``` ruby
 class UsersController < ApiController
@@ -61,7 +62,7 @@ raise an error whenever this class is loaded until someone deals with it.
 
 ### What kind of error?
 
-It depends on whether `Rails` is defined.
+It depends on whether you're using [Rails](https://rubyonrails.org) or not.
 
 #### When you're writing Real Ruby
 
@@ -70,26 +71,28 @@ 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!
+TODO: "Visit Wisconsin" came due on 2016-11-09. 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.
+`Rails.logger.warn` in production (while still raising the error in development
+and test).
 
-### Wait, won't raising time-based errors throughout my app ruin my weekend?
+### Wait, won't sprinkling time bombs throughout my app ruin my weekend?
 
-Sure will! It's TODO or Die, not TODO and Remember to Pace Yourself.
+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.
+Still, someone will probably get mad if you break production because you forgot
+to follow through on removing an A/B test, so I'd [strongly recommend you read
+what the default hook actually does](lib/todo_or_die.rb#L8-L16) before this gem
+leads to you losing your job. (Speaking of, please note the lack of any warranty
+in `todo_or_die`'s [license](LICENSE.txt).)
 
-You can customize the gem's behavior by passing in your own callable
-lambda/proc/thing like this:
+To appease your boss, you may customize the gem's behavior by passing in your
+own `call`'able lambda/proc/dingus like this:
 
 ```ruby
 TodoOrDie.config(
@@ -102,29 +105,30 @@ TodoOrDie.config(
 ```
 
 Now, any `TodoOrDie()` invocations in your codebase (other than Karen's) will be
-ignored. (You can reset this with `TodoOrDie.reset`).
+ignored. (You can restore the default hook 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.
+This gem may come in handy whenever you know the code _will_ need to change,
+but it can't be changed just yet, 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:
+This is a good time to recall [LeBlanc's
+Law](https://www.quora.com/What-resources-could-I-read-about-Leblancs-law),
+which states that `Later == Never`. Countless proofs of this theorem have been
+reproduced 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
+* A feature flag was added to the app a long time ago, but the old code path is
+  still present, even after the flag had been enabled for everyone. Except now
+  there's also a useless `TODO: delete` comment to keep it company
+* A failing test was blocking the build and someone felt an urgent pressure to
+  deploy the app anyway. So, rather than fix the test, Bill commented it out
+  "for now"
+* You're a real funny guy and you think it'd be hilarious to make a bunch of
+  Aaron's tests start failing on Christmas morning
 
-# Pro-tip
+## 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:
@@ -133,4 +137,4 @@ do this and actually accomplish anything:
 TodoOrDie("Update after APIv2 goes live", 2.weeks.from_now)
 ```
 
-
+It will never be two weeks from now.

data/lib/todo_or_die.rb

@@ -12,7 +12,7 @@ module TodoOrDie
       if defined?(Rails) && Rails.env.production?
         Rails.logger.warn(error_message)
       else
-        raise TodoOrDie::OverdueTodo.new(error_message)
+        raise TodoOrDie::OverdueTodo, error_message, TodoOrDie.__clean_backtrace(caller)
       end
     },
   }.freeze
@@ -25,6 +25,11 @@ module TodoOrDie
   def self.reset
     @config = DEFAULT_CONFIG.dup
   end
+
+  FILE_PATH_REGEX = Regexp.new(Regexp.quote(__dir__)).freeze
+  def self.__clean_backtrace(stack)
+    stack.delete_if {|line| line =~ FILE_PATH_REGEX }
+  end
 end
 
 # The main event

data/lib/todo_or_die/version.rb

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

data/todo_or_die.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   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.homepage      = "https://github.com/searls/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)/}) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: todo_or_die
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Justin Searls
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-01 00:00:00.000000000 Z
+date: 2019-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,9 +87,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
+- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
@@ -98,7 +100,7 @@ files:
 - 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
+homepage: https://github.com/searls/todo_or_die
 licenses: []
 metadata: {}
 post_install_message: