stoplight 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9ae554bc9377af5da84befa1e47b71f28d3610b
-  data.tar.gz: a65e07dbe879f7895751607894992ad5e8a437f1
+  metadata.gz: 2da543aa5426e5354ed20f5e6d8547190597073d
+  data.tar.gz: 70aa5cfae4dbeec33fbefcadff88098317ccf0cc
 SHA512:
-  metadata.gz: e7e320df17b172d01c35e397d21046f44d30608a3491eb05036b2cfeb75c79afc83c15e01c1fc676518de5e3313fa4597bfd5ca84f0322fbf30ff387bf5eead2
-  data.tar.gz: 0db404935da87b9e0b731d9a191288234db19f0b37b240bfe4d32418482a9fe4a6a03f2a039263d379447b5db991e1b172629216997bcf69278f2fb0ed743eda
+  metadata.gz: 7c022ff3500336be177976073695d9d197800e2ecdcfc9e1a498215f239b69e302b82c475f2ab8f7cfd6be508d20b9d9fd0c1170adfa70de1006de11751013c8
+  data.tar.gz: 857d9ea2421f83e516f64e6319421100d0bda5992875f023909c474ef78d140a173570a28944abc5865fbf5c2b603a79ce9689acd21013f5fa3e0b6e1c6174a8

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 Stoplight uses [Semantic Versioning][1].
 
+## v1.1.1 (2015-07-16)
+
+- Introduced a generic notifier to reduce duplication between the IO and Slack
+  notifiers.
+
 ## v1.1.0 (2015-07-04)
 
 - #71: Added Slack notifier. Thanks, @s1mplex!

data/README.md

@@ -14,7 +14,7 @@ breaker pattern in Ruby.
 
 Does your code use unreliable systems, like a flaky database or a
 spotty web service? Wrap those up with stoplights to prevent them
-from affecting the rest of your application down.
+from affecting the rest of your application.
 
 Check out [stoplight-admin][] for controlling your stoplights.
 
@@ -135,6 +135,9 @@ light.color
 # => "green"
 ```
 
+The following errors are always allowed: `NoMemoryError`, `ScriptError`,
+`SecurityError`, `SignalException`, `SystemExit`, and `SystemStackError`.
+
 ### Custom fallback
 
 By default, stoplights will re-raise errors when they're green.
@@ -178,6 +181,8 @@ light.run
 # Stoplight::Error::RedLight: example-5
 ```
 
+The default threshold is `3`.
+
 ### Custom timeout
 
 Stoplights will automatically attempt to recover after a certain
@@ -203,7 +208,8 @@ light.run
 # RuntimeError:
 ```
 
-Set the timeout to `-1` to disable automatic recovery.
+The default timeout is `60` seconds. Set the timeout to `-1` to disable
+automatic recovery.
 
 ### Rails
 

data/lib/stoplight.rb

@@ -17,6 +17,7 @@ require 'stoplight/data_store/redis'
 
 require 'stoplight/notifier'
 require 'stoplight/notifier/base'
+require 'stoplight/notifier/generic'
 require 'stoplight/notifier/hip_chat'
 require 'stoplight/notifier/io'
 require 'stoplight/notifier/slack'

data/lib/stoplight/notifier/generic.rb

@@ -0,0 +1,30 @@
+# coding: utf-8
+
+module Stoplight
+  module Notifier
+    module Generic
+      # @return [Proc]
+      attr_reader :formatter
+
+      # @param object [Object]
+      # @param formatter [Proc, nil]
+      def initialize(object, formatter = nil)
+        @object = object
+        @formatter = formatter || Default::FORMATTER
+      end
+
+      # @see Base#notify
+      def notify(light, from_color, to_color, error)
+        message = formatter.call(light, from_color, to_color, error)
+        put(message)
+        message
+      end
+
+      private
+
+      def put(_message)
+        fail NotImplementedError
+      end
+    end
+  end
+end

data/lib/stoplight/notifier/io.rb

@@ -1,27 +1,20 @@
 # coding: utf-8
 
-require 'stringio'
-
 module Stoplight
   module Notifier
     # @see Base
     class IO < Base
-      # @return [Proc]
-      attr_reader :formatter
-      # @return [::IO]
-      attr_reader :io
+      include Generic
 
-      # @param io [::IO]
-      # @param formatter [Proc, nil]
-      def initialize(io, formatter = nil)
-        @io = io
-        @formatter = formatter || Default::FORMATTER
+      # @return [::IO]
+      def io
+        @object
       end
 
-      def notify(light, from_color, to_color, error)
-        message = formatter.call(light, from_color, to_color, error)
+      private
+
+      def put(message)
         io.puts(message)
-        message
       end
     end
   end

data/lib/stoplight/notifier/slack.rb

@@ -4,23 +4,17 @@ module Stoplight
   module Notifier
     # @see Base
     class Slack < Base
-      # @return [Proc]
-      attr_reader :formatter
+      include Generic
 
       # @return [::Slack::Notifier]
-      attr_reader :slack
-
-      # @param slack [::Slack::Notifier]
-      # @param formatter [Proc, nil]
-      def initialize(slack, formatter = nil)
-        @slack = slack
-        @formatter = formatter || Default::FORMATTER
+      def slack
+        @object
       end
 
-      def notify(light, from_color, to_color, error)
-        message = formatter.call(light, from_color, to_color, error)
+      private
+
+      def put(message)
         slack.ping(message)
-        message
       end
     end
   end

data/lib/stoplight/version.rb

@@ -1,5 +1,5 @@
 # coding: utf-8
 
 module Stoplight
-  VERSION = Gem::Version.new('1.1.0')
+  VERSION = Gem::Version.new('1.1.1')
 end

data/spec/stoplight/light/runnable_spec.rb

@@ -1,6 +1,7 @@
 # coding: utf-8
 
 require 'spec_helper'
+require 'stringio'
 
 RSpec.describe Stoplight::Light::Runnable do
   subject { Stoplight::Light.new(name, &code) }

data/spec/stoplight/light_spec.rb

@@ -1,6 +1,7 @@
 # coding: utf-8
 
 require 'spec_helper'
+require 'stringio'
 
 RSpec.describe Stoplight::Light do
   let(:light) { described_class.new(name, &code) }

data/spec/stoplight/notifier/base_spec.rb

@@ -6,7 +6,7 @@ RSpec.describe Stoplight::Notifier::Base do
   let(:notifier) { described_class.new }
 
   it 'is a class' do
-    expect(described_class).to be_a(Module)
+    expect(described_class).to be_a(Class)
   end
 
   describe '#notify' do

data/spec/stoplight/notifier/generic_spec.rb

@@ -0,0 +1,50 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+RSpec.shared_examples_for 'a generic notifier' do
+  it 'includes Generic' do
+    expect(described_class).to include(Stoplight::Notifier::Generic)
+  end
+
+  describe '#formatter' do
+    it 'is initially the default' do
+      formatter = nil
+      expect(described_class.new(nil, formatter).formatter)
+        .to eql(Stoplight::Default::FORMATTER)
+    end
+
+    it 'reads the formatter' do
+      formatter = proc {}
+      expect(described_class.new(nil, formatter).formatter)
+        .to eql(formatter)
+    end
+  end
+
+  describe '#notify' do
+    let(:light) { Stoplight::Light.new(name, &code) }
+    let(:name) { ('a'..'z').to_a.shuffle.join }
+    let(:code) { -> {} }
+    let(:from_color) { Stoplight::Color::GREEN }
+    let(:to_color) { Stoplight::Color::RED }
+    let(:notifier) { described_class.new(double.as_null_object) }
+
+    it 'returns the message' do
+      error = nil
+      expect(notifier.notify(light, from_color, to_color, error))
+        .to eql(notifier.formatter.call(light, from_color, to_color, error))
+    end
+
+    it 'returns the message with an error' do
+      error = ZeroDivisionError.new('divided by 0')
+      expect(notifier.notify(light, from_color, to_color, error))
+        .to eql(notifier.formatter.call(light, from_color, to_color, error))
+    end
+  end
+end
+
+RSpec.describe Stoplight::Notifier::Generic do
+  it 'is a module' do
+    expect(described_class).to be_a(Module)
+  end
+end

data/spec/stoplight/notifier/hip_chat_spec.rb

@@ -5,7 +5,7 @@ require 'hipchat'
 
 RSpec.describe Stoplight::Notifier::HipChat do
   it 'is a class' do
-    expect(described_class).to be_a(Module)
+    expect(described_class).to be_a(Class)
   end
 
   it 'is a subclass of Base' do

data/spec/stoplight/notifier/io_spec.rb

@@ -1,29 +1,19 @@
 # coding: utf-8
 
 require 'spec_helper'
+require 'stringio'
 
 RSpec.describe Stoplight::Notifier::IO do
+  it_behaves_like 'a generic notifier'
+
   it 'is a class' do
-    expect(described_class).to be_a(Module)
+    expect(described_class).to be_a(Class)
   end
 
   it 'is a subclass of Base' do
     expect(described_class).to be < Stoplight::Notifier::Base
   end
 
-  describe '#formatter' do
-    it 'is initially the default' do
-      expect(described_class.new(nil).formatter)
-        .to eql(Stoplight::Default::FORMATTER)
-    end
-
-    it 'reads the formatter' do
-      formatter = proc {}
-      expect(described_class.new(nil, formatter).formatter)
-        .to eql(formatter)
-    end
-  end
-
   describe '#io' do
     it 'reads the IO' do
       io = StringIO.new
@@ -40,18 +30,6 @@ RSpec.describe Stoplight::Notifier::IO do
     let(:notifier) { described_class.new(io) }
     let(:io) { StringIO.new }
 
-    it 'returns the message' do
-      error = nil
-      expect(notifier.notify(light, from_color, to_color, error))
-        .to eql(notifier.formatter.call(light, from_color, to_color, error))
-    end
-
-    it 'returns the message with an error' do
-      error = ZeroDivisionError.new('divided by 0')
-      expect(notifier.notify(light, from_color, to_color, error))
-        .to eql(notifier.formatter.call(light, from_color, to_color, error))
-    end
-
     it 'writes the message' do
       error = nil
       notifier.notify(light, from_color, to_color, error)

data/spec/stoplight/notifier/slack_spec.rb

@@ -4,23 +4,17 @@ require 'spec_helper'
 require 'slack-notifier'
 
 RSpec.describe Stoplight::Notifier::Slack do
-  it 'is a subclass of Base' do
-    expect(described_class).to be < Stoplight::Notifier::Base
-  end
+  it_behaves_like 'a generic notifier'
 
-  describe '#formatter' do
-    it 'is initially the default' do
-      expect(described_class.new(nil).formatter)
-        .to eql(Stoplight::Default::FORMATTER)
-    end
+  it 'is a class' do
+    expect(described_class).to be_a(Class)
+  end
 
-    it 'reads the formatter' do
-      formatter = proc {}
-      expect(described_class.new(nil, formatter).formatter).to eql(formatter)
-    end
+  it 'is a subclass of Base' do
+    expect(described_class).to be < Stoplight::Notifier::Base
   end
 
-  describe '#slack_notifier' do
+  describe '#slack' do
     it 'reads Slack::Notifier client' do
       slack = Slack::Notifier.new('WEBHOOK_URL')
       expect(described_class.new(slack).slack).to eql(slack)
@@ -34,22 +28,13 @@ RSpec.describe Stoplight::Notifier::Slack do
     let(:from_color) { Stoplight::Color::GREEN }
     let(:to_color) { Stoplight::Color::RED }
     let(:notifier) { described_class.new(slack) }
-    let(:slack) { double(Slack::Notifier) }
-
-    before do
-      expect(slack).to receive(:ping).with(kind_of(String))
-    end
+    let(:slack) { double(Slack::Notifier).as_null_object }
 
-    it 'returns the message' do
+    it 'pings Slack' do
       error = nil
-      expect(notifier.notify(light, from_color, to_color, error))
-        .to eql(notifier.formatter.call(light, from_color, to_color, error))
-    end
-
-    it 'returns the message with an error' do
-      error = ZeroDivisionError.new('divided by 0')
-      expect(notifier.notify(light, from_color, to_color, error))
-        .to eql(notifier.formatter.call(light, from_color, to_color, error))
+      message = notifier.formatter.call(light, from_color, to_color, error)
+      expect(slack).to receive(:ping).with(message)
+      notifier.notify(light, from_color, to_color, error)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stoplight
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Cameron Desautels
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-04 00:00:00.000000000 Z
+date: 2015-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -233,6 +233,7 @@ files:
 - lib/stoplight/light/runnable.rb
 - lib/stoplight/notifier.rb
 - lib/stoplight/notifier/base.rb
+- lib/stoplight/notifier/generic.rb
 - lib/stoplight/notifier/hip_chat.rb
 - lib/stoplight/notifier/io.rb
 - lib/stoplight/notifier/slack.rb
@@ -250,6 +251,7 @@ files:
 - spec/stoplight/light/runnable_spec.rb
 - spec/stoplight/light_spec.rb
 - spec/stoplight/notifier/base_spec.rb
+- spec/stoplight/notifier/generic_spec.rb
 - spec/stoplight/notifier/hip_chat_spec.rb
 - spec/stoplight/notifier/io_spec.rb
 - spec/stoplight/notifier/slack_spec.rb
@@ -277,7 +279,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Traffic control for code.
@@ -294,6 +296,7 @@ test_files:
 - spec/stoplight/light/runnable_spec.rb
 - spec/stoplight/light_spec.rb
 - spec/stoplight/notifier/base_spec.rb
+- spec/stoplight/notifier/generic_spec.rb
 - spec/stoplight/notifier/hip_chat_spec.rb
 - spec/stoplight/notifier/io_spec.rb
 - spec/stoplight/notifier/slack_spec.rb