fixme 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c22c8de703949aee9f30546eb6e2c7bb31cbc01
-  data.tar.gz: a8ad824e7c638e50bc0f22fd865fb7808fc28290
+  metadata.gz: cbc2e5c159dcd920e203ec950ac493e9339b77e8
+  data.tar.gz: 96191e0feb5b2c28d2dc3d7bb65fd3e162307ef6
 SHA512:
-  metadata.gz: b3d9ec182e5b1a70559e04a14df877fa20432fde0567a77e73ac42444261eafcc8b47e042f9e71116c412c4441ff86778c015fe2fae85fe50cf5e6dd7c02d3d6
-  data.tar.gz: 0cbc5e4615e2debaf36b8251a10a29ab684e02fddfd9b2aa1ca82a3ca7653ff8d2b7c53229048516ac60aaccf9fd3e7c2e4c79d92dbc992584fdf2d323623d96
+  metadata.gz: 13424bc30b93a5c28007dd1bd80f4786c5c9a36918dde89c4d4e81e133fd7458bc5c8e6c41e2843db73840e918a2f036135aee3770e89e1171eaa260f6943d31
+  data.tar.gz: 8694fdbb13ed2d7382f3e04cfbe98c1ae3843e6d2baefaafad6f19dbf37f2d399ddcbadfd608b0e6f099d88a135af7b45edae60f2b7a239b16c8478dd6b50c86

data/README.md

@@ -16,7 +16,7 @@ You may want to use them next to:
 
 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"` environment. The production app will never raise these exceptions.
+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.
 
 
 ## Installation
@@ -40,7 +40,7 @@ Clone the repo, then:
 
 ```
 bundle  # Install gem dependencies.
-rspec   # Run tests.
+rake    # Run tests.
 ```
 
 

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/fixme.rb

@@ -1,5 +1,22 @@
 require "fixme/version"
+require "date"
 
 module Fixme
-  # Your code goes here...
+  class UnfixedError < StandardError; end
+
+  module Mixin
+    def FIXME(date_and_message)
+      raw_date, message = date_and_message.split(": ")
+      due_date = Date.parse(raw_date)
+
+      return if Date.today < due_date
+
+      env = defined?(Rails) ? Rails.env : ENV["RACK_ENV"]
+      return unless [ "", "test", "development" ].include?(env.to_s)
+
+      raise UnfixedError, "Fix by #{due_date}: #{message}"
+    end
+  end
 end
+
+Object.include(Fixme::Mixin)

data/lib/fixme/version.rb

@@ -1,3 +1,3 @@
 module Fixme
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/spec/fixme_spec.rb

@@ -1,2 +1,77 @@
-describe Fixme do
+require "fixme"
+
+describe Fixme, "#TODO" do
+  it "raises after the given date" do
+    expect {
+      FIXME "2013-12-31: Remove this stuff."
+    }.to raise_error(Fixme::UnfixedError, "Fix by 2013-12-31: Remove this stuff.")
+  end
+
+  it "raises on the given date" do
+    expect {
+      FIXME "#{Date.today.to_s}: Remove this stuff."
+    }.to raise_error(Fixme::UnfixedError, "Fix by #{Date.today.to_s}: Remove this stuff.")
+  end
+
+  it "does not raise before the given date" do
+    expect {
+      FIXME "9999-01-01: Upgrade to Ruby 641.3.1."
+    }.not_to raise_error
+  end
+
+  it "is available everywhere" do
+    expect {
+      "some random object".instance_eval do
+        FIXME "2013-12-31: Make it work everywhere."
+      end
+    }.to raise_error(Fixme::UnfixedError)
+  end
+
+  context "when a Rails environment is detected" do
+    before do
+      stub_const("Rails", double)
+    end
+
+    it "raises in the 'test' environment" do
+      Rails.stub(env: "test")
+      expect_to_raise
+    end
+
+    it "raises in the 'development' environment" do
+      Rails.stub(env: "development")
+      expect_to_raise
+    end
+
+    it "does not raise in other environments" do
+      Rails.stub(env: "production")
+      expect_not_to_raise
+    end
+  end
+
+  context "when a Rack environment is detected" do
+    it "raises in the 'test' environment" do
+      ENV.stub(:[]).with("RACK_ENV").and_return("test")
+      expect_to_raise
+    end
+
+    it "raises in the 'development' environment" do
+      ENV.stub(:[]).with("RACK_ENV").and_return("development")
+      expect_to_raise
+    end
+
+    it "does not raise in other environments" do
+      ENV.stub(:[]).with("RACK_ENV").and_return("production")
+      expect_not_to_raise
+    end
+  end
+
+  private
+
+  def expect_to_raise
+    expect { FIXME "2013-12-31: X" }.to raise_error(Fixme::UnfixedError)
+  end
+
+  def expect_not_to_raise
+    expect { FIXME "2013-12-31: X" }.not_to raise_error
+  end
 end

metadata

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