stink_bomb 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb7ad358d7796194b94cb6a8eed905525e0bf75c
-  data.tar.gz: 9b8abc3e4b9af39c16e5a3a813d5c53fcd1ef830
+  metadata.gz: c82e3f52414800f0276ac8121395d132c4215958
+  data.tar.gz: c9acb5ae4cdb5e12d2c79988ede0347d72e36914
 SHA512:
-  metadata.gz: 62e8dce51d3f57e80cfdf245cbf0fd57f636e60a751ed0b21d20cbfa0cd25365e71495e137ebc3b476d1a5c661d9575831dbc749f90f69e3392a917784506080
-  data.tar.gz: 96b4766e455ef771909044bda0415e50809b18629905532f150826c3233ce843212b3c605a61e2ba0f4766db316e47813bb0444dfeb85cc576c4c68c456f4841
+  metadata.gz: c3458bc18df1bc597e1fd402dc64aa954d9ba1b2311c1aa0f699773ada569c3a1c537239bd1f3fe96842db7e17bc36b6b05382b94b93f04d9ec41c65024dc16d
+  data.tar.gz: c102a4f09a8daaabaf7f96342943a2e41449fb3372675d153496afdde0e2ff43ca2be81d8aee58a09cd5925a5406ca757d4a14c1b9a9e3c3a12494241b9e7a32

data/.rspec

@@ -1,3 +1,2 @@
 --color
---warnings
 --require spec_helper

data/.travis.yml

@@ -1,6 +1,8 @@
+sudo: false
 language: ruby
 rvm:
   - 2.1.3
 script:
   - bundle exec travis lint --skip-completion-check
   - bundle exec rspec
+  - bundle exec rubocop -D

data/Gemfile

@@ -4,9 +4,12 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'coveralls'
-  gem 'rake'
-  gem 'travis'
-  gem 'rubocop'
-  gem 'rspec'
+  gem 'codeclimate-test-reporter', '~> 0.4.4'
+  gem 'guard-rspec', '~> 4.5.0'
+  gem 'guard-rubocop', '~> 1.2.0'
+  gem 'rake', '~> 10.4.2'
+  gem 'rspec', '~> 3.1.0'
+  gem 'rubocop', '~> 0.28.0'
+  gem 'simplecov', '~> 0.9.1'
+  gem 'travis', '~> 1.7.4'
 end

data/Guardfile

@@ -0,0 +1,22 @@
+group :everything, halt_on_fail: true do
+  guard :rspec, cmd: 'bundle exec rspec' do
+    require 'guard/rspec/dsl'
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    # Ruby files
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+  end
+
+  guard :rubocop, cli: %w(-D) do
+    watch(/.+\.rb$/)
+    watch(/Guardfile/)
+    watch(/Rakefile/)
+    watch(/(?:.+\/)?\.rubocop\.yml$/) { |m| File.dirname(m[0]) }
+  end
+end

data/README.md

@@ -2,7 +2,8 @@
 
 [![Gem Version](https://badge.fury.io/rb/stink_bomb.svg)](http://badge.fury.io/rb/stink_bomb)
 [![Build Status](https://travis-ci.org/ChalkSchools/stink-bomb.svg?branch=master)](https://travis-ci.org/ChalkSchools/stink-bomb)
-[![Coverage Status](https://img.shields.io/coveralls/ChalkSchools/stink-bomb.svg)](https://coveralls.io/r/ChalkSchools/stink-bomb?branch=master)
+[![Code Climate](https://codeclimate.com/github/ChalkSchools/stink-bomb/badges/gpa.svg)](https://codeclimate.com/github/ChalkSchools/stink-bomb)
+[![Test Coverage](https://codeclimate.com/github/ChalkSchools/stink-bomb/badges/coverage.svg)](https://codeclimate.com/github/ChalkSchools/stink-bomb)
 
 Create a `StinkBomb` that will throw an error if your code is out of date.
 Useful for when you have code that should be addressed in the near future,
@@ -32,7 +33,7 @@ StinkBomb.create('January 20, 2001')
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/stink-bomb/fork )
+1. Fork it ( https://github.com/ChalkSchools/stink-bomb/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`)

data/Rakefile

@@ -1 +1,8 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]

data/lib/stink_bomb.rb

@@ -1,9 +1,54 @@
 require 'time'
 require 'stink_bomb/version'
+require 'stink_bomb/configuration'
 require 'stink_bomb/bomb'
+require 'stink_bomb/raise_bomb'
+require 'stink_bomb/logger_bomb'
 
-class StinkBomb
-  def self.create(datetime, message: nil)
-    StinkBomb::Bomb.new(datetime, message: message)
+module StinkBomb
+  class StinkyCodeError < StandardError; end
+
+  class << self
+    def create(deadline, message: nil)
+      deadline = parse(deadline)
+      message = fill_in_message(deadline, message)
+      bombs.each { |bomb| bomb.trigger(deadline, message: message) }
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def reset
+      @configuration = nil
+    end
+
+    def bombs
+      configuration.bombs
+    end
+
+  private
+
+    def fill_in_message(deadline, message)
+      (message || configured_message).gsub('{deadline}', deadline.to_s)
+    end
+
+    def configured_message
+      StinkBomb.configuration.message
+    end
+
+    def parse(time)
+      if time.is_a?(String)
+        Time.parse(time)
+      elsif time.respond_to?(:to_time)
+        time.to_time
+      else
+        fail 'Parameter has to be a Time, Date, or a String'
+      end
+    end
   end
 end

data/lib/stink_bomb/bomb.rb

@@ -1,31 +1,7 @@
-class StinkBomb
+module StinkBomb
   class Bomb
-    attr_accessor :datetime
-
-    def initialize(datetime, message: nil)
-      self.datetime = parse(datetime)
-      fail (message || fail_message) if !production? && past_datetime?
-    end
-
-    def parse(datetime)
-      datetime = DateTime.parse(datetime) if datetime.is_a?(String)
-      unless datetime.respond_to?(:to_datetime)
-        fail 'Parameter has to be a Time, Date, or a String'
-      end
-
-      datetime.to_datetime
-    end
-
-    def fail_message
-      "Your code stinks! It was supposed to be fixed by #{datetime}"
-    end
-
-    def production?
-      ENV['RAILS_ENV'] == 'production' || ENV['RACK_ENV'] == 'production'
-    end
-
-    def past_datetime?
-      Time.now.getlocal.to_datetime > datetime
+    def past_deadline?(deadline)
+      Time.now.utc > deadline.utc
     end
   end
 end

data/lib/stink_bomb/configuration.rb

@@ -0,0 +1,40 @@
+module StinkBomb
+  class Configuration
+    attr_accessor :message
+
+    def initialize(options = {})
+      self.message = options.fetch(:message) { default_message }
+    end
+
+    def raise=(error_class)
+      configure_bomb(RaiseBomb, error_class)
+    end
+
+    def logger=(logger)
+      configure_bomb(LoggerBomb, logger)
+    end
+
+    def bombs
+      @bombs ||= []
+    end
+
+  private
+
+    def configure_bomb(bomb_type, bomb_arg)
+      remove_bomb(bomb_type)
+      if bomb_arg == true
+        bombs << bomb_type.new
+      elsif bomb_arg
+        bombs << bomb_type.new(bomb_arg)
+      end
+    end
+
+    def remove_bomb(bomb_class)
+      bombs.delete_if { |bomb| bomb.is_a?(bomb_class) }
+    end
+
+    def default_message
+      'Your code stinks! It was supposed to be fixed by {deadline}'
+    end
+  end
+end

data/lib/stink_bomb/logger_bomb.rb

@@ -0,0 +1,15 @@
+module StinkBomb
+  class LoggerBomb < Bomb
+    attr_accessor :deadline
+
+    def initialize(logger = nil)
+      logger ||= Rails.logger if defined?(Rails)
+      fail 'logger responding to "info" is required' unless logger
+      @logger = logger
+    end
+
+    def trigger(deadline, message:)
+      @logger.info(message) if past_deadline?(deadline)
+    end
+  end
+end

data/lib/stink_bomb/raise_bomb.rb

@@ -0,0 +1,13 @@
+module StinkBomb
+  class RaiseBomb < Bomb
+    attr_writer :message
+
+    def initialize(error_class = StinkyCodeError)
+      @error_class = error_class
+    end
+
+    def trigger(deadline, message:)
+      fail @error_class, message if past_deadline?(deadline)
+    end
+  end
+end

data/lib/stink_bomb/version.rb

@@ -1,3 +1,3 @@
-class StinkBomb
-  VERSION = '0.0.1'
+module StinkBomb
+  VERSION = '0.1.0'
 end

data/spec/lib/stink_bomb/configuration_spec.rb

@@ -0,0 +1,67 @@
+module StinkBomb
+  describe Configuration, '#bombs' do
+    let(:configuration) { StinkBomb::Configuration.new }
+
+    it 'returns an array of the currently assigned bombs' do
+      expect(configuration.bombs).to eq []
+      configuration.raise = true
+      expect(configuration.bombs.length).to eq 1
+    end
+  end
+
+  describe Configuration, '#raise=' do
+    let(:configuration) { StinkBomb::Configuration.new }
+    let(:message) { configuration.message }
+    let(:yesterday) { (Date.today - 1).to_time }
+
+    it 'removes any raise bombs when given false' do
+      configuration.bombs << RaiseBomb.new
+      configuration.raise = false
+      expect(configuration.bombs).to be_empty
+    end
+
+    it 'adds a bomb that raises a stinky error' do
+      configuration.raise = true
+      expect do
+        configuration.bombs.first.trigger(yesterday, message: message)
+      end.to raise_error(StinkyCodeError)
+    end
+
+    it 'adds a bomb that raises a specific error class when given' do
+      configuration.raise = StinkyTestError
+      expect do
+        configuration.bombs.first.trigger(yesterday, message: message)
+      end.to raise_error(StinkyTestError)
+    end
+  end
+
+  describe Configuration, '#logger=' do
+    let(:configuration) { StinkBomb::Configuration.new }
+    let(:message) { configuration.message }
+    let(:fake_logger) { double(info: 'foo') }
+    let(:yesterday) { (Date.today - 1).to_time }
+
+    it 'removes any logger bombs when given false' do
+      configuration.bombs << RaiseBomb.new
+      configuration.bombs << LoggerBomb.new(fake_logger)
+      configuration.logger = false
+      expect(configuration.bombs.length).to eq 1
+      expect(configuration.bombs.first).to be_a RaiseBomb
+    end
+
+    it 'adds a bomb that logs to the rails logger' do
+      stub_const('Rails', double(logger: fake_logger))
+      configuration.logger = true
+      configuration.bombs.first.trigger(yesterday, message: message)
+
+      expect(fake_logger).to have_received(:info).with(/Your code stinks!/)
+    end
+
+    it 'adds a bomb that logs to a custom logger' do
+      configuration.logger = fake_logger
+      configuration.bombs.first.trigger(yesterday, message: message)
+
+      expect(fake_logger).to have_received(:info).with(/Your code stinks!/)
+    end
+  end
+end

data/spec/lib/stink_bomb/logger_bomb_spec.rb

@@ -0,0 +1,51 @@
+module StinkBomb
+  describe LoggerBomb, '#initialize' do
+    let(:fake_logger) { double(info: 'foo') }
+    let(:yesterday) { (Date.today - 1).to_time }
+    let(:message) { StinkBomb.configuration.message }
+
+    it 'accepts a custom logger' do
+      LoggerBomb.new(fake_logger).trigger(yesterday, message: message)
+
+      expect(fake_logger).to have_received(:info).with(/Your code stinks!/)
+    end
+
+    it 'defaults to the Rails logger' do
+      stub_const('Rails', double(logger: fake_logger))
+
+      LoggerBomb.new.trigger(yesterday, message: message)
+
+      expect(fake_logger).to have_received(:info).with(/Your code stinks!/)
+    end
+
+    it 'fails if no valid logger is given or found' do
+      expect { LoggerBomb.new }.to raise_error(/logger.*required/)
+    end
+  end
+
+  describe LoggerBomb, '#trigger' do
+    let(:fake_logger) { double(info: 'foo') }
+    let(:logger_bomb) { LoggerBomb.new(fake_logger) }
+    let(:message) { StinkBomb.configuration.message }
+    let(:yesterday) { (Date.today - 1).to_time }
+    let(:tomorrow) { (Date.today + 1).to_time }
+
+    it 'does nothing if tomorrow is given' do
+      logger_bomb.trigger(tomorrow, message: message)
+
+      expect(fake_logger).not_to have_received(:info).with(/Your code stinks!/)
+    end
+
+    it 'does nothing if now + epsilon is given' do
+      logger_bomb.trigger(Time.now.getlocal + 1, message: message)
+
+      expect(fake_logger).not_to have_received(:info).with(/Your code stinks!/)
+    end
+
+    it 'logs a message if the given date is before today' do
+      logger_bomb.trigger(yesterday, message: message)
+
+      expect(fake_logger).to have_received(:info).with(/Your code stinks!/)
+    end
+  end
+end

data/spec/lib/stink_bomb/raise_bomb_spec.rb

@@ -0,0 +1,44 @@
+module StinkBomb
+  describe RaiseBomb, '#initialize' do
+    let(:message) { StinkBomb.configuration.message }
+    let(:yesterday) { (Date.today - 1).to_time }
+
+    it 'accepts an error class to raise' do
+      raise_bomb = RaiseBomb.new(StinkyTestError)
+      expect do
+        raise_bomb.trigger(yesterday, message: message)
+      end.to raise_error(StinkyTestError, /Your code stinks!/)
+    end
+
+    it 'raises a StinkyCodeError by default' do
+      expect do
+        RaiseBomb.new.trigger(yesterday, message: message)
+      end.to raise_error(StinkyCodeError, /Your code stinks!/)
+    end
+  end
+
+  describe RaiseBomb, '#trigger' do
+    let(:raise_bomb) { RaiseBomb.new }
+    let(:message) { StinkBomb.configuration.message }
+    let(:yesterday) { (Date.today - 1).to_time }
+    let(:tomorrow) { (Date.today + 1).to_time }
+
+    it 'does nothing if tomorrow is given' do
+      expect do
+        raise_bomb.trigger(tomorrow, message: message)
+      end.not_to raise_error
+    end
+
+    it 'does nothing if now + epsilon is given' do
+      expect do
+        raise_bomb.trigger(Time.now.getlocal + 1, message: message)
+      end.not_to raise_error
+    end
+
+    it 'raises an error if the given date is before today' do
+      expect do
+        raise_bomb.trigger(yesterday, message: message)
+      end.to raise_error(/Your code stinks!/)
+    end
+  end
+end

data/spec/lib/stink_bomb_spec.rb

@@ -1,8 +1,75 @@
 describe StinkBomb do
-  describe '#create' do
-    it 'creates an instance of Bomb with the parameters' do
-      expect(StinkBomb::Bomb).to receive(:new).with('My date', message: nil)
-      StinkBomb.create('My date')
+  describe '.create' do
+    let(:configuration) { StinkBomb.configuration }
+    let(:yesterday) { (Date.today - 1).to_time }
+
+    it 'triggers the configured bombs when there are bombs configured' do
+      configuration.raise = true
+      expect do
+        StinkBomb.create('01/01/1900')
+      end.to raise_error(StinkBomb::StinkyCodeError)
+    end
+
+    it 'does nothing when there are no bombs triggered' do
+      expect { StinkBomb.create('01/01/1900') }.not_to raise_error
+    end
+
+    it 'accepts a date object' do
+      configuration.raise = true
+      expect do
+        StinkBomb.create(yesterday)
+      end.to raise_error(StinkBomb::StinkyCodeError)
+    end
+
+    it 'accepts a time object' do
+      configuration.raise = true
+      expect do
+        StinkBomb.create(Time.now.getlocal - 86_400)
+      end.to raise_error(StinkBomb::StinkyCodeError)
+    end
+
+    it 'raises an error if the time is not a date or a string' do
+      expect do
+        StinkBomb.create(1)
+      end.to raise_error('Parameter has to be a Time, Date, or a String')
+    end
+
+    it 'raises an error if the given date is after today' do
+      configuration.raise = true
+      yesterday_string = Regexp.quote(yesterday.to_s)
+      expect do
+        StinkBomb.create(yesterday)
+      end.to raise_error(/It was supposed to be fixed by #{yesterday_string}/)
+    end
+
+    it 'raises a custom message when specified' do
+      configuration.raise = true
+      yesterday_string = Regexp.quote(yesterday.to_s)
+      expect do
+        StinkBomb.create(yesterday, message: '{deadline} Smells like poo')
+      end.to raise_error(/#{yesterday_string} Smells like poo/)
+    end
+  end
+
+  describe '.configuration' do
+    it 'returns the same object every time' do
+      expect(StinkBomb.configuration).to equal(StinkBomb.configuration)
+    end
+  end
+
+  describe '.configure' do
+    it 'yields the current configuration' do
+      StinkBomb.configure do |configuration|
+        expect(configuration).to equal(StinkBomb.configuration)
+      end
+    end
+  end
+
+  describe '.reset' do
+    it 'resets the configuration' do
+      old_configuration = StinkBomb.configuration
+      StinkBomb.reset
+      expect(StinkBomb.configuration).not_to equal(old_configuration)
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,9 +1,21 @@
-require 'coveralls'
-Coveralls.wear!
+require 'simplecov'
+if ENV['CI']
+  require 'codeclimate-test-reporter'
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    CodeClimate::TestReporter::Formatter
+  ]
+  SimpleCov.minimum_coverage 100
+end
+SimpleCov.start { add_filter '/spec/' }
 
 require_relative '../lib/stink_bomb'
 
 RSpec.configure do |config|
   config.filter_run focus: true
   config.run_all_when_everything_filtered = true
+
+  config.after(:each) { StinkBomb.reset }
 end
+
+class StinkyTestError < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stink_bomb
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Holman Gao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-01 00:00:00.000000000 Z
+date: 2015-01-07 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -17,18 +17,24 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .rubocop.yml
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/stink_bomb.rb
 - lib/stink_bomb/bomb.rb
+- lib/stink_bomb/configuration.rb
+- lib/stink_bomb/logger_bomb.rb
+- lib/stink_bomb/raise_bomb.rb
 - lib/stink_bomb/version.rb
-- spec/lib/stink_bomb/bomb_spec.rb
+- spec/lib/stink_bomb/configuration_spec.rb
+- spec/lib/stink_bomb/logger_bomb_spec.rb
+- spec/lib/stink_bomb/raise_bomb_spec.rb
 - spec/lib/stink_bomb_spec.rb
 - spec/spec_helper.rb
 - stink_bomb.gemspec
@@ -42,22 +48,23 @@ 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.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Fail your CI when your code becomes stinky
 test_files:
-- spec/lib/stink_bomb/bomb_spec.rb
+- spec/lib/stink_bomb/configuration_spec.rb
+- spec/lib/stink_bomb/logger_bomb_spec.rb
+- spec/lib/stink_bomb/raise_bomb_spec.rb
 - spec/lib/stink_bomb_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/spec/lib/stink_bomb/bomb_spec.rb

@@ -1,43 +0,0 @@
-class StinkBomb
-  describe Bomb, '#initialize' do
-    it 'does nothing if tomorrow is given' do
-      expect do
-        Bomb.new(Date.today + 1)
-      end.not_to raise_error
-    end
-
-    it 'does nothing if now + epsilon is given' do
-      expect do
-        Bomb.new(Time.now.getlocal + 1)
-      end.not_to raise_error
-    end
-
-    it 'does not raise an error in production' do
-      expect(ENV).to receive(:[]).with('RAILS_ENV').and_return('production')
-
-      expect do
-        Bomb.new(Date.today - 1)
-      end.not_to raise_error
-    end
-
-    it 'raises a custom message when specified' do
-      yesterday = Date.today - 1
-      expect do
-        Bomb.new(yesterday, message: 'Smells like poo')
-      end.to raise_error(/Smells like poo/)
-    end
-
-    it 'raises an error if the given date is after today' do
-      yesterday = Date.today - 1
-      expect do
-        Bomb.new(yesterday)
-      end.to raise_error(/stinks! It was supposed to be fixed by #{yesterday}/)
-    end
-
-    it 'raises an error if the parameter is not a date or a string' do
-      expect do
-        Bomb.new(1)
-      end.to raise_error('Parameter has to be a Time, Date, or a String')
-    end
-  end
-end