stoplight 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0194283983ed6568bca930b6640a7d397dd06e779d921e8bd169cb6a8e743448'
-  data.tar.gz: 9b68b81b05c15cbed7885d8f10a042c0e0ecacafacb0fe6e621e3c124007d74e
+  metadata.gz: 26a32d4e3aa3c515fb23a75f3055d250eaf10431eeae1316086bfe69ca569277
+  data.tar.gz: 9cfadd0dc4bbc99687aeffc847ae68b9926b29383530a2d55ae79ac2b22039b6
 SHA512:
-  metadata.gz: 64c7f5d19bb00b46f9908d938a120c475f1fd60e481e58400c49360dae260bd6c83690e61f34362a20dea0b3b955f4f9b9d76030b8ccbb7c788fd7a531ad395b
-  data.tar.gz: e48e470e7f72d811852df5576b132a11f6f69dedf711cf371c9cfbc4dc1a4600f217b147ba53c9313a8863a06aaef88e279d3cd5f7e8ff51bd69c731123b1093
+  metadata.gz: 5ee973ed322845425185904de1d681064794d3a39e7d303c36b172b377d080541867e81df5cfc2a1a75da07b1088dcf15de61c807d446ca3d60582c1d645d07f
+  data.tar.gz: 16420c055193f5c9364d517ecea8d4ffb1ad9fbd184a77f792d1b693ab13b5d9040f56b53027c1cfcc53b971590cb7c4ffb215c2cf3692e6c978bb8f51d592b3

data/README.md

@@ -9,9 +9,6 @@ Stoplight is traffic control for code. It's an implementation of the circuit
 breaker pattern in Ruby.
 
 ---
-:warning: You're browsing the documentation of the not realized version. You can find the documentation 
-for the most recent version 3.0.1 [here](https://github.com/bolshakov/stoplight/tree/v3.0.1).
-
 Does your code use unreliable systems, like a flaky database or a spotty web
 service? Wrap calls to those up in stoplights to prevent them from affecting
 the rest of your application.
@@ -38,7 +35,7 @@ Check out [stoplight-admin][] for controlling your stoplights.
 - [Advanced Usage](#advanced-usage)
   - [Locking](#locking)
   - [Testing](#testing)
-- [Maintenance Policy][#maintenance-policy]
+- [Maintenance Policy](#maintenance-policy)
 - [Credits](#credits)
 
 ## Installation

data/lib/stoplight/builder.rb

@@ -30,6 +30,8 @@ module Stoplight
     def_delegator :build, :with_error_handler
     def_delegator :build, :with_fallback
     def_delegator :build, :color
+    def_delegator :build, :name
+    def_delegator :build, :state
     def_delegator :build, :run
     def_delegator :build, :lock
     def_delegator :build, :unlock

data/lib/stoplight/circuit_breaker.rb

@@ -39,6 +39,16 @@ module Stoplight
       raise NotImplementedError
     end
 
+    # @return [String] one of +locked_green+, +locked_red+, and +unlocked+
+    def state
+      raise NotImplementedError
+    end
+
+    # @return [String] the light's name
+    def name
+      raise NotImplementedError
+    end
+
     # Returns current color:
     #   * +Stoplight::Color::GREEN+ -- circuit breaker is closed
     #   * +Stoplight::Color::RED+ -- circuit breaker is open

data/lib/stoplight/light/runnable.rb

@@ -3,6 +3,12 @@
 module Stoplight
   class Light
     module Runnable # rubocop:disable Style/Documentation
+      # @return [String]
+      def state
+        _, state = failures_and_state
+        state
+      end
+
       # @return [String]
       def color
         failures, state = failures_and_state

data/lib/stoplight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stoplight
-  VERSION = Gem::Version.new('4.0.0')
+  VERSION = Gem::Version.new('4.1.0')
 end

data/spec/stoplight/circuit_breaker_spec.rb

@@ -21,6 +21,14 @@ RSpec.describe Stoplight::CircuitBreaker do
     expect { circuit_breaker.color }.to raise_error(NotImplementedError)
   end
 
+  specify '#state' do
+    expect { circuit_breaker.state }.to raise_error(NotImplementedError)
+  end
+
+  specify '#name' do
+    expect { circuit_breaker.name }.to raise_error(NotImplementedError)
+  end
+
   specify '#run' do
     expect { circuit_breaker.run {} }.to raise_error(NotImplementedError)
   end

data/spec/stoplight/light/runnable_spec.rb

@@ -23,6 +23,7 @@ RSpec.describe Stoplight::Light::Runnable, :redis do
   context 'with memory data store' do
     let(:data_store) { Stoplight::DataStore::Memory.new }
 
+    it_behaves_like 'Stoplight::Light::Runnable#state'
     it_behaves_like 'Stoplight::Light::Runnable#color'
     it_behaves_like 'Stoplight::Light::Runnable#run'
   end
@@ -30,6 +31,7 @@ RSpec.describe Stoplight::Light::Runnable, :redis do
   context 'with redis data store', :redis do
     let(:data_store) { Stoplight::DataStore::Redis.new(redis) }
 
+    it_behaves_like 'Stoplight::Light::Runnable#state'
     it_behaves_like 'Stoplight::Light::Runnable#color'
     it_behaves_like 'Stoplight::Light::Runnable#run'
   end

data/spec/support/light/runnable/state.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'Stoplight::Light::Runnable#state' do
+  subject(:light) { Stoplight::Light.new(name) }
+
+  let(:name) { random_string }
+
+  it 'is initially unlocked' do
+    expect(light.state).to eql(Stoplight::State::UNLOCKED)
+  end
+
+  context 'when its locked green' do
+    before do
+      light.data_store.set_state(light, Stoplight::State::LOCKED_GREEN)
+    end
+
+    it 'is locked green' do
+      expect(light.state).to eql(Stoplight::State::LOCKED_GREEN)
+    end
+  end
+
+  context 'when its locked red' do
+    before do
+      light.data_store.set_state(light, Stoplight::State::LOCKED_RED)
+    end
+
+    it 'is locked red' do
+      expect(light.state).to eql(Stoplight::State::LOCKED_RED)
+    end
+  end
+end

data/spec/support/light/runnable.rb

@@ -2,3 +2,4 @@
 
 require_relative 'runnable/color'
 require_relative 'runnable/run'
+require_relative 'runnable/state'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stoplight
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Cameron Desautels
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-18 00:00:00.000000000 Z
+date: 2023-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redlock
@@ -103,6 +103,7 @@ files:
 - spec/support/light/runnable.rb
 - spec/support/light/runnable/color.rb
 - spec/support/light/runnable/run.rb
+- spec/support/light/runnable/state.rb
 homepage: https://github.com/bolshakov/stoplight
 licenses:
 - MIT
@@ -165,4 +166,5 @@ test_files:
 - spec/support/exception_helpers.rb
 - spec/support/light/runnable/color.rb
 - spec/support/light/runnable/run.rb
+- spec/support/light/runnable/state.rb
 - spec/support/light/runnable.rb