timed_lru 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 256a5775aadc75a4ba0151c3b2530d77b6fe66d8a80163bd4a51500008fc81c4
-  data.tar.gz: 2e46aa41b37eac70b04bcabac5abf3d160af09c4da00f8fa89b5e35223b9bf6a
+  metadata.gz: 32262a349b2bcc96380ae8cb5684ba4276ff2dd867b2d54b1f5fc92f537d0a1c
+  data.tar.gz: 0536c7d764505d25c48e7b0041051499f32166ac0ae259f30770d2d2dc58dbd5
 SHA512:
-  metadata.gz: 225fa64f43a2d8c4d730060df4af035697a628f4080c06542828fef00b58c9c7f53d0b871bb60d27cf203f5a0fd34cb47540e4eb3655fe06a192df9a8d1f12ba
-  data.tar.gz: 9a24526b95949e25e55b919d66a393a2fe7a1f0fcdd0315c7e8edf0c662038fdd9198d0a0fe808e54b4a66ac534763e6ca798a71f07238232ceeb0ef3214ea2d
+  metadata.gz: e61acf070a81d2b389131302435d49b9f7c0b663dc9840948cd63686bbea01e145a6b2f0df48ab4a72b52855b888c98a502f533b665423aa17d2f00d00d9f780
+  data.tar.gz: fda206b6600397bc0b486cfabb5a07b56bbdb67424da829ae14938e4025553f4c000ff2cbb3b3706d62d30b34c7cec78abeb5dfaf8bc7ee5949bd717d3d045c8

data/.github/workflows/ruby.yml

@@ -0,0 +1,21 @@
+name: Ruby
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["2.6", "2.7", "3.0"]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - run: bundle exec rake

data/.rubocop.yml

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

data/Gemfile

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

data/Gemfile.lock

@@ -1,70 +1,88 @@
 PATH
   remote: .
   specs:
-    timed_lru (0.4.0)
+    timed_lru (0.5.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    ast (2.4.0)
-    coveralls (0.8.23)
-      json (>= 1.8, < 3)
-      simplecov (~> 0.16.1)
-      term-ansicolor (~> 1.3)
-      thor (>= 0.19.4, < 2.0)
-      tins (~> 1.6)
-    diff-lcs (1.3)
-    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)
+    activesupport (6.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    concurrent-ruby (1.1.8)
+    diff-lcs (1.4.4)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rack (2.2.3)
     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)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    rubocop (0.71.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.11.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.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.7.1)
-      tins (~> 1.0)
-    thor (0.20.3)
-    tins (1.21.1)
-    unicode-display_width (1.6.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-bsm (0.5.4)
+      rubocop (~> 1.0)
+      rubocop-performance
+      rubocop-rails
+      rubocop-rake
+      rubocop-rspec
+    rubocop-performance (1.10.1)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.9.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 0.90.0, < 2.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler
-  coveralls
-  json (>= 1.7.7)
   rake
   rspec
-  rubocop
+  rubocop-bsm
   timed_lru!
 
 BUNDLED WITH
-   2.0.1
+   2.1.4

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2021 Black Square Media Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -1,16 +1,13 @@
-Timed LRU
-=========
+# 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.
 
-Install
--------
+## Install
 
 Install it via `gem`:
 
@@ -20,8 +17,7 @@ gem install timed_lru
 
 Or just bundle it with your project.
 
-Usage Example
--------------
+## Usage Example
 
 ```ruby
 # Initialize with a max size (default: 100) and a TTL (default: none)
@@ -45,29 +41,3 @@ 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
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-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/lib/timed_lru.rb

@@ -23,22 +23,22 @@ class TimedLRU
   # @param [Hash] opts options
   # @option opts [Integer] max_size
   #   maximum allowed number of items, defaults to 100
+  # @option opts [Integer,Float] ttl
+  #   the TTL in seconds
   # @option opts [Boolean] thread_safe
   #   true by default, set to false if you are not using threads a *really* need
   #   that extra bit of performance
-  # @option opts [Integer] ttl
-  #   the TTL in seconds
-  def initialize(opts={})
+  def initialize(max_size: 100, ttl: nil, thread_safe: true)
     super() # MonitorMixin
 
     @hash     = {}
-    @max_size = Integer(opts[:max_size] || 100)
-    @ttl      = Integer(opts[:ttl]) if opts[:ttl]
+    @max_size = Integer(max_size)
+    @ttl      = Float(ttl) if ttl
 
     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
+    extend ThreadUnsafe if thread_safe == false
   end
 
   # Stores a `value` by `key`
@@ -84,8 +84,7 @@ class TimedLRU
 
   def compact!
     remove(@tail) while @hash.size > max_size
-
-    remove(@tail) while ttl && @tail.expires_at < Time.now.to_i
+    remove(@tail) while ttl && @tail.expires_at < Time.now.to_f
   end
 
   def remove(node)
@@ -98,7 +97,7 @@ class TimedLRU
   end
 
   def touch(node)
-    node.expires_at = Time.now.to_i + ttl if ttl
+    node.expires_at = Time.now.to_f + ttl if ttl
     return if node == @head
 
     left = node.left

data/spec/timed_lru_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe TimedLRU do
-
   subject { described_class.new max_size: 4 }
 
   def full_chain
@@ -38,11 +37,13 @@ describe TimedLRU do
 
     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
 
@@ -59,16 +60,19 @@ describe TimedLRU do
 
     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) }
+
+      it { is_expected.to eq(120.0) }
     end
+
     it { is_expected.to be_a(described_class::ThreadUnsafe) }
 
-    it 'should assert correct option values' do
+    it 'asserts correct option values' do
       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)
@@ -80,46 +84,43 @@ describe TimedLRU do
   end
 
   describe 'storing' do
-
-    it 'should set head + tail on first item' do
+    it 'sets 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
+    it 'shifts 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
+    it 'expires 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
+    it 'updates 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
-
-    it 'should fetch values' do
+    it 'fetches values' do
       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
+    it 'renews 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])
@@ -127,26 +128,23 @@ describe TimedLRU do
       expect { subject['a'] }.to change { chain }.to(%w[a b c d])
       expect { subject['x'] }.not_to change { chain }
     end
-
   end
 
   describe 'deleting' do
-
-    it 'should delete an return values' do
+    it 'deletes an return values' do
       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
+    it 're-arranges 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)
+      expect { subject.delete('b') }.to change(subject, :size).from(1).to(0)
     end
-
   end
 
   describe 'TTL expiration' do
@@ -159,7 +157,7 @@ describe TimedLRU do
       allow(Time).to receive(:now).and_call_original
     end
 
-    it 'should expire on access' do
+    it 'expires on access' do
       in_past(70) do
         subject['a'] = 1
         expect(chain).to eq(%w[a])
@@ -174,7 +172,7 @@ describe TimedLRU do
       expect(chain).to eq(%w[c b])
     end
 
-    it 'should renew expiration on access' do
+    it 'renews expiration on access' do
       in_past(70) do
         subject['a'] = 1
         subject['b'] = 2
@@ -189,7 +187,5 @@ describe TimedLRU do
       subject['c'] = 3
       expect(chain).to eq(%w[c a])
     end
-
   end
-
 end

data/timed_lru.gemspec

@@ -1,14 +1,15 @@
 Gem::Specification.new do |s|
-  s.required_ruby_version = '>= 2.4.0'
+  s.required_ruby_version = '>= 2.6.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.4.0'
+  s.version     = '0.5.0'
 
   s.authors     = ['Black Square Media']
   s.email       = 'info@blacksquaremedia.com'
   s.homepage    = 'https://github.com/bsm/timed_lru'
+  s.license     = 'Apache-2.0'
 
   s.require_path = 'lib'
   s.files        = `git ls-files`.split("\n")
@@ -17,5 +18,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rubocop-bsm'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timed_lru
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Black Square Media
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-23 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-bsm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -73,20 +73,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - 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: []
+licenses:
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -96,14 +97,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Timed LRU

data/.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-before_install:
-  - gem install bundler
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-cache: bundler

data/spec/coverage_helper.rb

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