activetodo 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb46c5773e643c97afe3388f93bd9216eb0c01a0
+  data.tar.gz: 69d339ae2c71ad28df1ba11e438ecc60eb3b018c
+SHA512:
+  metadata.gz: 57300628de5eba3ee3f7128ac25bc580d267b9e198ab940c4db0a3ce02333007a1357a76cd6bc4d82164cce7d153007511066a083f2cded64dbe60587238bf89
+  data.tar.gz: 7a21708d3eb0a09d77809454358ab0a47ccb453a45f408b8d33e043d6752a6e1306608f51fd638fbd3e0d4bae23d7a247d71b1919ecf4a66949f988e88254cb1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - jruby-19mode
+  - rbx-19mode
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'coveralls', require: false
+
+# Specify your gem's dependencies in activetodo.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+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

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Tomas Varaneckas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# ActiveTodo
+
+[![Build Status](https://travis-ci.org/spajus/activetodo.png?branch=master)](https://travis-ci.org/spajus/activetodo)
+[![Coverage Status](https://coveralls.io/repos/spajus/activetodo/badge.png?branch=master)](https://coveralls.io/r/spajus/activetodo)
+[![Code Climate](https://codeclimate.com/github/spajus/activetodo.png?branch=master)](https://codeclimate.com/github/spajus/activetodo)
+
+Forget TODO comments that are sitting in your code forever
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activetodo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activetodo
+
+## Usage
+
+Use anywhere in code:
+```ruby
+# Generic TODO without deadline
+TODO 'Add specs'
+
+# Raises error after 2014-01-01
+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?
+```
+
+`TODO`, `FIXME` and `XXX` all have same interface: `TODO(<message>, [options_hash])`
+
+You can use `activetodo` with or without Rails.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/activetodo.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activetodo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'activetodo'
+  spec.version       = ActiveTodo::VERSION
+  spec.authors       = ['Tomas Varaneckas']
+  spec.email         = ['tomas.varaneckas@gmail.com']
+  spec.description   = %q{This gem provides 'TOD*', 'F*XME' and 'XX*' as methods you can use in code}
+  spec.summary       = %q{Forget 'TOD*' comments that are sitting in your code forever}
+  spec.homepage      = 'https://github.com/spajus/activetodo'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'pry-nav'
+end

data/lib/activetodo.rb

@@ -0,0 +1,39 @@
+require 'activetodo/version'
+
+module ActiveTodo
+
+  class PrivateMethods
+    class << self
+      def log_message(message)
+        if defined?(Rails) && Rails.logger
+          Rails.logger.warn(message)
+        else
+          puts message
+        end
+      end
+    end
+  end
+
+  module KernelMethods
+
+    def TODO(what, options = {})
+      deadline = DateTime.parse(options[:deadline]) if options[:deadline]
+
+      if deadline && DateTime.now >= deadline
+        message = "Deadline reached for \"#{what}\" (#{options[:deadline]})"
+
+        if options[:warn_only]
+          PrivateMethods.log_message(message)
+        else
+          raise message
+        end
+      end
+    end
+
+    alias_method :FIXME, :TODO
+    alias_method :XXX,   :TODO
+
+  end
+end
+
+include ActiveTodo::KernelMethods

data/lib/activetodo/version.rb

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

data/spec/activetodo_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'timecop'
+require 'pry-nav'
+
+describe ActiveTodo::KernelMethods do
+
+  context '.TODO' do
+    subject { TODO 'stuff' }
+    specify { expect { subject }.to_not raise_error }
+  end
+
+  context '.FIXME' do
+    subject { FIXME 'stuff' }
+    specify { expect { subject }.to_not raise_error }
+  end
+
+  context '.XXX' do
+    subject { XXX 'stuff' }
+    specify { expect { subject }.to_not raise_error }
+  end
+
+  context 'options' do
+
+    let(:now) { Time.local(2013, 12, 31, 12, 0, 0) }
+    let(:future) { Time.local(2014, 1, 1, 12, 0, 0) }
+
+    before { Timecop.freeze(now) }
+
+    context 'deadline' do
+
+      subject { FIXME 'Refactor shit', deadline: '2014-01-01' }
+
+      context 'no error before it is reached' do
+        specify { expect { subject }.to_not raise_error }
+      end
+
+      context 'raises error after it was reached' do
+        let(:now) { future }
+        specify { expect { subject }.to raise_error }
+      end
+    end
+
+    context 'warn_only' do
+
+      let(:now) { future }
+
+      subject { FIXME 'Refactor shit', deadline: '2014-01-01', warn_only: true }
+
+      context 'outside Rails' do
+        before { ActiveTodo::PrivateMethods.should_receive(:log_message) }
+        specify { expect { subject }.not_to raise_error }
+      end
+
+      context 'within Rails' 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)
+        end
+
+        specify { expect { subject }.not_to raise_error }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'activetodo'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: activetodo
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Tomas Varaneckas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem provides 'TOD*', 'F*XME' and 'XX*' as methods you can use in
+  code
+email:
+- tomas.varaneckas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- activetodo.gemspec
+- lib/activetodo.rb
+- lib/activetodo/version.rb
+- spec/activetodo_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/spajus/activetodo
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Forget 'TOD*' comments that are sitting in your code forever
+test_files:
+- spec/activetodo_spec.rb
+- spec/spec_helper.rb