stoplight 3.0.2 → 4.0.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stoplight
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 4.0.0
 platform: ruby
 authors:
 - Cameron Desautels
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-28 00:00:00.000000000 Z
+date: 2023-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redlock
@@ -26,216 +26,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: benchmark-ips
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-- !ruby/object:Gem::Dependency
-  name: bugsnag
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: fakeredis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: honeybadger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.5'
-- !ruby/object:Gem::Dependency
-  name: mock_redis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: pagerduty
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.1.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.1.1
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: redis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.1'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.11'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: sentry-raven
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.21'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.21'
-- !ruby/object:Gem::Dependency
-  name: simplecov-lcov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: slack-notifier
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
 description: An implementation of the circuit breaker pattern.
 email:
 - camdez@gmail.com
@@ -249,7 +39,11 @@ files:
 - LICENSE.md
 - README.md
 - lib/stoplight.rb
+- lib/stoplight/builder.rb
+- lib/stoplight/circuit_breaker.rb
 - lib/stoplight/color.rb
+- lib/stoplight/configurable.rb
+- lib/stoplight/configuration.rb
 - lib/stoplight/data_store.rb
 - lib/stoplight/data_store/base.rb
 - lib/stoplight/data_store/memory.rb
@@ -258,22 +52,23 @@ files:
 - lib/stoplight/error.rb
 - lib/stoplight/failure.rb
 - lib/stoplight/light.rb
+- lib/stoplight/light/deprecated.rb
+- lib/stoplight/light/lockable.rb
 - lib/stoplight/light/runnable.rb
 - lib/stoplight/notifier.rb
 - lib/stoplight/notifier/base.rb
-- lib/stoplight/notifier/bugsnag.rb
 - lib/stoplight/notifier/generic.rb
-- lib/stoplight/notifier/honeybadger.rb
 - lib/stoplight/notifier/io.rb
 - lib/stoplight/notifier/logger.rb
-- lib/stoplight/notifier/pagerduty.rb
-- lib/stoplight/notifier/raven.rb
-- lib/stoplight/notifier/rollbar.rb
-- lib/stoplight/notifier/slack.rb
+- lib/stoplight/rspec.rb
+- lib/stoplight/rspec/generic_notifier.rb
 - lib/stoplight/state.rb
 - lib/stoplight/version.rb
 - spec/spec_helper.rb
+- spec/stoplight/builder_spec.rb
+- spec/stoplight/circuit_breaker_spec.rb
 - spec/stoplight/color_spec.rb
+- spec/stoplight/configurable_spec.rb
 - spec/stoplight/data_store/base_spec.rb
 - spec/stoplight/data_store/memory_spec.rb
 - spec/stoplight/data_store/redis_spec.rb
@@ -281,22 +76,33 @@ files:
 - spec/stoplight/default_spec.rb
 - spec/stoplight/error_spec.rb
 - spec/stoplight/failure_spec.rb
+- spec/stoplight/light/lockable_spec.rb
 - spec/stoplight/light/runnable_spec.rb
 - spec/stoplight/light_spec.rb
 - spec/stoplight/notifier/base_spec.rb
-- spec/stoplight/notifier/bugsnag_spec.rb
 - spec/stoplight/notifier/generic_spec.rb
-- spec/stoplight/notifier/honeybadger_spec.rb
 - spec/stoplight/notifier/io_spec.rb
 - spec/stoplight/notifier/logger_spec.rb
-- spec/stoplight/notifier/pagerduty_spec.rb
-- spec/stoplight/notifier/raven_spec.rb
-- spec/stoplight/notifier/rollbar_spec.rb
-- spec/stoplight/notifier/slack_spec.rb
 - spec/stoplight/notifier_spec.rb
 - spec/stoplight/state_spec.rb
 - spec/stoplight/version_spec.rb
 - spec/stoplight_spec.rb
+- spec/support/configurable.rb
+- spec/support/data_store/base.rb
+- spec/support/data_store/base/clear_failures.rb
+- spec/support/data_store/base/clear_state.rb
+- spec/support/data_store/base/get_all.rb
+- spec/support/data_store/base/get_failures.rb
+- spec/support/data_store/base/get_state.rb
+- spec/support/data_store/base/names.rb
+- spec/support/data_store/base/record_failures.rb
+- spec/support/data_store/base/set_state.rb
+- spec/support/data_store/base/with_notification_lock.rb
+- spec/support/database_cleaner.rb
+- spec/support/exception_helpers.rb
+- spec/support/light/runnable.rb
+- spec/support/light/runnable/color.rb
+- spec/support/light/runnable/run.rb
 homepage: https://github.com/bolshakov/stoplight
 licenses:
 - MIT
@@ -309,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: 3.0.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -322,7 +128,10 @@ specification_version: 4
 summary: Traffic control for code.
 test_files:
 - spec/spec_helper.rb
+- spec/stoplight/builder_spec.rb
+- spec/stoplight/circuit_breaker_spec.rb
 - spec/stoplight/color_spec.rb
+- spec/stoplight/configurable_spec.rb
 - spec/stoplight/data_store/base_spec.rb
 - spec/stoplight/data_store/memory_spec.rb
 - spec/stoplight/data_store/redis_spec.rb
@@ -330,19 +139,30 @@ test_files:
 - spec/stoplight/default_spec.rb
 - spec/stoplight/error_spec.rb
 - spec/stoplight/failure_spec.rb
+- spec/stoplight/light/lockable_spec.rb
 - spec/stoplight/light/runnable_spec.rb
 - spec/stoplight/light_spec.rb
 - spec/stoplight/notifier/base_spec.rb
-- spec/stoplight/notifier/bugsnag_spec.rb
 - spec/stoplight/notifier/generic_spec.rb
-- spec/stoplight/notifier/honeybadger_spec.rb
 - spec/stoplight/notifier/io_spec.rb
 - spec/stoplight/notifier/logger_spec.rb
-- spec/stoplight/notifier/pagerduty_spec.rb
-- spec/stoplight/notifier/raven_spec.rb
-- spec/stoplight/notifier/rollbar_spec.rb
-- spec/stoplight/notifier/slack_spec.rb
 - spec/stoplight/notifier_spec.rb
 - spec/stoplight/state_spec.rb
 - spec/stoplight/version_spec.rb
 - spec/stoplight_spec.rb
+- spec/support/configurable.rb
+- spec/support/data_store/base/clear_failures.rb
+- spec/support/data_store/base/clear_state.rb
+- spec/support/data_store/base/get_all.rb
+- spec/support/data_store/base/get_failures.rb
+- spec/support/data_store/base/get_state.rb
+- spec/support/data_store/base/names.rb
+- spec/support/data_store/base/record_failures.rb
+- spec/support/data_store/base/set_state.rb
+- spec/support/data_store/base/with_notification_lock.rb
+- spec/support/data_store/base.rb
+- spec/support/database_cleaner.rb
+- spec/support/exception_helpers.rb
+- spec/support/light/runnable/color.rb
+- spec/support/light/runnable/run.rb
+- spec/support/light/runnable.rb

data/lib/stoplight/notifier/bugsnag.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module Stoplight
-  module Notifier
-    # @see Base
-    class Bugsnag < Base
-      DEFAULT_OPTIONS = {
-        severity: 'info'
-      }.freeze
-
-      StoplightStatusChange = Class.new(Error::Base)
-
-      # @return [Proc]
-      attr_reader :formatter
-      # @return [::Bugsnag]
-      attr_reader :bugsnag
-      # @return [Hash{Symbol => Object}]
-      attr_reader :options
-
-      # @param bugsnag [::Bugsnag]
-      # @param formatter [Proc, nil]
-      # @param options [Hash{Symbol => Object}]
-      # @option options [String] :severity
-      def initialize(bugsnag, formatter = nil, options = {})
-        @bugsnag = bugsnag
-        @formatter = formatter || Default::FORMATTER
-        @options = DEFAULT_OPTIONS.merge(options)
-      end
-
-      def notify(light, from_color, to_color, error)
-        message = formatter.call(light, from_color, to_color, error)
-        bugsnag.notify(StoplightStatusChange.new(message), **options)
-        message
-      end
-    end
-  end
-end

data/lib/stoplight/notifier/honeybadger.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module Stoplight
-  module Notifier
-    # @see Base
-    class Honeybadger < Base
-      DEFAULT_OPTIONS = {
-        parameters: {},
-        session: {},
-        context: {}
-      }.freeze
-
-      # @return [String]
-      attr_reader :api_key
-      # @return [Proc]
-      attr_reader :formatter
-      # @return [Hash{Symbol => Object}]
-      attr_reader :options
-
-      # @param api_key [String]
-      # @param formatter [Proc, nil]
-      # @param options [Hash{Symbol => Object}]
-      # @option options [Hash] :parameters
-      # @option options [Hash] :session
-      # @option options [Hash] :context
-      def initialize(api_key, formatter = nil, options = {})
-        @api_key = api_key
-        @formatter = formatter || Default::FORMATTER
-        @options = DEFAULT_OPTIONS.merge(options)
-      end
-
-      def notify(light, from_color, to_color, error)
-        message = formatter.call(light, from_color, to_color, error)
-        h = options.merge(
-          api_key: api_key,
-          error_message: message,
-          backtrace: error&.backtrace
-        )
-        ::Honeybadger.notify(h)
-        message
-      end
-    end
-  end
-end

data/lib/stoplight/notifier/pagerduty.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Stoplight
-  module Notifier
-    # @see Base
-    class Pagerduty < Base
-      include Generic
-
-      # @return [::Pagerduty]
-      def pagerduty
-        @object
-      end
-
-      private
-
-      def put(message)
-        pagerduty.trigger(message)
-      end
-    end
-  end
-end

data/lib/stoplight/notifier/raven.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module Stoplight
-  module Notifier
-    # @see Base
-    class Raven < Base
-      DEFAULT_OPTIONS = {
-        extra: {}
-      }.freeze
-
-      # @return [::Raven::Configuration]
-      attr_reader :configuration
-      # @return [Proc]
-      attr_reader :formatter
-      # @return [Hash{Symbol => Object}]
-      attr_reader :options
-
-      # @param api_key [String]
-      # @param formatter [Proc, nil]
-      # @param options [Hash{Symbol => Object}]
-      # @option options [Hash] :extra
-      def initialize(configuration, formatter = nil, options = {})
-        @configuration = configuration
-        @formatter = formatter || Default::FORMATTER
-        @options = DEFAULT_OPTIONS.merge(options)
-      end
-
-      def notify(light, from_color, to_color, error)
-        message = formatter.call(light, from_color, to_color, error)
-
-        h = options.merge(
-          configuration: configuration,
-          backtrace: error&.backtrace
-        )
-        ::Raven.capture_message(message, h)
-        message
-      end
-    end
-  end
-end

data/lib/stoplight/notifier/rollbar.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Stoplight
-  module Notifier
-    # @see Base
-    class Rollbar < Base
-      DEFAULT_OPTIONS = {
-        severity: 'info'
-      }.freeze
-
-      StoplightStatusChange = Class.new(Error::Base)
-
-      # @return [Proc]
-      attr_reader :formatter
-      # @return [::Rollbar]
-      attr_reader :rollbar
-      # @return [Hash{Symbol => Object}]
-      attr_reader :options
-
-      # @param rollbar [::Rollbar]
-      # @param formatter [Proc, nil]
-      # @param options [Hash{Symbol => Object}]
-      # @option options [String] :severity
-      def initialize(rollbar, formatter = nil, options = {})
-        @rollbar = rollbar
-        @formatter = formatter || Default::FORMATTER
-        @options = DEFAULT_OPTIONS.merge(options)
-      end
-
-      def notify(light, from_color, to_color, error)
-        formatter.call(light, from_color, to_color, error).tap do |message|
-          severity = options.fetch(:severity)
-          exception = StoplightStatusChange.new(message)
-          rollbar.__send__(severity, exception)
-        end
-      end
-    end
-  end
-end

data/lib/stoplight/notifier/slack.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Stoplight
-  module Notifier
-    # @see Base
-    class Slack < Base
-      include Generic
-
-      # @return [::Slack::Notifier]
-      def slack
-        @object
-      end
-
-      private
-
-      def put(message)
-        slack.ping(message)
-      end
-    end
-  end
-end

data/spec/stoplight/notifier/bugsnag_spec.rb

@@ -1,90 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-# require 'bugsnag'
-module Bugsnag
-end
-
-RSpec.describe Stoplight::Notifier::Bugsnag do
-  it 'is a class' do
-    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, 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 '#options' do
-    it 'is initially the default' do
-      expect(described_class.new(nil, nil).options)
-        .to eql(Stoplight::Notifier::Bugsnag::DEFAULT_OPTIONS)
-    end
-
-    it 'reads the options' do
-      options = { key: :value }
-      expect(described_class.new(nil, nil, options).options)
-        .to eql(Stoplight::Notifier::Bugsnag::DEFAULT_OPTIONS.merge(options))
-    end
-  end
-
-  describe '#bugsnag' do
-    it 'reads the Bugsnag client' do
-      client = Bugsnag
-      expect(described_class.new(client, nil).bugsnag)
-        .to eql(client)
-    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(bugsnag) }
-    let(:bugsnag) { Bugsnag }
-
-    subject(:result) do
-      notifier.notify(light, from_color, to_color, error)
-    end
-
-    before do
-      status_change = described_class::StoplightStatusChange.new(message)
-      expect(bugsnag).to receive(:notify).with(status_change, severity: 'info')
-    end
-
-    context 'when no error given' do
-      let(:error) { nil }
-
-      it 'logs message' do
-        expect(result).to eq(message)
-      end
-    end
-
-    context 'when message with an error given' do
-      let(:error) { ZeroDivisionError.new('divided by 0') }
-
-      it 'logs message' do
-        expect(result).to eq(message)
-      end
-    end
-
-    def message
-      notifier.formatter.call(light, from_color, to_color, error)
-    end
-  end
-end