memodis 0.0.1

data/.document

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

data/.gitignore

@@ -0,0 +1,25 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+test/config
+test/log
+test/pid
+test/dump.rdb

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/levicook/redis-rb"]
+	path = vendor/levicook/redis-rb
+	url = git@github.com:levicook/redis-rb.git

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 levicook@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 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,17 @@
+= memodis
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 levicook@gmail.com. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,146 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "memodis"
+    gem.summary = %Q{redis backed memoization helpers}
+    gem.description = %Q{
+semi-transparent memoization; backed by redis; redis-rb and redis-namespace
+
+Background
+-----------
+1) http://blog.grayproductions.net/articles/caching_and_memoization
+2) http://code.google.com/p/redis & http://github.com/ezmobius/redis-rb
+
+Important Moving Parts
+----------------------
+1) http://code.google.com/p/redis/wiki/GetCommand
+2) http://code.google.com/p/redis/wiki/SetCommand
+3) http://code.google.com/p/redis/wiki/SetnxCommand
+4) http://github.com/defunkt/redis-namespace
+}
+    gem.email = "levicook@gmail.com"
+    gem.homepage = "http://github.com/levicook/memodis"
+    gem.authors = ["levicook@gmail.com"]
+    gem.add_development_dependency "riot", ">= 0"
+    gem.add_development_dependency "reek", ">= 0"
+    gem.add_development_dependency "daemon_controller", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "memodis #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+# redis test environment...
+
+def write_redis_config(confile, port, slaveof=nil)
+  pidfile = File.expand_path("test/pid/#{ File.basename(confile, '.*') }.pid")
+  logfile = File.expand_path("test/log/#{ File.basename(confile, '.*') }.log")
+  open(confile, 'w') do |f|
+    f.puts "daemonize yes"
+    f.puts "port #{port}"
+    f.puts "pidfile #{pidfile}"
+    f.puts "bind 127.0.0.1"
+    f.puts "timeout 0"
+    f.puts "dir ./test"
+    f.puts "loglevel notice"
+    f.puts "logfile #{logfile}"
+    f.puts slaveof unless slaveof.nil?
+    f.puts "databases 2"
+    f.puts "maxmemory 6291456" 
+    f.puts "glueoutputbuf yes"
+    f.puts "shareobjects no"
+    f.puts "shareobjectspoolsize 1024"
+  end
+end
+
+directory 'test/config'
+directory 'test/log'
+directory 'test/pid'
+
+(16379..16380).each do |port|
+  config_file = "test/config/redis-server:#{port}.conf"
+  file config_file => %w(test/config test/log test/pid) do
+    write_redis_config(config_file, port)
+  end
+  namespace :test do
+    task :config => config_file
+  end
+end
+
+(16389..16394).each do |port|
+  config_file = "test/config/redis-server:#{port}.conf"
+  file config_file => %w(test/config test/log test/pid) do
+    master_port = port.even? ? 16379 : 16380
+    write_redis_config(config_file, port, "slaveof 127.0.0.1 #{master_port}")
+  end
+  namespace :test do
+    task :config => config_file
+  end
+end
+
+task :test => 'test:config'

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/examples/main.rb

@@ -0,0 +1,31 @@
+require 'pathname'
+load Pathname.new(__FILE__).parent.parent + 'lib/memodis.rb'
+
+require 'rubygems'
+require 'hitimes'
+
+def fib(num)
+  return num if num < 2
+  fib(num - 1) + fib(num - 2)
+end
+
+puts 'Before memoize: '
+puts Hitimes::Interval.measure { print fib(33); print ': ' }
+
+
+extend Memodis
+
+memoize :fib, Memodis::DistCache.new({
+  :key_gen => lambda { |k| "fib(#{k})" },
+  :decoder => :integer,
+  :expires => (10 * 60),
+  :master  => '127.0.0.1:16379 127.0.0.1:16380'.split,
+  :slaves  => '127.0.0.1:16389 127.0.0.1:16390 
+               127.0.0.1:16391 127.0.0.1:16392
+               127.0.0.1:16393 127.0.0.1:16394'.split
+})
+
+puts "\nAfter memoize: "
+puts Hitimes::Interval.measure { print fib(33); print ': ' }
+puts Hitimes::Interval.measure { print fib(33); print ': ' }
+puts Hitimes::Interval.measure { print fib(33); print ': ' }

data/lib/dependencies.rb

@@ -0,0 +1,10 @@
+
+require "pathname"
+vendor_path = Pathname.new(__FILE__).parent.parent + "vendor"
+Pathname.glob("#{vendor_path}/**/lib") do |lib|
+  next if $LOAD_PATH.include?(lib)
+  $LOAD_PATH.insert(0, lib.realpath.to_s) if lib.directory?
+end
+
+require "dist_redis"
+

data/lib/memodis.rb

@@ -0,0 +1,18 @@
+require 'pathname'
+load Pathname.new(__FILE__).parent+'dependencies.rb'
+
+require 'memodis/dist_cache'
+
+module Memodis
+
+  # slurp cool vendor goodies into our namespace. would declare them 
+  # as gem dependencies, but they don't seem to be published...
+
+  VENDOR_PATH = Pathname.new(__FILE__).parent.parent + 'vendor'
+
+  class_eval((VENDOR_PATH+'memoizable.rb').read) unless defined? Memodis::Memoizable
+  class_eval((VENDOR_PATH+'weak_cache.rb').read) unless defined? Memodis::WeakCache
+
+  include Memodis::Memoizable
+
+end

data/lib/memodis/dist_cache.rb

@@ -0,0 +1,88 @@
+module Memodis
+
+  class DistCache
+
+    CODERS = {}
+    CODERS.default   = lambda { |v| v }
+    CODERS[:float]   = lambda { |v| Float(v) }
+    CODERS[:integer] = lambda { |v| Integer(v) }
+    CODERS.freeze
+
+    def initialize(options)
+
+      @master = DistRedis.new({
+        :db => options[:db],
+        :hosts => options[:master],
+        :timeout => options[:timeout],
+      })
+
+      @slaves = options[:slaves].map do |h|
+        host, port = h.split(':')
+        Redis.new({
+          :db => options[:db],
+          :host => host,
+          :port => port,
+          :timeout => options[:timeout],
+        })
+      end
+
+      @encoder = case options[:encoder] 
+                 when Proc; options[:encoder]
+                 else; CODERS[options[:encoder]]
+                 end
+
+      @decoder = case options[:decoder] 
+                 when Proc; options[:decoder]
+                 else; CODERS[options[:decoder]]
+                 end
+
+      @key_gen = options.fetch(:key_gen, lambda { |k| k })
+
+      @expires = options[:expires]
+    end
+
+    def []= key, val
+      key = @key_gen.call(key)
+      @master.set(key, encode(val))
+      @master.expire(key, @expires) unless @expires.nil?
+    end
+
+    def [] key
+      key = @key_gen.call(key)
+      if val = get(key)
+        decode(val)
+      else
+        nil # don't decode a miss
+      end
+    end
+
+    private
+
+    def indexed_slaves
+      @indexed_slaves ||= @slaves.inject(Hash.new) do |index, slave|
+        slave_info  = slave.info
+        master_host = slave_info[:master_host]
+        master_port = slave_info[:master_port]
+        index["#{master_host}:#{master_port}"] = slave
+        index
+      end
+    end
+
+    def get key
+      m_node = @master.node_for_key(String(key.first))
+      s_node = indexed_slaves[m_node.server] || m_node
+      # TODO log warning if s_node == m_node
+      s_node.get(key)
+    end
+
+    def decode(val)
+      @decoder.call(val)
+    end
+
+    def encode(val)
+      @encoder.call(val)
+    end
+
+  end
+
+end

data/lib/memodis/local_redis_controller.rb

@@ -0,0 +1,60 @@
+require 'daemon_controller'
+require 'socket'
+
+module Memodis
+  class LocalRedisController
+    
+    def self.start(config_file)
+      new(config_file).start
+    end
+
+    attr_reader :config, :controller
+
+    def initialize(config_file)
+      config = IO.readlines(config_file)
+      config.reject!  { |l| l !~ /^(bind|port|pidfile|logfile)[ \t]?/ }
+      config.collect! { |l| l.chomp.split(/[ \t]/) }
+      config.flatten!
+      config = Hash[*config]
+      config['file'] = config_file
+      @config = config
+      @config.freeze
+
+      @controller = DaemonController.new({
+        :identifier => identifier,
+        :start_command => start_command,
+        :ping_command => ping_command,
+        :pid_file => pid_file,
+        :log_file => log_file
+      })
+    end
+
+    def connect
+      @controller.connect { TCPSocket.new(@config['bind'], @config['port']) }
+    end
+    alias :start :connect
+
+    private
+
+    def identifier
+      "redis-server #{@config['file']}"
+    end
+
+    def start_command
+      "redis-server #{@config['file']}"
+    end
+
+    def ping_command
+      lambda { TCPSocket.new(@config['bind'], @config['port']) }
+    end
+
+    def pid_file
+      @config['pidfile']
+    end
+
+    def log_file
+      @config['logfile']
+    end
+
+  end
+end

data/script/mooch

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+require "pathname"
+
+
+LOADER = '''
+require "pathname"
+
+vendor_path = Pathname.new(__FILE__).parent.parent + 'vendor'
+
+Pathname.glob("#{vendor_path}/**/lib") do |lib|
+  next if $LOAD_PATH.include?(lib)
+  $LOAD_PATH.insert(0, lib.realpath.to_s) if lib.directory?
+end
+'''
+
+
+if ARGV[0] == "init"
+  lib = Pathname.new(ARGV[1])
+  lib.mkpath
+  (lib + 'dependencies.rb').open("w") do |file|
+    file.write LOADER
+  end
+else
+  vendor = Pathname.new("vendor")
+  vendor.mkpath
+
+  if File.exist?('.git')
+    system("git add vendor")
+    system("git submodule add git://github.com/#{ARGV[0]}.git vendor/#{ARGV[0]}")
+  else
+    Dir.chdir(vendor.realpath)
+    system("git clone git://github.com/#{ARGV[0]}.git #{ARGV[0]}")
+    if ARGV[1]
+      Dir.chdir(ARGV[0])
+      system("git checkout #{ARGV[1]}")
+    end
+  end
+
+end

data/script/test.watchr

@@ -0,0 +1,7 @@
+#!/usr/bin/env watchr
+
+watch( 'test/teststrap.rb' ) { |md| system("ruby -Ilib -Itest test/*_test.rb")        }
+
+watch( 'test/.*_test.rb' )   { |md| system("ruby -Ilib -Itest #{md[0]}")              }
+
+watch( 'lib/(.*)\.rb' )      { |md| system("ruby -Ilib -Itest test/#{md[1]}_test.rb") }

data/test/memodis_test.rb

@@ -0,0 +1,12 @@
+require 'teststrap'
+
+context Memodis do
+  setup { Memodis }
+  asserts(:constants).includes('Memoizable')
+  asserts(:constants).includes('WeakCache')
+end
+
+context "Exteding Memodis" do
+  setup { Object.new.extend(Memodis) }
+  asserts(:methods).includes('memoize')
+end

data/test/teststrap.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'riot'
+require 'memodis'
+Riot.dots
+
+
+require 'memodis/local_redis_controller'
+Dir['test/config/redis-server*.conf'].each do |config_file|
+  Memodis::LocalRedisController.start(config_file)
+end

data/vendor/memoizable.rb

@@ -0,0 +1,37 @@
+#!/usr/local/bin/ruby -w
+
+# memoizable.rb
+#
+#  Created by James Edward Gray II on 2006-01-21.
+#  Copyright 2006 Gray Productions. All rights reserved.
+
+# 
+# Have your class or module <tt>extend Memoizable</tt> to gain access to the 
+# #memoize method.
+# 
+module Memoizable
+  # 
+  # This method is used to replace a computationally expensive method with an
+  # equivalent method that will answer repeat calls for indentical arguments 
+  # from a _cache_.  To use, make sure the current class extends Memoizable, 
+  # then call by passing the _name_ of the method you wish to cache results for.
+  # 
+  # The _cache_ object can be any object supporting both #[] and #[]=.  The keys
+  # used for the _cache_ are an Array of the arguments the method was called 
+  # with and the values are just the returned results of the original method 
+  # call.  The default _cache_ is a simple Hash, providing in-memory storage.
+  # 
+  def memoize( name, cache = Hash.new )
+    original = "__unmemoized_#{name}__"
+
+    # 
+    # <tt>self.class</tt> is used for the top level, to modify Object, otherwise
+    # we just modify the Class or Module directly
+    # 
+    ([Class, Module].include?(self.class) ? self : self.class).class_eval do
+      alias_method original, name
+      private      original
+      define_method(name) { |*args| cache[args] ||= send(original, *args) }
+    end
+  end
+end

data/vendor/weak_cache.rb

@@ -0,0 +1,37 @@
+# 
+# This cache uses weak references, which can be garbage collected.  When the 
+# cache is checked, the value will be returned if it is still around, otherwise
+# +nil+ is returned.
+# 
+# (Code by Mauricio Fernandez.)
+# 
+class WeakCache
+  def initialize
+    set_internal_hash
+  end
+
+  def method_missing( meth, *args, &block )
+    __get_hash__.send(meth, *args, &block)
+  end
+
+  private
+
+  def __get_hash__
+    old_critical    = Thread.critical
+    Thread.critical = true
+
+    @valid or set_internal_hash
+    return ObjectSpace._id2ref(@hash_id)
+  ensure
+    Thread.critical = old_critical
+  end
+
+  def set_internal_hash
+    hash     = Hash.new
+    @hash_id = hash.object_id
+    @valid   = true
+
+    ObjectSpace.define_finalizer(hash, lambda { @valid = false })
+    hash = nil
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification 
+name: memodis
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- levicook@gmail.com
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-14 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: riot
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: reek
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: daemon_controller
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: |
+  
+  semi-transparent memoization; backed by redis; redis-rb and redis-namespace
+  
+  Background
+  -----------
+  1) http://blog.grayproductions.net/articles/caching_and_memoization
+  2) http://code.google.com/p/redis & http://github.com/ezmobius/redis-rb
+  
+  Important Moving Parts
+  ----------------------
+  1) http://code.google.com/p/redis/wiki/GetCommand
+  2) http://code.google.com/p/redis/wiki/SetCommand
+  3) http://code.google.com/p/redis/wiki/SetnxCommand
+  4) http://github.com/defunkt/redis-namespace
+
+email: levicook@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- .gitmodules
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/main.rb
+- lib/dependencies.rb
+- lib/memodis.rb
+- lib/memodis/dist_cache.rb
+- lib/memodis/local_redis_controller.rb
+- script/mooch
+- script/test.watchr
+- test/memodis_test.rb
+- test/teststrap.rb
+- vendor/memoizable.rb
+- vendor/weak_cache.rb
+has_rdoc: true
+homepage: http://github.com/levicook/memodis
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: redis backed memoization helpers
+test_files: 
+- test/memodis_test.rb
+- test/teststrap.rb
+- examples/main.rb