rufus-lru 1.0.5 → 1.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d40c5ee89890b41593bb60c367782f88f3161f19
+  data.tar.gz: cc2e44a4052e047fcc8d19023e07f0c48697dba4
+SHA512:
+  metadata.gz: 74bcdcd1aac5ce64c9df134a13c83835e749ed019d374c9915ea200229588e2f749f4031a93f9a7a9b2c01b16639586adf0b655d84f8f0971ccd9259d7827aa0
+  data.tar.gz: 12fb4a8406a3026f9957e9f48770d9aa5a8bf3d369ee04c6bde4b6411fadffcf06c85ad78bcf0cd54d4b0dc6f3acd1da9218bca144de39d42da4e6f07eee81ee

data/CHANGELOG.txt

@@ -2,6 +2,18 @@
 = rufus-lru CHANGELOG.txt
 
 
+== rufus-lru - 1.0.7    released 2016/05/07
+
+- modernized spec/
+- switched from Rake to Make
+
+
+== rufus-lru - 1.0.6    not released
+
+- introduced manual #squeeze!
+- handling values with destructor #clear
+
+
 == rufus-lru - 1.0.5    released 2012/02/28
 
 - introduced Rufus::Lru::SynchronizedHash (thread-safe)

data/CREDITS.txt

@@ -0,0 +1,14 @@
+
+= CREDITS.txt
+
+
+== Contributors
+
+- Gleb Kuzmenko - https://github.com/bayclosed - squeeze! and more
+- Baldur Gudbjornsson - https://github.com/baldur
+
+
+== Feedback
+
+- many people
+

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2007-2012, John Mettraux, jmettraux@gmail.com
+Copyright (c) 2007-2016, John Mettraux, jmettraux@gmail.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Makefile

@@ -0,0 +1,23 @@
+
+NAME = \
+  $(shell ruby -e "s = eval(File.read(Dir['*.gemspec'][0])); puts s.name")
+VERSION = \
+  $(shell ruby -e "s = eval(File.read(Dir['*.gemspec'][0])); puts s.version")
+
+
+gemspec_validate:
+	@echo "---"
+	ruby -e "s = eval(File.read(Dir['*.gemspec'].first)); p s.validate"
+	@echo "---"
+
+name: gemspec_validate
+	@echo "$(NAME) $(VERSION)"
+
+build: gemspec_validate
+	gem build $(NAME).gemspec
+	mkdir -p pkg
+	mv $(NAME)-$(VERSION).gem pkg/
+
+push: build
+	gem push pkg/$(NAME)-$(VERSION).gem
+

data/README.md

@@ -1,12 +1,23 @@
 
 # rufus-lru
 
+[![Build Status](https://secure.travis-ci.org/jmettraux/rufus-lru.svg)](http://travis-ci.org/jmettraux/rufus-lru)
+[![Gem Version](https://badge.fury.io/rb/rufus-lru.svg)](http://badge.fury.io/rb/rufus-lru)
+
 LruHash class, a Hash with a max size, controlled by a LRU mechanism.
 
 
 ## getting it
 
-    gem install rufus-lru
+```
+gem install rufus-lru
+```
+
+or better, simply add to your ```Gemfile```
+
+```
+gem 'rufus-lru'
+```
 
 
 ## usage
@@ -16,27 +27,81 @@ It's a regular hash, but you have to set a maxsize at instantiation.
 Once the maxsize is reached, the hash will discard the element that was the
 least recently used (hence LRU).
 
-    require 'rubygems'
-    require 'rufus-lru'
+```ruby
+require 'rufus-lru'
 
-    h = Rufus::Lru::Hash.new(3)
+h = Rufus::Lru::Hash.new(3)
 
-    5.times { |i| h[i] = "a" * i }
+5.times { |i| h[i] = "a" * i }
 
-    puts h.inspect # >> {2=>"aa", 3=>"aaa", 4=>"aaaa"}
+puts h.inspect # >> {2=>"aa", 3=>"aaa", 4=>"aaaa"}
 
-    h[:newer] = 'b'
+h[:newer] = 'b'
 
-    puts h.inspect # >> {:newer=>"b", 3=>"aaa", 4=>"aaaa"}
+puts h.inspect # >> {:newer=>"b", 3=>"aaa", 4=>"aaaa"}
+```
 
 Rufus::Lru::Hash isn't thread-safe, if you need something that is, use Rufus::Lru::SynchronizedHash
 
-    require 'rubygems'
-    require 'rufus-lru'
+```ruby
+require 'rufus-lru'
+
+h = Rufus::Lru::SynchronizedHash.new(3)
+
+# ...
+```
+
+It's possible to squeeze LruHash manually:
+
+```ruby
+h = Rufus::Lru::Hash.new(33, :auto_squeeze => false)
+  # or
+#h = Rufus::Lru::Hash.new(33)
+#h.auto_squeeze = false
+
+# ... values keep accumulating ...
+
+# when a squeeze is needed...
+h.squeeze!
+```
+
+LruHash accepts on initialization a ```:on_removal``` option. It can be set to a Symbol, which is then used as the method name to call on the value just removed:
+
+```ruby
+require 'rufus-lru'
+
+class ObjectWithDestructor; def clear; puts 'Destructor called'; end; end
+
+h = LruHash.new(1, :on_removal => :clear)
+
+h[:one] = ObjectWithDestructor.new
+h[:two] = nil # :one is being removed >> "Destructor called"
+```
+
+Or it can be set to a lambda:
+
+```ruby
+require 'rufus-lru'
+
+seen = []
+h = Rufus::Lru::Hash.new(
+  1,
+  :on_removal => lambda { |val| seen << val.object_id })
+
+h[:one] = 'abc'
+h[:two] = 'xyz'
+
+# seen ends up with the object_id of the 'abc' String instance...
+```
+
+The value of ```on_removal``` can be set later on.
 
-    h = Rufus::Lru::SyncrhonizedHash.new(3)
+```ruby
+h.on_removal = :destroy
+h.on_removal = lambda { |val| bodycount += 1 if val.is_a?(Martian) }
+```
 
-    # ...
+`auto_squeeze` and `on_removal` were originally contributed by Gleb Kuzmenko.
 
 
 ## dependencies
@@ -65,18 +130,19 @@ irc.freenode.net #ruote
 
 http://github.com/jmettraux/rufus-lru
 
-    git clone git://github.com/jmettraux/rufus-lru.git
+```
+git clone git://github.com/jmettraux/rufus-lru.git
+```
 
 
 ## author
 
-John Mettraux, jmettraux@gmail.com
-http://jmettraux.wordpress.com
+John Mettraux, jmettraux@gmail.com, http://lambda.io/jmettraux
 
 
-## the rest of Rufus
+## contributors and help
 
-http://rufus.rubyforge.org
+see [CREDITS.txt](CREDITS.txt)
 
 
 ## license

data/lib/rufus/lru.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2007-2012, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2007-2016, John Mettraux, jmettraux@gmail.com
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -19,7 +19,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 #
-# "made in Japan"
+# "Made in Japan"
 #++
 
 require 'thread'
@@ -28,7 +28,7 @@ require 'thread'
 module Rufus
 module Lru
 
-  VERSION = '1.0.5'
+  VERSION = '1.0.7'
 
   #
   # A Hash that has a max size. After the maxsize has been reached, the
@@ -48,6 +48,20 @@ module Lru
   #
   #   puts h.inspect # >> {:newer=>"b", 3=>"aaa", 4=>"aaaa"}
   #
+  # One may want to squeeze hash manually
+  #
+  #   h = LruHash.new(3, true)
+  #   # or h.squeeze_on_demand=true after h is created
+  #   .
+  #   .
+  #   h.squeeze!
+  #
+  # If a value has destructor method #clear it may be called upon the
+  # key-value removal
+  #
+  #   h = LruHash.new(33, does_not_matter, true)
+  #   # or h.clear_value_on_removal=true after h is created
+  #
   # Nota bene: this class is not thread-safe. If you need something thread-safe,
   # use Rufus::Lru::SynchronizedHash.
   #
@@ -56,28 +70,58 @@ module Lru
     attr_reader :maxsize
     attr_reader :lru_keys
 
+    attr_accessor :on_removal
+
     # Initializes a LruHash with a given maxsize.
     #
-    def initialize(maxsize)
+    # Options:
+    #
+    # * :auto_squeeze
+    #   defaults to true
+    # * :on_removal
+    #   accepts false, a symbol or a lambda.
+    #   * False is the default, values are removed, nothing special happens.
+    #   * A symbol can be used to point to a method like :clear or :destroy
+    #     that has to be called on the value just removed
+    #   * A lambda/proc can be set, it's thus called (and passed the removed
+    #     value as argument) each time a removal occurs
+    #
+    def initialize(maxsize, opts={})
 
       super()
 
       @maxsize = maxsize
       @lru_keys = []
+
+      @auto_squeeze = opts.has_key?(:auto_squeeze) ? opts[:auto_squeeze] : true
+      @on_removal = opts[:on_removal]
     end
 
     def maxsize=(i)
 
       @maxsize = i
-      remove_lru
+      squeeze! if @auto_squeeze
 
       i
     end
 
+    def auto_squeeze=(b)
+
+      squeeze! if b
+      @auto_squeeze = b
+    end
+
+    def auto_squeeze?
+
+      @auto_squeeze
+    end
+
     def clear
 
       @lru_keys.clear
 
+      self.each_value { |v| call_on_removal(v) }
+
       super
     end
 
@@ -96,7 +140,7 @@ module Lru
 
     def []=(key, value)
 
-      remove_lru
+      remove_lru if @auto_squeeze
       touch(key)
 
       super
@@ -111,9 +155,12 @@ module Lru
 
     def delete(key)
 
+      value = super
+      call_on_removal(value)
+
       @lru_keys.delete(key)
 
-      super
+      value
     end
 
     # Returns a regular Hash with the entries in this hash.
@@ -123,6 +170,9 @@ module Lru
       {}.merge!(self)
     end
 
+    # public alias to remove_lru
+    def squeeze!; remove_lru; end
+
     protected
 
     # Puts the key on top of the lru 'stack'.
@@ -143,14 +193,25 @@ module Lru
         delete(@lru_keys.delete_at(0))
       end
     end
+
+    def call_on_removal(value)
+
+      if ! @on_removal
+        # nothing to do
+      elsif @on_removal.is_a?(Symbol)
+        value.send(@on_removal)
+      else # must be a block
+        @on_removal.call(value)
+      end
+    end
   end
 
   #
   # A thread-safe version of the lru hash.
   #
-  class SynchronizedHash < Hash
+  class SynchronizedHash < Rufus::Lru::Hash
 
-    def initialize(maxsize)
+    def initialize(maxsize, opts={})
 
       super
       @mutex = Mutex.new
@@ -165,6 +226,11 @@ module Lru
 
       @mutex.synchronize { super }
     end
+
+    def squeeze!
+
+      @mutex.synchronize { super }
+    end
   end
 end
 end

data/rufus-lru.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |s|
   s.email = [ 'jmettraux@gmail.com' ]
   s.homepage = 'http://github.com/jmettraux/rufus-lru'
   s.rubyforge_project = 'rufus'
+  s.license = 'MIT'
   s.summary = 'A Hash with a max size, controlled by a LRU mechanism'
 
   s.description = %{
@@ -20,15 +21,14 @@ LruHash class, a Hash with a max size, controlled by a LRU mechanism
 
   #s.files = `git ls-files`.split("\n")
   s.files = Dir[
-    'Rakefile',
-    'lib/**/*.rb', 'spec/**/*.rb', 'test/**/*.rb',
+    'Makefile',
+    'lib/**/*.rb', #'spec/**/*.rb', 'test/**/*.rb',
     '*.gemspec', '*.txt', '*.rdoc', '*.md'
   ]
 
   #s.add_runtime_dependency 'tzinfo', '>= 0.3.23'
 
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec', '>= 2.7.0'
+  s.add_development_dependency 'rspec', '>= 3.4.0'
 
   s.require_path = 'lib'
 end

metadata

@@ -1,39 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rufus-lru
 version: !ruby/object:Gem::Version
-  version: 1.0.5
-  prerelease: 
+  version: 1.0.7
 platform: ruby
 authors:
 - John Mettraux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-28 00:00:00.000000000 +09:00
-default_executable: 
+date: 2016-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &2153411200 !ruby/object:Gem::Requirement
-    none: false
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.4.0
   type: :development
   prerelease: false
-  version_requirements: *2153411200
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &2153410580 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.0
-  type: :development
-  prerelease: false
-  version_requirements: *2153410580
+        version: 3.4.0
 description: LruHash class, a Hash with a max size, controlled by a LRU mechanism
 email:
 - jmettraux@gmail.com
@@ -41,40 +31,36 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Rakefile
-- lib/rufus/lru.rb
-- lib/rufus-lru.rb
-- spec/hash_spec.rb
-- spec/lru_hash_spec.rb
-- spec/spec_helper.rb
-- spec/synchronized_hash_spec.rb
-- rufus-lru.gemspec
 - CHANGELOG.txt
+- CREDITS.txt
 - LICENSE.txt
+- Makefile
 - README.md
-has_rdoc: true
+- lib/rufus-lru.rb
+- lib/rufus/lru.rb
+- rufus-lru.gemspec
 homepage: http://github.com/jmettraux/rufus-lru
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: rufus
-rubygems_version: 1.6.2
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Hash with a max size, controlled by a LRU mechanism
 test_files: []

data/Rakefile

@@ -1,87 +0,0 @@
-
-$:.unshift('.') # 1.9.2
-
-require 'rubygems'
-require 'rubygems/user_interaction' if Gem::RubyGemsVersion == '1.5.0'
-
-require 'rake'
-require 'rake/clean'
-#require 'rake/rdoctask'
-require 'rdoc/task'
-
-
-#
-# clean
-
-CLEAN.include('pkg', 'rdoc')
-
-
-#
-# test / spec
-
-#task :spec => :check_dependencies do
-task :spec do
-  exec 'rspec spec/'
-end
-task :test => :spec
-
-task :default => :spec
-
-
-#
-# gem
-
-GEMSPEC_FILE = Dir['*.gemspec'].first
-GEMSPEC = eval(File.read(GEMSPEC_FILE))
-GEMSPEC.validate
-
-
-desc %{
-  builds the gem and places it in pkg/
-}
-task :build do
-
-  sh "gem build #{GEMSPEC_FILE}"
-  sh "mkdir pkg" rescue nil
-  sh "mv #{GEMSPEC.name}-#{GEMSPEC.version}.gem pkg/"
-end
-
-desc %{
-  builds the gem and pushes it to rubygems.org
-}
-task :push => :build do
-
-  sh "gem push pkg/#{GEMSPEC.name}-#{GEMSPEC.version}.gem"
-end
-
-
-#
-# rdoc
-#
-# make sure to have rdoc 2.5.x to run that
-
-Rake::RDocTask.new do |rd|
-
-  rd.main = 'README.txt'
-  rd.rdoc_dir = "rdoc/#{GEMSPEC.name}"
-
-  rd.rdoc_files.include('README.rdoc', 'CHANGELOG.txt', 'lib/**/*.rb')
-
-  rd.title = "#{GEMSPEC.name} #{GEMSPEC.version}"
-end
-
-
-#
-# upload_rdoc
-
-desc %{
-  upload the rdoc to rubyforge
-}
-task :upload_rdoc => [ :clean, :rdoc ] do
-
-  account = 'jmettraux@rubyforge.org'
-  webdir = '/var/www/gforge-projects/rufus'
-
-  sh "rsync -azv -e ssh rdoc/#{GEMSPEC.name} #{account}:#{webdir}/"
-end
-

data/spec/hash_spec.rb

@@ -1,126 +0,0 @@
-
-require 'spec_helper'
-
-
-describe Rufus::Lru::Hash do
-
-  let(:hash) { Rufus::Lru::Hash.new(3) }
-
-  context 'like a ::Hash' do
-
-    it 'supports insertion' do
-
-      hash[1] = 2
-
-      hash[1].should == 2
-    end
-
-    it 'supports deletion' do
-
-      hash[1] = 2
-
-      hash.delete(1).should == 2
-
-      hash.size.should == 0
-    end
-  end
-
-  context 'as a LRU Hash' do
-
-    it 'drops entries when the maxsize is reached' do
-
-      4.times { |i| hash[i] = i }
-
-      hash.size.should == 3
-    end
-
-    it 're-inserting under a key places the key at the end of the lru_keys' do
-
-      3.times { |i| hash[i] = i }
-
-      hash[0] = :new
-
-      hash.lru_keys.should == [ 1, 2, 0 ]
-    end
-
-    it 'removes keys from the lru_keys upon entry deletion' do
-
-      hash[1] = 1
-      hash.delete(1)
-
-      hash.lru_keys.should == []
-    end
-  end
-
-  describe '#lru_keys' do
-
-    it 'returns the keys with the least recently used first' do
-
-      3.times { |i| hash[i] = i }
-
-      hash.lru_keys.should == [ 0, 1, 2 ]
-    end
-  end
-
-  describe '#ordered_keys' do
-
-    it 'is an alias for #lru_keys' do
-
-      3.times { |i| hash[i] = i }
-
-      hash.lru_keys.should == [ 0, 1, 2 ]
-    end
-  end
-
-  describe '#[]' do
-
-    it 'returns nil if there is no value' do
-
-      hash[:x].should == nil
-    end
-
-    it 'returns false when the value is false' do
-
-      hash[1] = false
-
-      hash[1].should == false
-    end
-
-    it 'does not modify the LRU list when looking up a non-present key' do
-
-      hash[:x]
-
-      hash.lru_keys.should == []
-    end
-
-    it 'returns the current value' do
-
-      hash[1] = 2
-
-      hash[1].should == 2
-    end
-  end
-
-  describe '#merge!' do
-
-    it 'merges in place' do
-
-      hash.merge!(1 => 1, 2 => 2)
-
-      hash.size.should == 2
-      hash.lru_keys.sort.should == [ 1, 2 ]
-    end
-  end
-
-  describe '#to_h' do
-
-    it 'returns a new hash with the entries of the LRU hash' do
-
-      4.times { |i| hash[i] = i }
-
-      hash.to_h.class.should == ::Hash
-      hash.to_h.should == { 1 => 1, 2 => 2, 3 => 3 }
-    end
-  end
-end
-

data/spec/lru_hash_spec.rb

@@ -1,16 +0,0 @@
-
-require 'spec_helper'
-
-
-describe LruHash do
-
-  it 'is available from the root namespace' do
-
-    h = LruHash.new(1)
-
-    2.times { |i| h[i] = i }
-
-    h.size.should == 1
-  end
-end
-

data/spec/spec_helper.rb

@@ -1,21 +0,0 @@
-
-require 'rufus-lru'
-
-Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each do |f|
-  require(f)
-end
-
-RSpec.configure do |config|
-
-  # == Mock Framework
-  #
-  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
-  #
-  # config.mock_with :mocha
-  # config.mock_with :flexmock
-  # config.mock_with :rr
-  config.mock_with :rspec
-
-  #config.include SubalternHelper
-end
-

data/spec/synchronized_hash_spec.rb

@@ -1,23 +0,0 @@
-
-require 'spec_helper'
-
-
-describe Rufus::Lru::SynchronizedHash do
-
-  # well, you've probably seen better specs...
-
-  let(:hash) { Rufus::Lru::SynchronizedHash.new(3) }
-
-  it 'sports a mutex' do
-
-    hash.instance_variable_get(:@mutex).class.should == Mutex
-  end
-
-  it 'works' do
-
-    4.times { |i| hash[i] = i }
-
-    hash.size.should == 3
-  end
-end
-