fixme 1.1.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c67ae50e3df9d60ec0fade7d7a0f5c1e36977e9f
-  data.tar.gz: dc1a8c384a67c488afd83c16bba99f497a7d9513
+  metadata.gz: f17c8f6e1e7bf078eb5aecf0ff123ff697518798
+  data.tar.gz: 9d4e88a2b29c7be13ab6744dc3a90cfa1a71f251
 SHA512:
-  metadata.gz: 2ab32146fc4177eab5ca1777116ef256e1574bcd512d45c3c548edc3ee7ec81d2bdcedb7bdd8e046a81e22265875a74ad0ff1754b95b834a104ef9c7498fea13
-  data.tar.gz: 6816245408219c824abdfcafc2b90310c31bc567ddb4c76ce3b1df192c56dd6d7cf2ca5d4c9333f0ff5e72da351b1d4ff6ed4d633e5c66b658b21c43f1a29ddb
+  metadata.gz: 22bed2eda72ded7cda30319e24aa4e80f1cb76583c65ed456871fd71b4a0e9470bec39c3a1f5846655c4803a28ac91e21956bf48d1435c29d035e215389c7431
+  data.tar.gz: d664dc80938522c5d978b30bccbf34b0e2e01f0f7dbb147deced872daf2e5a4fd3b9f7b8b7ef914f7f6354fbd3e88a221d057b8e339c2790e256ebcb374cc45f

data/README.md

@@ -18,15 +18,39 @@ You may want to use these bad boys next to:
   * Experiments, to remember to evaluate them and make a decision.
   * Anything else you can't do now but should fix later.
 
-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.
-
 For simplicity, the date comparison uses machine-local time (not e.g. the Rails configured time zone).
 
 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).
+### Environment awareness
+
+If `Rails.env` (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.
+
+### Selectively disable
+
+If you e.g. don't want your CI server to raise, make it set the environment variable `DISABLE_FIXME_LIB`.
+
+### Do something other than raise
+
+When these exceptions trigger on your CI server they stop the line, blocking your delivery chain until they're addressed. This could be what you want, or it could be a little annoying.
+
+So you can configure the library to do something other than raise:
+
+```
+# In a Rails project, this might be in config/initializers/fixme.rb:
+Fixme.explode_with do |message|
+  YourOwnCodeOrSomeLibrary.email_developers(message)
+  YourOwnCodeOrSomeLibrary.notify_chat(message)
+end
+```
+
+If you want the parsed date and the message separately, do:
+
+```
+Fixme.explode_with do |_, date, message|
+  YourOwnCodeOrSomeLibrary.log(date, message)
+end
+```
 
 
 ## Installation

data/lib/fixme/version.rb

@@ -1,3 +1,3 @@
 module Fixme
-  VERSION = "1.1.3"
+  VERSION = "2.0.0"
 end

data/lib/fixme.rb

@@ -4,6 +4,25 @@ require "date"
 module Fixme
   class UnfixedError < StandardError; end
 
+  DEFAULT_EXPLODER = proc { |message| raise(UnfixedError, message) }
+
+  def self.reset_configuration
+    explode_with(&DEFAULT_EXPLODER)
+  end
+
+  def self.explode_with(&block)
+    @explode_with = block
+  end
+
+  def self.explode(date, message)
+    full_message = "Fix by #{date}: #{message}"
+    @explode_with.call(full_message, date, message)
+  end
+
+  reset_configuration
+end
+
+module Fixme
   module Mixin
     def FIXME(date_and_message)
       # In a separate class to avoid mixing in privates.
@@ -20,15 +39,13 @@ module Fixme
     end
 
     def run
-      return if ENV["DO_NOT_RAISE_FIXMES"]
+      return if ENV["DISABLE_FIXME_LIB"]
       return unless RUN_ONLY_IN_FRAMEWORK_ENVS.include?(framework_env.to_s)
 
       due_date, message = parse
 
       disallow_timecop do
-        if Date.today >= due_date
-          raise UnfixedError, "Fix by #{due_date}: #{message}"
-        end
+        Fixme.explode(due_date, message) if Date.today >= due_date
       end
     end
 

data/spec/fixme_spec.rb

@@ -2,6 +2,10 @@ require "fixme"
 require "timecop"
 
 describe Fixme, "#FIXME" do
+  before do
+    Fixme.reset_configuration
+  end
+
   it "raises after the given date" do
     expect {
       FIXME "2013-12-31: Remove this stuff."
@@ -9,9 +13,11 @@ describe Fixme, "#FIXME" do
   end
 
   it "raises on the given date" do
+    today = Date.today
+
     expect {
-      FIXME "#{Date.today.to_s}: Remove this stuff."
-    }.to raise_error(Fixme::UnfixedError, "Fix by #{Date.today.to_s}: Remove this stuff.")
+      FIXME "#{today}: Remove this stuff."
+    }.to raise_error(Fixme::UnfixedError, "Fix by #{today}: Remove this stuff.")
   end
 
   it "does not raise before the given date" do
@@ -68,7 +74,7 @@ describe Fixme, "#FIXME" do
 
   context "when a Rack environment is detected" do
     before do
-      stub_env "DO_NOT_RAISE_FIXMES", nil
+      stub_env "DISABLE_FIXME_LIB", nil
     end
 
     it "raises in the 'test' environment" do
@@ -87,11 +93,41 @@ describe Fixme, "#FIXME" do
     end
   end
 
-  it "does not raise when the DO_NOT_RAISE_FIXMES environment variable is set" do
-    stub_env "DO_NOT_RAISE_FIXMES", true
+  it "does not raise when the DISABLE_FIXME_LIB environment variable is set" do
+    stub_env "DISABLE_FIXME_LIB", true
     expect_not_to_raise
   end
 
+  context "configuring an alternative to raising" do
+    it "lets you provide a block" do
+      log = []
+
+      Fixme.explode_with do |full_message, date, message|
+        log << [ full_message, date, message ]
+      end
+
+      FIXME "2013-12-31: Do not explode."
+
+      expect(log.last).to eq [
+        "Fix by 2013-12-31: Do not explode.",
+        Date.new(2013, 12, 31),
+        "Do not explode.",
+      ]
+    end
+
+    it "lets the block take a subset of parameters" do
+      log = []
+
+      Fixme.explode_with do |full_message|
+        log << full_message
+      end
+
+      FIXME "2013-12-31: Do not explode."
+
+      expect(log.last).to eq "Fix by 2013-12-31: Do not explode."
+    end
+  end
+
   private
 
   def stub_rails_env(value)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fixme
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Henrik Nyh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-24 00:00:00.000000000 Z
+date: 2014-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler