sized_list 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rdoc", "~> 3.12"
+  gem "jeweler", "~> 1.8.4"
+  gem "rspec", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    rake (10.0.4)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  rspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Doug Youch
+
+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/README.rdoc

@@ -0,0 +1,19 @@
+= sized_list
+
+Keeps only a limited number of items in a list.  It removes the least recently used item.
+
+== Contributing to sized_list
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Doug Youch. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "sized_list"
+  gem.homepage = "http://github.com/dyouch5@yahoo.com/sized_list"
+  gem.license = "MIT"
+  gem.summary = %Q{Limited size list}
+  gem.description = %Q{Uses LRU functionality to keep a limited size list of items}
+  gem.email = "doug@sessionm.com"
+  gem.authors = ["Doug Youch"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "sized_list #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/sized_list.rb

@@ -0,0 +1,63 @@
+class SizedList
+  include Enumerable
+
+  attr_reader :max_size
+
+  def initialize(max_size)
+    @max_size = max_size
+    @used = []
+    @items = {}
+  end
+
+  def get(key)
+    if value = @items[key]
+      used! key
+    end
+    value
+  end
+  alias [] get
+
+  def set(key, value)
+    @items[key] = value
+    remove_least_recently_used! if @items.size > @max_size
+    used! key
+    nil
+  end
+  alias []= set
+
+  def each
+    @items.each do |k, v|
+      yield v
+    end
+  end
+
+  def size
+    @items.size
+  end
+
+  def keys
+    @used
+  end
+
+  def values
+    @items.values
+  end
+
+  private
+
+  def used!(key)
+    if @used.first == key
+      # no-op
+    elsif @used.last == key
+      @used.unshift @used.pop
+    else
+      @used.reject! { |k| k == key }
+      @used.unshift key
+    end
+  end
+
+  def remove_least_recently_used!
+    key = @used.pop
+    @items.delete key
+  end
+end

data/spec/sized_list_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe SizedList do
+  it "should store a limited number of items" do
+    list = SizedList.new 5
+    5.times { |i| list.set "item-#{i}", 1 }
+    list.size.should == 5
+    100.times { |i| list.set "new-item-#{i}", 1 }
+    list.size.should == 5
+    list['new-item-99'].should == 1
+  end
+
+  it "should keep the most recent used item at the top of the list" do
+    list = SizedList.new 5
+    list['a'] = 1
+    list['b'] = 1
+    list['c'] = 1
+    list['d'] = 1
+    list['e'] = 1
+    list.keys.should == ['e', 'd', 'c', 'b', 'a']
+
+    list['b'].should == 1
+    list.keys.should == ['b', 'e', 'd', 'c', 'a']
+
+    list['b'].should == 1
+    list.keys.should == ['b', 'e', 'd', 'c', 'a']
+  end
+
+  it "should remove the least accessed" do
+    list = SizedList.new 5
+    list['a'] = 1
+    list['b'] = 1
+    list['c'] = 1
+    list['d'] = 1
+    list['e'] = 1
+    list.keys.should == ['e', 'd', 'c', 'b', 'a']
+
+    list['a'].should == 1
+    list.keys.should == ['a', 'e', 'd', 'c', 'b']
+
+    list['new'] = 1
+    list.keys.should == ['new', 'a', 'e', 'd', 'c']
+
+    list['d'].should == 1
+    list.keys.should == ['d', 'new', 'a', 'e', 'c']
+
+    list['new2'] = 1
+    list.keys.should == ['new2', 'd', 'new', 'a', 'e']
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'sized_list'

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: sized_list
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Doug Youch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !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'
+description: Uses LRU functionality to keep a limited size list of items
+email: doug@sessionm.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/sized_list.rb
+- spec/sized_list_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/dyouch5@yahoo.com/sized_list
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1772257885057037827
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Limited size list
+test_files: []