do_by 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ac827c16c5a8a9f3b26d4666d59363c139818ed
+  data.tar.gz: 36147bfacc93db4b9a7de5945d9a6173ed973ad2
+SHA512:
+  metadata.gz: 00f3a53e6918fbcf2ea4f8749bbd253049ac00bcd4dc01704c5f3b6c5cb98ca1b1268c3f857703ea04d555b022b7f9d7db91c997d81c041817ae81b0d2886bb1
+  data.tar.gz: fde4245de69422df8d4d2bddd924394a8608984924e007b2e326fdae3b588b97d89749ffc1d8675297d093edf54558d819349f8f546c9c846525cef47b1dd03d

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in do_by.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andy Waite
+
+MIT License
+
+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,44 @@
+# DoBy
+
+This is a proof-of-concept of automatically-expiring TODO notes.
+
+TODO comments can be a plague on a software codebase. They begin as a good
+intention to go back and do something, but are easily forgotten or ignored.
+They can hang around in code for years. And unlike stale code, they're not excecuted,
+so they never cause anything to break.
+
+DoBy makes your TODO comments complain when they become stale. You add a note
+using a special `TODO` method, providing a date which you to defer until.
+When your code runs, the expiry date on the TODO will be checked, and it will
+raise an error if it's overdue.
+
+This forces you to look at the TODO task again. If it's no longer relevant, you
+can delete it. If you can fix it, you fix it. If you cannot fix it right now,
+change the date to something in the future to re-visit it again.
+
+# Example
+
+DoBy requires that all TODO commments are suffixed with a due date, for example:
+
+`# TODO 20140601 fix this, '2014-06-01'`
+
+In your CI system, configure your test suite to be dependent on DoBy exiting
+succesfully, for example in your build script:
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'do_by', group: 'test'
+
+And then execute:
+
+    $ bundle
+
+## Contributing
+
+1. Fork it ( https://github.com/andyw8/do_by/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/do_by

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'do_by'
+
+DoBy::Checker.invoke

data/do_by.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'do_by/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "do_by"
+  spec.version       = DoBy::VERSION
+  spec.authors       = ["Andy Waite"]
+  spec.email         = ["github.aw@andywaite.com"]
+  spec.summary       = %q{Expiring 'to do' reminders}
+  spec.description   = %q{Expiring 'to do' reminders}
+  spec.homepage      = "https://github.com/andyw8/do_by"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/do_by.rb

@@ -0,0 +1,35 @@
+require "do_by/version"
+
+module DoBy
+  class Checker
+    def self.invoke
+      new.invoke
+    end
+
+    def invoke
+      Dir.glob("**/*").each do |path|
+        next if File.directory?(path)
+        File.open(path).each_line.with_index do |line, line_no|
+          # TODO 20140531 make this more efficient
+          parse(path, line, line_no + 1)
+        end
+      end
+    end
+
+    def parse(path, line, line_no)
+      return if ENV['DO_BY_TESTING']
+      return unless line.match('TODO')
+      matches = line.match('TODO (\d{8}) (.*)')
+      unless matches
+        Kernel.abort("#{path}:#{line_no} No due by date detected in TODO comment")
+      end
+      date_portion = matches[1]
+      comment = matches[2]
+      parsed_date = DateTime.parse date_portion
+      if parsed_date < Time.now
+        message = "Expired TODO: #{comment} (#{date_portion})"
+        Kernel.abort(message)
+      end
+    end
+  end
+end

data/lib/do_by/version.rb

@@ -0,0 +1,3 @@
+module DoBy
+  VERSION = "0.0.1"
+end

data/spec/do_by_spec.rb

@@ -0,0 +1,52 @@
+require 'do_by'
+
+describe DoBy::Note do
+  before do
+    allow(Time).to receive(:now) { DateTime.parse('20140601') }
+  end
+
+  it "is happy with a note with a date in the future" do
+    scan '# TODO 20140701 with date'
+  end
+
+  it "is not happy with a note with a date in the past" do
+    expect do
+      scan '# TODO 20140501 with date'
+    end.to exit_with_code(1)
+  end
+
+  it "is not happy with a note without a date" do
+    expect do
+      scan '# TODO without date'
+    end.to exit_with_code(1)
+  end
+
+  private
+
+  def scan(line)
+    DoBy::Note.parse line
+  end
+end
+
+# http://stackoverflow.com/questions/1480537/how-can-i-validate-exits-and-aborts-in-rspec
+RSpec::Matchers.define :exit_with_code do |exp_code|
+  actual = nil
+  match do |block|
+    begin
+      block.call
+    rescue SystemExit => e
+      actual = e.status
+    end
+    actual and actual == exp_code
+  end
+  failure_message do |block|
+    "expected block to call exit(#{exp_code}) but exit" +
+      (actual.nil? ? " not called" : "(#{actual}) was called")
+  end
+  failure_message_when_negated do |block|
+    "expected block not to call exit(#{exp_code})"
+  end
+  description do
+    "expect block to call exit(#{exp_code})"
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: do_by
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andy Waite
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+description: Expiring 'to do' reminders
+email:
+- github.aw@andywaite.com
+executables:
+- do_by
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/do_by
+- do_by.gemspec
+- lib/do_by.rb
+- lib/do_by/version.rb
+- spec/do_by_spec.rb
+homepage: https://github.com/andyw8/do_by
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Expiring 'to do' reminders
+test_files:
+- spec/do_by_spec.rb