berater 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1270edae5d2c019ae92b623ff4c26e588cf8d5413c8f7b6c549d3d3ec4e16766
-  data.tar.gz: a9a659acde5a04263b1ca516a2fb1ecdd760d9133f3603b4fa7ec336c06f59df
+  metadata.gz: 3780da104c79084b2c3b348363a5f763c42d9d936dc218e68df90cdbbc223cfe
+  data.tar.gz: a3b7e7af7b3a764f97c013cb642eccf6d71ad825df459d32722a4e312ca2cdd8
 SHA512:
-  metadata.gz: 07fc3784c2e6d41648f97878e3a0c62e3a089c1ef69315e88141642350180634c65a89deda082ed5933a90666c620111329756d0699d3fde5238b97d0ad37e82
-  data.tar.gz: 6f8dc42b5b694a45c286b1d66a0b8efbf17371b3fd6bfd8936098b4155b85ae6523146fecfc6b7c46e3b0a8df1ddb03158f1fd181c9e6a1e13042232089e1a41
+  metadata.gz: 364a70d42009b4c80b7235cbbc736f8c074f309abfa529f494f2fd01959e9b5ffb2bbd08ad3a39b12b0565abb8435bf86cd59b774055c4fbd845ba7d2f0c798b
+  data.tar.gz: 92271042126ccc8b70a3a95f6fa530a8f36dceddaf7cc8de3ef9eb1ac861fcd9f7d10e066d27ac4d7bb807d5f43741f78aaf4b9b43a970bc159a5b2a3142f73a

data/lib/berater/mutex.rb

@@ -0,0 +1,28 @@
+module Berater
+  module Mutex
+    def self.included(base)
+      # add class methods
+      base.instance_eval do
+        def synchronize(subkey = nil, **opts, &block)
+          key = [ 'Mutex', name&.delete(':') || object_id, subkey ].compact.join(':')
+
+          Berater::ConcurrencyLimiter(key, 1, **mutex_options.merge(opts)) do
+            yield if block_given?
+          end
+        end
+
+        def mutex_options(**kwargs)
+          (@mutex_options ||= {}).update(kwargs)
+        end
+      end
+    end
+
+    def synchronize(...)
+      self.class.synchronize(...)
+    end
+
+    def self.extend_object(base)
+      included(base)
+    end
+  end
+end

data/lib/berater/version.rb

@@ -1,3 +1,3 @@
 module Berater
-  VERSION = "0.13.1"
+  VERSION = "0.14.0"
 end

data/lib/berater.rb

@@ -3,11 +3,13 @@ require 'berater/limiter_set'
 require 'berater/lock'
 require 'berater/lua_script'
 require 'berater/middleware'
+require 'berater/mutex'
 require 'berater/utils'
 require 'berater/version'
 require 'meddleware'
 
 module Berater
+  include Meddleware
   extend self
 
   class Overloaded < StandardError; end
@@ -22,12 +24,6 @@ module Berater
     @limiters ||= LimiterSet.new
   end
 
-  def middleware(&block)
-    (@middleware ||= Meddleware.new).tap do
-      @middleware.instance_eval(&block) if block_given?
-    end
-  end
-
   def new(key, capacity, **opts)
     args = []
 

data/spec/mutex_spec.rb

@@ -0,0 +1,110 @@
+describe Berater::Mutex do
+  let(:klass) do
+    Class.new do
+      include Berater::Mutex
+    end
+  end
+
+  describe 'synchronize' do
+    it { expect(klass).to respond_to(:synchronize) }
+    it { expect(klass.new).to respond_to(:synchronize) }
+
+    it { expect { |block| klass.synchronize(&block) }.to yield_control }
+
+    it 'returns the blocks value' do
+      res = klass.synchronize { 123 }
+      expect(res).to be 123
+    end
+
+    it 'still works and returns nil without a block' do
+      expect(klass.synchronize).to be nil
+    end
+
+    it 'does not allow simultaneous calls' do
+      expect {
+        klass.synchronize do
+          klass.synchronize
+        end
+      }.to be_overloaded
+    end
+
+    it 'allows simultaneous calls with different sub-keys' do
+      expect {
+        klass.synchronize(:a) do
+          klass.synchronize(:b)
+        end
+      }.not_to raise_error
+    end
+
+    it 'allows consecutive calls' do
+      expect {
+        3.times { klass.synchronize }
+      }.not_to raise_error
+    end
+
+    describe 'the instance method' do
+      it 'is a pass through to the class method' do
+        expect(klass).to receive(:synchronize)
+        klass.new.synchronize
+      end
+
+      it 'works with arguments' do
+        key = 'key'
+        opts = { timeout: 1 }
+        block = ->{}
+
+        expect(klass).to receive(:synchronize) do |this_key, **these_opts, &this_block|
+          expect(this_key).to be key
+          expect(these_opts).to eq opts
+          expect(this_block).to be block
+        end
+
+        klass.new.synchronize(key, **opts, &block)
+      end
+    end
+  end
+
+  describe '.mutex_options' do
+    subject { klass.mutex_options }
+
+    it { expect(klass).to respond_to(:mutex_options) }
+    it { is_expected.to be_a Hash }
+    it { is_expected.to be_empty }
+    it { expect(klass.new).not_to respond_to(:mutex_options) }
+
+    context 'when mutex_options are set' do
+      let(:klass) do
+        Class.new do
+          include Berater::Mutex
+
+          mutex_options timeout: 1
+        end
+      end
+
+      it { is_expected.to eq(timeout: 1) }
+
+      it 'uses mutex_options during synchronize' do
+        expect(Berater::ConcurrencyLimiter).to receive(:new).and_wrap_original do |original, *args, **kwargs|
+          expect(kwargs).to eq(subject)
+          original.call(*args, **kwargs)
+        end
+
+        klass.synchronize
+      end
+    end
+  end
+
+  describe 'when extended rather than included' do
+    let(:klass) do
+      Class.new do
+        extend Berater::Mutex
+      end
+    end
+
+    it { expect(klass).to respond_to(:synchronize) }
+    it { expect(klass).to respond_to(:mutex_options) }
+
+    it { expect(klass.new).not_to respond_to(:synchronize) }
+    it { expect(klass.new).not_to respond_to(:mutex_options) }
+  end
+end

data/spec/test_mode_spec.rb

@@ -171,4 +171,13 @@ describe Berater::TestMode do
     it_behaves_like 'it supports test_mode'
   end
 
+  describe 'Mutex' do
+    let(:klass) { Class.new { include Berater::Mutex } }
+
+    context 'when test_mode = :fail' do
+      before { Berater.test_mode = :fail }
+
+      it { expect { klass.synchronize }.to be_overloaded }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: berater
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Daniel Pepper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-13 00:00:00.000000000 Z
+date: 2022-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: meddleware
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -183,6 +183,7 @@ files:
 - lib/berater/middleware/load_shedder.rb
 - lib/berater/middleware/statsd.rb
 - lib/berater/middleware/trace.rb
+- lib/berater/mutex.rb
 - lib/berater/rate_limiter.rb
 - lib/berater/rspec.rb
 - lib/berater/rspec/matchers.rb
@@ -205,6 +206,7 @@ files:
 - spec/middleware/statsd_spec.rb
 - spec/middleware/trace_spec.rb
 - spec/middleware_spec.rb
+- spec/mutex_spec.rb
 - spec/rate_limiter_spec.rb
 - spec/riddle_spec.rb
 - spec/static_limiter_spec.rb
@@ -230,28 +232,29 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Berater
 test_files:
-- spec/rate_limiter_spec.rb
+- spec/berater_spec.rb
+- spec/concurrency_limiter_spec.rb
+- spec/dsl_refinement_spec.rb
+- spec/dsl_spec.rb
+- spec/inhibitor_spec.rb
+- spec/limiter_set_spec.rb
+- spec/limiter_spec.rb
+- spec/lua_script_spec.rb
+- spec/matchers_spec.rb
+- spec/middleware/fail_open_spec.rb
 - spec/middleware/load_shedder_spec.rb
 - spec/middleware/statsd_spec.rb
 - spec/middleware/trace_spec.rb
-- spec/middleware/fail_open_spec.rb
-- spec/matchers_spec.rb
-- spec/dsl_refinement_spec.rb
-- spec/test_mode_spec.rb
 - spec/middleware_spec.rb
-- spec/dsl_spec.rb
-- spec/lua_script_spec.rb
-- spec/concurrency_limiter_spec.rb
+- spec/mutex_spec.rb
+- spec/rate_limiter_spec.rb
 - spec/riddle_spec.rb
-- spec/limiter_set_spec.rb
-- spec/utils_spec.rb
-- spec/berater_spec.rb
-- spec/limiter_spec.rb
 - spec/static_limiter_spec.rb
-- spec/inhibitor_spec.rb
+- spec/test_mode_spec.rb
 - spec/unlimiter_spec.rb
+- spec/utils_spec.rb