Ruby-MemCache 0.0.1

data/.irbrc

@@ -0,0 +1,38 @@
+#!/usr/bin/ruby
+
+puts ">>> Adding lib and ext to load path..."
+$LOAD_PATH.unshift( "lib" )
+
+require './utils'
+include UtilityFunctions
+
+def colored( prompt, *args )
+	return ansiCode( *(args.flatten) ) + prompt + ansiCode( 'reset' )
+end
+
+
+# Modify prompt to do highlighting unless we're running in an inferior shell.
+unless ENV['EMACS']
+	IRB.conf[:PROMPT][:memcache] = { # name of prompt mode
+		:PROMPT_I => colored( "%N(%m):%03n:%i>", %w{bold white on_blue} ) + " ",
+		:PROMPT_S => colored( "%N(%m):%03n:%i%l", %w{white on_blue} ) + " ",
+		:PROMPT_C => colored( "%N(%m):%03n:%i*", %w{white on_blue} ) + " ",
+		:RETURN => "    ==> %s\n\n"      # format to return value
+	}
+	IRB.conf[:PROMPT_MODE] = :memcache
+end
+
+# Try to require the 'memcache' library
+begin
+	puts "Requiring Memcache..."
+	require "memcache"
+rescue => e
+	$stderr.puts "Ack! Memcache library failed to load: #{e.message}\n\t" +
+		e.backtrace.join( "\n\t" )
+end
+
+
+__END__
+Local Variables:
+mode: ruby
+

data/README

@@ -0,0 +1,69 @@
+
+= Ruby-MemCache
+
+A Ruby memcache client library.
+
+== Authors
+
+ Michael Granger <mgranger@RubyCrafters.com>
+
+Thanks to Martin Chase and Rick Bradley for peer review, suggestions, and
+bugfixes.
+
+
+== General Information
+
+According to its documentation, memcache "is a high-performance, distributed
+memory object caching system, generic in nature, but intended for use in
+speeding up dynamic web applications by alleviating database load."
+
+This is a Ruby client library for accessing one or more memcache servers.
+
+
+== Installation
+
+=== Requirements
+
+* Ruby 1.8.2
+* Memcached 1.1.11
+
+
+==== Quickstart
+
+Install:
+
+  $ install.rb
+
+The install script will check for dependencies and install the libraries.
+
+
+== Current Status
+
+This is a beta release. It might eat your house, set your dog on fire, or
+baptize your children against your will.
+
+Comments welcomed.
+
+
+== Contact
+
+* Project Page: http://www.deveiate.org/code/Ruby-MemCache.html
+
+
+== Legal
+
+Copyright (c) 2004 The FaerieMUD Consortium. Most rights reserved.
+
+This library is licensed under the Creative Commons Attribution License. To view
+a copy of this license, visit http://creativecommons.org/licenses/by/1.0/ or
+send a letter to Creative Commons, 559 Nathan Abbott Way, Stanford, California
+94305, USA.
+
+THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND
+FITNESS FOR A PARTICULAR PURPOSE.
+
+
+ $Id: README 26 2004-11-12 18:12:15Z ged $
+
+

data/docs/CATALOG

@@ -0,0 +1,9 @@
+#
+# Title:  Ruby MemCache Client Library
+# Main:   README
+# Upload: ssh://yhaliwell/usr/local/www/devEiate.org/4.0/code/Ruby-MemCache/
+# Webcvs: http://svn.faeriemud.org/index.cgi/RMemCache/log/trunk/
+#
+lib/memcache.rb
+README
+TODO

data/docs/makedocs.rb

@@ -0,0 +1,191 @@
+#!/usr/bin/ruby
+#
+#	RDoc Documentation Generation Script
+#	$Id: makedocs.rb 12 2004-10-03 21:04:34Z ged $
+#
+#	Copyright (c) 2001-2004 The FaerieMUD Consortium.
+#
+#	This is free software. You may use, modify, and/or redistribute this
+#	software under the terms of the Perl Artistic License. (See
+#	http://language.perl.com/misc/Artistic.html)
+#
+
+# Make sure we're in the correct directory, and if not, change there.
+BEGIN {
+	basedir = File::dirname(File::dirname( File::expand_path(__FILE__) ))
+	unless Dir::pwd == basedir
+		Dir::chdir( basedir ) 
+	end
+	$LOAD_PATH.unshift basedir
+}
+
+# Load modules
+require 'getoptlong'
+require 'rdoc/rdoc'
+require 'utils'
+include UtilityFunctions
+
+def makeDocs( docsdir, template='html', diagrams=false, upload=nil, ridocs=false )
+	debugMsg "docsdir = %p, template = %p, diagrams = %p, upload = %p, ridocs = %p" %
+		[docsdir, template, diagrams, upload, ridocs]
+
+	title = findRdocTitle()
+	docs = findRdocableFiles()
+	main = findRdocMain()
+	webcvs = findRdocCvsURL()
+
+	header "Making documentation in #{docsdir}."
+	header "Will upload to '#{upload}'\n" if upload
+	header "Will also create/install 'ri' source" if ridocs
+
+	flags = [
+		'--all',
+		'--inline-source',
+		'--fmt', 'html',
+		'--include', 'docs',
+		'--template', template,
+		'--op', docsdir,
+		'--title', title,
+		'--tab-width', 4,
+	]
+
+	flags += [ '--quiet' ] unless $VERBOSE
+	flags += [ '--diagram' ] if diagrams
+	flags += [ '--main', main ] if main
+	flags += [ '--webcvs', webcvs ] if webcvs
+
+	buildDocs( flags, docs )
+	uploadDocs( upload, docsdir ) if upload
+	buildRi( docs ) if ridocs
+end
+
+
+def buildDocs( flags, docs )
+	message "Running 'rdoc #{flags.join(' ')} #{docs.join(' ')}'\n" if $VERBOSE
+	unless $DEBUG
+		begin
+			r = RDoc::RDoc.new
+			r.document( flags + docs )
+		rescue RDoc::RDocError => e
+			$stderr.puts e.message
+			exit(1)
+		end
+	end
+end
+
+
+def uploadDocs( url, docsdir )
+	header "Uploading new docs snapshot to #{url}."
+
+	case url
+	
+	# SSH target
+	when %r{^ssh://(.*)}
+		target = $1
+		if target =~ %r{^([^/]+)/(.*)}
+			host, path = $1, $2
+			path = "/" + path unless path =~ /^(\/|\.)/
+			cmd = "tar -C #{docsdir} -cf - . | ssh #{host} 'tar -C #{path} -xvf -'"
+			unless $DEBUG
+				system( cmd )
+			else
+				message "Would have uploaded using the command:\n    #{cmd}\n\n"
+			end
+		else
+			abort "--upload ssh://host/path"
+		end
+	when %r{^file://(.*)}
+		targetdir = $1
+		targetdir.gsub!( %r{^file://}, '' )
+
+		File.makedirs targetdir, true
+		Dir["#{docsdir}/**/*"].each {|file|
+			fname = file.gsub( %r:#{docsdir}/:, '' )
+			if File.directory? file
+				unless $DEBUG
+					File.makedirs File.join(targetdir, fname), true
+				else
+					message %{File.makedirs %s, true\n} % File.join(targetdir, fname)
+				end
+			else
+				unless $DEBUG
+					File.install( file, File.join(targetdir, fname), 0444, true )
+				else
+					message %{File.install( %s, %s, 0444, true )\n} % [
+						file,
+						File.join(targetdir, fname),
+					]
+				end
+			end
+		}
+
+	else
+		raise "I don't know how to upload to urls like '#{url}'."
+	end
+end
+
+def buildRi( docs )
+	message "Running 'rdoc #{flags.join(' ')} #{docs.join(' ')}'\n" if $VERBOSE
+	unless $DEBUG
+		begin
+			r = RDoc::RDoc.new
+			r.document([ '-i', 'docs', '-f', 'xml', 'lib', 'ext' ])
+		rescue RDoc::RDocError => e
+			$stderr.puts e.message
+			exit(1)
+		end
+	end
+	
+end
+
+
+if $0 == __FILE__
+	opts = GetoptLong.new
+	opts.set_options(
+		[ '--debug',	'-d',	GetoptLong::NO_ARGUMENT ],
+		[ '--verbose',	'-v',	GetoptLong::NO_ARGUMENT ],
+		[ '--upload',	'-u',	GetoptLong::OPTIONAL_ARGUMENT ],
+		[ '--diagrams', '-D',	GetoptLong::NO_ARGUMENT ],
+		[ '--template',	'-T',	GetoptLong::REQUIRED_ARGUMENT ],
+		[ '--output',	'-o',	GetoptLong::REQUIRED_ARGUMENT ]
+		#[ '--ri',		'-r',	GetoptLong::NO_ARGUMENT ],
+	)
+
+	debug = false
+	verbose = false
+	upload = nil
+	diagrams = false
+	template = 'html'
+	docsdir = "docs/html"
+	rimode = false
+	
+	opts.each {|opt,val|
+		case opt
+
+		when '--debug'
+			debug = true
+
+		when '--verbose'
+			verbose = true
+
+		when '--upload'
+			upload = val
+			upload = findRdocUpload() if val.nil? || val.empty?
+
+		when '--diagrams'
+			diagrams = true
+
+		when '--output'
+			docsdir = val
+
+ 		when '--ri'
+ 			rimode = true
+
+		end
+	}
+
+	$DEBUG = true if debug
+	$VERBOSE = true if verbose
+
+	makeDocs( docsdir, template, diagrams, upload, rimode )
+end

data/install.rb

@@ -0,0 +1,185 @@
+#!/usr/bin/ruby
+#
+#	Module Install Script
+#	$Id: install.rb 12 2004-10-03 21:04:34Z ged $
+#
+#	Thanks to Masatoshi SEKI for ideas found in his install.rb.
+#
+#	Copyright (c) 2001-2004 The FaerieMUD Consortium.
+#
+#	This is free software. You may use, modify, and/or redistribute this
+#	software under the terms of the Perl Artistic License. (See
+#	http://language.perl.com/misc/Artistic.html)
+#
+
+require './utils.rb'
+include UtilityFunctions
+
+require 'rbconfig'
+include Config
+
+require 'find'
+require 'ftools'
+require 'optparse'
+
+$version	= %q$Rev: 12 $
+$rcsId		= %q$Id: install.rb 12 2004-10-03 21:04:34Z ged $
+
+# Define required libraries
+RequiredLibraries = [
+	# libraryname, nice name, RAA URL, Download URL, e.g.,
+	[ 'io/reactor', "IO-Reactor", 
+		'http://raa.ruby-lang.org/project/io-reactor/',
+		'http://www.deveiate.org/code/IO-Reactor-0.05.tar.gz',
+	],
+]
+
+class Installer
+
+	@@PrunePatterns = [
+		/CVS/,
+		/~$/,
+		%r:(^|/)\.:,
+		/\.tpl$/,
+	]
+
+	def initialize( testing=false )
+		@ftools = (testing) ? self : File
+	end
+
+	### Make the specified dirs (which can be a String or an Array of Strings)
+	### with the specified mode.
+	def makedirs( dirs, mode=0755, verbose=false )
+		dirs = [ dirs ] unless dirs.is_a? Array
+
+		oldumask = File::umask
+		File::umask( 0777 - mode )
+
+		for dir in dirs
+			if @ftools == File
+				File::mkpath( dir, $verbose )
+			else
+				$stderr.puts "Make path %s with mode %o" % [ dir, mode ]
+			end
+		end
+
+		File::umask( oldumask )
+	end
+
+	def install( srcfile, dstfile, mode=nil, verbose=false )
+		dstfile = File.catname(srcfile, dstfile)
+		unless FileTest.exist? dstfile and File.cmp srcfile, dstfile
+			$stderr.puts "   install #{srcfile} -> #{dstfile}"
+		else
+			$stderr.puts "   skipping #{dstfile}: unchanged"
+		end
+	end
+
+	public
+
+	def installFiles( src, dstDir, mode=0444, verbose=false )
+		directories = []
+		files = []
+		
+		if File.directory?( src )
+			Find.find( src ) {|f|
+				Find.prune if @@PrunePatterns.find {|pat| f =~ pat}
+				next if f == src
+
+				if FileTest.directory?( f )
+					directories << f.gsub( /^#{src}#{File::Separator}/, '' )
+					next 
+
+				elsif FileTest.file?( f )
+					files << f.gsub( /^#{src}#{File::Separator}/, '' )
+
+				else
+					Find.prune
+				end
+			}
+		else
+			files << File.basename( src )
+			src = File.dirname( src )
+		end
+		
+		dirs = [ dstDir ]
+		dirs |= directories.collect {|d| File.join(dstDir,d)}
+		makedirs( dirs, 0755, verbose )
+		files.each {|f|
+			srcfile = File.join(src,f)
+			dstfile = File.dirname(File.join( dstDir,f ))
+
+			if verbose
+				if mode
+					$stderr.puts "Install #{srcfile} -> #{dstfile} (mode %o)" % mode
+				else
+					$stderr.puts "Install #{srcfile} -> #{dstfile}"
+				end
+			end
+
+			@ftools.install( srcfile, dstfile, mode, verbose )
+		}
+	end
+
+end
+
+
+if $0 == __FILE__
+	dryrun = false
+
+	# Parse command-line switches
+	ARGV.options {|oparser|
+		oparser.banner = "Usage: #$0 [options]\n"
+
+		oparser.on( "--verbose", "-v", TrueClass, "Make progress verbose" ) {
+			$VERBOSE = true
+			debugMsg "Turned verbose on."
+		}
+
+		oparser.on( "--dry-run", "-n", TrueClass, "Don't really install anything" ) {
+			debugMsg "Turned dry-run on."
+			dryrun = true
+		}
+
+		# Handle the 'help' option
+		oparser.on( "--help", "-h", "Display this text." ) {
+			$stderr.puts oparser
+			exit!(0)
+		}
+
+		oparser.parse!
+	}
+
+	# Don't do anything if they expect this to be the three-step install script
+	# and they aren't doing the 'install' step.
+	if ARGV.include?( "config" )
+		for lib in RequiredLibraries
+			testForRequiredLibrary( *lib )
+		end
+		puts "Done."
+	elsif ARGV.include?( "setup" )
+		puts "Done."
+	elsif ARGV.empty?
+		for lib in RequiredLibraries
+			testForRequiredLibrary( *lib )
+		end
+	end
+
+	if ARGV.empty? || ARGV.include?( "install" )
+		debugMsg "Sitelibdir = '#{CONFIG['sitelibdir']}'"
+		sitelibdir = CONFIG['sitelibdir']
+		debugMsg "Sitearchdir = '#{CONFIG['sitearchdir']}'"
+		sitearchdir = CONFIG['sitearchdir']
+
+		message "Installing..."
+		i = Installer.new( dryrun )
+		#i.installFiles( "redist", sitelibdir, 0444, verbose )
+		i.installFiles( "lib", sitelibdir, 0444, $VERBOSE )
+
+		message "done.\n"
+	end
+end
+	
+
+
+