jruby-ehcache 0.5.0

data/History.txt

@@ -0,0 +1,15 @@
+== 0.0.3 2008-08-20
+* 1 bug fix
+  * removed un-needed marshalling
+* 1 major enhancement
+  * added support for configurable bootstrap cache loader and event listener
+
+== 0.0.2 2008-06-08
+
+* 1 bug fix
+  * add mutex, and marshalling for serialization to cache
+
+== 0.0.1 2008-06-05
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2008 Dylan Stamat
+
+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,37 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+bin/ehcache
+config/ehcache.yml
+config/hoe.rb
+config/requirements.rb
+ext/ehcache-1.4.1/ehcache-1.4.1-remote-debugger.jar
+ext/ehcache-1.4.1/ehcache-1.4.1.jar
+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
+ext/rails/ehcache_store.rb
+lib/ehcache.rb
+lib/ehcache/cache.rb
+lib/ehcache/cache_manager.rb
+lib/ehcache/config.rb
+lib/ehcache/element.rb
+lib/ehcache/extensions.rb
+lib/ehcache/java.rb
+lib/ehcache/status.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

data/PostInstall.txt

@@ -0,0 +1,2 @@
+For more information on this gem, and Ehcache proper, see:
+http://github.com/dylanz/ehcache/tree/master/README.txt

data/README.txt

@@ -0,0 +1,84 @@
+= Ehcache for JRuby
+
+http://github.com/dylanz/ehcache
+
+== DESCRIPTION:
+
+Ehcache is a simplified JRuby interface to Java's (JSR-107 compliant) Ehcache.
+Simplified meaning that it should work out-of-the-box, but a lot of native
+methods haven't been interfaced yet, as they weren't needed.  Configuration
+occurs in config/ehcache.yml, and should support all the configuration
+options available.
+
+Some biased and non-biased Ehcache VS Memcache articles:
+http://gregluck.com/blog/archives/2007/05/comparing_memca.html
+http://feedblog.org/2007/05/21/unfair-benchmarks-of-ehcache-vs-memcached
+http://blog.aristotlesdog.com/2008/05/01/memcached_vs_ehcache/
+http://www.hugotroche.com/my_weblog/2008/06/ehcache-vs-memc.html
+
+For more information on Ehcache, see:
+http://www.ehcache.org/
+
+Configuration, Code Samples and everything else, see:
+http://ehcache.org/documentation/index.html
+
+Google Groups:
+http://groups.google.com/group/ehcache-jruby
+
+Tickets:
+http://dylanz.lighthouseapp.com/projects/14518-ehcache-jruby/overview
+
+
+== BASIC USAGE:
+
+manager = CacheManager.new
+cache = manager.cache
+cache.put("key", "value", {:ttl => 120})
+cache.get("key")
+manager.shutdown
+
+
+== RAILS:
+
+Rails 2 and Rails 3 integration are provided by the separate ehcache-rails2
+and ehcache-rails3 gems.  To install, choose the correct version for your
+Rails application and use JRuby's gem command to install, e.g.:
+
+$ jgem install ehcache-rails3
+OR
+$ jruby -S gem install ehcache-rails3
+
+
+== REQUIREMENTS:
+
+Tested with JRuby 1.5.0.
+
+
+== INSTALL:
+
+$ sudo jruby -S gem install ehcache
+
+
+== LICENSE:
+Copyright (c) 2008 Dylan Stamat <dstamat@elctech.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/Rakefile

@@ -0,0 +1,46 @@
+begin
+  require 'jeweler'
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+def defaults(gemspec)
+  gemspec.rubyforge_project = 'ehcache'
+  gemspec.homepage = "http://ehcache.rubyforge.org"
+  gemspec.authors = ["Dylan Stamat", "Jason Voegele"]
+  gemspec.email = ['dstamat@elctech.com', 'jvoegele@terracotta.org']
+end
+
+Jeweler::Tasks.new do |gemspec|
+  defaults(gemspec)
+  gemspec.name = "jruby-ehcache"
+  gemspec.summary = "JRuby interface to Ehcache"
+  gemspec.description = "JRuby interface to the popular Java caching library Ehcache"
+  gemspec.files.exclude '.gitignore'
+
+  # These files go in the ehcache-rails2 and ehcache-rails3 gems
+  gemspec.files.exclude 'lib/ehcache_store.rb'
+  gemspec.files.exclude 'lib/active_support/**/*'
+end
+
+Jeweler::Tasks.new do |gemspec|
+  defaults(gemspec)
+  gemspec.name = 'ehcache-rails3'
+  gemspec.summary = 'Rails 3 cache store provider using Ehcache'
+  gemspec.description = 'Rails 3 cache store provider using Ehcache'
+  gemspec.files = 'lib/active_support/**/*'
+  gemspec.test_files = []
+  gemspec.add_dependency 'jruby-ehcache', ">=0.5.0"
+end
+
+Jeweler::Tasks.new do |gemspec|
+  defaults(gemspec)
+  gemspec.name = 'ehcache-rails2'
+  gemspec.summary = 'Rails 2 cache store provider using Ehcache'
+  gemspec.description = 'Rails 2 cache store provider using Ehcache'
+  gemspec.files = 'lib/ehcache_store.rb'
+  gemspec.test_files = []
+  gemspec.add_dependency 'jruby-ehcache', ">=0.5.0"
+end
+
+Jeweler::GemcutterTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/bin/ehcache

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require 'rake'
+require 'rubygems'
+require 'ehcache'
+
+# TODO:  optionparser this up once anything else is added
+if $*.pop == "rails"
+  unless File.exists?("config/boot.rb")
+    abort "Oops... make sure you are running this from your RAILS_ROOT"
+  end
+
+  # copy default ehcache.yml into config/
+  if File.exists?("config/ehcache.yml")
+    warn "It looks like ehcache.yml already exists in config/"
+  else
+    FileUtils.cp("#{Ehcache::EHCACHE_HOME}/config/ehcache.yml", "config/")
+  end
+
+  # add ehcache store 
+  if File.exists?("lib/ehcache_store.rb")
+    warn "It looks like ehcache_store.rb already exists in lib/"
+  else
+    FileUtils.cp("#{Ehcache::EHCACHE_HOME}/ext/rails/ehcache_store.rb", "lib/")
+  end
+else
+  warn "Usage: specify 'rails' as an argument to install required files"
+end

data/config/ehcache.yml

@@ -0,0 +1,22 @@
+disk:
+  path: java.io.tmpdir
+
+peer_provider:
+  class: net.sf.ehcache.distribution.RMICacheManagerPeerProviderFactory
+  properties: peerDiscovery=automatic,multicastGroupAddress=230.0.0.1,multicastGroupPort=4446,timeToLive=1
+  property_separator: "\,"
+
+peer_listener:
+  class: net.sf.ehcache.distribution.RMICacheManagerPeerListenerFactory
+
+default:
+  name: cache
+  max_elements_in_memory:  10000
+  time_to_live_seconds:  0
+  time_to_idle_seconds:  0
+  overflow_to_disk: true
+  eternal: false
+  disk_spool_buffer_size_mb: 30
+  disk_persistent: false
+  disk_expiry_thread_interval_seconds: 120
+  memory_store_eviction_policy: LRU

data/config/ehcache_manual_rmi.yml

@@ -0,0 +1,27 @@
+disk:
+  path: java.io.tmpdir
+
+peer_provider:
+  class: net.sf.ehcache.distribution.RMICacheManagerPeerProviderFactory
+  properties: peerDiscovery=manual,rmiUrls=//that_hostname:40001/cache
+  property_separator: "\,"
+
+peer_listener:
+  class: net.sf.ehcache.distribution.RMICacheManagerPeerListenerFactory
+  properties: hostName=this_hostname,port=40000
+
+default:
+  name: cache
+  max_elements_in_memory:  10000
+  time_to_live_seconds:  0
+  time_to_idle_seconds:  0
+  overflow_to_disk: true
+  eternal: false
+  disk_spool_buffer_size_mb: 30
+  disk_persistent: false
+  disk_expiry_thread_interval_seconds: 120
+  memory_store_eviction_policy: LRU
+  event_listener: { class: net.sf.ehcache.distribution.RMICacheReplicatorFactory }
+  bootstrap_loader: { class: net.sf.ehcache.distribution.RMIBootstrapCacheLoaderFactory,
+                      properties: 'bootstrapAsynchronously=true,maximumChunkSizeBytes=5000000',
+                      property_separator: "\," }

data/lib/ehcache.rb

@@ -0,0 +1,22 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'java'
+
+module Ehcache
+  unless defined?(EHCACHE_HOME)
+    EHCACHE_HOME = File.expand_path(File.dirname(__FILE__) + '/..')
+  end
+
+  # wraps all native exceptions
+  class EhcacheError < RuntimeError; end
+end
+
+require 'ehcache/java'
+require 'ehcache/config'
+require 'ehcache/cache'
+require 'ehcache/cache_manager'
+require 'ehcache/element'
+require 'ehcache/extensions'
+require 'ehcache/version'
+require 'ehcache/status'

data/lib/ehcache/cache.rb

@@ -0,0 +1,127 @@
+module Ehcache
+  class Cache
+    PRIMARY = "cache"
+
+    # pull cache from given manager by name
+    def initialize(manager, cache_name)
+      @proxy = manager.get_cache(cache_name)
+    end
+
+    # put a new element into the cache
+    def put(key, value, options = {})
+      if key.nil? || key.empty?
+        raise EhcacheError, "Element cannot be blank"
+      end
+      element = Ehcache::Element.new(key, value, options)
+      @proxy.put(element.proxy)
+    rescue NativeException => e
+      raise EhcacheError, e.cause
+    end
+    alias_method :set, :put
+    alias_method :add, :put
+
+    # another alias for put
+    def []=(key, value)
+      put(key, value)
+    end
+
+    # get an element value from cache by key
+    def get(key)
+      element = @proxy.get(key)
+      element ? element.get_value : nil
+    rescue NativeException => e
+      raise EhcacheError, e.cause
+    end
+    alias_method :[], :get
+
+    # get an element from cache by key
+    def element(key)
+      element = @proxy.get(key)
+      return nil unless element
+      Ehcache::Element.new(element.get_key, element.get_value,
+        {:ttl => element.get_time_to_live })
+    rescue NativeException => e
+      raise EhcacheError, e.cause
+    end
+
+    # remove an element from the cache by key
+    def remove(key)
+      @proxy.remove(key)
+    rescue NativeException => e
+      raise EhcacheError, e.cause
+    end
+    alias_method :delete, :remove
+
+    # remove all elements from the cache
+    def remove_all
+      @proxy.remove_all
+    rescue NativeException => e
+      raise EhcacheError, e.cause
+    end
+    alias_method :clear, :remove_all
+
+    def keys
+      @proxy.get_keys
+    end
+
+    def exist?(key)
+      @proxy.is_key_in_cache(key)
+    end
+
+    # returns the current status of the cache
+    def status
+      @proxy.get_status
+    end
+
+    def alive?
+      @proxy.get_status == Status::ALIVE
+    end
+
+    def shutdown?
+      @proxy.get_status == Status::SHUTDOWN
+    end
+
+    def uninitialized?
+      @proxy.get_status == Status::UNINITIALISED
+    end
+
+    # number of elements in the cache
+    def size
+      @proxy.get_size
+    end
+
+    # number of elements in the memory store
+    def memory_size
+      @proxy.get_memory_store_size
+    end
+
+    # number of elements in the cache store
+    def disk_size
+      @proxy.get_disk_store_size
+    end
+
+    # TODO: implement statistics !
+    # return statistics about the cache
+    def statistics
+      @proxy.get_statistics
+    rescue NativeException => e
+      raise EhcacheError, e.cause
+    end
+
+    def max_elements
+      @proxy.get_max_elements_in_memory
+    end
+
+    def eternal?
+      @proxy.is_eternal
+    end
+    
+    def ttl
+      @proxy.get_time_to_live_seconds
+    end
+
+    def tti
+      @proxy.get_time_to_idle_seconds
+    end
+  end
+end