fixme 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f17c8f6e1e7bf078eb5aecf0ff123ff697518798
-  data.tar.gz: 9d4e88a2b29c7be13ab6744dc3a90cfa1a71f251
+  metadata.gz: 7e1ab3e11f1dd62c6d26791d1278dc0f1b0da2b4
+  data.tar.gz: 6b702750cb9cf2598a711e0d99be151d56c1bde5
 SHA512:
-  metadata.gz: 22bed2eda72ded7cda30319e24aa4e80f1cb76583c65ed456871fd71b4a0e9470bec39c3a1f5846655c4803a28ac91e21956bf48d1435c29d035e215389c7431
-  data.tar.gz: d664dc80938522c5d978b30bccbf34b0e2e01f0f7dbb147deced872daf2e5a4fd3b9f7b8b7ef914f7f6354fbd3e88a221d057b8e339c2790e256ebcb374cc45f
+  metadata.gz: 8b1038bbedf63b7c176638a1772f3574dc31408b885244432dd0b70f431ebcb18980f8b9e513f180005e39cf76cd0d14e3fbc22272dd0a084f71932062346116
+  data.tar.gz: 19e4702838cb5434f1dbd9c35854f4835e91354591821a5457fb610dc5e823272f6cd23c6a2d9139daba0b86b21a1d06042f7f12570b68e8fcc907e0fa1e9de1

data/README.md

@@ -26,10 +26,6 @@ Protip: make sure it's clear from the exception or from a separate comment just
 
 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.
@@ -37,20 +33,18 @@ When these exceptions trigger on your CI server they stop the line, blocking you
 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)
+# In a Rails project, this might be in config/initializers/fixme.rb
+Fixme.explode_with do |details|
+  YourOwnCodeOrSomeLibrary.email_developers(details.full_message)
+  YourOwnCodeOrSomeLibrary.notify_chat(details.full_message)
 end
 ```
 
-If you want the parsed date and the message separately, do:
+There's also `details.date`, `details.message` and `details.backtrace`.
 
-```
-Fixme.explode_with do |_, date, message|
-  YourOwnCodeOrSomeLibrary.log(date, message)
-end
-```
+### Selectively disable
+
+If you e.g. don't want your CI server to raise, make it set the environment variable `DISABLE_FIXME_LIB`.
 
 
 ## Installation

data/lib/fixme.rb

@@ -2,9 +2,10 @@ require "fixme/version"
 require "date"
 
 module Fixme
-  class UnfixedError < StandardError; end
+  UnfixedError = Class.new(StandardError)
+  Details = Struct.new(:full_message, :backtrace, :date, :message)
 
-  DEFAULT_EXPLODER = proc { |message| raise(UnfixedError, message) }
+  DEFAULT_EXPLODER = proc { |details| raise(UnfixedError, details.full_message, details.backtrace) }
 
   def self.reset_configuration
     explode_with(&DEFAULT_EXPLODER)
@@ -16,7 +17,8 @@ module Fixme
 
   def self.explode(date, message)
     full_message = "Fix by #{date}: #{message}"
-    @explode_with.call(full_message, date, message)
+    backtrace = caller.reverse.take_while { |line| !line.include?(__FILE__) }.reverse
+    @explode_with.call Details.new(full_message, backtrace, date, message)
   end
 
   reset_configuration
@@ -32,7 +34,7 @@ module Fixme
   end
 
   class Runner
-    RUN_ONLY_IN_FRAMEWORK_ENVS = [ "", "test", "development" ]
+    RUN_ONLY_IN_THESE_FRAMEWORK_ENVS = [ "", "test", "development" ]
 
     def initialize(date_and_message)
       @date_and_message = date_and_message
@@ -40,7 +42,7 @@ module Fixme
 
     def run
       return if ENV["DISABLE_FIXME_LIB"]
-      return unless RUN_ONLY_IN_FRAMEWORK_ENVS.include?(framework_env.to_s)
+      return unless RUN_ONLY_IN_THESE_FRAMEWORK_ENVS.include?(framework_env.to_s)
 
       due_date, message = parse
 

data/lib/fixme/version.rb

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

data/spec/fixme_spec.rb

@@ -26,6 +26,14 @@ describe Fixme, "#FIXME" do
     }.not_to raise_error
   end
 
+  it "truncates the backtrace to exclude itself" do
+    begin
+      FIXME "2013-12-31: Remove this stuff."
+    rescue => e
+      expect(e.backtrace.first).to include("fixme_spec.rb:")
+    end
+  end
+
   # Had a bug with ": " in the message.
   it "parses the date and message flawlessly" do
     expect {
@@ -98,34 +106,19 @@ describe Fixme, "#FIXME" do
     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
+  it "lets you configure an alternative to raising" do
+    log = nil
 
-      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.",
-      ]
+    Fixme.explode_with do |details|
+      log = details
     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."
 
-      FIXME "2013-12-31: Do not explode."
-
-      expect(log.last).to eq "Fix by 2013-12-31: Do not explode."
-    end
+    expect(log.full_message).to eq "Fix by 2013-12-31: Do not explode."
+    expect(log.date).to eq Date.new(2013, 12, 31)
+    expect(log.message).to eq "Do not explode."
+    expect(log.backtrace.first).to include "fixme_spec.rb:"
   end
 
   private

metadata

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