Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

initial commit

  • Loading branch information...
commit 6bcc8a26fce5054c3bfe8f97bf4ac66eae5f2b97 0 parents
Dylan Stamat authored
Showing with 3,280 additions and 0 deletions.
  1. +4 −0 History.txt
  2. +2 −0  License.txt
  3. +43 −0 Manifest.txt
  4. +7 −0 PostInstall.txt
  5. +35 −0 README.txt
  6. +4 −0 Rakefile
  7. +13 −0 config/ehcache.yml
  8. +73 −0 config/hoe.rb
  9. +15 −0 config/requirements.rb
  10. +15 −0 ext/ehcache-1.4.1/LICENSE.txt
  11. +131 −0 ext/ehcache-1.4.1/RELEASE_NOTES.txt
  12. BIN  ext/ehcache-1.4.1/ehcache-1.4.1-javadoc.zip
  13. BIN  ext/ehcache-1.4.1/ehcache-1.4.1-remote-debugger.jar
  14. BIN  ext/ehcache-1.4.1/ehcache-1.4.1-sources.jar
  15. BIN  ext/ehcache-1.4.1/ehcache-1.4.1.jar
  16. +123 −0 ext/ehcache-1.4.1/ehcache.xsd
  17. BIN  ext/ehcache-1.4.1/lib/backport-util-concurrent-3.0.jar
  18. BIN  ext/ehcache-1.4.1/lib/commons-logging-1.0.4.jar
  19. BIN  ext/ehcache-1.4.1/lib/jsr107cache-1.0.jar
  20. +15 −0 lib/ehcache.rb
  21. +42 −0 lib/ehcache/cache.rb
  22. +67 −0 lib/ehcache/cache_manager.rb
  23. +80 −0 lib/ehcache/config.rb
  24. +11 −0 lib/ehcache/element.rb
  25. +8 −0 lib/ehcache/java.rb
  26. +9 −0 lib/ehcache/version.rb
  27. BIN  pkg/ehcache-0.0.1.gem
  28. +10 −0 script/console
  29. +14 −0 script/destroy
  30. +14 −0 script/generate
  31. +82 −0 script/txt2html
  32. +1,585 −0 setup.rb
  33. +56 −0 spec/cache_manager_spec.rb
  34. +31 −0 spec/cache_spec.rb
  35. +2 −0  spec/spec.opts
  36. +12 −0 spec/spec_helper.rb
  37. +34 −0 tasks/deployment.rake
  38. +7 −0 tasks/environment.rake
  39. +17 −0 tasks/website.rake
  40. +11 −0 test/test_ehcache.rb
  41. +11 −0 test/test_ehcachejr.rb
  42. +2 −0  test/test_helper.rb
  43. +141 −0 website/index.html
  44. +83 −0 website/index.txt
  45. +285 −0 website/javascripts/rounded_corners_lite.inc.js
  46. +138 −0 website/stylesheets/screen.css
  47. +48 −0 website/template.html.erb
4 History.txt
@@ -0,0 +1,4 @@
+== 0.0.1 2008-06-05
+
+* 1 major enhancement:
+ * Initial release
2  License.txt
@@ -0,0 +1,2 @@
+Copyright (c) 2008 Dylan Stamat
+...
43 Manifest.txt
@@ -0,0 +1,43 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+config/ehcache.yml
+config/hoe.rb
+config/requirements.rb
+ext/ehcache-1.4.1/LICENSE.txt
+ext/ehcache-1.4.1/RELEASE_NOTES.txt
+ext/ehcache-1.4.1/ehcache-1.4.1-javadoc.zip
+ext/ehcache-1.4.1/ehcache-1.4.1-remote-debugger.jar
+ext/ehcache-1.4.1/ehcache-1.4.1-sources.jar
+ext/ehcache-1.4.1/ehcache-1.4.1.jar
+ext/ehcache-1.4.1/ehcache.xsd
+ext/ehcache-1.4.1/lib/backport-util-concurrent-3.0.jar
+ext/ehcache-1.4.1/lib/commons-logging-1.0.4.jar
+ext/ehcache-1.4.1/lib/jsr107cache-1.0.jar
+lib/ehcache.rb
+lib/ehcache/cache.rb
+lib/ehcache/cache_manager.rb
+lib/ehcache/config.rb
+lib/ehcache/element.rb
+lib/ehcache/java.rb
+lib/ehcache/version.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+spec/spec_helper.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_ehcache.rb
+test/test_ehcachejr.rb
+test/test_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb
7 PostInstall.txt
@@ -0,0 +1,7 @@
+
+For more information on ehcache, see http://ehcache.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt
+You can also delete it if you don't want it.
+
+
35 README.txt
@@ -0,0 +1,35 @@
+= ehcache
+
+* FIX (url)
+
+== DESCRIPTION:
+
+Ehcache is a simplified JRuby interface to Java's Ehcache.
+Simplified, meaning no Singleton support, and a ton of other small
+things left out primarily because I didn't need them :P
+
+A complete inteface would be grand, and contribution is welcome !
+
+== FEATURES/PROBLEMS:
+
+No Singleton support, and... probably more.
+
+== SYNOPSIS:
+
+manager = CacheManager.new
+cache = manager.cache("cache")
+cache.put("key", "value")
+cache.get("key")
+
+manager.shutdown
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+sudo gem install ehcache
+
+== LICENSE:
+...
4 Rakefile
@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }
13 config/ehcache.yml
@@ -0,0 +1,13 @@
+# cache managers
+defaults:
+ store: disk
+ max_elements: 10000
+ time_to_live: 120
+ time_to_idle: 120
+ disk_overflow: true
+ clients:
+ - 127.0.0.1:40001
+
+sample_cache:
+ servers:
+ - 127.0.0.1:40000
73 config/hoe.rb
@@ -0,0 +1,73 @@
+require 'ehcache/version'
+
+AUTHOR = 'Dylan Stamat' # can also be an array of Authors
+EMAIL = "dstamat@elctech.com"
+DESCRIPTION = "JRuby interface to Ehcache"
+GEM_NAME = 'ehcache' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'ehcache' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+# ['activesupport', '>= 1.3.1']
+] # An array of rubygem dependencies [name, version]
+
+@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 = YAML.load(`svn info`)['Revision']
+VERS = Ehcache::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'ehcache 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.developer(AUTHOR, EMAIL)
+ p.description = DESCRIPTION
+ 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 = EXTRA_DEPENDENCIES
+
+ #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')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""
15 config/requirements.rb
@@ -0,0 +1,15 @@
+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]))
15 ext/ehcache-1.4.1/LICENSE.txt
@@ -0,0 +1,15 @@
+/**
+ * Copyright 2003-2007 Luck Consulting Pty Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
131 ext/ehcache-1.4.1/RELEASE_NOTES.txt
@@ -0,0 +1,131 @@
+$Id: RELEASE_NOTES.txt,v 1.16 2006/03/01 01:52:03 gregluck Exp $
+
+
+Release Notes For ehcache version 1.4
+=====================================
+
+Introduction
+============
+Ehcache is a pure Java, in-process cache with the following features:
+
+ 1. Fast.
+ 2. Simple.
+ 3. Multiple eviction policies: LRU, LFU and FIFO.
+ 4. Caches can be in memory or on disk.
+ 5. Disk Stores can be persistent between VM restarts.
+ 6. Distributed caching using multicast and RMI, with a pluggable API.
+ 7. Cache and CacheManager listeners
+ 8. Supports multiple Caches per CacheManager, and multiple CacheManagers per application.
+ 9. Acts as a pluggable cache for Hibernate 3.1, 3 and 2.1.
+ 10. Small foot print. Both in terms of size and memory requirements.
+ 11. Minimal dependencies apart from J2SE.
+ 12. Fully documented. See the online Documentation and the online JavaDoc.
+ 13. Comprehensive Test Coverage. See the clover test report.
+ 14. Available under the Apache 1.1 license. EHCache's copyright and licensing has been reviewed and approved by the Apache Software Foundation, making EHCache suitable for use in Apache projects.
+ 15. Production tested. EHCache is used on a large and very busy eCommerce site.
+ 16. Web caching, pull-through caches and other common caching implementations are provided in the ehcache-constructs module.
+ 17. Full JMX monitoring implementation
+ 18. Complete implementation of the draft JCACHE (JSR107) specification.
+
+Java Requirements
+=================
+
+ Ehcache supports 1.4, 1.5 and 1.6 at runtime. Ehcache final releases are compiled with -target 1.4.
+ This produces Java class data, version 48.0.
+
+ Because of an {{{http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4267864}RMI bug}}, in JDKs before JDK1.5
+ ehcache is limited to one CacheManager operating in distributed mode per virtual machine.
+ (The bug limits the number of RMI registries to one per virtual machine). Because this is the expected deployment
+ configuration, however, ther should be no practical effect.
+
+ On JDK1.5 and higher it is possible to have multiple CacheManagers per VM each participating in the same or different clusters.
+ Indeed the replication tests do this with 5 CacheManagers on the same VM all run from JUnit.
+
+Dependencies
+============
+
+
+Mandatory Dependencies
+----------------------
+
+Commons Logging
+
+ Ehcache requires {{{http://jakarta.apache.org/commons/logging/}commons-logging}} commons-logging is a very common dependency, and is therefore not included in the distribution.
+
+ It is included in the tarball and the maven dependencies.
+
+
+Backport Concurrent
+
+ Backport Concurrent is a dependency for use of the JCache API. Rather than using the library which maven will pull down, users should consider
+ using a version which matches their JDK version. See {{http://dcl.mathcs.emory.edu/util/backport-util-concurrent}}.
+
+ The Java 4 version, which is compatible with Java 4 - 6 is included in the tarball and the maven dependencies.
+
+Optional Dependencies
+---------------------
+
+JMX
+
+ The management package of ehcache requires JMX. Version 1.3 or higher will work. This is optional and only required if you are using the
+ <<<ManagementService>>>.
+
+ Of course JDK1.5 has it built in.
+
+Commons collections
+
+ This is optional. Use it if you are using ehcache with Terracotta. They have a limitation which prevents them from using
+ the build in JDK one.
+
+ It can be turned on using by setting the system property <<<net.sf.ehcache.useLRUMap>>> to true.
+
+Maven POM snippet
+=================
+
+
+ Ehcache releases are placed in the central Maven repository.
+
+ The Maven snippet for ehcache 1.4.0, for example, is:
+
+
+ <dependency>
+ <groupId>net.sf.ehcache</groupId>
+ <artifactId>ehcache</artifactId>
+ <version>1.4.0</version>
+ </dependency>
+
+
+Installation
+============
+Place the ehcache.jar into your classpath. Ensure the required dependencies are in the classpath.
+
+Create an ehcache.xml configuration from the one supplied in the distribution and place it in your classpath.
+
+The ehcache-remote-debugger.jar is a tool to be used for distributed debugging. Do not install it in
+your project. See http://ehcache.sourceforge.net/documentation/logging.html for how to use it.
+
+
+Documentation
+=============
+See http://ehcache.sourceforge.net/documentation for full documentation.
+
+The JavaDoc is in the distribution and also online at http://ehcache.sourceforge.net/javadoc.
+
+Compatibility With Ehcache 1.1
+==============================
+1. Due to an internal reorganisation in the code base the DiskStore path will default to java.io.tmp when the ehcache-1.1
+constructor is used.
+
+2. APIs are the same. CacheException is now a runtime exception. Additionally, IOException is no longer thrown.
+This does not cause a runtime error but will cause a compile time error if clients are recompiled against ehcache. In
+this case change the code to not catch an IOException. Catching CacheException is optional.
+
+Known Issues
+============
+
+1. Due to a limitation in RMI, JDK1.5 or higher is required to run multiple distributed CacheManagers on the same machine.
+ Normally distributed caching is used between machines, so this should be a very rare issue.
+
+2. There are a number of known issues and workarounds for Tomcat. See the Using Ehcache with Tomcat chapter in the online documentation.
+
+3. See the FAQ online for more.
BIN  ext/ehcache-1.4.1/ehcache-1.4.1-javadoc.zip
Binary file not shown
BIN  ext/ehcache-1.4.1/ehcache-1.4.1-remote-debugger.jar
Binary file not shown
BIN  ext/ehcache-1.4.1/ehcache-1.4.1-sources.jar
Binary file not shown
BIN  ext/ehcache-1.4.1/ehcache-1.4.1.jar
Binary file not shown
123 ext/ehcache-1.4.1/ehcache.xsd
@@ -0,0 +1,123 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
+ <xs:element name="ehcache" >
+ <xs:complexType>
+ <xs:sequence>
+ <xs:element ref="diskStore"/>
+ <xs:element minOccurs="0" maxOccurs="1"
+ ref="cacheManagerEventListenerFactory"/>
+ <xs:element minOccurs="0" maxOccurs="1"
+ ref="cacheManagerPeerProviderFactory"/>
+ <xs:element minOccurs="0" maxOccurs="1"
+ ref="cacheManagerPeerListenerFactory"/>
+ <xs:element ref="defaultCache"/>
+ <xs:element maxOccurs="unbounded" ref="cache"/>
+ </xs:sequence>
+ </xs:complexType>
+ </xs:element>
+ <xs:element name="diskStore">
+ <xs:complexType>
+ <xs:attribute name="path" use="optional" />
+ </xs:complexType>
+ </xs:element>
+ <xs:element name="cacheManagerEventListenerFactory">
+ <xs:complexType>
+ <xs:attribute name="class" use="required"/>
+ <xs:attribute name="properties" use="optional"/>
+ <xs:attribute name="propertySeparator" use="optional"/>
+ </xs:complexType>
+ </xs:element>
+ <xs:element name="cacheManagerPeerProviderFactory">
+ <xs:complexType>
+ <xs:attribute name="class" use="required"/>
+ <xs:attribute name="properties" use="optional"/>
+ <xs:attribute name="propertySeparator" use="optional"/>
+ </xs:complexType>
+ </xs:element>
+ <xs:element name="cacheManagerPeerListenerFactory">
+ <xs:complexType>
+ <xs:attribute name="class" use="required"/>
+ <xs:attribute name="properties" use="optional"/>
+ <xs:attribute name="propertySeparator" use="optional"/>
+ </xs:complexType>
+ </xs:element>
+ <!-- add clone support for addition of cacheExceptionHandler. Important! -->
+ <xs:element name="defaultCache">
+ <xs:complexType>
+ <xs:sequence>
+ <xs:element minOccurs="0" maxOccurs="unbounded" ref="cacheEventListenerFactory"/>
+ <xs:element minOccurs="0" maxOccurs="unbounded" ref="cacheExtensionFactory"/>
+ <xs:element minOccurs="0" maxOccurs="1" ref="bootstrapCacheLoaderFactory"/>
+ <xs:element minOccurs="0" maxOccurs="1" ref="cacheExceptionHandlerFactory"/>
+ <xs:element minOccurs="0" maxOccurs="1" ref="cacheLoaderFactory"/>
+ </xs:sequence>
+ <xs:attribute name="diskExpiryThreadIntervalSeconds" use="optional" type="xs:integer"/>
+ <xs:attribute name="diskSpoolBufferSizeMB" use="optional" type="xs:integer"/>
+ <xs:attribute name="diskPersistent" use="optional" type="xs:boolean"/>
+ <xs:attribute name="eternal" use="required" type="xs:boolean"/>
+ <xs:attribute name="maxElementsInMemory" use="required" type="xs:integer"/>
+ <xs:attribute name="memoryStoreEvictionPolicy" use="optional" type="xs:string"/>
+ <xs:attribute name="overflowToDisk" use="required" type="xs:boolean"/>
+ <xs:attribute name="timeToIdleSeconds" use="optional" type="xs:integer"/>
+ <xs:attribute name="timeToLiveSeconds" use="optional" type="xs:integer"/>
+ <xs:attribute name="maxElementsOnDisk" use="optional" type="xs:integer"/>
+ </xs:complexType>
+ </xs:element>
+ <xs:element name="cache">
+ <xs:complexType>
+ <xs:sequence>
+ <xs:element minOccurs="0" maxOccurs="unbounded" ref="cacheEventListenerFactory"/>
+ <xs:element minOccurs="0" maxOccurs="unbounded" ref="cacheExtensionFactory"/>
+ <xs:element minOccurs="0" maxOccurs="1" ref="bootstrapCacheLoaderFactory"/>
+ <xs:element minOccurs="0" maxOccurs="1" ref="cacheExceptionHandlerFactory"/>
+ <xs:element minOccurs="0" maxOccurs="1" ref="cacheLoaderFactory"/>
+ </xs:sequence>
+ <xs:attribute name="diskExpiryThreadIntervalSeconds" use="optional" type="xs:integer"/>
+ <xs:attribute name="diskSpoolBufferSizeMB" use="optional" type="xs:integer"/>
+ <xs:attribute name="diskPersistent" use="optional" type="xs:boolean"/>
+ <xs:attribute name="eternal" use="required" type="xs:boolean"/>
+ <xs:attribute name="maxElementsInMemory" use="required" type="xs:integer"/>
+ <xs:attribute name="memoryStoreEvictionPolicy" use="optional" type="xs:string"/>
+ <xs:attribute name="name" use="required" type="xs:string"/>
+ <xs:attribute name="overflowToDisk" use="required" type="xs:boolean"/>
+ <xs:attribute name="timeToIdleSeconds" use="optional" type="xs:integer"/>
+ <xs:attribute name="timeToLiveSeconds" use="optional" type="xs:integer"/>
+ <xs:attribute name="maxElementsOnDisk" use="optional" type="xs:integer"/>
+ </xs:complexType>
+ </xs:element>
+ <xs:element name="cacheEventListenerFactory">
+ <xs:complexType>
+ <xs:attribute name="class" use="required"/>
+ <xs:attribute name="properties" use="optional"/>
+ <xs:attribute name="propertySeparator" use="optional"/>
+ </xs:complexType>
+ </xs:element>
+ <xs:element name="bootstrapCacheLoaderFactory">
+ <xs:complexType>
+ <xs:attribute name="class" use="required"/>
+ <xs:attribute name="properties" use="optional"/>
+ <xs:attribute name="propertySeparator" use="optional"/>
+ </xs:complexType>
+ </xs:element>
+ <xs:element name="cacheExtensionFactory">
+ <xs:complexType>
+ <xs:attribute name="class" use="required"/>
+ <xs:attribute name="properties" use="optional"/>
+ <xs:attribute name="propertySeparator" use="optional"/>
+ </xs:complexType>
+ </xs:element>
+ <xs:element name="cacheExceptionHandlerFactory">
+ <xs:complexType>
+ <xs:attribute name="class" use="required"/>
+ <xs:attribute name="properties" use="optional"/>
+ <xs:attribute name="propertySeparator" use="optional"/>
+ </xs:complexType>
+ </xs:element>
+ <xs:element name="cacheLoaderFactory">
+ <xs:complexType>
+ <xs:attribute name="class" use="required"/>
+ <xs:attribute name="properties" use="optional"/>
+ <xs:attribute name="propertySeparator" use="optional"/>
+ </xs:complexType>
+ </xs:element>
+</xs:schema>
BIN  ext/ehcache-1.4.1/lib/backport-util-concurrent-3.0.jar
Binary file not shown
BIN  ext/ehcache-1.4.1/lib/commons-logging-1.0.4.jar
Binary file not shown
BIN  ext/ehcache-1.4.1/lib/jsr107cache-1.0.jar
Binary file not shown
15 lib/ehcache.rb
@@ -0,0 +1,15 @@
+$:.unshift(File.dirname(__FILE__)) unless
+ $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Ehcache
+ unless defined?(EHCACHE_HOME)
+ EHCACHE_HOME = File.expand_path(File.dirname(__FILE__) + '/..')
+ end
+end
+
+require 'ehcache/java'
+require 'ehcache/config'
+require 'ehcache/cache'
+require 'ehcache/cache_manager'
+require 'ehcache/element'
+require 'ehcache/version'
42 lib/ehcache/cache.rb
@@ -0,0 +1,42 @@
+module Ehcache
+ class Cache
+ # pull cache from given manager by name
+ def initialize(manager, cache_name)
+ @cache = manager.get_cache(cache_name)
+ end
+
+ # put a new element into the cache
+ def put(key, value)
+ @cache.put(Ehcache::Java::Element.new(key, value))
+ end
+ alias_method :set, :put
+
+ # get an element value from cache by key
+ def get(key)
+ element = @cache.get(key)
+ element ? element.get_value : nil
+ end
+
+ # get an element from cache by key
+ def element(key)
+ element = @cache.get(key)
+ return nil unless element
+ Ehcache::Element.new(element.get_key, element.get_value)
+ end
+
+ # number of elements in the cache
+ def size
+ @cache.get_size
+ end
+
+ # number of elements in the memory store
+ def memory_size
+ @cache.get_memory_store_size
+ end
+
+ # number of elements in the cache store
+ def disk_size
+ @cache.get_disk_store_size
+ end
+ end
+end
67 lib/ehcache/cache_manager.rb
@@ -0,0 +1,67 @@
+# TODO statuses
+module Ehcache
+ class CacheManager
+ def initialize(options={})
+ unless options[:security]
+ import java.lang.System unless defined?(System)
+ import java.rmi.RMISecurityManager unless defined?(RMISecurityManager)
+ if System.getSecurityManager == nil
+ RMISecurityManager.new.inspect
+ end
+ end
+ @manager = Ehcache::Java::CacheManager.new(Ehcache::Config.default)
+ end
+
+ # return cache by name
+ def cache(cache_name)
+ Ehcache::Cache.new(@manager, cache_name)
+ end
+
+ # return all cache names
+ def caches
+ @manager.get_cache_names
+ end
+
+ # adds cache based on default configuration
+ def add_cache(cache_name)
+ @manager.add_cache(cache_name)
+ end
+
+ # remove cache
+ def remove(cache_name)
+ @manager.remove_cache(cache_name)
+ end
+
+ # remove all caches
+ def remove_all
+ @manager.removal_all
+ end
+
+ # empty all caches
+ def flush_all
+ @manager.clear_all
+ end
+
+ def enable_shutdown_hook
+ @manager.add_shutdown_hook_if_required
+ end
+
+ def disable_shutdown_hook
+ @manager.disable_shutdown_hook
+ end
+
+ def shutdown
+ @manager.shutdown
+ end
+
+ def status
+ @manager.get_status.to_s
+ end
+
+ # true if cache by given name is being managed, false otherwise
+ def include?(cache_name)
+ @manager.cache_exists(cache_name)
+ end
+ alias_method :exists?, :include?
+ end
+end
80 lib/ehcache/config.rb
@@ -0,0 +1,80 @@
+module Ehcache
+ module Config
+ PRIMARY_CACHE_NAME = "cache"
+ CONFIGURATION_FILE = "ext/ehcache-1.4.1/ehcache.xml"
+
+ # standard tmpdir default
+ @@default_disk = {
+ :path => "java.io.tmpdir"
+ }
+
+ # standard cache defaults
+ @@default_cache = {
+ :name => "default",
+ :max_elements_in_memory => 10000,
+ :eternal => false,
+ :time_to_idle_seconds => 120,
+ :time_to_live_seconds => 120,
+ :overflow_to_disk => true,
+ :disk_spool_buffer_size_mb => 30,
+ :max_elements_on_disk => 1000000,
+ :disk_persistent => false,
+ :disk_expiry_thread_interval_seconds => 120,
+ :memory_store_eviction_policy => "LRU"
+ }
+
+ # standard rmi/multicast discover
+ @@default_peer_provider = {
+ :class => "net.sf.ehcache.distribution.RMICacheManagerPeerProviderFactory",
+ :properties => "peerDiscovery=automatic,multicastGroupAddress=230.0.0.1," +
+ "multicastGroupPort=4446, timeToLive=1",
+ :property_separator => ","
+ }
+
+ # standard listener
+ @@default_peer_listener = {
+ :class => "net.sf.ehcache.distribution.RMICacheManagerPeerListenerFactory"
+ }
+
+ # standard lack of event listener
+ @@default_event_listener = {}
+
+ class << self
+ # instantiates default configuration as well as the primary
+ # cache configuration used. this is cheap bootstrap.
+ def default
+ configuration = Ehcache::Java::Configuration.new
+ disk_config = Ehcache::Java::DiskStoreConfiguration.new
+ cache_config = Ehcache::Java::CacheConfiguration.new
+ peer_provider = Ehcache::Java::FactoryConfiguration.new
+ peer_listener = Ehcache::Java::FactoryConfiguration.new
+ event_listener = Ehcache::Java::FactoryConfiguration.new
+
+ # set all the defaults
+ setter(disk_config, @@default_disk)
+ setter(cache_config, @@default_cache)
+ setter(peer_provider, @@default_peer_provider)
+ setter(peer_listener, @@default_peer_listener)
+ setter(event_listener, @@default_event_listener)
+
+ # add the default and primary caches
+ configuration.add_default_cache(cache_config)
+ sample_cache_config = Ehcache::Java::CacheConfiguration.new
+ setter(sample_cache_config, @@default_cache.merge({:name => PRIMARY_CACHE_NAME}))
+ configuration.add_cache(sample_cache_config)
+
+ # populate the configuration
+ configuration.add_disk_store(disk_config)
+ configuration.add_cache_manager_peer_provider_factory(peer_provider)
+ configuration.add_cache_manager_peer_listener_factory(peer_listener)
+ configuration.add_cache_manager_event_listener_factory(event_listener)
+ configuration
+ end
+
+ # helper for setters
+ def setter(factory, config)
+ config.each { |k,v| factory.send("set_#{k.to_s}",v) }
+ end
+ end
+ end
+end
11 lib/ehcache/element.rb
@@ -0,0 +1,11 @@
+module Ehcache
+ class Element
+ attr_accessor :key, :value
+
+ # simple constructor
+ def initialize(key, value)
+ @key = key
+ @value = value
+ end
+ end
+end
8 lib/ehcache/java.rb
@@ -0,0 +1,8 @@
+module Ehcache
+ module Java
+ include Java
+ Dir["#{Ehcache::EHCACHE_HOME}/ext/**/*.jar"].sort.each {|l| require l}
+ include_package "net.sf.ehcache"
+ include_package "net.sf.ehcache.config"
+ end
+end
9 lib/ehcache/version.rb
@@ -0,0 +1,9 @@
+module Ehcache #:nodoc:
+ module VERSION #:nodoc:
+ MAJOR = 0
+ MINOR = 0
+ TINY = 1
+
+ STRING = [MAJOR, MINOR, TINY].join('.')
+ end
+end
BIN  pkg/ehcache-0.0.1.gem
Binary file not shown
10 script/console
@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs = " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs << " -r #{File.dirname(__FILE__) + '/../lib/ehcache.rb'}"
+puts "Loading ehcache gem"
+exec "#{irb} #{libs} --simple-prompt"
14 script/destroy
@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(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, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)
14 script/generate
@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(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, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)
82 script/txt2html
@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+GEM_NAME = 'ehcache' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'ehcache'
+
+require 'rubygems'
+begin
+ require 'newgem'
+ require 'rubyforge'
+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/#{GEM_NAME}/version.rb"
+
+version = Ehcache::VERSION::STRING
+download = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+def rubyforge_project_id
+ RubyForge.new.autoconfig["group_ids"][RUBYFORGE_PROJECT]
+end
+
+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.html.erb')
+else
+ puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > 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_template = fsrc.read
+ body_text = ERB.new(body_text_template).result(binding)
+ 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)
1,585 setup.rb
@@ -0,0 +1,1585 @@
+#
+# setup.rb
+#
+# Copyright (c) 2000-2005 Minero Aoki
+#
+# This program is free software.
+# You can distribute/modify this program under the terms of
+# the GNU LGPL, Lesser General Public License version 2.1.
+#
+
+unless Enumerable.method_defined?(:map) # Ruby 1.4.6
+ module Enumerable
+ alias map collect
+ end
+end
+
+unless File.respond_to?(:read) # Ruby 1.6
+ def File.read(fname)
+ open(fname) {|f|
+ return f.read
+ }
+ end
+end
+
+unless Errno.const_defined?(:ENOTEMPTY) # Windows?
+ module Errno
+ class ENOTEMPTY
+ # We do not raise this exception, implementation is not needed.
+ end
+ end
+end
+
+def File.binread(fname)
+ open(fname, 'rb') {|f|
+ return f.read
+ }
+end
+
+# for corrupted Windows' stat(2)
+def File.dir?(path)
+ File.directory?((path[-1,1] == '/') ? path : path + '/')
+end
+
+
+class ConfigTable
+
+ include Enumerable
+
+ def initialize(rbconfig)
+ @rbconfig = rbconfig
+ @items = []
+ @table = {}
+ # options
+ @install_prefix = nil
+ @config_opt = nil
+ @verbose = true
+ @no_harm = false
+ end
+
+ attr_accessor :install_prefix
+ attr_accessor :config_opt
+
+ attr_writer :verbose
+
+ def verbose?
+ @verbose
+ end
+
+ attr_writer :no_harm
+
+ def no_harm?
+ @no_harm
+ end
+
+ def [](key)
+ lookup(key).resolve(self)
+ end
+
+ def []=(key, val)
+ lookup(key).set val
+ end
+
+ def names
+ @items.map {|i| i.name }
+ end
+
+ def each(&block)
+ @items.each(&block)
+ end
+
+ def key?(name)
+ @table.key?(name)
+ end
+
+ def lookup(name)
+ @table[name] or setup_rb_error "no such config item: #{name}"
+ end
+
+ def add(item)
+ @items.push item
+ @table[item.name] = item
+ end
+
+ def remove(name)
+ item = lookup(name)
+ @items.delete_if {|i| i.name == name }
+ @table.delete_if {|name, i| i.name == name }
+ item
+ end
+
+ def load_script(path, inst = nil)
+ if File.file?(path)
+ MetaConfigEnvironment.new(self, inst).instance_eval File.read(path), path
+ end
+ end
+
+ def savefile
+ '.config'
+ end
+
+ def load_savefile
+ begin
+ File.foreach(savefile()) do |line|
+ k, v = *line.split(/=/, 2)
+ self[k] = v.strip
+ end
+ rescue Errno::ENOENT
+ setup_rb_error $!.message + "\n#{File.basename($0)} config first"
+ end
+ end
+
+ def save
+ @items.each {|i| i.value }
+ File.open(savefile(), 'w') {|f|
+ @items.each do |i|
+ f.printf "%s=%s\n", i.name, i.value if i.value? and i.value
+ end
+ }
+ end
+
+ def load_standard_entries
+ standard_entries(@rbconfig).each do |ent|
+ add ent
+ end
+ end
+
+ def standard_entries(rbconfig)
+ c = rbconfig
+
+ rubypath = File.join(c['bindir'], c['ruby_install_name'] + c['EXEEXT'])
+
+ major = c['MAJOR'].to_i
+ minor = c['MINOR'].to_i
+ teeny = c['TEENY'].to_i
+ version = "#{major}.#{minor}"
+
+ # ruby ver. >= 1.4.4?
+ newpath_p = ((major >= 2) or
+ ((major == 1) and
+ ((minor >= 5) or
+ ((minor == 4) and (teeny >= 4)))))
+
+ if c['rubylibdir']
+ # V > 1.6.3
+ libruby = "#{c['prefix']}/lib/ruby"
+ librubyver = c['rubylibdir']
+ librubyverarch = c['archdir']
+ siteruby = c['sitedir']
+ siterubyver = c['sitelibdir']
+ siterubyverarch = c['sitearchdir']
+ elsif newpath_p
+ # 1.4.4 <= V <= 1.6.3
+ libruby = "#{c['prefix']}/lib/ruby"
+ librubyver = "#{c['prefix']}/lib/ruby/#{version}"
+ librubyverarch = "#{c['prefix']}/lib/ruby/#{version}/#{c['arch']}"
+ siteruby = c['sitedir']
+ siterubyver = "$siteruby/#{version}"
+ siterubyverarch = "$siterubyver/#{c['arch']}"
+ else
+ # V < 1.4.4
+ libruby = "#{c['prefix']}/lib/ruby"
+ librubyver = "#{c['prefix']}/lib/ruby/#{version}"
+ librubyverarch = "#{c['prefix']}/lib/ruby/#{version}/#{c['arch']}"
+ siteruby = "#{c['prefix']}/lib/ruby/#{version}/site_ruby"
+ siterubyver = siteruby
+ siterubyverarch = "$siterubyver/#{c['arch']}"
+ end
+ parameterize = lambda {|path|
+ path.sub(/\A#{Regexp.quote(c['prefix'])}/, '$prefix')
+ }
+
+ if arg = c['configure_args'].split.detect {|arg| /--with-make-prog=/ =~ arg }
+ makeprog = arg.sub(/'/, '').split(/=/, 2)[1]
+ else
+ makeprog = 'make'
+ end
+
+ [
+ ExecItem.new('installdirs', 'std/site/home',
+ 'std: install under libruby; site: install under site_ruby; home: install under $HOME')\
+ {|val, table|
+ case val
+ when 'std'
+ table['rbdir'] = '$librubyver'
+ table['sodir'] = '$librubyverarch'
+ when 'site'
+ table['rbdir'] = '$siterubyver'
+ table['sodir'] = '$siterubyverarch'
+ when 'home'
+ setup_rb_error '$HOME was not set' unless ENV['HOME']
+ table['prefix'] = ENV['HOME']
+ table['rbdir'] = '$libdir/ruby'
+ table['sodir'] = '$libdir/ruby'
+ end
+ },
+ PathItem.new('prefix', 'path', c['prefix'],
+ 'path prefix of target environment'),
+ PathItem.new('bindir', 'path', parameterize.call(c['bindir']),
+ 'the directory for commands'),
+ PathItem.new('libdir', 'path', parameterize.call(c['libdir']),
+ 'the directory for libraries'),
+ PathItem.new('datadir', 'path', parameterize.call(c['datadir']),
+ 'the directory for shared data'),
+ PathItem.new('mandir', 'path', parameterize.call(c['mandir']),
+ 'the directory for man pages'),
+ PathItem.new('sysconfdir', 'path', parameterize.call(c['sysconfdir']),
+ 'the directory for system configuration files'),
+ PathItem.new('localstatedir', 'path', parameterize.call(c['localstatedir']),
+ 'the directory for local state data'),
+ PathItem.new('libruby', 'path', libruby,
+ 'the directory for ruby libraries'),
+ PathItem.new('librubyver', 'path', librubyver,
+ 'the directory for standard ruby libraries'),
+ PathItem.new('librubyverarch', 'path', librubyverarch,
+ 'the directory for standard ruby extensions'),
+ PathItem.new('siteruby', 'path', siteruby,
+ 'the directory for version-independent aux ruby libraries'),
+ PathItem.new('siterubyver', 'path', siterubyver,
+ 'the directory for aux ruby libraries'),
+ PathItem.new('siterubyverarch', 'path', siterubyverarch,
+ 'the directory for aux ruby binaries'),
+ PathItem.new('rbdir', 'path', '$siterubyver',
+ 'the directory for ruby scripts'),
+ PathItem.new('sodir', 'path', '$siterubyverarch',
+ 'the directory for ruby extentions'),
+ PathItem.new('rubypath', 'path', rubypath,
+ 'the path to set to #! line'),
+ ProgramItem.new('rubyprog', 'name', rubypath,
+ 'the ruby program using for installation'),
+ ProgramItem.new('makeprog', 'name', makeprog,
+ 'the make program to compile ruby extentions'),
+ SelectItem.new('shebang', 'all/ruby/never', 'ruby',
+ 'shebang line (#!) editing mode'),
+ BoolItem.new('without-ext', 'yes/no', 'no',
+ 'does not compile/install ruby extentions')
+ ]
+ end
+ private :standard_entries
+
+ def load_multipackage_entries
+ multipackage_entries().each do |ent|
+ add ent
+ end
+ end
+
+ def multipackage_entries
+ [
+ PackageSelectionItem.new('with', 'name,name...', '', 'ALL',
+ 'package names that you want to install'),
+ PackageSelectionItem.new('without', 'name,name...', '', 'NONE',
+ 'package names that you do not want to install')
+ ]
+ end
+ private :multipackage_entries
+
+ ALIASES = {
+ 'std-ruby' => 'librubyver',
+ 'stdruby' => 'librubyver',
+ 'rubylibdir' => 'librubyver',
+ 'archdir' => 'librubyverarch',
+ 'site-ruby-common' => 'siteruby', # For backward compatibility
+ 'site-ruby' => 'siterubyver', # For backward compatibility
+ 'bin-dir' => 'bindir',
+ 'bin-dir' => 'bindir',
+ 'rb-dir' => 'rbdir',
+ 'so-dir' => 'sodir',
+ 'data-dir' => 'datadir',
+ 'ruby-path' => 'rubypath',
+ 'ruby-prog' => 'rubyprog',
+ 'ruby' => 'rubyprog',
+ 'make-prog' => 'makeprog',
+ 'make' => 'makeprog'
+ }
+
+ def fixup
+ ALIASES.each do |ali, name|
+ @table[ali] = @table[name]
+ end
+ @items.freeze
+ @table.freeze
+ @options_re = /\A--(#{@table.keys.join('|')})(?:=(.*))?\z/
+ end
+
+ def parse_opt(opt)
+ m = @options_re.match(opt) or setup_rb_error "config: unknown option #{opt}"
+ m.to_a[1,2]
+ end
+
+ def dllext
+ @rbconfig['DLEXT']
+ end
+
+ def value_config?(name)
+ lookup(name).value?
+ end
+
+ class Item
+ def initialize(name, template, default, desc)
+ @name = name.freeze
+ @template = template
+ @value = default
+ @default = default
+ @description = desc
+ end
+
+ attr_reader :name
+ attr_reader :description
+
+ attr_accessor :default
+ alias help_default default
+
+ def help_opt
+ "--#{@name}=#{@template}"
+ end
+
+ def value?
+ true
+ end
+
+ def value
+ @value
+ end
+
+ def resolve(table)
+ @value.gsub(%r<\$([^/]+)>) { table[$1] }
+ end
+
+ def set(val)
+ @value = check(val)
+ end
+
+ private
+
+ def check(val)
+ setup_rb_error "config: --#{name} requires argument" unless val
+ val
+ end
+ end
+
+ class BoolItem < Item
+ def config_type
+ 'bool'
+ end
+
+ def help_opt
+ "--#{@name}"
+ end
+
+ private
+
+ def check(val)
+ return 'yes' unless val
+ case val
+ when /\Ay(es)?\z/i, /\At(rue)?\z/i then 'yes'
+ when /\An(o)?\z/i, /\Af(alse)\z/i then 'no'
+ else
+ setup_rb_error "config: --#{@name} accepts only yes/no for argument"
+ end
+ end
+ end
+
+ class PathItem < Item
+ def config_type
+ 'path'
+ end
+
+ private
+
+ def check(path)
+ setup_rb_error "config: --#{@name} requires argument" unless path
+ path[0,1] == '$' ? path : File.expand_path(path)
+ end
+ end
+
+ class ProgramItem < Item
+ def config_type
+ 'program'
+ end
+ end
+
+ class SelectItem < Item
+ def initialize(name, selection, default, desc)
+ super
+ @ok = selection.split('/')
+ end
+
+ def config_type
+ 'select'
+ end
+
+ private
+
+ def check(val)
+ unless @ok.include?(val.strip)
+ setup_rb_error "config: use --#{@name}=#{@template} (#{val})"
+ end
+ val.strip
+ end
+ end
+
+ class ExecItem < Item
+ def initialize(name, selection, desc, &block)
+ super name, selection, nil, desc
+ @ok = selection.split('/')
+ @action = block
+ end
+
+ def config_type
+ 'exec'
+ end
+
+ def value?
+ false
+ end
+
+ def resolve(table)
+ setup_rb_error "$#{name()} wrongly used as option value"
+ end
+
+ undef set
+
+ def evaluate(val, table)
+ v = val.strip.downcase
+ unless @ok.include?(v)
+ setup_rb_error "invalid option --#{@name}=#{val} (use #{@template})"
+ end
+ @action.call v, table
+ end
+ end
+
+ class PackageSelectionItem < Item
+ def initialize(name, template, default, help_default, desc)
+ super name, template, default, desc
+ @help_default = help_default
+ end
+
+ attr_reader :help_default
+
+ def config_type
+ 'package'
+ end
+
+ private
+
+ def check(val)
+ unless File.dir?("packages/#{val}")
+ setup_rb_error "config: no such package: #{val}"
+ end
+ val
+ end
+ end
+
+ class MetaConfigEnvironment
+ def initialize(config, installer)
+ @config = config
+ @installer = installer
+ end
+
+ def config_names
+ @config.names
+ end
+
+ def config?(name)
+ @config.key?(name)
+ end
+
+ def bool_config?(name)
+ @config.lookup(name).config_type == 'bool'
+ end
+
+ def path_config?(name)
+ @config.lookup(name).config_type == 'path'
+ end
+
+ def value_config?(name)
+ @config.lookup(name).config_type != 'exec'
+ end
+
+ def add_config(item)
+ @config.add item
+ end
+
+ def add_bool_config(name, default, desc)
+ @config.add BoolItem.new(name, 'yes/no', default ? 'yes' : 'no', desc)
+ end
+
+ def add_path_config(name, default, desc)
+ @config.add PathItem.new(name, 'path', default, desc)
+ end
+
+ def set_config_default(name, default)
+ @config.lookup(name).default = default
+ end
+
+ def remove_config(name)
+ @config.remove(name)
+ end
+
+ # For only multipackage
+ def packages
+ raise '[setup.rb fatal] multi-package metaconfig API packages() called for single-package; contact application package vendor' unless @installer
+ @installer.packages
+ end
+
+ # For only multipackage
+ def declare_packages(list)
+ raise '[setup.rb fatal] multi-package metaconfig API declare_packages() called for single-package; contact application package vendor' unless @installer
+ @installer.packages = list
+ end
+ end
+
+end # class ConfigTable
+
+
+# This module requires: #verbose?, #no_harm?
+module FileOperations
+
+ def mkdir_p(dirname, prefix = nil)
+ dirname = prefix + File.expand_path(dirname) if prefix
+ $stderr.puts "mkdir -p #{dirname}" if verbose?
+ return if no_harm?
+
+ # Does not check '/', it's too abnormal.
+ dirs = File.expand_path(dirname).split(%r<(?=/)>)
+ if /\A[a-z]:\z/i =~ dirs[0]
+ disk = dirs.shift
+ dirs[0] = disk + dirs[0]
+ end
+ dirs.each_index do |idx|
+ path = dirs[0..idx].join('')
+ Dir.mkdir path unless File.dir?(path)
+ end
+ end
+
+ def rm_f(path)
+ $stderr.puts "rm -f #{path}" if verbose?
+ return if no_harm?
+ force_remove_file path
+ end
+
+ def rm_rf(path)
+ $stderr.puts "rm -rf #{path}" if verbose?
+ return if no_harm?
+ remove_tree path
+ end
+
+ def remove_tree(path)
+ if File.symlink?(path)
+ remove_file path
+ elsif File.dir?(path)
+ remove_tree0 path
+ else
+ force_remove_file path
+ end
+ end
+
+ def remove_tree0(path)
+ Dir.foreach(path) do |ent|
+ next if ent == '.'
+ next if ent == '..'
+ entpath = "#{path}/#{ent}"
+ if File.symlink?(entpath)
+ remove_file entpath
+ elsif File.dir?(entpath)
+ remove_tree0 entpath
+ else
+ force_remove_file entpath
+ end
+ end
+ begin
+ Dir.rmdir path
+ rescue Errno::ENOTEMPTY
+ # directory may not be empty
+ end
+ end
+
+ def move_file(src, dest)
+ force_remove_file dest
+ begin
+ File.rename src, dest
+ rescue
+ File.open(dest, 'wb') {|f|
+ f.write File.binread(src)
+ }
+ File.chmod File.stat(src).mode, dest
+ File.unlink src
+ end
+ end
+
+ def force_remove_file(path)
+ begin
+ remove_file path
+ rescue
+ end
+ end
+
+ def remove_file(path)
+ File.chmod 0777, path
+ File.unlink path
+ end
+
+ def install(from, dest, mode, prefix = nil)
+ $stderr.puts "install #{from} #{dest}" if verbose?
+ return if no_harm?
+
+ realdest = prefix ? prefix + File.expand_path(dest) : dest
+ realdest = File.join(realdest, File.basename(from)) if File.dir?(realdest)
+ str = File.binread(from)
+ if diff?(str, realdest)
+ verbose_off {
+ rm_f realdest if File.exist?(realdest)
+ }
+ File.open(realdest, 'wb') {|f|
+ f.write str
+ }
+ File.chmod mode, realdest
+
+ File.open("#{objdir_root()}/InstalledFiles", 'a') {|f|
+ if prefix
+ f.puts realdest.sub(prefix, '')
+ else
+ f.puts realdest
+ end
+ }
+ end
+ end
+
+ def diff?(new_content, path)
+ return true unless File.exist?(path)
+ new_content != File.binread(path)
+ end
+
+ def command(*args)
+ $stderr.puts args.join(' ') if verbose?
+ system(*args) or raise RuntimeError,
+ "system(#{args.map{|a| a.inspect }.join(' ')}) failed"
+ end
+
+ def ruby(*args)
+ command config('rubyprog'), *args
+ end
+
+ def make(task = nil)
+ command(*[config('makeprog'), task].compact)
+ end
+
+ def extdir?(dir)
+ File.exist?("#{dir}/MANIFEST") or File.exist?("#{dir}/extconf.rb")
+ end
+
+ def files_of(dir)
+ Dir.open(dir) {|d|
+ return d.select {|ent| File.file?("#{dir}/#{ent}") }
+ }
+ end
+
+ DIR_REJECT = %w( . .. CVS SCCS RCS CVS.adm .svn )
+
+ def directories_of(dir)
+ Dir.open(dir) {|d|
+ return d.select {|ent| File.dir?("#{dir}/#{ent}") } - DIR_REJECT
+ }
+ end
+
+end
+
+
+# This module requires: #srcdir_root, #objdir_root, #relpath
+module HookScriptAPI
+
+ def get_config(key)
+ @config[key]
+ end
+
+ alias config get_config
+
+ # obsolete: use metaconfig to change configuration
+ def set_config(key, val)
+ @config[key] = val
+ end
+
+ #
+ # srcdir/objdir (works only in the package directory)
+ #
+
+ def curr_srcdir
+ "#{srcdir_root()}/#{relpath()}"
+ end
+
+ def curr_objdir
+ "#{objdir_root()}/#{relpath()}"
+ end
+
+ def srcfile(path)
+ "#{curr_srcdir()}/#{path}"
+ end
+
+ def srcexist?(path)
+ File.exist?(srcfile(path))
+ end
+
+ def srcdirectory?(path)
+ File.dir?(srcfile(path))
+ end
+
+ def srcfile?(path)
+ File.file?(srcfile(path))
+ end
+
+ def srcentries(path = '.')
+ Dir.open("#{curr_srcdir()}/#{path}") {|d|
+ return d.to_a - %w(. ..)
+ }
+ end
+
+ def srcfiles(path = '.')
+ srcentries(path).select {|fname|
+ File.file?(File.join(curr_srcdir(), path, fname))
+ }
+ end
+
+ def srcdirectories(path = '.')
+ srcentries(path).select {|fname|
+ File.dir?(File.join(curr_srcdir(), path, fname))
+ }
+ end
+
+end
+
+
+class ToplevelInstaller
+
+ Version = '3.4.1'
+ Copyright = 'Copyright (c) 2000-2005 Minero Aoki'
+
+ TASKS = [
+ [ 'all', 'do config, setup, then install' ],
+ [ 'config', 'saves your configurations' ],
+ [ 'show', 'shows current configuration' ],
+ [ 'setup', 'compiles ruby extentions and others' ],
+ [ 'install', 'installs files' ],
+ [ 'test', 'run all tests in test/' ],
+ [ 'clean', "does `make clean' for each extention" ],
+ [ 'distclean',"does `make distclean' for each extention" ]
+ ]
+
+ def ToplevelInstaller.invoke
+ config = ConfigTable.new(load_rbconfig())
+ config.load_standard_entries
+ config.load_multipackage_entries if multipackage?
+ config.fixup
+ klass = (multipackage?() ? ToplevelInstallerMulti : ToplevelInstaller)
+ klass.new(File.dirname($0), config).invoke
+ end
+
+ def ToplevelInstaller.multipackage?
+ File.dir?(File.dirname($0) + '/packages')
+ end
+
+ def ToplevelInstaller.load_rbconfig
+ if arg = ARGV.detect {|arg| /\A--rbconfig=/ =~ arg }
+ ARGV.delete(arg)
+ load File.expand_path(arg.split(/=/, 2)[1])
+ $".push 'rbconfig.rb'
+ else
+ require 'rbconfig'
+ end
+ ::Config::CONFIG
+ end
+
+ def initialize(ardir_root, config)
+ @ardir = File.expand_path(ardir_root)
+ @config = config
+ # cache
+ @valid_task_re = nil
+ end
+
+ def config(key)
+ @config[key]
+ end
+
+ def inspect
+ "#<#{self.class} #{__id__()}>"
+ end
+
+ def invoke
+ run_metaconfigs
+ case task = parsearg_global()
+ when nil, 'all'
+ parsearg_config
+ init_installers
+ exec_config
+ exec_setup
+ exec_install
+ else
+ case task
+ when 'config', 'test'
+ ;
+ when 'clean', 'distclean'
+ @config.load_savefile if File.exist?(@config.savefile)
+ else
+ @config.load_savefile
+ end
+ __send__ "parsearg_#{task}"
+ init_installers
+ __send__ "exec_#{task}"
+ end
+ end
+
+ def run_metaconfigs
+ @config.load_script "#{@ardir}/metaconfig"
+ end
+
+ def init_installers
+ @installer = Installer.new(@config, @ardir, File.expand_path('.'))
+ end
+
+ #
+ # Hook Script API bases
+ #
+
+ def srcdir_root
+ @ardir
+ end
+
+ def objdir_root
+ '.'
+ end
+
+ def relpath
+ '.'
+ end
+
+ #
+ # Option Parsing
+ #
+
+ def parsearg_global
+ while arg = ARGV.shift
+ case arg
+ when /\A\w+\z/
+ setup_rb_error "invalid task: #{arg}" unless valid_task?(arg)
+ return arg
+ when '-q', '--quiet'
+ @config.verbose = false
+ when '--verbose'
+ @config.verbose = true
+ when '--help'
+ print_usage $stdout
+ exit 0
+ when '--version'
+ puts "#{File.basename($0)} version #{Version}"
+ exit 0
+ when '--copyright'
+ puts Copyright
+ exit 0
+ else
+ setup_rb_error "unknown global option '#{arg}'"
+ end
+ end
+ nil
+ end
+
+ def valid_task?(t)
+ valid_task_re() =~ t
+ end
+
+ def valid_task_re
+ @valid_task_re ||= /\A(?:#{TASKS.map {|task,desc| task }.join('|')})\z/
+ end
+
+ def parsearg_no_options
+ unless ARGV.empty?
+ task = caller(0).first.slice(%r<`parsearg_(\w+)'>, 1)
+ setup_rb_error "#{task}: unknown options: #{ARGV.join(' ')}"
+ end
+ end
+
+ alias parsearg_show parsearg_no_options
+ alias parsearg_setup parsearg_no_options
+ alias parsearg_test parsearg_no_options
+ alias parsearg_clean parsearg_no_options
+ alias parsearg_distclean parsearg_no_options
+
+ def parsearg_config
+ evalopt = []
+ set = []
+ @config.config_opt = []
+ while i = ARGV.shift
+ if /\A--?\z/ =~ i
+ @config.config_opt = ARGV.dup
+ break
+ end
+ name, value = *@config.parse_opt(i)
+ if @config.value_config?(name)
+ @config[name] = value
+ else
+ evalopt.push [name, value]
+ end
+ set.push name
+ end
+ evalopt.each do |name, value|
+ @config.lookup(name).evaluate value, @config
+ end
+ # Check if configuration is valid
+ set.each do |n|
+ @config[n] if @config.value_config?(n)
+ end
+ end
+
+ def parsearg_install
+ @config.no_harm = false
+ @config.install_prefix = ''
+ while a = ARGV.shift
+ case a
+ when '--no-harm'
+ @config.no_harm = true
+ when /\A--prefix=/
+ path = a.split(/=/, 2)[1]
+ path = File.expand_path(path) unless path[0,1] == '/'
+ @config.install_prefix = path
+ else
+ setup_rb_error "install: unknown option #{a}"
+ end
+ end
+ end
+
+ def print_usage(out)
+ out.puts 'Typical Installation Procedure:'
+ out.puts " $ ruby #{File.basename $0} config"
+ out.puts " $ ruby #{File.basename $0} setup"
+ out.puts " # ruby #{File.basename $0} install (may require root privilege)"
+ out.puts
+ out.puts 'Detailed Usage:'
+ out.puts " ruby #{File.basename $0} <global option>"
+ out.puts " ruby #{File.basename $0} [<global options>] <task> [<task options>]"
+
+ fmt = " %-24s %s\n"
+ out.puts
+ out.puts 'Global options:'
+ out.printf fmt, '-q,--quiet', 'suppress message outputs'
+ out.printf fmt, ' --verbose', 'output messages verbosely'
+ out.printf fmt, ' --help', 'print this message'
+ out.printf fmt, ' --version', 'print version and quit'
+ out.printf fmt, ' --copyright', 'print copyright and quit'
+ out.puts
+ out.puts 'Tasks:'
+ TASKS.each do |name, desc|
+ out.printf fmt, name, desc
+ end
+
+ fmt = " %-24s %s [%s]\n"
+ out.puts
+ out.puts 'Options for CONFIG or ALL:'
+ @config.each do |item|
+ out.printf fmt, item.help_opt, item.description, item.help_default
+ end
+ out.printf fmt, '--rbconfig=path', 'rbconfig.rb to load',"running ruby's"
+ out.puts
+ out.puts 'Options for INSTALL:'
+ out.printf fmt, '--no-harm', 'only display what to do if given', 'off'
+ out.printf fmt, '--prefix=path', 'install path prefix', ''
+ out.puts
+ end
+
+ #
+ # Task Handlers
+ #
+
+ def exec_config
+ @installer.exec_config
+ @config.save # must be final
+ end
+
+ def exec_setup
+ @installer.exec_setup
+ end
+
+ def exec_install
+ @installer.exec_install
+ end
+
+ def exec_test
+ @installer.exec_test
+ end
+
+ def exec_show
+ @config.each do |i|
+ printf "%-20s %s\n", i.name, i.value if i.value?
+ end
+ end
+
+ def exec_clean
+ @installer.exec_clean
+ end
+
+ def exec_distclean
+ @installer.exec_distclean
+ end
+
+end # class ToplevelInstaller
+
+
+class ToplevelInstallerMulti < ToplevelInstaller
+
+ include FileOperations
+
+ def initialize(ardir_root, config)
+ super
+ @packages = directories_of("#{@ardir}/packages")
+ raise 'no package exists' if @packages.empty?
+ @root_installer = Installer.new(@config, @ardir, File.expand_path('.'))
+ end
+
+ def run_metaconfigs
+ @config.load_script "#{@ardir}/metaconfig", self
+ @packages.each do |name|
+ @config.load_script "#{@ardir}/packages/#{name}/metaconfig"
+ end
+ end
+
+ attr_reader :packages
+
+ def packages=(list)
+ raise 'package list is empty' if list.empty?
+ list.each do |name|
+ raise "directory packages/#{name} does not exist"\
+ unless File.dir?("#{@ardir}/packages/#{name}")
+ end
+ @packages = list
+ end
+
+ def init_installers
+ @installers = {}
+ @packages.each do |pack|
+ @installers[pack] = Installer.new(@config,
+ "#{@ardir}/packages/#{pack}",
+ "packages/#{pack}")
+ end
+ with = extract_selection(config('with'))
+ without = extract_selection(config('without'))
+ @selected = @installers.keys.select {|name|
+ (with.empty? or with.include?(name)) \
+ and not without.include?(name)
+ }
+ end
+
+ def extract_selection(list)
+ a = list.split(/,/)
+ a.each do |name|
+ setup_rb_error "no such package: #{name}" unless @installers.key?(name)
+ end
+ a
+ end
+
+ def print_usage(f)
+ super
+ f.puts 'Inluded packages:'
+ f.puts ' ' + @packages.sort.join(' ')
+ f.puts
+ end
+
+ #
+ # Task Handlers
+ #
+
+ def exec_config
+ run_hook 'pre-config'
+ each_selected_installers {|inst| inst.exec_config }
+ run_hook 'post-config'
+ @config.save # must be final
+ end
+
+ def exec_setup
+ run_hook 'pre-setup'
+ each_selected_installers {|inst| inst.exec_setup }
+ run_hook 'post-setup'
+ end
+
+ def exec_install
+ run_hook 'pre-install'
+ each_selected_installers {|inst| inst.exec_install }
+ run_hook 'post-install'
+ end
+
+ def exec_test
+ run_hook 'pre-test'
+ each_selected_installers {|inst| inst.exec_test }
+ run_hook 'post-test'
+ end
+
+ def exec_clean
+ rm_f @config.savefile
+ run_hook 'pre-clean'
+ each_selected_installers {|inst| inst.exec_clean }
+ run_hook 'post-clean'
+ end
+
+ def exec_distclean
+ rm_f @config.savefile
+ run_hook 'pre-distclean'
+ each_selected_installers {|inst| inst.exec_distclean }
+ run_hook 'post-distclean'
+ end
+
+ #
+ # lib
+ #
+
+ def each_selected_installers
+ Dir.mkdir 'packages' unless File.dir?('packages')
+ @selected.each do |pack|
+ $stderr.puts "Processing the package `#{pack}' ..." if verbose?
+ Dir.mkdir "packages/#{pack}" unless File.dir?("packages/#{pack}")
+ Dir.chdir "packages/#{pack}"
+ yield @installers[pack]
+ Dir.chdir '../..'
+ end
+ end
+
+ def run_hook(id)
+ @root_installer.run_hook id
+ end
+
+ # module FileOperations requires this
+ def verbose?
+ @config.verbose?
+ end
+
+ # module FileOperations requires this
+ def no_harm?
+ @config.no_harm?
+ end
+
+end # class ToplevelInstallerMulti
+
+
+class Installer
+
+ FILETYPES = %w( bin lib ext data conf man )
+
+ include FileOperations
+ include HookScriptAPI
+
+ def initialize(config, srcroot, objroot)
+ @config = config
+ @srcdir = File.expand_path(srcroot)
+ @objdir = File.expand_path(objroot)
+ @currdir = '.'
+ end
+
+ def inspect
+ "#<#{self.class} #{File.basename(@srcdir)}>"
+ end
+
+ def noop(rel)
+ end
+
+ #
+ # Hook Script API base methods
+ #
+
+ def srcdir_root
+ @srcdir
+ end
+
+ def objdir_root
+ @objdir
+ end
+
+ def relpath
+ @currdir
+ end
+
+ #
+ # Config Access
+ #
+
+ # module FileOperations requires this
+ def verbose?
+ @config.verbose?
+ end
+
+ # module FileOperations requires this
+ def no_harm?
+ @config.no_harm?
+ end
+
+ def verbose_off
+ begin
+ save, @config.verbose = @config.verbose?, false
+ yield
+ ensure
+ @config.verbose = save
+ end
+ end
+
+ #
+ # TASK config
+ #
+
+ def exec_config
+ exec_task_traverse 'config'
+ end
+
+ alias config_dir_bin noop
+ alias config_dir_lib noop
+
+ def config_dir_ext(rel)
+ extconf if extdir?(curr_srcdir())
+ end
+
+ alias config_dir_data noop
+ alias config_dir_conf noop
+ alias config_dir_man noop
+
+ def extconf
+ ruby "#{curr_srcdir()}/extconf.rb", *@config.config_opt
+ end
+
+ #
+ # TASK setup
+ #
+
+ def exec_setup
+ exec_task_traverse 'setup'
+ end
+
+ def setup_dir_bin(rel)
+ files_of(curr_srcdir()).each do |fname|
+ update_shebang_line "#{curr_srcdir()}/#{fname}"
+ end
+ end
+
+ alias setup_dir_lib noop
+
+ def setup_dir_ext(rel)
+ make if extdir?(curr_srcdir())
+ end
+
+ alias setup_dir_data noop
+ alias setup_dir_conf noop
+ alias setup_dir_man noop
+
+ def update_shebang_line(path)
+ return if no_harm?
+ return if config('shebang') == 'never'
+ old = Shebang.load(path)
+ if old
+ $stderr.puts "warning: #{path}: Shebang line includes too many args. It is not portable and your program may not work." if old.args.size > 1
+ new = new_shebang(old)
+ return if new.to_s == old.to_s
+ else
+ return unless config('shebang') == 'all'
+ new = Shebang.new(config('rubypath'))
+ end
+ $stderr.puts "updating shebang: #{File.basename(path)}" if verbose?
+ open_atomic_writer(path) {|output|
+ File.open(path, 'rb') {|f|
+ f.gets if old # discard
+ output.puts new.to_s
+ output.print f.read
+ }
+ }
+ end
+
+ def new_shebang(old)
+ if /\Aruby/ =~ File.basename(old.cmd)
+ Shebang.new(config('rubypath'), old.args)
+ elsif File.basename(old.cmd) == 'env' and old.args.first == 'ruby'
+ Shebang.new(config('rubypath'), old.args[1..-1])
+ else
+ return old unless config('shebang') == 'all'
+ Shebang.new(config('rubypath'))
+ end
+ end
+
+ def open_atomic_writer(path, &block)
+ tmpfile = File.basename(path) + '.tmp'
+ begin
+ File.open(tmpfile, 'wb', &block)
+ File.rename tmpfile, File.basename(path)
+ ensure
+ File.unlink tmpfile if File.exist?(tmpfile)
+ end
+ end
+
+ class Shebang
+ def Shebang.load(path)
+ line = nil
+ File.open(path) {|f|
+ line = f.gets
+ }
+ return nil unless /\A#!/ =~ line
+ parse(line)
+ end
+
+ def Shebang.parse(line)
+ cmd, *args = *line.strip.sub(/\A\#!/, '').split(' ')
+ new(cmd, args)
+ end
+
+ def initialize(cmd, args = [])
+ @cmd = cmd
+ @args = args
+ end
+
+ attr_reader :cmd
+ attr_reader :args
+
+ def to_s
+ "#! #{@cmd}" + (@args.empty? ? '' : " #{@args.join(' ')}")
+ end
+ end
+
+ #
+ # TASK install
+ #
+
+ def exec_install
+ rm_f 'InstalledFiles'
+ exec_task_traverse 'install'
+ end
+
+ def install_dir_bin(rel)
+ install_files targetfiles(), "#{config('bindir')}/#{rel}", 0755
+ end
+
+ def install_dir_lib(rel)
+ install_files libfiles(), "#{config('rbdir')}/#{rel}", 0644
+ end
+
+ def install_dir_ext(rel)
+ return unless extdir?(curr_srcdir())
+ install_files rubyextentions('.'),
+ "#{config('sodir')}/#{File.dirname(rel)}",
+ 0555
+ end
+
+ def install_dir_data(rel)
+ install_files targetfiles(), "#{config('datadir')}/#{rel}", 0644
+ end
+
+ def install_dir_conf(rel)
+ # FIXME: should not remove current config files
+ # (rename previous file to .old/.org)
+ install_files targetfiles(), "#{config('sysconfdir')}/#{rel}", 0644