activetodo 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb46c5773e643c97afe3388f93bd9216eb0c01a0
-  data.tar.gz: 69d339ae2c71ad28df1ba11e438ecc60eb3b018c
+  metadata.gz: 30e34aacbfddd41896e87811832fcb596e6bef87
+  data.tar.gz: d4a34e7e3b84356653fb173a4d7949fb001e1623
 SHA512:
-  metadata.gz: 57300628de5eba3ee3f7128ac25bc580d267b9e198ab940c4db0a3ce02333007a1357a76cd6bc4d82164cce7d153007511066a083f2cded64dbe60587238bf89
-  data.tar.gz: 7a21708d3eb0a09d77809454358ab0a47ccb453a45f408b8d33e043d6752a6e1306608f51fd638fbd3e0d4bae23d7a247d71b1919ecf4a66949f988e88254cb1
+  metadata.gz: 186285aac96fc6b24828f2cd931cb51bd1149316547f2d15667b6a1906b6c6d9f5c343ebee780c50a5e4fbf0fe3a0f6bf3ed044f95a5660cdda0947e824dd2ed
+  data.tar.gz: 16dfab5227fccefe7c759bc59adad3d8d8af456afa6c518aeabed8f48d96cf441d8ff16787f0d427db77253d550236e2ddb03d58866523d6fc77de881dcbabc4

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+Gemfile.lock
 coverage
 InstalledFiles
 lib/bundler/man

data/README.md

@@ -27,17 +27,35 @@ Use anywhere in code:
 # Generic TODO without deadline
 TODO 'Add specs'
 
-# Raises error after 2014-01-01
+# After 2014-01-01 it will `Rails.logger.warn` or `puts` if outside Rails
 FIXME 'Certificate will expire soon', deadline: '2014-01-01'
 
-# After 2014-02-28, does Rails.logger.warn in production, raises error in development / test
-XXX 'Dirty hack, must refactor', deadline: '2014-02-28', warn_only: Rails.env.production?
+# Raises error after 2014-02-28
+XXX 'Dirty hack, must refactor', deadline: '2014-02-28', warn_only: false
 ```
 
 `TODO`, `FIXME` and `XXX` all have same interface: `TODO(<message>, [options_hash])`
 
 You can use `activetodo` with or without Rails.
 
+## Configuring default deadline behavior
+
+By default, ActiveTodo will not raise errors when deadline is reached. You may want to enabled that
+depending on your environment. In Rails, do that by creating `config/initializers/activetodo.rb`
+with following lines:
+
+```ruby
+ActiveTodo.configure do |config|
+  # Log deadline warnings in Production, raise errors in Development / Test
+  config.warn_only = Rails.env.production?
+end
+```
+
+You can still override the default configuration by passing `warn_only` option:
+```ruby
+TODO 'Remove this internal testing controller', deadline: '2013-05-01', warn_only: false
+```
+
 ## Contributing
 
 1. Fork it

data/lib/activetodo.rb

@@ -2,6 +2,23 @@ require 'activetodo/version'
 
 module ActiveTodo
 
+  class Configuration
+    class << self
+      def warn_only?(options = {})
+        return options[:warn_only] if options.keys.include?(:warn_only)
+        @@warn_only ||= false
+      end
+
+      def warn_only=(condition)
+        @@warn_only = condition
+      end
+    end
+  end
+
+  def self.configure
+    yield Configuration if block_given?
+  end
+
   class PrivateMethods
     class << self
       def log_message(message)
@@ -22,7 +39,7 @@ module ActiveTodo
       if deadline && DateTime.now >= deadline
         message = "Deadline reached for \"#{what}\" (#{options[:deadline]})"
 
-        if options[:warn_only]
+        if Configuration.warn_only?(options)
           PrivateMethods.log_message(message)
         else
           raise message

data/lib/activetodo/version.rb

@@ -1,3 +1,3 @@
 module ActiveTodo
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/activetodo_spec.rb

@@ -46,6 +46,25 @@ describe ActiveTodo::KernelMethods do
 
       subject { FIXME 'Refactor shit', deadline: '2014-01-01', warn_only: true }
 
+      context 'preconfigured' do
+
+        before { ActiveTodo.configure { |c| c.warn_only = true } }
+
+        context 'without override' do
+          subject { FIXME 'Refactor shit', deadline: '2014-01-01' }
+
+          before { ActiveTodo::PrivateMethods.should_receive(:log_message) }
+
+          specify { expect { subject }.not_to raise_error }
+        end
+
+        context 'with override' do
+          subject { FIXME 'Refactor shit', deadline: '2014-01-01', warn_only: false }
+
+          specify { expect { subject }.to raise_error }
+        end
+      end
+
       context 'outside Rails' do
         before { ActiveTodo::PrivateMethods.should_receive(:log_message) }
         specify { expect { subject }.not_to raise_error }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activetodo
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Tomas Varaneckas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-27 00:00:00.000000000 Z
+date: 2013-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,7 +92,6 @@ files:
 - .rspec
 - .travis.yml
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,58 +0,0 @@
-PATH
-  remote: .
-  specs:
-    activetodo (0.0.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    coderay (1.0.9)
-    coveralls (0.6.9)
-      multi_json (~> 1.3)
-      rest-client
-      simplecov (>= 0.7)
-      term-ansicolor
-      thor
-    diff-lcs (1.2.4)
-    method_source (0.8.2)
-    mime-types (1.25)
-    multi_json (1.8.0)
-    pry (0.9.12.2)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.4)
-    pry-nav (0.2.3)
-      pry (~> 0.9.10)
-    rake (10.1.0)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.5)
-    rspec-expectations (2.14.2)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.3)
-    simplecov (0.7.1)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.7.1)
-    simplecov-html (0.7.1)
-    slop (3.4.6)
-    term-ansicolor (1.2.2)
-      tins (~> 0.8)
-    thor (0.18.1)
-    timecop (0.6.3)
-    tins (0.9.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activetodo!
-  bundler (~> 1.3)
-  coveralls
-  pry-nav
-  rake
-  rspec
-  timecop