activetodo 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b40f8e450fae6ca97b4f0503463356d3b6f3f2c
-  data.tar.gz: 7a24f5c2d994679bf7f49407a312a1c8b0298fbc
+  metadata.gz: 01a11fd21b937537cbbe408befd6c119794aaba1
+  data.tar.gz: ad55f542e79054abf66b6fab387c370afe8bed13
 SHA512:
-  metadata.gz: 559f222945e4ca8325331b7eca5bbf1b12893ffbc383493ad0d1e5f407f8bdc0053e29969c687a6e84edb15a44d64e6c6525f792d4ffa6b47829e3bd147118f3
-  data.tar.gz: 9d005388d995474b866a917edaf358b22f27a28470a162ef5f4d44cd0d340cb58589483a556194daf7acabd06c8c31cde77272ebb6d0e84f9f4ad315c92685a9
+  metadata.gz: d47fcbf7aba8e4c42e5783184300d561a584058020ae3600a4ccfc92bf65a6574621271caf99b6ceb50419552aff88cff199adea809396d79ba2c0f746ea7199
+  data.tar.gz: 70faa9762a238baef6388004ddbc3907b68947d231ddc53851b57a8064c071cc358277cfc069a35bf9842d4d49d5ced4928ba83c4d9a19772d1d8e8ae8d2ee1b

data/.travis.yml

@@ -3,5 +3,4 @@ rvm:
   - "1.9.3"
   - "2.0.0"
   - jruby-19mode
-  - rbx-19mode
 script: bundle exec rspec spec

data/README.md

@@ -32,6 +32,10 @@ FIXME 'Certificate will expire soon', deadline: '2014-01-01'
 
 # Raises error after 2014-02-28
 XXX 'Dirty hack, must refactor', deadline: '2014-02-28', warn_only: false
+
+# In Rails, if you want it to log warnings in production, use `ignore_production` = false
+# By default it will do nothing in production
+TODO 'Remove unused class LegacyModel', deadline: '2015-01-04', ignore_production: false
 ```
 
 `TODO`, `FIXME` and `XXX` all have same interface: `TODO(<message>, [options_hash])`
@@ -48,6 +52,9 @@ with following lines:
 ActiveTodo.configure do |config|
   # Log deadline warnings in Production, raise errors in Development / Test
   config.warn_only = Rails.env.production?
+
+  # Allow logging in Rails.env.production (by default it will not do anything)
+  config.ignore_production = false
 end
 ```
 
@@ -56,6 +63,10 @@ You can still override the default configuration by passing `warn_only` option:
 TODO 'Remove this internal testing controller', deadline: '2013-05-01', warn_only: false
 ```
 
+ActiveTodo will not do anything in production, unless you provide `ignore_production: false`
+option in your `TODO` calls, or add `config.ignore_production = false` in `ActiveTodo.configure`
+block.
+
 ## Contributing
 
 1. Fork it

data/lib/activetodo/version.rb

@@ -1,3 +1,3 @@
 module ActiveTodo
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/activetodo.rb

@@ -12,6 +12,15 @@ module ActiveTodo
       def warn_only=(condition)
         @@warn_only = condition
       end
+
+      def ignore_production?(options = {})
+        return options[:ignore_production] if options.keys.include?(:ignore_production)
+        @@ignore_production ||= true
+      end
+
+      def ignore_production=(condition)
+        @@ignore_production = condition
+      end
     end
   end
 
@@ -21,7 +30,10 @@ module ActiveTodo
 
   class PrivateMethods
     class << self
-      def log_message(message)
+      def log_message(message, options)
+        if defined?(Rails) && Configuration.ignore_production?(options)
+          return if Rails.env.production?
+        end
         if defined?(Rails) && Rails.logger
           Rails.logger.warn(message)
         else
@@ -40,7 +52,7 @@ module ActiveTodo
         message = "Deadline reached for \"#{what}\" (#{options[:deadline]})"
 
         if Configuration.warn_only?(options)
-          PrivateMethods.log_message(message)
+          PrivateMethods.log_message(message, options)
         else
           raise message
         end

data/spec/activetodo_spec.rb

@@ -76,13 +76,26 @@ describe ActiveTodo::KernelMethods do
         let(:rails) { double(:rails) }
         let(:logger) { double(:logger) }
 
-        before do
-          stub_const('Rails', rails)
-          Rails.should_receive(:logger).twice.and_return(logger)
-          logger.should_receive(:warn)
+        context 'not production' do
+          before do
+            stub_const('Rails', rails)
+            Rails.stub_chain(:env, :production?).and_return(false)
+            Rails.should_receive(:logger).twice.and_return(logger)
+            logger.should_receive(:warn)
+          end
+
+          specify { expect { subject }.not_to raise_error }
         end
 
-        specify { expect { subject }.not_to raise_error }
+        context 'production' do
+          before do
+            stub_const('Rails', rails)
+            Rails.stub_chain(:env, :production?).and_return(true)
+            Rails.should_not_receive(:logger)
+          end
+
+          specify { expect { subject }.not_to raise_error }
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activetodo
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Tomas Varaneckas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-30 00:00:00.000000000 Z
+date: 2014-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -127,3 +127,4 @@ summary: Forget 'TOD*' comments that are sitting in your code forever
 test_files:
 - spec/activetodo_spec.rb
 - spec/spec_helper.rb
+has_rdoc: