berater 0.7.1 → 0.10.1

data/spec/berater_spec.rb

@@ -24,50 +24,33 @@ describe Berater do
     end
   end
 
-  describe '.new' do
-    context 'Unlimiter mode' do
-      let(:limiter) { Berater.new(:key, Float::INFINITY) }
+  describe '.limiters' do
+    subject { Berater.limiters }
 
-      it 'instantiates an Unlimiter' do
-        expect(limiter).to be_a Berater::Unlimiter
-        expect(limiter.key).to be :key
-      end
+    let(:limiter) { Berater(:key, 1) }
 
-      it 'inherits redis' do
-        expect(limiter.redis).to be Berater.redis
-      end
-
-      it 'accepts options' do
-        redis = double('Redis')
-        limiter = Berater.new(:key, Float::INFINITY, redis: redis)
-        expect(limiter.redis).to be redis
-      end
+    it 'provides access to predefined limiters' do
+      expect(Berater.limiters).to be_a Berater::LimiterSet
     end
 
-    context 'Inhibitor mode' do
-      let(:limiter) { Berater.new(:key, 0) }
+    it 'resets with Berater' do
+      subject << limiter
+      is_expected.not_to be_empty
 
-      it 'instantiates an Inhibitor' do
-        expect(limiter).to be_a Berater::Inhibitor
-        expect(limiter.key).to be :key
-      end
+      Berater.reset
+      is_expected.to be_empty
+    end
+  end
 
-      it 'inherits redis' do
-        expect(limiter.redis).to be Berater.redis
-      end
+  shared_examples 'a Berater' do |klass, capacity, **opts|
+    describe '.new' do
+      let(:limiter) { Berater.new(:key, capacity, **opts) }
 
-      it 'accepts options' do
-        redis = double('Redis')
-        limiter = Berater.new(:key, 0, redis: redis)
-        expect(limiter.redis).to be redis
+      it 'instantiates the right class' do
+        expect(limiter).to be_a klass
       end
-    end
 
-    context 'rate mode' do
-      let(:limiter) { Berater.new(:key, 1, interval: :second) }
-
-      it 'instantiates a RateLimiter' do
-        expect(limiter).to be_a Berater::RateLimiter
+      it 'sets the key' do
         expect(limiter.key).to be :key
       end
 
@@ -75,60 +58,45 @@ describe Berater do
         expect(limiter.redis).to be Berater.redis
       end
 
-      it 'accepts options' do
-        redis = double('Redis')
-        limiter = Berater.new(:key, 1, interval: :second, redis: redis)
+      it 'accepts an optional redis parameter' do
+        redis = double(Redis)
+        limiter = Berater.new(:key, capacity, **opts.merge(redis: redis))
         expect(limiter.redis).to be redis
       end
     end
 
-    context 'concurrency mode' do
-      let(:limiter) { Berater.new(:key, 1) }
+    describe 'Berater() convenience method' do
+      let(:limiter) { Berater(:key, capacity, **opts) }
 
-      it 'instantiates a ConcurrencyLimiter' do
-        expect(limiter).to be_a Berater::ConcurrencyLimiter
-        expect(limiter.key).to be :key
+      it 'creates a limiter' do
+        expect(limiter).to be_a klass
       end
 
-      it 'inherits redis' do
-        expect(limiter.redis).to be Berater.redis
+      it 'creates an equivalent limiter' do
+        expect(limiter).to eq Berater.new(:key, capacity, **opts)
       end
 
-      it 'accepts options' do
-        redis = double('Redis')
-        limiter = Berater.new(:key, 1, redis: redis)
-        expect(limiter.redis).to be redis
-      end
-    end
-  end
+      context 'with a block' do
+        before { Berater.test_mode = :pass }
 
-  describe 'Berater() - convenience method' do
-    RSpec.shared_examples 'test convenience' do |klass, capacity, **opts|
-      it 'creates a limiter' do
-        limiter = Berater(:key, capacity, **opts)
-        expect(limiter).to be_a klass
-      end
+        subject { Berater(:key, capacity, **opts) { 123 } }
 
-      context 'with a block' do
         it 'creates a limiter and calls limit' do
-          limiter = Berater(:key, capacity, **opts)
           expect(klass).to receive(:new).and_return(limiter)
           expect(limiter).to receive(:limit).and_call_original
+          subject
+        end
 
-          begin
-            res = Berater(:key, capacity, **opts) { true }
-            expect(res).to be true
-          rescue Berater::Overloaded
-            expect(klass).to be Berater::Inhibitor
-          end
+        it 'yields' do
+          is_expected.to be 123
         end
       end
     end
-
-    include_examples 'test convenience', Berater::Unlimiter, Float::INFINITY
-    include_examples 'test convenience', Berater::Inhibitor, 0
-    include_examples 'test convenience', Berater::RateLimiter, 1, interval: :second
-    include_examples 'test convenience', Berater::ConcurrencyLimiter, 1
   end
 
+  include_examples 'a Berater', Berater::ConcurrencyLimiter, 1, timeout: 1
+  include_examples 'a Berater', Berater::Inhibitor, 0
+  include_examples 'a Berater', Berater::RateLimiter, 1, interval: :second
+  include_examples 'a Berater', Berater::StaticLimiter, 1
+  include_examples 'a Berater', Berater::Unlimiter, Float::INFINITY
 end

data/spec/concurrency_limiter_spec.rb

@@ -36,22 +36,28 @@ describe Berater::ConcurrencyLimiter do
       it { expect_bad_capacity(-1) }
       it { expect_bad_capacity('1') }
       it { expect_bad_capacity(:one) }
+      it { expect_bad_capacity(Float::INFINITY) }
     end
   end
 
   describe '#timeout' do
     # see spec/utils_spec.rb
 
+    it 'defaults to nil' do
+      limiter = described_class.new(:key, 1)
+      expect(limiter.timeout).to be nil
+    end
+
     it 'saves the interval in original and millisecond format' do
       limiter = described_class.new(:key, 1, timeout: 3)
       expect(limiter.timeout).to be 3
-      expect(limiter.instance_variable_get(:@timeout_msec)).to be (3 * 10**3)
+      expect(limiter.instance_variable_get(:@timeout)).to be (3 * 10**3)
     end
 
     it 'handles infinity' do
       limiter = described_class.new(:key, 1, timeout: Float::INFINITY)
       expect(limiter.timeout).to be Float::INFINITY
-      expect(limiter.instance_variable_get(:@timeout_msec)).to be 0
+      expect(limiter.instance_variable_get(:@timeout)).to be 0
     end
   end
 

data/spec/inhibitor_spec.rb

@@ -1,7 +1,9 @@
 describe Berater::Inhibitor do
+  subject { described_class.new }
+
   describe '.new' do
     it 'initializes without any arguments or options' do
-      expect(described_class.new).to be_a described_class
+      is_expected.to be_a described_class
     end
 
     it 'initializes with any arguments and options' do
@@ -9,15 +11,18 @@ describe Berater::Inhibitor do
     end
 
     it 'has default values' do
-      expect(described_class.new.key).to be :inhibitor
-      expect(described_class.new.redis).to be Berater.redis
+      expect(subject.key).to be :inhibitor
+      expect(subject.redis).to be Berater.redis
     end
   end
 
   describe '#limit' do
-    subject { described_class.new }
-
     it_behaves_like 'it is overloaded'
   end
 
+  describe '#to_s' do
+    it do
+      expect(subject.to_s).to include described_class.to_s
+    end
+  end
 end

data/spec/limiter_set_spec.rb

@@ -0,0 +1,173 @@
+describe Berater::LimiterSet do
+  subject { described_class.new }
+
+  let(:unlimiter) { Berater::Unlimiter.new }
+  let(:inhibitor) { Berater::Inhibitor.new }
+
+  describe '#each' do
+    it 'returns an Enumerator' do
+      expect(subject.each).to be_a Enumerator
+    end
+
+    it 'works with an empty set' do
+      expect(subject.each.to_a).to eq []
+    end
+
+    it 'returns elements' do
+      subject << unlimiter
+      expect(subject.each.to_a).to eq [ unlimiter ]
+    end
+  end
+
+  describe '#<<' do
+    it 'adds a limiter' do
+      subject << unlimiter
+      expect(subject.each.to_a).to eq [ unlimiter ]
+    end
+
+    it 'rejects things that are not limiters' do
+      expect {
+        subject << :foo
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'updates existing keys' do
+      limiter = Berater::Unlimiter.new
+      expect(limiter).to eq unlimiter
+      expect(limiter).not_to be unlimiter
+
+      subject << unlimiter
+      subject << limiter
+
+      expect(subject.each.to_a).to eq [ limiter ]
+    end
+  end
+
+  describe '[]=' do
+    it 'adds a limiter' do
+      subject[:key] = unlimiter
+
+      expect(subject.each.to_a).to eq [ unlimiter ]
+      is_expected.to include :key
+      is_expected.to include unlimiter
+    end
+
+    it 'rejects things that are not limiters' do
+      expect {
+        subject[:key] = :foo
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#[]' do
+    it 'returns nil for missing keys' do
+      expect(subject[:key]).to be nil
+      expect(subject[nil]).to be nil
+    end
+
+    it 'retreives limiters' do
+      subject << unlimiter
+      expect(subject[unlimiter.key]).to be unlimiter
+    end
+  end
+
+  describe '#fetch' do
+    it 'raises for missing keys' do
+      expect {
+        subject.fetch(:key)
+      }.to raise_error(KeyError)
+
+      expect {
+        subject.fetch(nil)
+      }.to raise_error(KeyError)
+    end
+
+    it 'returns the default if provided' do
+      expect(subject.fetch(:key, unlimiter)).to be unlimiter
+    end
+
+    it 'calls the default proc if provided' do
+      expect {|block| subject.fetch(:key, &block) }.to yield_control
+    end
+
+    it 'retreives limiters' do
+      subject << unlimiter
+      expect(subject.fetch(unlimiter.key)).to be unlimiter
+      expect(subject.fetch(unlimiter.key, :default)).to be unlimiter
+    end
+  end
+
+  describe '#include?' do
+    before do
+      subject << unlimiter
+    end
+
+    it 'works with keys' do
+      is_expected.to include unlimiter.key
+    end
+
+    it 'works with limiters' do
+      is_expected.to include unlimiter
+    end
+
+    it 'works when target is missing' do
+      is_expected.not_to include inhibitor.key
+      is_expected.not_to include inhibitor
+    end
+  end
+
+  describe '#clear' do
+    it 'works when empty' do
+      subject.clear
+    end
+
+    it 'clears limiters' do
+      subject << unlimiter
+      is_expected.to include unlimiter
+
+      subject.clear
+      is_expected.not_to include unlimiter
+    end
+  end
+
+  describe '#count' do
+    it 'counts' do
+      expect(subject.count).to be 0
+
+      subject << unlimiter
+      expect(subject.count).to be 1
+    end
+  end
+
+  describe '#delete' do
+    it 'works when the target is missing' do
+      subject.delete(unlimiter)
+      subject.delete(unlimiter.key)
+    end
+
+    it 'works with keys' do
+      subject << unlimiter
+      is_expected.to include unlimiter
+
+      subject.delete(unlimiter.key)
+      is_expected.not_to include unlimiter
+    end
+
+    it 'works with limiters' do
+      subject << unlimiter
+      is_expected.to include unlimiter
+
+      subject.delete(unlimiter)
+      is_expected.not_to include unlimiter
+    end
+  end
+
+  describe '#empty?' do
+    it 'works' do
+      is_expected.to be_empty
+
+      subject << unlimiter
+      is_expected.not_to be_empty
+    end
+  end
+end

data/spec/limiter_spec.rb

@@ -1,6 +1,8 @@
 describe Berater::Limiter do
-  it 'can not be initialized' do
-    expect { described_class.new }.to raise_error(NoMethodError)
+  describe '.new' do
+    it 'can only be called on subclasses' do
+      expect { described_class.new }.to raise_error(NoMethodError)
+    end
   end
 
   describe 'abstract methods' do
@@ -44,8 +46,49 @@ describe Berater::Limiter do
         expect {
           subject.limit(cost: -1)
         }.to raise_error(ArgumentError)
+
+        expect {
+          subject.limit(cost: Float::INFINITY)
+        }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'when Berater.redis is nil' do
+      let!(:redis) { Berater.redis }
+
+      before { Berater.redis = nil }
+
+      it 'works with Unlimiter since redis is not used' do
+        expect(subject.redis).to be nil
+        expect {|b| subject.limit(&b) }.to yield_control
+      end
+
+      it 'raises when redis is needed' do
+        limiter = Berater::RateLimiter.new(:key, 1, :second)
+        expect(limiter.redis).to be nil
+        expect { limiter.limit }.to raise_error(RuntimeError)
+      end
+
+      it 'works when redis is passed in' do
+        limiter = Berater::RateLimiter.new(:key, 1, :second, redis: redis)
+        expect {|b| limiter.limit(&b) }.to yield_control
+      end
+
+      it 'raises when redis is bogus' do
+        limiter = Berater::RateLimiter.new(:key, 1, :second, redis: :stub)
+        expect { limiter.limit }.to raise_error(RuntimeError)
       end
     end
+
+    it 'releases the lock even when limited code raises an error' do
+      lock = Berater::Lock.new(Float::INFINITY, 0)
+      expect(subject).to receive(:acquire_lock).and_return(lock)
+      expect(lock).to receive(:release)
+
+      expect {
+        subject.limit { raise 'fail' }
+      }.to raise_error(RuntimeError)
+    end
   end
 
   describe '#==' do
@@ -61,12 +104,6 @@ describe Berater::Limiter do
       )
     end
 
-    it 'equals something with equvalent initialization parameters' do
-      expect(limiter).to eq(
-        Berater::RateLimiter.new(:key, 1, 1)
-      )
-    end
-
     it 'does not equal something different' do
       expect(limiter).not_to eq(
         Berater::RateLimiter.new(:key, 2, :second)
@@ -104,4 +141,56 @@ describe Berater::Limiter do
     end
   end
 
+  describe '#cache_key' do
+    subject { klass.new(:key).send(:cache_key) }
+
+    context 'with Unlimiter' do
+      let(:klass) { Berater::Unlimiter }
+
+      it do
+        is_expected.to eq 'Berater:Unlimiter:key'
+      end
+    end
+
+    context 'with custom limiter' do
+      MyLimiter = Class.new(Berater::Unlimiter)
+
+      let(:klass) { MyLimiter }
+
+      it 'adds Berater prefix' do
+        is_expected.to eq 'Berater:MyLimiter:key'
+      end
+    end
+  end
+
+  describe '.cache_key' do
+    subject { klass.send(:cache_key, :key) }
+
+    context 'with Unlimiter' do
+      let(:klass) { Berater::Unlimiter }
+
+      it do
+        is_expected.to eq 'Berater:Unlimiter:key'
+      end
+    end
+
+    context 'with custom limiter' do
+      MyLimiter = Class.new(Berater::Unlimiter)
+
+      let(:klass) { MyLimiter }
+
+      it 'adds Berater prefix' do
+        is_expected.to eq 'Berater:MyLimiter:key'
+      end
+    end
+  end
+
+  describe '.inherited' do
+    it 'creates convenience methods' do
+      expect(Berater.method(:Unlimiter)).to be_a Method
+      expect(Berater::Unlimiter()).to be_a Berater::Unlimiter
+      expect {|b| Berater::Unlimiter(&b) }.to yield_control
+    end
+  end
+
 end

data/spec/lua_script_spec.rb

@@ -93,5 +93,4 @@ describe Berater::LuaScript do
       it { subject }
     end
   end
-
 end

data/spec/middleware_spec.rb

@@ -0,0 +1,110 @@
+class Meddler
+  def call(*args, **kwargs)
+    yield
+  end
+end
+
+describe 'Berater.middleware' do
+  subject { Berater.middleware }
+
+  describe 'adding middleware' do
+    after { is_expected.to include Meddler }
+
+    it 'can be done inline' do
+      Berater.middleware.use Meddler
+    end
+
+    it 'can be done with a block' do
+      Berater.middleware do
+        use Meddler
+      end
+    end
+  end
+
+  it 'resets along with Berater' do
+    Berater.middleware.use Meddler
+    is_expected.to include Meddler
+
+    Berater.reset
+    is_expected.to be_empty
+  end
+
+  describe 'Berater::Limiter#limit' do
+    let(:middleware) { Meddler.new }
+    let(:limiter) { Berater::ConcurrencyLimiter.new(:key, 1) }
+
+    before do
+      expect(Meddler).to receive(:new).and_return(middleware).at_least(1)
+      Berater.middleware.use Meddler
+    end
+
+    it 'calls the middleware' do
+      expect(middleware).to receive(:call)
+      limiter.limit
+    end
+
+    it 'calls the middleware, passing the limiter and options' do
+      expect(middleware).to receive(:call).with(
+        limiter,
+        hash_including(:capacity, :cost)
+      )
+
+      limiter.limit
+    end
+
+    context 'when used per ususual' do
+      before do
+        expect(middleware).to receive(:call).and_call_original.at_least(1)
+      end
+
+      it 'still works inline' do
+        expect(limiter.limit).to be_a Berater::Lock
+      end
+
+      it 'still works in block mode' do
+        expect(limiter.limit { 123 }).to be 123
+      end
+
+      it 'still has limits' do
+        limiter.limit
+        expect(limiter).to be_overloaded
+      end
+    end
+
+    context 'when middleware meddles' do
+      it 'can change the capacity' do
+        expect(middleware).to receive(:call) do |limiter, **opts, &block|
+          opts[:capacity] = 0
+          block.call(limiter, **opts)
+        end
+
+        expect { limiter.limit }.to be_overloaded
+      end
+
+      it 'can change the cost' do
+        expect(middleware).to receive(:call) do |limiter, **opts, &block|
+          opts[:cost] = 2
+          block.call(limiter, **opts)
+        end
+
+        expect { limiter.limit }.to be_overloaded
+      end
+
+      it 'can change the limiter' do
+        other_limiter = Berater::Inhibitor.new
+
+        expect(middleware).to receive(:call) do |limiter, **opts, &block|
+          block.call(other_limiter, **opts)
+        end
+        expect(other_limiter).to receive(:acquire_lock).and_call_original
+
+        expect { limiter.limit }.to be_overloaded
+      end
+
+      it 'can abort by not yielding' do
+        expect(middleware).to receive(:call)
+        expect(limiter.limit).to be nil
+      end
+    end
+  end
+end

data/spec/rate_limiter_spec.rb

@@ -37,6 +37,7 @@ describe Berater::RateLimiter do
       it { expect_bad_capacity(-1) }
       it { expect_bad_capacity('1') }
       it { expect_bad_capacity(:one) }
+      it { expect_bad_capacity(Float::INFINITY) }
     end
   end
 
@@ -47,7 +48,7 @@ describe Berater::RateLimiter do
 
     it 'saves the interval in original and millisecond format' do
       expect(subject.interval).to be :second
-      expect(subject.instance_variable_get(:@interval_msec)).to be 10**3
+      expect(subject.instance_variable_get(:@interval)).to be 10**3
     end
 
     it 'must be > 0' do

data/spec/riddle_spec.rb

@@ -47,7 +47,7 @@ class ConcurrenyRiddler
   ensure
     # decrement counter
     if lock
-      key = limiter.send(:cache_key, :key)
+      key = limiter.send(:cache_key)
       count, ts = limiter.redis.get(key).split ';'
       limiter.redis.set(key, "#{count.to_f - 1};#{ts}")
     end