jruby-ehcache-rails2 1.2.0 → 1.3.0

data/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"

data/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)

data/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)

data/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)

data/spec/cache_manager_spec.rb

@@ -0,0 +1,81 @@
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe CacheManager do
+  before(:each) do
+    @manager = Ehcache::CacheManager.new
+  end
+
+  after(:each) do
+    @manager.shutdown
+  end
+  it "should return false if include? is called with a non-existant cache name" do
+    @manager.include?("zomg").should == false
+  end
+
+  it "should return false if exists? is called with a non-existant cache name" do
+    @manager.exists?("zomg").should == false
+  end
+
+  it "should return true if include? is called with an existant cache name" do
+    @manager.include?(Ehcache::Cache::PRIMARY).should == true
+  end
+
+  it "should return true if exists? is called with an existant cache name" do
+    @manager.exists?(Ehcache::Cache::PRIMARY).should == true
+  end
+
+  it "should return all the cache names when caches is called" do
+    @manager.caches.length.should == 1
+  end
+
+  it "should remove the cache when remove is called with a cache name" do
+    @manager.remove(Ehcache::Cache::PRIMARY)
+    @manager.caches.length.should == 0
+  end
+
+  it "should remove all the caches when remove_all is called" do
+    @manager.add_cache("mynewcache")
+    @manager.caches.length.should == 2
+    @manager.remove_all
+    @manager.caches.length.should == 0
+  end
+
+  it "should add a cache when cache is called with a cache name" do
+    @manager.add_cache("mynewcache")
+    @manager.caches.length.should == 2
+  end
+
+  it "should add a cache when cache is called with a cache name" do
+    cache = @manager.cache(Ehcache::Cache::PRIMARY)
+    cache.put("key", "value")
+    cache.get("key").should == "value"
+    @manager.flush_all
+    cache.get("key").should == nil
+  end
+end
+
+describe CacheManager, "customized" do
+  after(:each) do
+    @manager.shutdown
+  end
+
+  it "should create a primary cache with values based on default cache" do
+    @manager = Ehcache::CacheManager.new
+    @manager.cache.max_elements.should == 10000
+  end
+
+  it "should create a cache with cache named steve" do
+    @manager = Ehcache::CacheManager.new({"cache" => {"name" => "steve"}})
+    @manager.include?("steve").should == true
+  end
+
+  it "should create a custom default and primary cache" do
+    @manager = Ehcache::CacheManager.new({
+      "default" => {"max_elements_in_memory" => 200000},
+      "cache"   => {"name" => "cache", "time_to_live_seconds" => 180, "eternal" => true}
+    })
+    @manager.cache("cache").max_elements.should == 200000
+    @manager.cache("cache").ttl.should == 180
+    @manager.cache("cache").eternal?.should == true
+  end
+end

data/spec/cache_spec.rb

@@ -0,0 +1,86 @@
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe Cache do
+  before(:each) do
+    @manager = Ehcache::CacheManager.new
+    @cache   = @manager.cache
+  end
+
+  after(:each) do
+    @manager.shutdown
+  end
+
+  it "should have an alive status on creation" do
+    @cache.status.should == Ehcache::Status::ALIVE
+  end
+
+  it "should have a shutdown status when its manager shutsdown" do
+    @manager.shutdown
+    @cache.status.should == Ehcache::Status::SHUTDOWN
+  end
+
+  it "should return an element value from get when given a valid key" do
+    @cache.put("lol", "123456")
+    @cache.get("lol").should == "123456"
+  end
+
+  it "should return true when removing an element from the cache given a valid key" do
+    @cache.put("lol", "123456")
+    @cache.remove("lol").should == true
+  end
+
+  it "should return false when removing an element from the cache given a valid key" do
+    @cache.put("lol", "123456")
+    @cache.remove("rofl").should == false
+  end
+
+  it "should remove all elements from the cache on a call to remove_all" do
+    @cache.put("lol", "123456")
+    @cache.put("rofl", "123456")
+    @cache.remove_all
+    @cache.size.should == 0
+  end
+
+  it "should return true when exist? is called when a valid key is in the cache" do
+    @cache.put("lol", "123456")
+    @cache.exist?("lol").should == true
+  end
+
+  it "should return false when exist? is called when a valid key is in the cache" do
+    @cache.put("lol", "123456")
+    @cache.exist?("rofl").should == false
+  end
+
+  it "should raise an EhcacheArgumentException when given an empty key" do
+    lambda { @cache.put("", "123456") }.should raise_error(EhcacheError)
+  end
+
+  it "should raise an EhcacheArgumentException when given nil key" do
+    lambda { @cache.put(nil, "123456") }.should raise_error(EhcacheError)
+  end
+
+  it "should allow adding an element to the cache with a time to live" do
+    @cache.put("lol", "123456", { :ttl => 60 })
+    @cache.element("lol").ttl.should == 60
+  end
+
+  it "should return an element from a call to element when given a valid key" do
+    @cache.put("lol", "123456")
+    @cache.element("lol").class.should == Ehcache::Element
+  end
+
+  it "should return the number of elements in the cache" do
+    @cache.size.should == 0
+    @cache.put("lol", "123456")
+    @cache.size.should == 1
+  end
+
+  it "should return all the keys in the cache" do
+    @cache.put("lol", "123456")
+    @cache.put("rofl", "123456")
+    @cache.keys.size.should == 2
+  end
+
+  it "should return the number of elements in the memory store"
+  it "should return the number of elements in the disk store"
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format=specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'spec'
+require 'spec/story'
+require 'java'
+
+require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib ehcache]))
+include Ehcache
+include Ehcache::Java
+
+Spec::Runner.configure do |config|
+  #config.mock_with :mocha
+end

data/src/net/sf/ehcache/MarshaledRubyObject.java

@@ -0,0 +1,15 @@
+package net.sf.ehcache;
+
+import java.io.Serializable;
+
+public class MarshaledRubyObject implements Serializable {
+  private byte[] bytes;
+
+  public MarshaledRubyObject(byte[] bytes) {
+    this.bytes = bytes;
+  }
+
+  public byte[] getBytes() {
+    return this.bytes;
+  }
+}

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/website.rake

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]

data/test/ehcache.xml

@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="../../main/config/ehcache.xsd">
+
+    <!-- Disable for test ehcache.xml. Should go to the same place. -->
+    <diskStore path="java.io.tmpdir"/>
+
+    <cacheManagerPeerProviderFactory class="net.sf.ehcache.distribution.RMICacheManagerPeerProviderFactory"
+                                     properties="peerDiscovery=automatic, multicastGroupAddress=230.0.0.1, multicastGroupPort=4446, timeToLive=0"/>
+
+
+    <cacheManagerPeerListenerFactory class="net.sf.ehcache.distribution.RMICacheManagerPeerListenerFactory"
+                                     properties="hostName=, port=, socketTimeoutMillis="/>
+
+
+    <defaultCache
+            name="default"
+            maxElementsInMemory="10"
+            eternal="false"
+            timeToIdleSeconds="5"
+            timeToLiveSeconds="10"
+            overflowToDisk="true"
+            />
+
+
+    <!-- Sample cache named sampleCache1 -->
+    <cache name="sampleCache1"
+           maxElementsInMemory="10000"
+           maxElementsOnDisk="1000"
+           eternal="false"
+           timeToIdleSeconds="360"
+           timeToLiveSeconds="1000"
+           overflowToDisk="true">
+    </cache>
+
+    <!-- Sample cache named sampleCache2. Is eternal. Is diskPersistent but does not overflow to disk -->
+    <cache name="sampleCache2"
+           maxElementsInMemory="1000"
+           eternal="true"
+           overflowToDisk="false"
+           diskPersistent="true"
+            />
+</ehcache>

data/test/ehcache.yml

@@ -0,0 +1,67 @@
+name: testing
+update_check: false
+monitoring: autodetect
+dynamic_config: true
+
+disk_store:
+  path: java.io.tmpdir
+
+transaction_manager:
+  class: net.sf.ehcache.transaction.manager.DefaultTransactionManagerLookup
+  properties: jndiName=java:/TransactionManager
+  property_separator: ";"
+
+peer_providers:
+- class: net.sf.ehcache.distribution.RMICacheManagerPeerProviderFactory
+  properties: peerDiscovery=automatic,multicastGroupAddress=230.0.0.1,multicastGroupPort=4446,timeToLive=1
+  property_separator: ","
+
+peer_listeners:
+- class: net.sf.ehcache.distribution.RMICacheManagerPeerListenerFactory
+
+default_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
+
+caches:
+  # Sample cache named sampleCache1
+- name: sampleCache1
+  max_elements_in_memory: 10000
+  max_elements_on_disk: 1000
+  eternal: false
+  time_to_idle_seconds: 360
+  time_to_live_seconds: 1000
+  overflow_to_disk: true
+
+  #Sample cache named sampleCache2. Is eternal. Is diskPersistent but does not overflow to disk
+- name: sampleCache2
+  max_elements_in_memory: 1000
+  eternal: true
+  overflow_to_disk: false
+  disk_persistent: true
+
+- name: sampleCacheWithCacheConfigurations
+  max_elements_in_memory: 10
+  eternal: false
+  time_to_idle_seconds: 100
+  time_to_live_seconds: 100
+  overflow_to_disk: false
+  bootstrap_loader:
+    class: net.sf.ehcache.distribution.RMIBootstrapCacheLoaderFactory
+    properties: "bootstrapAsynchronously=true, maximumChunkSizeBytes=5000000"
+    property_separator: ","
+  event_listeners:
+    - class: net.sf.ehcache.distribution.RMICacheReplicatorFactory
+      properties: "replicateAsynchronously=false, replicatePuts=false, replicatePutsViaCopy=false, replicateUpdates=true, replicateUpdatesViaCopy=true, replicateRemovals=false"
+    - class: net.sf.ehcache.distribution.RMICacheReplicatorFactory
+      properties: "replicateAsynchronously=false, replicatePuts=false, replicatePutsViaCopy=false, replicateUpdates=true, replicateUpdatesViaCopy=true, replicateRemovals=false"
+#  extensions:
+#    - class: com.example.FileWatchingCacheRefresherExtensionFactory
+#      properties: "refreshIntervalMillis=18000, loaderTimeout=3000, flushPeriod=whatever, someOtherProperty=someValue"