jruby-ehcache-rails2 0.5.0 → 1.0.0

data/README.txt

@@ -1,14 +1,14 @@
-= Ehcache for JRuby
+= jruby-ehcache - 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.
+jruby-ehcache is a JRuby interface to Java's (JSR-107 compliant) Ehcache.
+It provides 100% full coverage of the native Ehcache API and also provides
+some Rubyesque enhancements to make it idiomatic to Ruby developers.
+Configuration is done with the traditional ehcache.xml file that Java
+developers use.
 
 Some biased and non-biased Ehcache VS Memcache articles:
 http://gregluck.com/blog/archives/2007/05/comparing_memca.html
@@ -30,33 +30,35 @@ http://dylanz.lighthouseapp.com/projects/14518-ehcache-jruby/overview
 
 
 == BASIC USAGE:
-
+require 'ehcache'
 manager = CacheManager.new
 cache = manager.cache
 cache.put("key", "value", {:ttl => 120})
-cache.get("key")
+cache.get("key")  # => returns the Ehcache Element object
+cache["key"]      # => returns "value", the value of the Element
 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.:
+Rails 2 and Rails 3 integration are provided by the separate
+jruby-ehcache-rails2 and jruby-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
+$ jgem install jruby-ehcache-rails3
 OR
-$ jruby -S gem install ehcache-rails3
+$ jruby -S gem install jruby-ehcache-rails3
 
 
 == REQUIREMENTS:
 
-Tested with JRuby 1.5.0.
+Tested with JRuby 1.5.3.
 
 
 == INSTALL:
 
-$ sudo jruby -S gem install ehcache
+$ sudo jruby -S gem install jruby-ehcache
 
 
 == LICENSE:

data/lib/active_support/cache/ehcache_store.rb

@@ -0,0 +1,66 @@
+require 'ehcache/rails/ehcache_rails_common'
+
+module ActiveSupport
+  module Cache
+
+    # Rails 3 cache store implementation which stores data in Ehcache:
+    # http://www.ehcache.org/
+    class EhcacheStore < Store
+      include Ehcache::Rails
+
+      def initialize(*args)
+        args = args.flatten
+        options = args.extract_options!
+        super(*options)
+        @ehcache = self.create_cache   # This comes from the Ehcache::Rails mixin.
+        extend Strategy::LocalCache
+      end
+
+      def increment(name, amount = 1, options = nil) # :nodoc:
+        @ehcache.compare_and_swap(name) { |current_value|
+          current_value + amount
+        }
+      end
+
+      def decrement(name, amount = 1, options = nil) # :nodoc:
+        @ehcache.compare_and_swap(name) { |current_value|
+          current_value - amount
+        }
+      end
+
+      def clear(options = nil)
+        @ehcache.remove_all
+      end
+
+      def stats
+        @ehcache.statistics
+      end
+
+      protected
+      # Read an entry from the cache.
+      def read_entry(key, options) # :nodoc:
+        @ehcache[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:
+        @ehcache.put(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:
+        @ehcache.remove(key)
+      rescue Exception => e
+        logger.error("EhcacheError (#{e}): #{e.message}")
+        false
+      end
+    end
+  end
+end

data/lib/ehcache/rails/ehcache_rails_common.rb

@@ -0,0 +1,37 @@
+begin
+  require 'ehcache'
+rescue LoadError => e
+  $stderr.puts "You don't have ehcache installed in your application."
+  $stderr.puts "Please add it to your Gemfile and run bundle install"
+  raise e
+end
+
+module Ehcache
+  # Mixin module providing facilities for the Rails 2 and Rails 3 Cache::Store
+  # implementations.
+  module Rails
+
+    RAILS_CONFIG_DIR =
+        if defined?(::Rails)
+          File.join(::Rails.root.to_s, 'config')
+        elsif defined?(RAILS_ROOT)
+          File.join(RAILS_ROOT, 'config')
+        end
+
+    DEFAULT_RAILS_CACHE_NAME = 'rails_cache'
+
+    def create_cache_manager(*args)
+      config = Ehcache::Config::Configuration.find(RAILS_CONFIG_DIR)
+      @cache_manager = Ehcache::CacheManager.create(config)
+    end
+
+    def create_cache(name = DEFAULT_RAILS_CACHE_NAME)
+      create_cache_manager if @cache_manager.nil?
+      @cache = @cache_manager.cache(name)
+    end
+
+    at_exit do
+      @cache_manager.shutdown if @cache_manager
+    end
+  end
+end

metadata

@@ -3,10 +3,10 @@ name: jruby-ehcache-rails2
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
+    - 1
     - 0
-    - 5
     - 0
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors: 
   - Dylan Stamat
@@ -15,22 +15,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-24 00:00:00 -04:00
+date: 2010-11-15 00:00:00 -05: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: 
+              - 1
               - 0
-              - 5
               - 0
-            version: 0.5.0
+            version: 1.0.0
     type: :runtime
     version_requirements: *id001
 description: Rails 2 cache store provider using Ehcache
@@ -44,9 +43,9 @@ extensions: []
 extra_rdoc_files: 
   - README.txt
 files: 
-  - lib/ehcache_store.rb
+  - lib/active_support/cache/ehcache_store.rb
+  - lib/ehcache/rails/ehcache_rails_common.rb
   - README.txt
-  - bin/ehcache
 has_rdoc: true
 homepage: http://ehcache.rubyforge.org
 licenses: []
@@ -57,7 +56,6 @@ rdoc_options:
 require_paths: 
   - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -65,7 +63,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
           - 0
         version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -75,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: ehcache
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Rails 2 cache store provider using Ehcache

data/lib/ehcache_store.rb

@@ -1,59 +0,0 @@
-require 'activesupport'
-require 'ehcache'
-
-module ActiveSupport
-  module Cache
-    class EhcacheStore < Store
-      def initialize(options = {})
-        manager = Ehcache::CacheManager.new(options)
-        @data = manager.cache
-      end
-
-      def read(key, options = nil)
-        super
-        @data.get(key)
-      rescue Ehcache::EhcacheError => e
-        logger.error("EhcacheError (#{e}): #{e.message}")
-        false
-      end
-
-      def write(key, value, options = nil)
-        super
-        @data.set(key, value, options)
-        true
-      rescue Ehcache::EhcacheError => e
-        logger.error("EhcacheError (#{e}): #{e.message}")
-        false
-      end
-
-      def delete(key, options = nil)
-        super
-        @data.delete(key)
-      rescue Exception => e
-        logger.error("EhcacheError (#{e}): #{e.message}")
-        false
-      end
-
-      def keys
-        @data.keys
-      end
-
-      def exist?(key, options = nil)
-        @data.exist?(key)
-      end
-
-      def delete_matched(matcher, options = nil)
-        super
-        raise "Not supported by Ehcache"
-      end
-
-      def clear
-        @data.clear
-        true
-      rescue Exception => e
-        logger.error("EhcacheError (#{e}): #{e.message}")
-        false
-      end
-    end
-  end
-end