fixme 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5918a9a8d6c7ed2b50dffce574ddd35938855694
-  data.tar.gz: 174d74e39c33019eeb487ad97cf58c827a0618dd
+  metadata.gz: c67ae50e3df9d60ec0fade7d7a0f5c1e36977e9f
+  data.tar.gz: dc1a8c384a67c488afd83c16bba99f497a7d9513
 SHA512:
-  metadata.gz: 42f862c20eb8fd60cbc2bd6fcefbaaee13ed635d0f4ebefe84167b13f9c8a3df23eeac57c5ae60c40ec1394f2b4ff029d5fee13d9f0a90138312da6e9977fa4a
-  data.tar.gz: 3bec830317f532f8e923ce858921f3ad12dc1a65ddeb753c8d4771ef0f38950ca672ee36788a368d44c7d65b515b8f92ddbe9eb1aa8ac0313a25124a6a36a010
+  metadata.gz: 2ab32146fc4177eab5ca1777116ef256e1574bcd512d45c3c548edc3ee7ec81d2bdcedb7bdd8e046a81e22265875a74ad0ff1754b95b834a104ef9c7498fea13
+  data.tar.gz: 6816245408219c824abdfcafc2b90310c31bc567ddb4c76ce3b1df192c56dd6d7cf2ca5d4c9333f0ff5e72da351b1d4ff6ed4d633e5c66b658b21c43f1a29ddb

data/README.md

@@ -22,6 +22,8 @@ If `Rails.environment` (Ruby on Rails) or `ENV["RACK_ENV"]` (e.g. Sinatra) is pr
 
 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).

data/lib/fixme.rb

@@ -6,26 +6,50 @@ module Fixme
 
   module Mixin
     def FIXME(date_and_message)
-      return if ENV["DO_NOT_RAISE_FIXMES"]
+      # In a separate class to avoid mixing in privates.
+      # http://thepugautomatic.com/2014/02/private-api/
+      Runner.new(date_and_message).run
+    end
+  end
+
+  class Runner
+    RUN_ONLY_IN_FRAMEWORK_ENVS = [ "", "test", "development" ]
 
-      env = defined?(Rails) ? Rails.env : ENV["RACK_ENV"]
-      return unless [ "", "test", "development" ].include?(env.to_s)
+    def initialize(date_and_message)
+      @date_and_message = date_and_message
+    end
+
+    def run
+      return if ENV["DO_NOT_RAISE_FIXMES"]
+      return unless RUN_ONLY_IN_FRAMEWORK_ENVS.include?(framework_env.to_s)
 
-      raw_date, message = date_and_message.split(": ", 2)
-      due_date = Date.parse(raw_date)
+      due_date, message = parse
 
-      raise_if_due = -> {
+      disallow_timecop do
         if Date.today >= due_date
           raise UnfixedError, "Fix by #{due_date}: #{message}"
         end
-      }
+      end
+    end
 
+    private
+
+    def framework_env
+      defined?(Rails) ? Rails.env : ENV["RACK_ENV"]
+    end
+
+    def disallow_timecop(&block)
       if defined?(Timecop)
-        Timecop.return(&raise_if_due)
+        Timecop.return(&block)
       else
-        raise_if_due.call
+        block.call
       end
     end
+
+    def parse
+      raw_date, message = @date_and_message.split(": ", 2)
+      [ Date.parse(raw_date), message ]
+    end
   end
 end
 

data/lib/fixme/version.rb

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

metadata

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