fixme 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 446328def31c867a17062161e563e6b6a5d292a1
-  data.tar.gz: 46c74e2f259703dc4e329c2fd3ca78e90206ffe1
+  metadata.gz: a739fb14f76d1ecaf78b09daa1ef1bb44d3619dc
+  data.tar.gz: 6b4463e54b2eb7c81324fc0d26498b494db25eed
 SHA512:
-  metadata.gz: b7ac9527bd3cbced205d5c2200e04acba028345dd1ae6f647b01e671ebd66366ab1b34562a53883390e71b51aa3d8eeed7424ca55b749d196013fb73547c55ea
-  data.tar.gz: 4c41a4c9aba365850ad2fec9f4024c2e20d0697c5ca9a92f38064f64769e7ac31539fab84783c1709eea9bfc4952fd71e12f0607628c14e3afe0d9c853c53ff4
+  metadata.gz: f07137de06cedb7e5141b04f87e2573c3f625068e58bdd7f0b132ec6b3405768d20e5c708c02f729151e6ca9200480f3d0d557d9c4d98f891536c6c1aedb6abf
+  data.tar.gz: fd5d5a33abe502db63b0e18dc144d5e4b36197791647e0f1482cd68da5d80697e3f2cb323fcd2d769bbd89247acd23f4c41a66b768f7b9ae3a59591b477618b1

data/README.md

@@ -7,17 +7,25 @@ FIXME "2014-07-31: Stop hard-coding currency."
 currency = "USD"
 ```
 
-You may want to use them next to:
+This library makes a `FIXME()` method available everywhere.
+
+Starting July 31st 2014, the "FIXME" line in the example above would raise `Fixme::UnfixedError` with the message `"Fix by 2014-07-31: Stop hard-coding currency."`
+
+You may want to use these bad boys next to:
 
   * Temporary quick fixes, to ensure they really *are* temporary.
   * Code that supports legacy workflows during a transitional period.
   * Experiments, to remember to evaluate them and make a decision.
   * Anything else you can't do now but should fix later.
 
-Starting July 31st 2014, the "FIXME" line in the example above would start raising an exception with the given message.
-
 If `Rails.environment` (Ruby on Rails) or `ENV["RACK_ENV"]` (e.g. Sinatra) is present, it will only ever raise in the `"test"` and `"development"` environments. That is, the production app will never raise these exceptions.
 
+If you don't want your CI server to raise, make it set the environment variable `DO_NOT_RAISE_FIXMES`. I like having CI raise them, though.
+
+Protip: make sure it's clear from the exception or from a separate comment just what should be done – sometimes not even the person who wrote the quickfix will remember what you're meant to change.
+
+This library is an extraction of a helper (originally called `wip_raise`) we tried and liked at [Barsoom](http://barsoom.se).
+
 
 ## Installation
 

data/lib/fixme.rb

@@ -6,6 +6,8 @@ module Fixme
 
   module Mixin
     def FIXME(date_and_message)
+      return if ENV["DO_NOT_RAISE_FIXMES"]
+
       raw_date, message = date_and_message.split(": ", 2)
       due_date = Date.parse(raw_date)
 

data/lib/fixme/version.rb

@@ -1,3 +1,3 @@
 module Fixme
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/spec/fixme_spec.rb

@@ -19,6 +19,7 @@ describe Fixme, "#TODO" do
     }.not_to raise_error
   end
 
+  # Had a bug with ": " in the message.
   it "parses the date and message flawlessly" do
     expect {
       FIXME "2013-12-31: Remove this: and this."
@@ -55,6 +56,10 @@ describe Fixme, "#TODO" do
   end
 
   context "when a Rack environment is detected" do
+    before do
+      ENV.stub(:[]).with("DO_NOT_RAISE_FIXMES")
+    end
+
     it "raises in the 'test' environment" do
       ENV.stub(:[]).with("RACK_ENV").and_return("test")
       expect_to_raise
@@ -71,6 +76,11 @@ describe Fixme, "#TODO" do
     end
   end
 
+  it "does not raise when the DO_NOT_RAISE_FIXMES environment variable is set" do
+    ENV.stub(:[]).with("DO_NOT_RAISE_FIXMES").and_return("true")
+    expect_not_to_raise
+  end
+
   private
 
   def expect_to_raise

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fixme
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Henrik Nyh