timed_lru 0.3.1 → 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6cf30083009f9f233369eea32cbbe9446ed8cb37
+  data.tar.gz: 0eaf174e3f28b27e20983daf5adb38a73158e0ac
+SHA512:
+  metadata.gz: 5e8e534ba9487aab9255be94956beea7c7bec8cd1364c2c2db446258f308c4e5969b50df303ac21197be77ea5d938aeff02577a825247e7147bf76555f7c29ec
+  data.tar.gz: a4a8b1b83dbd3ad8d50a3d74ad6ff566f27a0ec1e9782615fadd83fdd6e3e643eaf425b4c26efe15c10ec675bcbc596f9942fd88c290bc9858150a66a8cf6029

data/.gitignore

@@ -1 +1,4 @@
 *.gem
+.yardoc/
+coverage/
+doc/

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+script: bundle exec rake coverage
+rvm:
+  - 2.2
+  - 2.3
+  - 2.4
+gemfile:
+  - Gemfile

data/Gemfile

@@ -1,2 +1,6 @@
 source "http://rubygems.org"
-gemspec
+gemspec
+
+gem 'coveralls', require: false, group: :test
+gem 'json', '>= 1.7.7', require: false, group: :test
+

data/Gemfile.lock

@@ -1,29 +1,58 @@
 PATH
   remote: .
   specs:
-    timed_lru (0.3.1)
+    timed_lru (0.3.2)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.2.1)
-    rake (10.0.3)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.0)
-    rspec-expectations (2.13.0)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.0)
-    yard (0.8.5.2)
+    coveralls (0.8.21)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.14.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    json (2.1.0)
+    rake (12.3.0)
+    redcarpet (3.4.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.16.3)
+    yard (0.9.12)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler
+  coveralls
+  json (>= 1.7.7)
   rake
+  redcarpet
   rspec
   timed_lru!
   yard
+
+BUNDLED WITH
+   1.16.0

data/README.md

@@ -1,6 +1,10 @@
 Timed LRU
 =========
 
+[![Build Status](https://travis-ci.org/bsm/timed_lru.png)](https://travis-ci.org/bsm/timed_lru)
+[![Dependency Status](https://gemnasium.com/bsm/timed_lru.png)](https://gemnasium.com/bsm/timed_lru)
+[![Coverage Status](https://coveralls.io/repos/bsm/timed_lru/badge.png)](https://coveralls.io/r/bsm/timed_lru)
+
 My implementation of a simple, thread-safe LRU with (optional) TTLs
 and constant time operations. There are many LRUs for Ruby available but
 I was unable to find one that matches all three requirements.
@@ -10,37 +14,42 @@ Install
 
 Install it via `gem`:
 
-    gem install timed_lru
+```ruby
+gem install timed_lru
+```
 
 Or just bundle it with your project.
 
 Usage Example
 -------------
 
-    # Initialize with a max size (default: 100) and a TTL (default: none)
-    lru = TimedLRU.new max_size: 3, ttl: 5
+```ruby
+# Initialize with a max size (default: 100) and a TTL (default: none)
+lru = TimedLRU.new max_size: 3, ttl: 5
 
-    # Add values
-    lru["a"] = "value 1"
-    lru["b"] = "value 2"
-    lru["c"] = "value 3"
-    lru.keys # => ["a", "b"]
+# Add values
+lru["a"] = "value 1"
+lru["b"] = "value 2"
+lru["c"] = "value 3"
+lru.keys # => ["a", "b"]
 
-    # Wait a second
-    sleep(1)
+# Wait a second
+sleep(1)
 
-    # Add more values
-    lru["d"] = "value 4"
-    lru.keys # => ["b", "c", "d"]
+# Add more values
+lru["d"] = "value 4"
+lru.keys # => ["b", "c", "d"]
 
-    # Sleep a little longer
-    sleep(4)
-    lru["c"] # => "value 3"
-    lru.keys # => ["c", "d"]
+# Sleep a little longer
+sleep(4)
+lru["c"] # => "value 3"
+lru.keys # => ["c", "d"]
+```
 
 Licence
 -------
 
+```
 Copyright (c) 2013 Black Square Media Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining
@@ -61,3 +70,4 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+```

data/Rakefile

@@ -1,8 +1,11 @@
-require 'rake'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
 
-require 'rspec/mocks/version'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:coverage) do |c|
+  c.ruby_opts = '-r ./spec/coverage_helper'
+end
 
 require 'yard'
 YARD::Rake::YardocTask.new

data/lib/timed_lru.rb

@@ -117,20 +117,3 @@ class TimedLRU
     end
 
 end
-
-      # right ?  : @tail = left
-
-      # return if node == @head
-      # if @head
-      #   @head.left  = node
-      #   @head.right = right if @head.right == node
-      # end
-
-      # if right
-      #   right.left = left
-      # end
-
-      # if @tail == node
-      #   left.right = nil
-      #   @tail = left
-      # end

data/spec/coverage_helper.rb

@@ -0,0 +1,5 @@
+require 'coveralls'
+
+# Enable coverage
+Coveralls.wear!
+

data/spec/timed_lru_spec.rb

@@ -9,17 +9,17 @@ describe TimedLRU do
 
     res = [head]
     while curr = res.last.right
-      curr.left.should == res.last
+      expect(curr.left).to eq(res.last)
       res << curr
     end
-    head.left.should be_nil
-    tail.right.should be_nil
-    res.last.should == tail
+    expect(head.left).to be_nil
+    expect(tail.right).to be_nil
+    expect(res.last).to eq(tail)
     res
   end
 
   def chain
-    full_chain.map &:key
+    full_chain.map(&:key)
   end
 
   def head
@@ -33,61 +33,76 @@ describe TimedLRU do
   describe "defaults" do
     subject { described_class.new }
 
-    its(:max_size) { should be(100) }
-    its(:ttl)      { should be_nil }
-    it             { should be_a(MonitorMixin) }
-    it             { should_not be_a(described_class::ThreadUnsafe) }
-    it             { should respond_to(:empty?) }
-    it             { should respond_to(:keys) }
-    it             { should respond_to(:size) }
-    it             { should respond_to(:each_key) }
+    describe '#max_size' do
+      subject { super().max_size }
+      it { is_expected.to be(100) }
+    end
+
+    describe '#ttl' do
+      subject { super().ttl }
+      it { is_expected.to be_nil }
+    end
+
+    it { is_expected.to be_a(MonitorMixin) }
+    it { is_expected.not_to be_a(described_class::ThreadUnsafe) }
+    it { is_expected.to respond_to(:empty?) }
+    it { is_expected.to respond_to(:keys) }
+    it { is_expected.to respond_to(:size) }
+    it { is_expected.to respond_to(:each_key) }
   end
 
   describe "init" do
     subject { described_class.new max_size: 25, ttl: 120, thread_safe: false }
 
-    its(:max_size) { should be(25) }
-    its(:ttl)      { should be(120) }
-    it             { should be_a(described_class::ThreadUnsafe) }
+    describe '#max_size' do
+      subject { super().max_size }
+      it { is_expected.to be(25) }
+    end
+
+    describe '#ttl' do
+      subject { super().ttl }
+      it { is_expected.to be(120) }
+    end
+    it             { is_expected.to be_a(described_class::ThreadUnsafe) }
 
     it 'should assert correct option values' do
-      lambda { described_class.new(max_size: "X") }.should raise_error(ArgumentError)
-      lambda { described_class.new(max_size: -1) }.should raise_error(ArgumentError)
-      lambda { described_class.new(max_size: 0) }.should raise_error(ArgumentError)
+      expect { described_class.new(max_size: "X") }.to raise_error(ArgumentError)
+      expect { described_class.new(max_size: -1) }.to raise_error(ArgumentError)
+      expect { described_class.new(max_size: 0) }.to raise_error(ArgumentError)
 
-      lambda { described_class.new(ttl: "X") }.should raise_error(ArgumentError)
-      lambda { described_class.new(ttl: true) }.should raise_error(TypeError)
-      lambda { described_class.new(ttl: 0) }.should raise_error(ArgumentError)
+      expect { described_class.new(ttl: "X") }.to raise_error(ArgumentError)
+      expect { described_class.new(ttl: true) }.to raise_error(TypeError)
+      expect { described_class.new(ttl: 0) }.to raise_error(ArgumentError)
     end
   end
 
   describe "storing" do
 
     it "should set head + tail on first item" do
-      lambda {
-        subject.store("a", 1).should == 1
-      }.should change { chain }.from([]).to(["a"])
+      expect {
+        expect(subject.store("a", 1)).to eq(1)
+      }.to change { chain }.from([]).to(["a"])
     end
 
     it "should shift chain when new items are added" do
       subject["a"] = 1
-      lambda { subject["b"] = 2 }.should change { chain }.from(%w|a|).to(%w|b a|)
-      lambda { subject["c"] = 3 }.should change { chain }.to(%w|c b a|)
-      lambda { subject["d"] = 4 }.should change { chain }.to(%w|d c b a|)
+      expect { subject["b"] = 2 }.to change { chain }.from(%w|a|).to(%w|b a|)
+      expect { subject["c"] = 3 }.to change { chain }.to(%w|c b a|)
+      expect { subject["d"] = 4 }.to change { chain }.to(%w|d c b a|)
     end
 
     it "should expire LRU items when chain exceeds max size" do
       ("a".."d").each {|x| subject[x] = 1 }
-      lambda { subject["e"] = 5 }.should change { chain }.to(%w|e d c b|)
-      lambda { subject["f"] = 6 }.should change { chain }.to(%w|f e d c|)
+      expect { subject["e"] = 5 }.to change { chain }.to(%w|e d c b|)
+      expect { subject["f"] = 6 }.to change { chain }.to(%w|f e d c|)
     end
 
     it "should update items" do
       ("a".."d").each {|x| subject[x] = 1 }
-      lambda { subject["d"] = 2 }.should_not change { chain }
-      lambda { subject["c"] = 2 }.should change { chain }.to(%w|c d b a|)
-      lambda { subject["b"] = 2 }.should change { chain }.to(%w|b c d a|)
-      lambda { subject["a"] = 2 }.should change { chain }.to(%w|a b c d|)
+      expect { subject["d"] = 2 }.not_to change { chain }
+      expect { subject["c"] = 2 }.to change { chain }.to(%w|c d b a|)
+      expect { subject["b"] = 2 }.to change { chain }.to(%w|b c d a|)
+      expect { subject["a"] = 2 }.to change { chain }.to(%w|a b c d|)
     end
 
   end
@@ -95,19 +110,19 @@ describe TimedLRU do
   describe "retrieving" do
 
     it 'should fetch values' do
-      subject.fetch("a").should be_nil
-      subject["a"].should be_nil
+      expect(subject.fetch("a")).to be_nil
+      expect(subject["a"]).to be_nil
       subject["a"] = 1
-      subject["a"].should == 1
+      expect(subject["a"]).to eq(1)
     end
 
     it 'should renew membership on access' do
       ("a".."d").each {|x| subject[x] = 1 }
-      lambda { subject["d"] }.should_not change { chain }
-      lambda { subject["c"] }.should change { chain }.to(%w|c d b a|)
-      lambda { subject["b"] }.should change { chain }.to(%w|b c d a|)
-      lambda { subject["a"] }.should change { chain }.to(%w|a b c d|)
-      lambda { subject["x"] }.should_not change { chain }
+      expect { subject["d"] }.not_to change { chain }
+      expect { subject["c"] }.to change { chain }.to(%w|c d b a|)
+      expect { subject["b"] }.to change { chain }.to(%w|b c d a|)
+      expect { subject["a"] }.to change { chain }.to(%w|a b c d|)
+      expect { subject["x"] }.not_to change { chain }
     end
 
   end
@@ -115,18 +130,18 @@ describe TimedLRU do
   describe "deleting" do
 
     it 'should delete an return values' do
-      subject.delete("a").should be_nil
+      expect(subject.delete("a")).to be_nil
       subject["a"] = 1
-      subject.delete("a").should == 1
+      expect(subject.delete("a")).to eq(1)
     end
 
     it 'should re-arrange membership chain' do
       ("a".."d").each {|x| subject[x] = 1 }
-      lambda { subject.delete("x") }.should_not change { chain }
-      lambda { subject.delete("c") }.should change { chain }.to(%w|d b a|)
-      lambda { subject.delete("a") }.should change { chain }.to(%w|d b|)
-      lambda { subject.delete("d") }.should change { chain }.to(%w|b|)
-      lambda { subject.delete("b") }.should change { subject.size }.from(1).to(0)
+      expect { subject.delete("x") }.not_to change { chain }
+      expect { subject.delete("c") }.to change { chain }.to(%w|d b a|)
+      expect { subject.delete("a") }.to change { chain }.to(%w|d b|)
+      expect { subject.delete("d") }.to change { chain }.to(%w|b|)
+      expect { subject.delete("b") }.to change { subject.size }.from(1).to(0)
     end
 
   end
@@ -135,43 +150,43 @@ describe TimedLRU do
     subject    { described_class.new max_size: 4, ttl: 60 }
 
     def in_past(ago)
-      Time.stub now: (Time.now - ago)
+      allow(Time).to receive_messages now: (Time.now - ago)
       yield
     ensure
-      Time.unstub :now
+      allow(Time).to receive(:now).and_call_original
     end
 
     it 'should expire on access' do
       in_past(70) do
         subject["a"] = 1
-        chain.should == %w|a|
+        expect(chain).to eq(%w|a|)
       end
 
       in_past(50) do
         subject["b"] = 2
-        chain.should == %w|b a|
+        expect(chain).to eq(%w|b a|)
       end
 
       subject["c"] = 3
-      chain.should == %w|c b|
+      expect(chain).to eq(%w|c b|)
     end
 
     it 'should renew expiration on access' do
       in_past(70) do
         subject["a"] = 1
         subject["b"] = 2
-        chain.should == %w|b a|
+        expect(chain).to eq(%w|b a|)
       end
 
       in_past(50) do
-        subject["a"].should == 1
-        chain.should == %w|a b|
+        expect(subject["a"]).to eq(1)
+        expect(chain).to eq(%w|a b|)
       end
 
       subject["c"] = 3
-      chain.should == %w|c a|
+      expect(chain).to eq(%w|c a|)
     end
 
   end
 
-end
+end

data/timed_lru.gemspec

@@ -1,11 +1,10 @@
 Gem::Specification.new do |s|
-  s.required_ruby_version = '>= 1.9.1'
-  s.required_rubygems_version = ">= 1.8.0"
+  s.required_ruby_version = '>= 2.2.0'
 
   s.name        = File.basename(__FILE__, '.gemspec')
   s.summary     = "Timed LRU"
   s.description = "Thread-safe LRU implementation with (optional) TTL and constant time operations"
-  s.version     = "0.3.1"
+  s.version     = "0.3.2"
 
   s.authors     = ["Black Square Media"]
   s.email       = "info@blacksquaremedia.com"
@@ -19,4 +18,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "bundler"
   s.add_development_dependency "rspec"
   s.add_development_dependency "yard"
+  s.add_development_dependency "redcarpet"
 end

metadata

@@ -1,78 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: timed_lru
 version: !ruby/object:Gem::Version
-  version: 0.3.1
-  prerelease: 
+  version: 0.3.2
 platform: ruby
 authors:
 - Black Square Media
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-04 00:00:00.000000000 Z
+date: 2017-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Thread-safe LRU implementation with (optional) TTL and constant time
@@ -82,38 +87,38 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
 - lib/timed_lru.rb
+- spec/coverage_helper.rb
 - spec/spec_helper.rb
 - spec/timed_lru_spec.rb
 - timed_lru.gemspec
 homepage: https://github.com/bsm/timed_lru
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.1
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.0
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.6.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Timed LRU
 test_files: []
-has_rdoc: