timed_lru 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6cf30083009f9f233369eea32cbbe9446ed8cb37
-  data.tar.gz: 0eaf174e3f28b27e20983daf5adb38a73158e0ac
+SHA256:
+  metadata.gz: 256a5775aadc75a4ba0151c3b2530d77b6fe66d8a80163bd4a51500008fc81c4
+  data.tar.gz: 2e46aa41b37eac70b04bcabac5abf3d160af09c4da00f8fa89b5e35223b9bf6a
 SHA512:
-  metadata.gz: 5e8e534ba9487aab9255be94956beea7c7bec8cd1364c2c2db446258f308c4e5969b50df303ac21197be77ea5d938aeff02577a825247e7147bf76555f7c29ec
-  data.tar.gz: a4a8b1b83dbd3ad8d50a3d74ad6ff566f27a0ec1e9782615fadd83fdd6e3e643eaf425b4c26efe15c10ec675bcbc596f9942fd88c290bc9858150a66a8cf6029
+  metadata.gz: 225fa64f43a2d8c4d730060df4af035697a628f4080c06542828fef00b58c9c7f53d0b871bb60d27cf203f5a0fd34cb47540e4eb3655fe06a192df9a8d1f12ba
+  data.tar.gz: 9a24526b95949e25e55b919d66a393a2fe7a1f0fcdd0315c7e8edf0c662038fdd9198d0a0fe808e54b4a66ac534763e6ca798a71f07238232ceeb0ef3214ea2d

data/.gitignore

@@ -2,3 +2,4 @@
 .yardoc/
 coverage/
 doc/
+.rubocop-*

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from:
+  - https://gitlab.com/bsm/misc/raw/master/rubocop/default.yml
+
+AllCops:
+  TargetRubyVersion: "2.4"
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
-script: bundle exec rake coverage
+before_install:
+  - gem install bundler
 rvm:
-  - 2.2
-  - 2.3
   - 2.4
-gemfile:
-  - Gemfile
+  - 2.5
+  - 2.6
+cache: bundler

data/Gemfile

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

data/Gemfile.lock

@@ -1,45 +1,58 @@
 PATH
   remote: .
   specs:
-    timed_lru (0.3.2)
+    timed_lru (0.4.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    coveralls (0.8.21)
+    ast (2.4.0)
+    coveralls (0.8.23)
       json (>= 1.8, < 3)
-      simplecov (~> 0.14.1)
+      simplecov (~> 0.16.1)
       term-ansicolor (~> 1.3)
-      thor (~> 0.19.4)
+      thor (>= 0.19.4, < 2.0)
       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)
+    docile (1.3.2)
+    jaro_winkler (1.5.3)
+    json (2.2.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
       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)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rubocop (0.71.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    term-ansicolor (1.6.0)
+    term-ansicolor (1.7.1)
       tins (~> 1.0)
-    thor (0.19.4)
-    tins (1.16.3)
-    yard (0.9.12)
+    thor (0.20.3)
+    tins (1.21.1)
+    unicode-display_width (1.6.0)
 
 PLATFORMS
   ruby
@@ -49,10 +62,9 @@ DEPENDENCIES
   coveralls
   json (>= 1.7.7)
   rake
-  redcarpet
   rspec
+  rubocop
   timed_lru!
-  yard
 
 BUNDLED WITH
-   1.16.0
+   2.0.1

data/Rakefile

@@ -1,14 +1,9 @@
 require 'bundler/setup'
 require 'bundler/gem_tasks'
-
 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 'rubocop/rake_task'
 
-require 'yard'
-YARD::Rake::YardocTask.new
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
 
-desc 'Default: run specs.'
-task :default => :spec
+task default: %i[spec rubocop]

data/lib/timed_lru.rb

@@ -28,15 +28,15 @@ class TimedLRU
   #   that extra bit of performance
   # @option opts [Integer] ttl
   #   the TTL in seconds
-  def initialize(opts = {})
+  def initialize(opts={})
     super() # MonitorMixin
 
     @hash     = {}
     @max_size = Integer(opts[:max_size] || 100)
     @ttl      = Integer(opts[:ttl]) if opts[:ttl]
 
-    raise ArgumentError, "Option :max_size must be > 0" unless max_size > 0
-    raise ArgumentError, "Option :ttl must be > 0" unless ttl.nil? || ttl > 0
+    raise ArgumentError, 'Option :max_size must be > 0' unless max_size.positive?
+    raise ArgumentError, 'Option :ttl must be > 0' unless ttl.nil? || ttl.positive?
 
     extend ThreadUnsafe if opts[:thread_safe] == false
   end
@@ -48,13 +48,13 @@ class TimedLRU
   def store(key, value)
     mon_synchronize do
       node = (@hash[key] ||= Node.new(key))
-      node.value      = value
+      node.value = value
       touch(node)
       compact!
       node.value
     end
   end
-  alias_method :[]=, :store
+  alias []= store
 
   # Retrieves a `value` by `key`
   # @param [Object] key the storage key
@@ -68,7 +68,7 @@ class TimedLRU
       node.value
     end
   end
-  alias_method :[], :fetch
+  alias [] fetch
 
   # Deletes by `key`
   # @param [Object] key the storage key
@@ -82,38 +82,36 @@ class TimedLRU
 
   private
 
-    def compact!
-      while @hash.size > max_size
-        remove(@tail)
-      end
+  def compact!
+    remove(@tail) while @hash.size > max_size
 
-      while ttl && @tail.expires_at < Time.now.to_i
-        remove(@tail)
-      end
-    end
-
-    def remove(node)
-      @hash.delete(node.key)
-      left, right = node.left, node.right
-      left.nil?  ? @head = right : left.right = right
-      right.nil? ? @tail = left : right.left = left
-      node
-    end
+    remove(@tail) while ttl && @tail.expires_at < Time.now.to_i
+  end
 
-    def touch(node)
-      node.expires_at = Time.now.to_i + ttl if ttl
-      return if node == @head
+  def remove(node)
+    @hash.delete(node.key)
+    left = node.left
+    right = node.right
+    left.nil?  ? @head = right : left.right = right
+    right.nil? ? @tail = left : right.left = left
+    node
+  end
 
-      left, right = node.left, node.right
-      node.left, node.right = nil, @head
-      @head.left = node if @head
+  def touch(node)
+    node.expires_at = Time.now.to_i + ttl if ttl
+    return if node == @head
 
-      left.right = right if left
-      right.left = left  if right
+    left = node.left
+    right = node.right
+    node.left = nil
+    node.right = @head
+    @head.left = node if @head
 
-      @tail = left if @tail == node
-      @head = node
-      @tail = @head unless @tail
-    end
+    left.right = right if left
+    right.left = left  if right
 
+    @tail = left if @tail == node
+    @head = node
+    @tail ||= @head
+  end
 end

data/spec/coverage_helper.rb

@@ -2,4 +2,3 @@ require 'coveralls'
 
 # Enable coverage
 Coveralls.wear!
-

data/spec/spec_helper.rb

@@ -1,4 +1,3 @@
 require 'bundler/setup'
 require 'rspec'
 require 'timed_lru'
-

data/spec/timed_lru_spec.rb

@@ -8,9 +8,12 @@ describe TimedLRU do
     return [] unless head
 
     res = [head]
-    while curr = res.last.right
-      expect(curr.left).to eq(res.last)
-      res << curr
+    loop do
+      current = res.last.right
+      break unless current
+
+      expect(current.left).to eq(res.last)
+      res << current
     end
     expect(head.left).to be_nil
     expect(tail.right).to be_nil
@@ -30,7 +33,7 @@ describe TimedLRU do
     subject.instance_variable_get(:@tail)
   end
 
-  describe "defaults" do
+  describe 'defaults' do
     subject { described_class.new }
 
     describe '#max_size' do
@@ -51,7 +54,7 @@ describe TimedLRU do
     it { is_expected.to respond_to(:each_key) }
   end
 
-  describe "init" do
+  describe 'init' do
     subject { described_class.new max_size: 25, ttl: 120, thread_safe: false }
 
     describe '#max_size' do
@@ -63,91 +66,91 @@ describe TimedLRU do
       subject { super().ttl }
       it { is_expected.to be(120) }
     end
-    it             { is_expected.to be_a(described_class::ThreadUnsafe) }
+    it { is_expected.to be_a(described_class::ThreadUnsafe) }
 
     it 'should assert correct option values' do
-      expect { described_class.new(max_size: "X") }.to 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)
 
-      expect { described_class.new(ttl: "X") }.to 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
+  describe 'storing' do
 
-    it "should set head + tail on first item" do
-      expect {
-        expect(subject.store("a", 1)).to eq(1)
-      }.to change { chain }.from([]).to(["a"])
+    it 'should set head + tail on first item' do
+      expect do
+        expect(subject.store('a', 1)).to eq(1)
+      end.to change { chain }.from([]).to(['a'])
     end
 
-    it "should shift chain when new items are added" do
-      subject["a"] = 1
-      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|)
+    it 'should shift chain when new items are added' do
+      subject['a'] = 1
+      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 }
-      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|)
+    it 'should expire LRU items when chain exceeds max size' do
+      ('a'..'d').each {|x| subject[x] = 1 }
+      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 }
-      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|)
+    it 'should update items' do
+      ('a'..'d').each {|x| subject[x] = 1 }
+      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
 
-  describe "retrieving" do
+  describe 'retrieving' do
 
     it 'should fetch values' do
-      expect(subject.fetch("a")).to be_nil
-      expect(subject["a"]).to be_nil
-      subject["a"] = 1
-      expect(subject["a"]).to eq(1)
+      expect(subject.fetch('a')).to be_nil
+      expect(subject['a']).to be_nil
+      subject['a'] = 1
+      expect(subject['a']).to eq(1)
     end
 
     it 'should renew membership on access' do
-      ("a".."d").each {|x| subject[x] = 1 }
-      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 }
+      ('a'..'d').each {|x| subject[x] = 1 }
+      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
 
-  describe "deleting" do
+  describe 'deleting' do
 
     it 'should delete an return values' do
-      expect(subject.delete("a")).to be_nil
-      subject["a"] = 1
-      expect(subject.delete("a")).to eq(1)
+      expect(subject.delete('a')).to be_nil
+      subject['a'] = 1
+      expect(subject.delete('a')).to eq(1)
     end
 
     it 'should re-arrange membership chain' do
-      ("a".."d").each {|x| subject[x] = 1 }
-      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)
+      ('a'..'d').each {|x| subject[x] = 1 }
+      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
 
-  describe "TTL expiration" do
-    subject    { described_class.new max_size: 4, ttl: 60 }
+  describe 'TTL expiration' do
+    subject { described_class.new max_size: 4, ttl: 60 }
 
     def in_past(ago)
       allow(Time).to receive_messages now: (Time.now - ago)
@@ -158,33 +161,33 @@ describe TimedLRU do
 
     it 'should expire on access' do
       in_past(70) do
-        subject["a"] = 1
-        expect(chain).to eq(%w|a|)
+        subject['a'] = 1
+        expect(chain).to eq(%w[a])
       end
 
       in_past(50) do
-        subject["b"] = 2
-        expect(chain).to eq(%w|b a|)
+        subject['b'] = 2
+        expect(chain).to eq(%w[b a])
       end
 
-      subject["c"] = 3
-      expect(chain).to eq(%w|c b|)
+      subject['c'] = 3
+      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
-        expect(chain).to eq(%w|b a|)
+        subject['a'] = 1
+        subject['b'] = 2
+        expect(chain).to eq(%w[b a])
       end
 
       in_past(50) do
-        expect(subject["a"]).to eq(1)
-        expect(chain).to eq(%w|a b|)
+        expect(subject['a']).to eq(1)
+        expect(chain).to eq(%w[a b])
       end
 
-      subject["c"] = 3
-      expect(chain).to eq(%w|c a|)
+      subject['c'] = 3
+      expect(chain).to eq(%w[c a])
     end
 
   end

data/timed_lru.gemspec

@@ -1,22 +1,21 @@
 Gem::Specification.new do |s|
-  s.required_ruby_version = '>= 2.2.0'
+  s.required_ruby_version = '>= 2.4.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.2"
+  s.summary     = 'Timed LRU'
+  s.description = 'Thread-safe LRU implementation with (optional) TTL and constant time operations'
+  s.version     = '0.4.0'
 
-  s.authors     = ["Black Square Media"]
-  s.email       = "info@blacksquaremedia.com"
-  s.homepage    = "https://github.com/bsm/timed_lru"
+  s.authors     = ['Black Square Media']
+  s.email       = 'info@blacksquaremedia.com'
+  s.homepage    = 'https://github.com/bsm/timed_lru'
 
   s.require_path = 'lib'
   s.files        = `git ls-files`.split("\n")
   s.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")
 
-  s.add_development_dependency "rake"
-  s.add_development_dependency "bundler"
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "yard"
-  s.add_development_dependency "redcarpet"
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rubocop'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: timed_lru
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Black Square Media
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-21 00:00:00.000000000 Z
+date: 2019-07-23 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -88,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -109,15 +96,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Timed LRU