torquebox-cache 2.3.2-java → 3.0.0.beta1-java

data/lib/active_support/cache/torque_box_store.rb

@@ -59,11 +59,11 @@ module ActiveSupport
 
         # Get the current entry
         key = namespaced_key( name, options )
-        current = cache.get(key)
-        value = decode(current).value.to_i
+        current = read_entry(key, options)
+        value = current.value.to_i
 
         new_entry = Entry.new( value+amount, options )
-        if cache.replace( key, current, encode(new_entry) )
+        if cache.replace(key, current, new_entry)
           return new_entry.value
         else
           raise "Concurrent modification, old value was #{value}"
@@ -90,14 +90,6 @@ module ActiveSupport
         {:name=>'__torque_box_store__', :mode => :invalidation, :sync => false}
       end
 
-      def encode value
-        Marshal.dump(value).to_java_bytes
-      end
-
-      def decode value
-        value && Marshal.load(String.from_java_bytes(value))
-      end
-      
       # Return the keys in the cache; potentially very expensive depending on configuration
       def keys
         cache.keys
@@ -105,12 +97,13 @@ module ActiveSupport
 
       # Read an entry from the cache implementation. Subclasses must implement this method.
       def read_entry(key, options)
-        decode( cache.get( key ) )
+        cache.get( key )
       end
 
       # Write an entry to the cache implementation. Subclasses must implement this method.
       def write_entry(key, entry, options = {})
-        options[:unless_exist] ? cache.put_if_absent( key, encode(entry) ) : cache.put( key, encode(entry) )
+        previous_value = options[:unless_exist] ? cache.put_if_absent( key, entry ) : cache.put( key, entry )
+        previous_value unless previous_value.nil?
       end
 
       # Delete an entry from the cache implementation. Subclasses must implement this method.
@@ -127,4 +120,3 @@ module ActiveSupport
     end
   end
 end
-

data/lib/active_support/cache/torquebox_store.rb

@@ -0,0 +1,2 @@
+# This assignment allows :torquebox_store to work as a symbol
+ActiveSupport::Cache::TorqueboxStore = ActiveSupport::Cache::TorqueBoxStore

data/lib/cache.rb

@@ -18,14 +18,13 @@
 require 'torquebox/kernel'
 require 'torquebox/injectors'
 require 'torquebox/transactions'
-require 'sequence'
+require 'torquebox/codecs'
 
 module TorqueBox
   module Infinispan
 
     # @api private
     class ContainerTransactionManagerLookup
-      include TorqueBox::Injectors
       begin
         include org.infinispan.transaction.lookup.TransactionManagerLookup
       rescue NameError
@@ -33,22 +32,11 @@ module TorqueBox
       end
 
       def getTransactionManager
-        fetch('transaction-manager')
-      end
-    end
-
-    class NoOpCodec
-      def self.encode(object)
-        object
-      end
-
-      def self.decode(object)
-        object
+        TorqueBox.fetch('transaction-manager')
       end
     end
 
     class Cache
-      include TorqueBox::Injectors
 
       SECONDS = java.util.concurrent.TimeUnit::SECONDS
       begin
@@ -56,6 +44,7 @@ module TorqueBox
         java_import org.infinispan.configuration.cache::ConfigurationBuilder
         java_import org.infinispan.transaction::TransactionMode
         java_import org.infinispan.transaction::LockingMode
+        java_import org.infinispan.eviction::EvictionStrategy
         java_import org.projectodd.polyglot.cache.as::CacheService
         INFINISPAN_AVAILABLE = true
       rescue NameError => e
@@ -69,6 +58,13 @@ module TorqueBox
         options[:transaction_mode] = :transactional unless options.has_key?( :transaction_mode )
         options[:locking_mode] ||= :optimistic if (transactional? && !options.has_key?( :locking_mode ))
         options[:sync] = true if options[:sync].nil?
+        if options[:encoding] == :marshal
+          log( "Encoding of :marshal cannot be used with " +
+               "TorqueBox::Infinispan::Cache - using :marshal_base64 instead",
+               'WARN')
+          options[:encoding] = :marshal_base64
+        end
+        @codec = TorqueBox::Codecs[ options[:encoding] || :marshal_smart ]
         cache
       end
 
@@ -77,7 +73,7 @@ module TorqueBox
       end
 
       def persisted?
-        !options[:persist].nil?
+        !!options[:persist]
       end
 
       def replicated?
@@ -126,77 +122,82 @@ module TorqueBox
         transaction_mode == TransactionMode::TRANSACTIONAL
       end
 
+      def eviction_strategy
+        case options[:eviction]
+        when :lirs then EvictionStrategy::LIRS
+        when :lru then EvictionStrategy::LRU
+        when :unordered then EvictionStrategy::UNORDERED
+        end
+      end
+
+      def max_entries
+        options[:max_entries] || -1
+      end
+
       # Clear the entire cache. Be careful with this method since it could
       # affect other processes if shared cache is being used.
       def clear
-        cache.clearAsync
+        cache.clear
       end
 
       # Return the keys in the cache; potentially very expensive depending on configuration
       def keys
-        cache.key_set
+        cache.key_set.map{|k| decode(k)}
+      end
+
+      def size
+        cache.size
       end
 
       def all
-        cache.key_set.collect{|k| get(k)}
+        keys.map{|k| get(k)}
       end
+      alias_method :values, :all
 
       def contains_key?( key )
-        cache.contains_key( key.to_s )
+        cache.contains_key( encode(key) )
       end
 
       # Get an entry from the cache 
       def get(key)
-        cache.get( key.to_s )
+        decode(cache.get(encode(key)))
       end
+      alias_method :[], :get
 
       # Write an entry to the cache 
       def put(key, value, expires = 0)
-        __put(key, value, expires, :put_async)
+        __put(key, value, expires, :put)
       end
+      alias_method :[]=, :put
 
       def put_if_absent(key, value, expires = 0)
-        __put(key, value, expires, :put_if_absent_async)
+        __put(key, value, expires, :put_if_absent)
       end
 
       def evict( key )
-        cache.evict( key.to_s )
+        cache.evict( encode(key) )
       end
 
-      def replace(key, original_value, new_value, codec=NoOpCodec)
-        # First, grab the raw value from the cache, which is a byte[]
-
-        current = get( key )
-        decoded = codec.decode( current )
-
-        # great!  we've got a byte[] now.  Let's apply == to it, like Jim says will work always
-
-        if ( decoded == original_value )
-           # how does this work?
-           cache.replace( key.to_s, current, codec.encode( new_value ) )
-        end
+      def replace(key, original_value, new_value)
+        cache.replace(encode(key), encode(original_value), encode(new_value))
       end
 
-      # Delete an entry from the cache 
+      # Delete an entry from the cache
       def remove(key)
-        cache.removeAsync( key.to_s ) && true
+        decode(cache.remove(encode(key)))
       end
 
-      def increment( sequence_name, amount = 1 )
-        current_entry = Sequence::Codec.decode( get( sequence_name )  )
-
-        # If we can't find the sequence in the cache, create a new one and return
-        put( sequence_name, Sequence::Codec.encode( Sequence.new( amount ) ) ) and return amount if current_entry.nil?
-
-        # Increment the sequence, stash it, and return
-        next_entry = current_entry.next( amount )
-
-        # Since replace() doesn't encode, let's encode everything to a byte[] for it, no?
-        if replace( sequence_name, current_entry, next_entry, Sequence::Codec  )
-          return next_entry.value
+      def increment(sequence_name, amount = 1)
+        result, current = amount, get(sequence_name)
+        if current.nil?
+          put(sequence_name, result)
         else
-          raise "Concurrent modification, old value was #{current_entry.value} new value #{next_entry.value}"
+          result = current + amount
+          unless replace(sequence_name, current, result)
+            raise "Concurrent modification, old value was #{current} new value #{result}"
+          end
         end
+        result
       end
 
       # Decrement an integer value in the cache; return new value
@@ -207,7 +208,7 @@ module TorqueBox
       def transaction(&block)
         if !transactional?
           yield self
-        elsif fetch('transaction-manager').nil?
+        elsif TorqueBox.fetch('transaction-manager').nil?
           tm = cache.getAdvancedCache.getTransactionManager
           begin
             tm.begin if tm
@@ -255,6 +256,14 @@ module TorqueBox
 
       private
 
+      def encode(data)
+        @codec.encode(data)
+      end
+
+      def decode(data)
+        @codec.decode(data)
+      end
+      
       def options 
         @options ||= {}
       end
@@ -278,17 +287,23 @@ module TorqueBox
       def reconfigure(mode=clustering_mode)
         existing_cache  = manager.get_cache(name)
         base_config = existing_cache.cache_configuration
-        unless base_config.clustering.cache_mode == mode
-          log( "Reconfiguring Infinispan cache #{name} from #{base_config.cache_mode} to #{mode}" )
+        new_config = configuration(mode)
+        unless same_config?(base_config, new_config)
+          log("Reconfiguring Infinispan cache #{name}")
           existing_cache.stop
-          configure(mode)
+          manager.define_configuration(name, new_config )
           existing_cache.start
         end
         return existing_cache
       end
 
       def configure(mode=clustering_mode)
-        log( "Configuring Infinispan cache #{name} as #{mode}" )
+        log( "Configuring Infinispan cache #{name}" )
+        manager.define_configuration(name, configuration(mode) )
+        manager.get_cache(name)
+      end
+
+      def configuration(mode=clustering_mode)
         config = ConfigurationBuilder.new.read( manager.default_cache_configuration )
         config.clustering.cacheMode( mode )
         config.transaction.transactionMode( transaction_mode )
@@ -301,19 +316,34 @@ module TorqueBox
           store.purgeOnStartup( false )
           store.location(options[:persist]) if File.exist?( options[:persist].to_s )
         end
-        manager.define_configuration(name, config.build )
-        manager.get_cache(name)
+        if ( options[:max_entries] ) 
+          config.eviction.max_entries( options[:max_entries] )
+          if ( options[:eviction] )
+            config.eviction.strategy( eviction_strategy )
+          end
+        end
+        config.build
       end
 
+      def same_config?(c1, c2)
+        c1.clustering.cacheMode == c2.clustering.cacheMode &&
+          (c1.loaders == c2.loaders ||
+           (c1.loaders.cacheLoaders.size == c2.loaders.cacheLoaders.size &&
+            c1.loaders.cacheLoaders.first.location == c2.loaders.cacheLoaders.first.location)) &&
+          c1.transaction.transactionMode == c2.transaction.transactionMode &&
+          c1.transaction.lockingMode == c2.transaction.lockingMode &&
+          c1.eviction.max_entries == c2.eviction.max_entries &&
+          c1.eviction.strategy == c2.eviction.strategy
+      end
+      
       def transaction_manager_lookup
-        @tm ||= if fetch('transaction-manager')
+        @tm ||= if TorqueBox.fetch('transaction-manager')
                   ContainerTransactionManagerLookup.new 
                 else
                   org.infinispan.transaction.lookup.GenericTransactionManagerLookup.new
                 end
       end
 
-
       def nothing
         result = Object.new
         def result.method_missing(*args); end
@@ -322,7 +352,8 @@ module TorqueBox
       end
 
       def __put(key, value, expires, operation)
-        args = [ operation, key.to_s, value ]
+        # encode
+        args = [ operation, encode(key), encode(value) ]
         if expires > 0
           # Set the Infinispan expire a few minutes into the future to support
           # :race_condition_ttl on read
@@ -331,7 +362,7 @@ module TorqueBox
           args << expires_in << SECONDS
           args << expires << SECONDS
         end
-        cache.send( *args ) && true
+        decode(cache.send(*args))
       end
 
     end

data/lib/gem_hook.rb

@@ -19,6 +19,7 @@ require 'cache'
 begin
   ActiveSupport
   require 'active_support/cache/torque_box_store.rb'
+  require 'active_support/cache/torquebox_store.rb'
 rescue NameError
   # ActiveSupport not used
 end

data/lib/torquebox-cache.rb

@@ -1,11 +1,11 @@
 module TorqueboxCache
-  VERSION = '2.3.2'
-  MAVEN_VERSION = '2.3.2'
+  VERSION = '3.0.0.beta1'
+  MAVEN_VERSION = '3.0.0.beta1'
 end
 begin
   require 'java'
   require File.dirname(__FILE__) + '/torquebox-cache.jar'
-  require File.dirname(__FILE__) + '/polyglot-cache-1.12.2.jar'
+  require File.dirname(__FILE__) + '/polyglot-cache-1.14.0.jar'
 rescue LoadError
   puts 'JAR-based gems require JRuby to load. Please visit www.jruby.org.'
   raise

data/licenses/cc0-1.0.txt

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

data/spec/cache_listener_spec.rb

@@ -19,15 +19,17 @@ require 'cache_listener'
 
 describe TorqueBox::Infinispan::CacheListener do
   before :each do
-    manager = org.infinispan.manager.DefaultCacheManager.new 
+    @manager = org.infinispan.manager.DefaultCacheManager.new
     service = org.projectodd.polyglot.cache.as.CacheService.new
-    service.stub!(:cache_container).and_return( manager )
+    service.stub!(:cache_container).and_return( @manager )
+    TorqueBox::Registry.merge!("transaction-manager" => nil)
     TorqueBox::ServiceRegistry.stub!(:[]).with(org.projectodd.polyglot.cache.as.CacheService::CACHE).and_return( service )
     @cache = TorqueBox::Infinispan::Cache.new( :name => 'foo-cache' )
   end
 
   after :each do
     @cache.clear
+    @manager.stop
   end
 
   it "the cache should accept listeners" do

data/spec/cache_spec.rb

@@ -18,15 +18,17 @@ require File.dirname(__FILE__) + '/spec_helper'
 
 describe TorqueBox::Infinispan::Cache do
   before :each do
-    manager = org.infinispan.manager.DefaultCacheManager.new 
+    @manager = org.infinispan.manager.DefaultCacheManager.new
     service = org.projectodd.polyglot.cache.as.CacheService.new
-    service.stub!(:cache_container).and_return( manager )
+    service.stub!(:cache_container).and_return( @manager )
+    TorqueBox::Registry.merge!("transaction-manager" => nil)
     TorqueBox::ServiceRegistry.stub!(:[]).with(org.projectodd.polyglot.cache.as.CacheService::CACHE).and_return( service )
     @cache = TorqueBox::Infinispan::Cache.new( :name => 'foo-cache' )
   end
 
   after :each do
     @cache.clear
+    @manager.stop
   end
 
   it "should have a name" do
@@ -34,17 +36,35 @@ describe TorqueBox::Infinispan::Cache do
   end
 
   it "should respond to clustering_mode" do
-    @cache.should respond_to( :clustering_mode ) 
+    @cache.should respond_to( :clustering_mode )
+  end
+
+  it "should respond to eviction_strategy" do
+    @cache.should respond_to( :eviction_strategy )
+  end
+
+  it "should have a size" do
+    @cache.clear
+    @cache.size.should == 0
+    @cache.put('foo', 'bar');
+    @cache.size.should == 1
   end
 
   it "should accept and return strings" do
-    @cache.put('foo', 'bar').should be_true
+    @cache.put('foo', 'bar').should be_nil
     @cache.get('foo').should == 'bar'
   end
 
+  it "should work with index operators" do
+    @cache[:a] = 1
+    @cache[:a].should == 1
+    @cache[:b] = "two"
+    @cache[:b].should == "two"
+  end
+
   it "should accept and return ruby objects" do
     heffalump = Snuffleuffagus.new(100, 'snuffle')
-    @cache.put('heffalump', heffalump).should be_true
+    @cache.put('heffalump', heffalump).should be_nil
     rheffalump = @cache.get('heffalump')
     rheffalump.name.should == heffalump.name
     rheffalump.id.should == heffalump.id
@@ -61,6 +81,14 @@ describe TorqueBox::Infinispan::Cache do
     keys.include?('three').should be_true
   end
 
+  it "should return all values" do
+    @cache.put(:a, 1)
+    @cache.put(:b, 2)
+    @cache.put(:c, 3)
+    @cache.all.sort.should eql([1, 2, 3])
+    @cache.values.sort.should eql([1, 2, 3])
+  end
+
   it "should allow removal of a key/value" do
     @cache.put('foo', 'bar')
     @cache.keys.length.should == 1
@@ -69,13 +97,13 @@ describe TorqueBox::Infinispan::Cache do
   end
 
   it "should only insert on put_if_absent if the key is not already in the cache" do
-    @cache.put_if_absent('foo', 'bar').should be_true
-    @cache.put_if_absent('foo', 'foobar')
+    @cache.put_if_absent('foo', 'bar').should be_nil
+    @cache.put_if_absent('foo', 'foobar').should == 'bar'
     @cache.get('foo').should == 'bar'
   end
 
   it "should clear" do
-    @cache.clear.should be_true
+    @cache.clear.should be_nil
   end
 
   it "should replace existing string values" do
@@ -153,7 +181,7 @@ describe TorqueBox::Infinispan::Cache do
 
   it "should allow symbols as keys for increment" do
     @cache.increment :countsymbol
-    @cache.get(:countsymbol).should == "1"
+    @cache.get(:countsymbol).should == 1
     @cache.increment(:countsymbol).should == 2
   end
 
@@ -290,7 +318,7 @@ describe TorqueBox::Infinispan::Cache do
     it "should persist dates with a configured directory" do
       cache = TorqueBox::Infinispan::Cache.new( :name => 'persisted-configured-date-cache', :persist => @date_cfg_dir.to_s )
       entry = java.util.Date.new
-      cache.put('foo', entry).should be_true
+      cache.put('foo', entry).should be_nil
       File.exist?("#{@date_cfg_dir.to_s}/persisted-configured-date-cache").should be_true
     end