berater 0.6.1 → 0.9.0

data/spec/dsl_refinement_spec.rb

@@ -3,18 +3,6 @@ require 'berater/dsl'
 describe Berater do
   using Berater::DSL
 
-  it 'instatiates an Unlimiter' do
-    limiter = Berater.new(:key) { unlimited }
-    expect(limiter).to be_a Berater::Unlimiter
-    expect(limiter.key).to be :key
-  end
-
-  it 'instatiates an Inhibiter' do
-    limiter = Berater.new(:key) { inhibited }
-    expect(limiter).to be_a Berater::Inhibitor
-    expect(limiter.key).to be :key
-  end
-
   it 'instatiates a RateLimiter' do
     limiter = Berater.new(:key) { 1.per second }
     expect(limiter).to be_a Berater::RateLimiter

data/spec/dsl_spec.rb

@@ -13,13 +13,13 @@ describe Berater::DSL do
     end
 
     it 'parses' do
-      check([ 1, :second ]) { 1.per second }
-      check([ 3, :minute ]) { 3.per minute }
-      check([ 5, :hour ]) { 5.every hour }
+      check([ 1, interval: :second ]) { 1.per second }
+      check([ 3, interval: :minute ]) { 3.per minute }
+      check([ 5, interval: :hour ]) { 5.every hour }
     end
 
     it 'cleans up afterward' do
-      check([ 1, :second ]) { 1.per second }
+      check([ 1, interval: :second ]) { 1.per second }
 
       expect(Integer).not_to respond_to(:per)
       expect(Integer).not_to respond_to(:every)
@@ -29,7 +29,7 @@ describe Berater::DSL do
       count = 1
       interval = :second
 
-      check([ count, interval ]) { count.per interval }
+      check([ count, interval: interval ]) { count.per interval }
     end
   end
 
@@ -57,16 +57,4 @@ describe Berater::DSL do
     end
   end
 
-  context 'unlimited mode' do
-    it 'has keywords' do
-      check(:unlimited) { unlimited }
-    end
-  end
-
-  context 'inhibited mode' do
-    it 'has keywords' do
-      check(:inhibited) { inhibited }
-    end
-  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(NotImplementedError)
+  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
@@ -8,11 +10,78 @@ describe Berater::Limiter do
 
     it do
       expect { limiter.limit }.to raise_error(NotImplementedError)
-      expect { limiter.overloaded? }.to raise_error(NotImplementedError)
+      expect { limiter.utilization }.to raise_error(NotImplementedError)
     end
   end
 
-  describe '==' do
+  describe '#limit' do
+    subject { Berater::Unlimiter.new }
+
+    context 'with a capacity parameter' do
+      it 'overrides the stored value' do
+        is_expected.to receive(:acquire_lock).with(3, anything)
+
+        subject.limit(capacity: 3)
+      end
+
+      it 'validates the type' do
+        expect {
+          subject.limit(capacity: 'abc')
+        }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'with a cost parameter' do
+      it 'overrides the stored value' do
+        is_expected.to receive(:acquire_lock).with(anything, 2)
+
+        subject.limit(cost: 2)
+      end
+
+      it 'validates' do
+        expect {
+          subject.limit(cost: 'abc')
+        }.to raise_error(ArgumentError)
+
+        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
+  end
+
+  describe '#==' do
     let(:limiter)  { Berater::RateLimiter.new(:key, 1, :second) }
 
     it 'equals itself' do
@@ -25,12 +94,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)
@@ -68,4 +131,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/matchers_spec.rb

@@ -1,118 +1,80 @@
 describe Berater::Matchers::Overloaded do
 
   context 'Berater::Unlimiter' do
-    let(:limiter) { Berater.new(:key, :unlimited) }
+    let(:limiter) { Berater::Unlimiter.new }
 
     it { expect(limiter).not_to be_overloaded }
-    it { expect(limiter).not_to be_inhibited }
-    it { expect(limiter).not_to be_overrated }
-    it { expect(limiter).not_to be_incapacitated }
-
     it { expect { limiter }.not_to be_overloaded }
-    it { expect { limiter }.not_to be_inhibited }
-    it { expect { limiter }.not_to be_overrated }
-    it { expect { limiter }.not_to be_incapacitated }
-
     it { expect { limiter.limit }.not_to be_overloaded }
-    it { expect { limiter.limit }.not_to be_inhibited }
-    it { expect { limiter.limit }.not_to be_overrated }
-    it { expect { limiter.limit }.not_to be_incapacitated }
   end
 
   context 'Berater::Inhibitor' do
-    let(:limiter) { Berater.new(:key, :inhibited) }
+    let(:limiter) { Berater::Inhibitor.new }
 
     it { expect(limiter).to be_overloaded }
-    it { expect(limiter).to be_inhibited }
-
     it { expect { limiter }.to be_overloaded }
-    it { expect { limiter }.to be_inhibited }
-
     it { expect { limiter.limit }.to be_overloaded }
-    it { expect { limiter.limit }.to be_inhibited }
   end
 
   context 'Berater::RateLimiter' do
-    let(:limiter) { Berater.new(:key, 1, :second) }
+    let(:limiter) { Berater::RateLimiter.new(:key, 1, :second) }
 
     it { expect(limiter).not_to be_overloaded }
-    it { expect(limiter).not_to be_inhibited }
-    it { expect(limiter).not_to be_overrated }
-    it { expect(limiter).not_to be_incapacitated }
-
     it { expect { limiter }.not_to be_overloaded }
-    it { expect { limiter }.not_to be_inhibited }
-    it { expect { limiter }.not_to be_overrated }
-    it { expect { limiter }.not_to be_incapacitated }
-
     it { expect { limiter.limit }.not_to be_overloaded }
-    it { expect { limiter.limit }.not_to be_inhibited }
-    it { expect { limiter.limit }.not_to be_overrated }
-    it { expect { limiter.limit }.not_to be_incapacitated }
 
     context 'once limit is used up' do
       before { limiter.limit }
 
-      it 'should be_overrated' do
-        expect(limiter).to be_overrated
+      it 'should be_overloaded' do
+        expect(limiter).to be_overloaded
       end
 
-      it 'should be_overrated' do
-        expect { limiter }.to be_overrated
+      it 'should be_overloaded' do
+        expect { limiter }.to be_overloaded
       end
 
-      it 'should be_overrated' do
-        expect { limiter.limit }.to be_overrated
+      it 'should be_overloaded' do
+        expect { limiter.limit }.to be_overloaded
       end
     end
   end
 
   context 'Berater::ConcurrencyLimiter' do
-    let(:limiter) { Berater.new(:key, 1) }
+    let(:limiter) { Berater::ConcurrencyLimiter.new(:key, 1) }
 
     it { expect(limiter).not_to be_overloaded }
-    it { expect(limiter).not_to be_inhibited }
-    it { expect(limiter).not_to be_overrated }
-    it { expect(limiter).not_to be_incapacitated }
-
     it { expect { limiter }.not_to be_overloaded }
-    it { expect { limiter }.not_to be_inhibited }
-    it { expect { limiter }.not_to be_overrated }
-    it { expect { limiter }.not_to be_incapacitated }
-
     it { expect { limiter.limit }.not_to be_overloaded }
-    it { expect { limiter.limit }.not_to be_inhibited }
-    it { expect { limiter.limit }.not_to be_overrated }
-    it { expect { limiter.limit }.not_to be_incapacitated }
 
     context 'when lock is released' do
-      it 'should be_incapacitated' do
+      it 'should be_overloaded' do
         3.times do
-          expect(limiter).not_to be_incapacitated
+          expect(limiter).not_to be_overloaded
         end
       end
 
-      it 'should be_incapacitated' do
+      it 'should be_overloaded' do
         3.times do
-          expect { limiter }.not_to be_incapacitated
+          expect { limiter }.not_to be_overloaded
         end
       end
 
-      it 'should be_incapacitated' do
+      it 'should be_overloaded' do
         3.times do
-          expect { limiter.limit {} }.not_to be_incapacitated
+          expect { limiter.limit {} }.not_to be_overloaded
         end
       end
     end
 
     context 'when lock is *not* released' do
-      it 'should be_incapacitated' do
-        expect { limiter.limit }.not_to be_incapacitated
-        expect { limiter.limit }.to be_incapacitated
+      it 'should be_overloaded' do
+        expect { limiter.limit }.not_to be_overloaded
+        expect { limiter.limit }.to be_overloaded
       end
 
-      it 'should be_incapacitated' do
-        expect { 3.times { limiter.limit } }.to be_incapacitated
+      it 'should be_overloaded' do
+        expect { 3.times { limiter.limit } }.to be_overloaded
       end
     end
   end
@@ -156,31 +118,5 @@ describe Berater::Matchers::Overloaded do
         expect { raise Berater::Overloaded }.not_to be_overloaded
       }.to fail_including("did not expect #{Berater::Overloaded} to be raised")
     end
-
-    it 'supports different verbs' do
-      expect {
-        expect { unlimiter }.to be_overrated
-      }.to fail_including('expected to be overrated')
-
-      expect {
-        expect { unlimiter }.to be_incapacitated
-      }.to fail_including('expected to be incapacitated')
-    end
-
-    it 'supports different exceptions' do
-      expect {
-        expect { 123 }.to be_overrated
-      }.to fail_including(
-        "expected #{Berater::RateLimiter::Overrated} to be raised"
-      )
-
-      expect {
-        expect {
-          raise Berater::ConcurrencyLimiter::Incapacitated
-        }.not_to be_incapacitated
-      }.to fail_including(
-        "did not expect #{Berater::ConcurrencyLimiter::Incapacitated} to be raised"
-      )
-    end
   end
 end