lru 0.1.0

data/History.txt

@@ -0,0 +1,6 @@
+== 0.1 2007-09-29
+
+* Initial release. 
+  * Full test suite. 
+  * LRU implemented based on the maximum number of elements to cache.
+

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 FIXME full name
+
+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/Manifest.txt

@@ -0,0 +1,25 @@
+init.rb
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/test.rb
+lib/lru.rb
+lib/test/version.rb
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_helper.rb
+test/test_lru.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,29 @@
+= Efficient LRU Cache in Ruby
+
+This class implements an LRU Cache where all operations are
+implemented in constant time. This is in contract to other classes,
+e.g. ruby-cache, whose operations complete in Order(n) time. The
+primary implementation details for this class include:
+
+  - Simple API. We do not provide a complete Hash API, but do provide
+    enumerable and common shortcuts.
+
+  - True linked list underlying the LRU. Ruby-cache uses a ruby array
+    and traverses ALL elements for key operations (like get).
+
+  - No aggressive cache flushing. Items are expired only once the
+    cache reaches the capacity you configured. There is no garbage
+    collection or other process that can delay operations. Every
+    access to the cache occurs in constant time.
+
+== Usage
+require 'lru'
+cache = Cache::LRU.new(:max_elements => 5)
+cache.put(:a, 1)
+cache[:a] = 2
+cache.get(:b) { 1 }
+cache[:b]
+
+== Authors
+Michael Bryzek mbryzek<at>alum.mit.edu
+Phong Nguyen   phong<at>gilt.com

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'test/version'
+
+AUTHOR = ['Michael Bryzek', 'Phong Nguyen']  # can also be an array of Authors
+EMAIL = "mbryzek@alum.mit.edu"
+DESCRIPTION = "Efficient LRU in pure ruby where all operations are constant time"
+GEM_NAME = 'lru' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'lru' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Test::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'test documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\\n\\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'test'

data/init.rb

@@ -0,0 +1,21 @@
+# Copyright (c) 2007 Michael Bryzek
+# 
+# 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.
+
+require 'lru'

data/lib/lru.rb

@@ -0,0 +1,193 @@
+# Copyright (c) 2007 Michael Bryzek
+# 
+# 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.
+#
+module Cache
+
+  # Defines a local LRU cache. All operations are maintained in
+  # constant size regardless of the size of the Cache. When creating
+  # the cache, you specify the max size of the cache.
+  #
+  # Example:
+  #   cache = Cache::LRU.new(:max_elements => 5)
+  #    cache.put(:a, 1)
+  #    cache[:a] = 2
+  #    cache.get(:b) { 1 }
+  #    cache[:b]
+  class LRU
+
+    include Enumerable
+
+    attr_reader :size
+    attr_reader :keys
+    # opts:
+    #  - max_elements - maximum number of elements to keep in the
+    #    cache at any time. The default is 100 elements
+    def initialize(opts = {})
+      opts = { :max_elements => 100 }.merge(opts)
+      @max_elements = opts.delete(:max_elements)
+      raise "Invalid options: #{opts.keys.join(' ')}" if opts.keys.size > 0
+      @keys = LinkedList.new
+      @map = {}
+      @size = 0
+    end
+
+    def clear!
+      initialize( :max_elements => @max_elements )
+    end
+    
+    # Iterates through all of the key/value pairs added to the cache,
+    # in random order. Accepts a block that is yielded to with the key
+    # and value for each entry in the cache.
+    def each
+      @map.each do |k, el| 
+        yield k, el.value
+      end
+    end
+
+    def [](key)
+      get(key)
+    end
+    
+    # Fetches the value of the element with the given key. If this key
+    # does not exist in the cache, you can provide an optional code
+    # block that we'll yield to to repopulate the value
+    def get(key)
+      if el = @map[key]
+        @keys.move_to_head(el)
+        return el.value
+      elsif block_given?
+        return put(key, yield)
+      end
+      return nil
+    end
+
+    def []=(key, value)
+      put(key, value)
+    end
+    
+    def put(key, value)
+      el = @map[key]
+      if el
+        el.value = value
+        @keys.move_to_head(el)
+      else
+        el = @keys.add(key, value)
+        @size += 1
+      end
+      @map[key] = el
+
+      if @size > @max_elements
+        delete_element(@keys.last) 
+        @size -= 1
+      end
+      value
+    end
+
+    def delete(key) 
+      if el = @map[key]
+        delete_element(el)
+        @size -= 1
+      else
+        nil
+      end
+    end
+
+    private
+    def delete_element(el)
+      @keys.remove_element(el)
+      @map.delete(el.key)
+      el.value
+    end
+
+  end
+
+  class LinkedList
+
+    attr_reader :last
+    def initialize
+      @head = @last = nil
+    end
+
+    def add(key, value)
+      add_element(Element.new(key, value, @head))
+    end
+
+    def add_element(el)
+      @head.previous_element = el if @head
+
+      el.next_element = @head
+      el.previous_element = nil
+      @head = el
+      @last = el unless @last
+      el
+    end
+
+    def remove_element(el)
+      el.previous_element.next_element = el.next_element if el.previous_element
+      el.next_element.previous_element = el.previous_element if el.next_element
+
+      @last = el.previous_element if el == @last
+      @head = el.next_element if el == @head
+    end
+
+    def move_to_head(el)
+      remove_element(el)
+      add_element(el)
+    end
+
+    # Returns a nicely formatted stirng of all elements in the linked
+    # list. First element is most recently used, last element is least
+    # recently used.
+    def pp
+      s = ''
+      el = @head
+      while el
+        s << ', ' if s.size > 0
+        s <<  el.to_s
+        el = el.next_element
+      end
+      s
+    end
+
+    class Element
+
+      attr_accessor :key, :value, :previous_element, :next_element
+      def initialize(key, value, next_element)
+        @key = key
+        @value = value
+        @next_element = next_element
+        @previous_element = nil
+      end
+
+      def inspect
+        to_s
+      end
+
+      def to_s
+        p = @previous_element ? @previous_element.key : 'nil'
+        n = @next_element ? @next_element.key : 'nil'
+        "[#{@key}: #{@value.inspect}, previous: #{p}, next: #{n}]"
+      end
+
+    end
+
+  end
+
+end

data/lib/test.rb

@@ -0,0 +1,5 @@
+$:.unshift File.dirname(__FILE__)
+
+module Test
+  
+end

data/lib/test/version.rb

@@ -0,0 +1,9 @@
+module Test #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/txt2html

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+begin
+  require 'newgem'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + '/../lib/test/version.rb'
+
+version  = Test::VERSION::STRING
+download = 'http://rubyforge.org/projects/test'
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.rhtml')
+  
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.rhtml] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text = fsrc.read
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)