jruby-ehcache-rails3 0.5.0

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/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/lib/active_support/cache/ehcache_store.rb

@@ -0,0 +1,76 @@
+begin
+  require 'ehcache'
+rescue LoadError => e
+  $stderr.puts "You don't have ehcache installed in your application. Please add it to your Gemfile and run bundle install"
+  raise e
+end
+#require 'digest/md5'
+
+module ActiveSupport
+  module Cache
+    # A cache store implementation which stores data in Ehcache:
+    # http://www.ehcache.org/
+    class EhcacheStore < Store
+
+      def initialize(*args)
+        super(*args)
+        @data = Ehcache::CacheManager.new.cache
+        extend Strategy::LocalCache
+      end
+
+      def increment(name, amount = 1, options = nil) # :nodoc:
+        if num = @data.get(name)
+          num = num.to_i + amount
+          @data.put(name, num, options)
+          num
+        else
+          nil
+        end
+      end
+
+      def decrement(name, amount = 1, options = nil) # :nodoc:
+        if num = @data.get(name)
+          num = num.to_i - amount
+          @data.put(name, num, options)
+          num
+        else
+          nil
+        end
+      end
+
+      def clear(options = nil)
+        @data.remove_all
+      end
+
+      def stats
+        @data.statistics
+      end
+
+      protected
+      # Read an entry from the cache.
+      def read_entry(key, options) # :nodoc:
+        @data.get(key)
+      rescue Ehcache::EhcacheError => e
+        logger.error("EhcacheError (#{e}): #{e.message}")
+        false
+      end
+
+      # Write an entry to the cache.
+      def write_entry(key, entry, options) # :nodoc:
+        @data.set(key, entry, options)
+        true
+      rescue Ehcache::EhcacheError => e
+        logger.error("EhcacheError (#{e}): #{e.message}")
+        false
+      end
+
+      # Delete an entry from the cache.
+      def delete_entry(key, options) # :nodoc:
+        @data.delete(key)
+      rescue Exception => e
+        logger.error("EhcacheError (#{e}): #{e.message}")
+        false
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: jruby-ehcache-rails3
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+    - 0
+    - 5
+    - 0
+  version: 0.5.0
+platform: ruby
+authors: 
+  - Dylan Stamat
+  - Jason Voegele
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-24 00:00:00 -04:00
+default_executable: ehcache
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: jruby-ehcache
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 0
+              - 5
+              - 0
+            version: 0.5.0
+    type: :runtime
+    version_requirements: *id001
+description: Rails 3 cache store provider using Ehcache
+email: 
+  - dstamat@elctech.com
+  - jvoegele@terracotta.org
+executables: 
+  - ehcache
+extensions: []
+
+extra_rdoc_files: 
+  - README.txt
+files: 
+  - lib/active_support/cache/ehcache_store.rb
+  - README.txt
+  - bin/ehcache
+has_rdoc: true
+homepage: http://ehcache.rubyforge.org
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+  - --charset=UTF-8
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+requirements: []
+
+rubyforge_project: ehcache
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rails 3 cache store provider using Ehcache
+test_files: []
+