timebomb 0.9.0 → 0.9.1

checksums.yaml

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

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/timebomb/
 
 # rspec failure tracking
 .rspec_status

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    timebomb (0.1.0)
+    timebomb (0.9.0)
       chronic
       thor
 

data/README.md

@@ -30,6 +30,17 @@ Then create your first timebomb test:
 
     $ timebomb create --title "Remove the old feature" --date "2 months from now"
 
+This creates a file at `./timebombs/remove_the_old_feature.tb` which you can edit to add more context:
+
+```
+---
+title: Remove the old feature
+date: 2018-06-16 00:00:00.000000000 -07:00
+---
+
+We're running an experiment on this feature. The metrics team said if we don't get 1,000 users in 2 months we should just pull it.
+```
+
 To check to see if any of the timebombs went off, run:
 
     $ timebomb report

data/lib/timebomb.rb

@@ -66,27 +66,36 @@ module Timebomb
       Would create the file #{DEFAULT_PATH.join("remove_the_feature.tb")}
     LONGDESC
     option :title, required: true, aliases: :t
-    option :date, aliases: :d
+    option :date, aliases: :d, default: DEFAULT_DATE_FROM_NOW
     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
+      path = DEFAULT_PATH.join tb_file(options[:title])
+      file = BombFile.new(path)
+      file.bomb.tap do |b|
+        b.title = options[:title]
+        b.description = options[:description]
+        b.date = options[:date]
       end
-
+      file.write
       puts "Timebomb created at #{path}"
     end
 
+    desc "bump", "bumps all exploded timebombs to specified date"
+    option :date, aliases: :d, default: DEFAULT_DATE_FROM_NOW
+    def bump(path = DEFAULT_PATTERN)
+      date = options[:date]
+      suite = Suite.new
+      suite.load_files Dir.glob(path)
+      suite.timebomb_files.each do |file|
+        file.read
+        if file.bomb.has_exploded?
+          file.bomb.date = date
+          file.write
+          puts "Bumped #{file.path} to #{date}"
+        end
+      end
+    end
+
     private
       def underscore(title)
         title.downcase.split(/\W/).reject{ |word| word == "" || word.nil? }.join("_")
@@ -99,6 +108,8 @@ module Timebomb
 
   class CLIReport
     RED_COLOR_CODE = 31
+    EXPLODED_CHARACTER = "💥"
+    UNEXPLODED_CHARACTER = "💣"
 
     attr_reader :suite
 
@@ -109,7 +120,7 @@ module Timebomb
     def print(out)
       out.puts "Detected #{suite.timebombs.count} timebombs"
       suite.timebombs.each do |tb|
-        out.puts timebomb_line(tb)
+        out.puts row " #{explosion_symbol(tb)} ", format_date(tb.date), days_until(tb), tb.title
       end
       if suite.has_exploded?
         out.puts "#{suite.exploded_timebombs.count} timebombs have exploded!"
@@ -117,12 +128,25 @@ module Timebomb
     end
 
     private
-      def timebomb_line(tb)
-        [result(tb), tb.date, tb.title].join("\t")
+      def row(*columns)
+        columns.join("\t")
       end
 
-      def result(tb)
-        tb.has_exploded? ? " 💣 " : " 💥 "
+      def days_until(tb)
+        days = tb.days_difference
+        if days < 0
+          "Exploded #{-days.to_i} days ago"
+        else
+          "Explodes in #{days.to_i} days"
+        end
+      end
+
+      def explosion_symbol(tb)
+        tb.has_exploded? ? EXPLODED_CHARACTER : UNEXPLODED_CHARACTER
+      end
+
+      def format_date(date)
+        date.strftime "%b %e, %Y"
       end
   end
 
@@ -142,36 +166,61 @@ module Timebomb
     end
   end
 
-  class Timebomb
-    attr_accessor :title, :date, :description
+  # Handles reading and writing to a Timebomb file `*.tb`.
+  class BombFile
+    EXTENSION = ".tb".freeze
 
+    attr_reader :path, :bomb
 
-    def parse_data(data)
-      frontmatter = Frontmatter.new(data)
-      self.title = frontmatter.data.fetch("title")
-      self.date = frontmatter.data.fetch("date")
-      self.description = frontmatter.body
+    def initialize(path)
+      @path = Pathname.new(path)
+      @bomb = Bomb.new
+    end
 
-      self
+    def read
+      File.open(path, 'r') do |file|
+        data = file.read
+        frontmatter = Frontmatter.new(data)
+        bomb.title = frontmatter.data.fetch("title")
+        bomb.date = frontmatter.data.fetch("date")
+        bomb.description = frontmatter.body
+      end
     end
 
-    def parse_file(path)
-      parse_data File.read(path)
+    def write
+      data = { "title" => bomb.title, "date" => bomb.date }
+
+      File.open(path, 'w') do |file|
+        file.puts data.to_yaml
+        file.puts "---"
+        file.puts
+        file.puts bomb.description
+      end
     end
+  end
+
+  class Bomb
+    SECONDS_IN_DAY = 86400
+
+    attr_accessor :title, :date, :description
 
     def date=(date)
       @date = date.is_a?(String) ? Chronic.parse(date) : date
     end
 
     def has_exploded?
-      self.date > ::Timebomb.current_time
+      date < Timebomb.current_time
+    end
+
+    def days_difference
+      (date - Timebomb.current_time) / SECONDS_IN_DAY
     end
   end
 
   class Suite
     def load_files(paths)
       paths.each do |path|
-        self.timebombs << Timebomb.new.parse_file(path)
+        self.timebomb_files << BombFile.new(path)
       end
     end
 
@@ -188,7 +237,14 @@ module Timebomb
     end
 
     def timebombs
-      @timebombs ||= []
+      timebomb_files.map do |file|
+        file.read
+        file.bomb
+      end
+    end
+
+    def timebomb_files
+      @timebomb_files ||= []
     end
   end
 

data/lib/timebomb/version.rb

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

data/timebomb.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   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.summary       = %q{Blow up a CI server when its time to deprecate something or remove a feature.}
   spec.homepage      = "https://github.com/bradgessler/timebomb"
   spec.license       = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timebomb
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Brad Gessler
@@ -127,5 +127,5 @@ 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
+summary: Blow up a CI server when its time to deprecate something or remove a feature.
 test_files: []