timebomb 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1833e77693bf971f43b78c5bef33fcf679e510d8a530bb079ff5157616218ce6
+  data.tar.gz: c96e02c9065acde6d35cabc4097d588d2c4ef1f8c996a395ff659bbf6fb70eba
+SHA512:
+  metadata.gz: 47f7c64923d5a917b2096f4c7b755a3fba4d3384a21b70213dbd16432ffb9d52208d3dab8dac6725650e1d8460cb19c324104850e8ba96da047318a0f7806b3f
+  data.tar.gz: 8b78dec64771c5f342da9cb63c72e1895e1906bb4ded1dedf3e157a5c9507a005d5396a6c32f2145f313bfa056f0339b377a39f6a5223e0544d50308c8c2c4df

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at bradgessler@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in timebomb.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    timebomb (0.1.0)
+      chronic
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    chronic (0.10.2)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    thor (0.20.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  timebomb!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Brad Gessler
+
+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,55 @@
+# Timebomb
+
+[![Build Status](https://travis-ci.org/bradgessler/timebomb.svg?branch=master)](https://travis-ci.org/bradgessler/timebomb) [![Maintainability](https://api.codeclimate.com/v1/badges/ca9b943b703e7023e6a5/maintainability)](https://codeclimate.com/github/bradgessler/timebomb/maintainability)
+
+Timebomb is a way for development teams to set reminders to remove or do things in their codebase by a certain date. Its best run in a CI server so that it "blows up" when a date is reached.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'timebomb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install timebomb
+
+## Usage
+
+First, initialize Timebomb in your project by running:
+
+    $ timebomb init .
+
+Then create your first timebomb test:
+
+    $ timebomb create --title "Remove the old feature" --date "2 months from now"
+
+To check to see if any of the timebombs went off, run:
+
+    $ timebomb report
+
+If one went off, `timebomb` will return with a non-zero error code and details on the exceeded thresholds. If nothing went off then it will exit with 0. This is what you'd run on a CI server job.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bradgessler/timebomb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Timebomb project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bradgessler/timebomb/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "timebomb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/timebomb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "timebomb"
+
+Timebomb::CLI.start(ARGV)

data/lib/timebomb.rb

@@ -0,0 +1,199 @@
+require "timebomb/version"
+require "yaml"
+require "thor"
+require "chronic"
+require "pathname"
+require "fileutils"
+
+module Timebomb
+  class CLI < Thor
+    include FileUtils
+
+    DEFAULT_PATH = Pathname.new("./timebomb").freeze
+    DEFAULT_PATTERN = DEFAULT_PATH.join("**/**.tb").freeze
+    DEFAULT_DATE_FROM_NOW = "1 month from today".freeze
+
+    default_task :report
+
+    desc "report PATH", "run a report for timebombs in PATH"
+    def report(path = DEFAULT_PATTERN)
+      suite = Suite.new
+      suite.load_files Dir.glob(path)
+      report = CLIReport.new suite
+      report.print $stdout
+      exit suite.has_exploded? ? 1 : 0
+    end
+
+    desc "init PATH", "initialize timebomb in project at PATH"
+    def init(path = ".")
+      path = Pathname.new(path).join(DEFAULT_PATH)
+      mkdir path
+      puts "Timebomb project initialized at #{path}"
+    end
+
+    desc "create", "create a new timebomb"
+    long_desc <<-LONGDESC
+      `timebomb create` will create a `*.tb` file in the #{DEFAULT_PATH} directory.
+
+      A title is required via the `-t` flag. It should be a brief
+      sentence that gives the person in the future something actionable to do when
+      the timebomb blows up. More details and context can be provided in the description.
+
+      A date is required so the timebomb explodes on the given future date. The date is
+      parsed by a natrual language parser, so you can give absolute dates or relative dates
+      like:
+
+      > $ timebomb create -d "2 months from now" -t "Remove the feature"
+
+      > $ timebomb create -d "next year" -t "Remove the feature"
+
+      > $ timebomb create -d "tomorrow" -t "Remove the feature"
+
+      Absolute dates can be given too such as:
+
+      > $ timebomb create -d "Jan 14 2050" -t "Remove the feature"
+
+      > $ timebomb create -d "Sunday, June 13 at 7pm" -t "Remove the feature"
+
+      > $ timebomb create -d "2013-08-01T19:30:00.34-07:00" -t "Remove the feature"
+
+      You can optionally specify an extended description via the `-m` flag. The description
+      is meant to have all of the detail and context for why a timebomb was created and
+      what should be removed when it blows up.
+
+      > $ timebomb create -t "Remove the feature" -d "2 months from now" -m "Delete the Foo and Bar class"
+
+      Would create the file #{DEFAULT_PATH.join("remove_the_feature.tb")}
+    LONGDESC
+    option :title, required: true, aliases: :t
+    option :date, aliases: :d
+    option :description, aliases: :m
+    def create
+      title = options[:title]
+      date = Chronic.parse(options.fetch(:date, DEFAULT_DATE_FROM_NOW))
+      description = options[:description]
+
+
+      path = DEFAULT_PATH.join tb_file(title)
+      data = { "title" => title, "date" => date }
+
+      File.open(path, 'w') do |file|
+        file.puts data.to_yaml
+        file.puts "---"
+        file.puts
+        file.puts description
+      end
+
+      puts "Timebomb created at #{path}"
+    end
+
+    private
+      def underscore(title)
+        title.downcase.split(/\W/).reject{ |word| word == "" || word.nil? }.join("_")
+      end
+
+      def tb_file(title)
+        "#{underscore(title)}.tb"
+      end
+  end
+
+  class CLIReport
+    RED_COLOR_CODE = 31
+
+    attr_reader :suite
+
+    def initialize(suite)
+      @suite = suite
+    end
+
+    def print(out)
+      out.puts "Detected #{suite.timebombs.count} timebombs"
+      suite.timebombs.each do |tb|
+        out.puts timebomb_line(tb)
+      end
+      if suite.has_exploded?
+        out.puts "#{suite.exploded_timebombs.count} timebombs have exploded!"
+      end
+    end
+
+    private
+      def timebomb_line(tb)
+        [result(tb), tb.date, tb.title].join("\t")
+      end
+
+      def result(tb)
+        tb.has_exploded? ? " 💣 " : " 💥 "
+      end
+  end
+
+  class Frontmatter
+    DELIMITER = "---".freeze
+    NEWLINE = /\r\n?|\n/.freeze
+    PATTERN = /\A(#{DELIMITER}#{NEWLINE}(.+?)#{NEWLINE}#{DELIMITER}#{NEWLINE}*)?(.+)\Z/m
+
+    attr_reader :body
+
+    def initialize(content)
+      _, @data, @body = content.match(PATTERN).captures
+    end
+
+    def data
+      @data ? YAML.load(@data) : {}
+    end
+  end
+
+  class Timebomb
+    attr_accessor :title, :date, :description
+
+
+    def parse_data(data)
+      frontmatter = Frontmatter.new(data)
+      self.title = frontmatter.data.fetch("title")
+      self.date = frontmatter.data.fetch("date")
+      self.description = frontmatter.body
+
+      self
+    end
+
+    def parse_file(path)
+      parse_data File.read(path)
+    end
+
+    def date=(date)
+      @date = date.is_a?(String) ? Chronic.parse(date) : date
+    end
+
+    def has_exploded?
+      self.date > ::Timebomb.current_time
+    end
+  end
+
+  class Suite
+    def load_files(paths)
+      paths.each do |path|
+        self.timebombs << Timebomb.new.parse_file(path)
+      end
+    end
+
+    def has_exploded?
+      exploded_timebombs.any?
+    end
+
+    def exploded_timebombs
+      timebombs.lazy.select(&:has_exploded?)
+    end
+
+    def unexploded_timebombs
+      timebombs.lazy.reject(&:has_exploded?)
+    end
+
+    def timebombs
+      @timebombs ||= []
+    end
+  end
+
+  # Override this if you want to use a different current time.
+  def self.current_time
+    Time.now
+  end
+end

data/lib/timebomb/version.rb

@@ -0,0 +1,3 @@
+module Timebomb
+  VERSION = "0.9.0"
+end

data/timebomb.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "timebomb/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "timebomb"
+  spec.version       = Timebomb::VERSION
+  spec.authors       = ["Brad Gessler"]
+  spec.email         = ["bradgessler@gmail.com"]
+
+  spec.summary       = %q{Blow up a CI server when a date is exceeded for a feature}
+  spec.homepage      = "https://github.com/bradgessler/timebomb"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "chronic"
+  spec.add_dependency "thor"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: timebomb
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Brad Gessler
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- bradgessler@gmail.com
+executables:
+- timebomb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/timebomb
+- lib/timebomb.rb
+- lib/timebomb/version.rb
+- timebomb.gemspec
+homepage: https://github.com/bradgessler/timebomb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Blow up a CI server when a date is exceeded for a feature
+test_files: []