cachetastic 1.1.8 → 1.2.1

data/lib/{stores/cachetastic_stores_base.rb → adapters/cachetastic_adapters_base.rb}

@@ -1,18 +1,18 @@
-# This class is the interface used to develop stores for caches.
+# This class is the interface used to develop adapters for stores.
 # Stores are where the data is actually held. These could be local memory,
 # memcached, a database, the file system, etc...
 # If you implement this API, then you should be able to plug in different
 # stores for your caches without having to change any of your code.
 # 
 # === Methods that need to be implemented:
-# * setup - used to setup the implementation of the store.
+# * setup - used to setup the implementation of the adapter.
 # * set(key, object, expiry) - sets an object into the store using the given key and the expiry time.
 # * get(key) - returns an object from the store for a given key.
 # * delete(key, delay) - deletes an object from the store for a given key. If the store supports it, a delay can be used.
 # * expire_all - expires all objects in the store for a given cache.
 # * stats - returns statistics for the store.
-# * valid? - used to test whether or not the store is still valid. If this returns false a new instance of the store is created by Cachetastic::Connection
-class Cachetastic::Stores::Base
+# * valid? - used to test whether or not the store is still valid. If this returns false a new instance of the adapter is created by Cachetastic::Connection
+class Cachetastic::Adapters::Base
   
   attr_reader :all_options
   attr_reader :store_options
@@ -48,22 +48,22 @@ class Cachetastic::Stores::Base
   class << self
     # Merges options for the store in the configuration file with the cachetastic_default_options 
     # found in the configuration file, and returns the results.
-    # Options need to be specified in the configuration file as the methodized name of the store with
+    # Options need to be specified in the configuration file as the methodized name of the cache with
     # _options attached at the end.
     # Examples:
     #   Cachetastic::Caches::PageCache # => cachetastic_caches_page_cache_options
     #   MyAwesomeCache # => my_awesome_cache_options
     def get_options(name)
       options = app_config.cachetastic_default_options
-      options.merge!(app_config.send(name.methodize + "_options") || {})
-      options = {"store" => "local_memory"}.merge(options)
+      options = {"adapter" => "local_memory"}.merge(options)
+      options = options.merge(app_config.send(name.methodize + "_options") || {})
       options
     end
   end
   
   private
   def configure
-    @all_options = Cachetastic::Stores::Base.get_options(self.name)
+    @all_options = Cachetastic::Adapters::Base.get_options(self.name)
     @store_options = (self.all_options["store_options"] || {})
     @servers = self.all_options["servers"]
     @logging = (self.all_options["logging"] || {})

data/lib/{stores/cachetastic_stores_file.rb → adapters/cachetastic_adapters_file.rb}

@@ -1,8 +1,8 @@
-# This store uses the file system as it's backing.
+# This adapter uses the file system as it's backing.
 # The configuration for this should look something like this:
 #  my_awesome_cache_options:
 #    debug: false
-#    store: file
+#    adapter: file
 #    marshall_method: none
 #    default_expiry: <%= 24.hours %>
 #    store_options:  
@@ -11,7 +11,7 @@
 #      logger_1:
 #        type: file
 #        file: log/file_store_cache.log
-class Cachetastic::Stores::File < Cachetastic::Stores::Base
+class Cachetastic::Adapters::File < Cachetastic::Adapters::Base
   
   attr_reader :directory
   attr_reader :hashed_keys
@@ -51,7 +51,7 @@ class Cachetastic::Stores::File < Cachetastic::Stores::Base
   end
   
   def set(key, value, expiry = 0)
-    so = Cachetastic::Stores::StoreObject.new(key.to_s, value, expiry)
+    so = Cachetastic::Adapters::StoreObject.new(key.to_s, value, expiry)
     File.open(full_path_from_key(key), "w") do |f|
       f.puts YAML.dump(so)
     end

data/lib/{stores/cachetastic_stores_local_memory.rb → adapters/cachetastic_adapters_local_memory.rb}

@@ -1,7 +1,7 @@
-# A store that keeps objects in local memory. This is great for development/testing,
+# An adapter/store that keeps objects in local memory. This is great for development/testing,
 # but probably shouldn't be put into production. 
-# It's also a very good example of how to write a store.
-class Cachetastic::Stores::LocalMemory < Cachetastic::Stores::Base
+# It's also a very good example of how to write a adapter.
+class Cachetastic::Adapters::LocalMemory < Cachetastic::Adapters::Base
   
   attr_accessor :local_store
   
@@ -17,7 +17,7 @@ class Cachetastic::Stores::LocalMemory < Cachetastic::Stores::Base
     self.local_store = {}
   end
   
-  # See Cachetastic::Stores::Base
+  # See Cachetastic::Adapters::Base
   def get(key)
     so = self.local_store[key.to_s]
     if so
@@ -31,7 +31,7 @@ class Cachetastic::Stores::LocalMemory < Cachetastic::Stores::Base
   end
   
   def set(key, value, expiry = 0)
-    self.local_store[key.to_s] = Cachetastic::Stores::StoreObject.new(key.to_s, value, expiry)
+    self.local_store[key.to_s] = Cachetastic::Adapters::StoreObject.new(key.to_s, value, expiry)
   end
   
   def delete(key, delay = 0)

data/lib/{stores/cachetastic_stores_memcache.rb → adapters/cachetastic_adapters_memcache.rb}

@@ -1,8 +1,8 @@
-# This store uses Memcache as it's backing.
+# This adapter uses Memcache as it's backing.
 # The configuration for this should look something like this:
 #  my_awesome_cache_options:
 #    debug: false
-#    store: memcache
+#    adapter: memcache
 #    marshall_method: none
 #    default_expiry: <%= 24.hours %>
 #    store_options:  
@@ -17,7 +17,7 @@
 #        file: log/memcached.log
 #    servers:
 #      - 127.0.0.1:11211
-class Cachetastic::Stores::Memcache < Cachetastic::Stores::Base
+class Cachetastic::Adapters::Memcache < Cachetastic::Adapters::Base
   
   def setup
     self.conn = MemCache.new(self.servers, self.store_options.merge({:namespace => self.namespace}))

data/lib/{stores/cachetastic_stores_store_object.rb → adapters/cachetastic_adapters_store_object.rb}

@@ -1,4 +1,4 @@
-class Cachetastic::Stores::StoreObject #:nodoc:#
+class Cachetastic::Adapters::StoreObject #:nodoc:#
   attr_accessor :key
   attr_accessor :value
   attr_accessor :expires_at

data/lib/caches/cachetastic_caches_base.rb

@@ -58,13 +58,28 @@ class Cachetastic::Caches::Base
     def get(key)
       res = nil
       do_with_logging(:get, key) do
-        res = store.get(key.to_s)
-        if res.nil?
-          res = yield key if block_given?
-        else
-          res = unmarshall(res)
+        retryable(:on => ArgumentError) do
+          begin
+            res = adapter.get(key.to_s)
+            if res.nil?
+              res = yield key if block_given?
+            else
+              res = unmarshall(res)
+            end
+            res
+          rescue ArgumentError => e
+            m = e.message.match(/class\/module .*/)
+            if m
+              m = m.to_s
+              m.gsub!("class/module", '')
+              m.gsub!("(ArgumentError)", '')
+              require m.strip.underscore
+              raise e
+            end
+          rescue Exception => e
+            raise e
+          end
         end
-        res
       end
       res
     end
@@ -76,10 +91,10 @@ class Cachetastic::Caches::Base
     # used.
     # If there is an expiry_swing set in the config file it will be +/- to the
     # expiry time. See also: calculate_expiry_time
-    def set(key, value, expiry = (store.all_options["default_expiry"] || 0))
+    def set(key, value, expiry = (adapter.all_options["default_expiry"] || 0))
       do_with_logging(:set, key) do
         expiry = calculate_expiry_time(expiry)
-        store.set(key.to_s, marshall(value), expiry.to_i)
+        adapter.set(key.to_s, marshall(value), expiry.to_i)
         logger.info('', '', :expiry, cache_name, key, expiry.to_i)
         value
       end
@@ -92,13 +107,13 @@ class Cachetastic::Caches::Base
     # The default of 0 means the object gets deleted right away.
     def delete(key, delay = 0)
       do_with_logging(:delete, key) do
-        store.delete(key.to_s, delay)
+        adapter.delete(key.to_s, delay)
       end
     end
     
     # Expires all objects for this cache.
     def expire_all
-      store.expire_all
+      adapter.expire_all
       logger.info('', '', :expired, cache_name)
     end
     
@@ -109,9 +124,9 @@ class Cachetastic::Caches::Base
       raise MethodNotImplemented.new("populate_all")
     end
     
-    # A convenience method that returns statistics for the underlying Cachetastic::Stores::Base for the cache.
+    # A convenience method that returns statistics for the underlying Cachetastic::Adapters::Base for the cache.
     def stats
-      store.stats
+      adapter.stats
     end
     
     # Returns a 'methodize' version of the cache's class name. This gets used in logging,
@@ -122,21 +137,21 @@ class Cachetastic::Caches::Base
       self.name.methodize
     end
     
-    # Returns the underlying Cachetastic::Stores::Base for this cache.
-    def store
+    # Returns the underlying Cachetastic::Adapters::Base for this cache.
+    def adapter
       cache_conn_instance.get(cache_name)
     end
     
-    # Returns the Cachetastic::Logger for the underlying Cachetastic::Stores::Base.
+    # Returns the Cachetastic::Logger for the underlying Cachetastic::Adapters::Base.
     def logger
-      store.logger
+      adapter.logger
     end
     
     private
     # If the expiry time is set to 60 minutes and the expiry_swing time is set to
     # 15 minutes, this method will return a number between 45 minutes and 75 minutes.
     def calculate_expiry_time(expiry) # :doc:
-      exp_swing = store.all_options["expiry_swing"]
+      exp_swing = adapter.all_options["expiry_swing"]
       if exp_swing
         swing = rand(exp_swing.to_i)
         case rand(2)
@@ -156,7 +171,7 @@ class Cachetastic::Caches::Base
     end
     
     def marshall(value)
-      return case store.all_options["marshall_method"]
+      return case adapter.all_options["marshall_method"]
       when "yaml"
         YAML.dump(value)
       else
@@ -165,7 +180,7 @@ class Cachetastic::Caches::Base
     end
     
     def unmarshall(value)
-      return case store.all_options["marshall_method"]
+      return case adapter.all_options["marshall_method"]
       when "yaml"
         YAML.load(value)
       else
@@ -186,7 +201,7 @@ class Cachetastic::Caches::Base
       unless res.nil?
         str = "[#{res.class.name}]"
         str << "\t[Size = #{res.size}]" if res.respond_to? :size
-        str << "\t" << res.inspect if store.debug?
+        str << "\t" << res.inspect if adapter.debug?
       end
       logger.info(:finished, action, cache_name, key, (end_time - start_time), str)
       res

data/lib/cachetastic.rb

@@ -12,7 +12,7 @@ module Cachetastic #:nodoc:#
     module ActiveRecord #:nodoc:#
     end
   end
-  module Stores #:nodoc:#
+  module Adapters #:nodoc:#
   end
   module Helpers #:nodoc:#
     module ActiveRecord #:nodoc:#
@@ -27,11 +27,11 @@ require 'cachetastic_logger'
 require 'caches/cachetastic_caches_base'
 require 'caches/cachetastic_caches_page_cache'
 require 'caches/cachetastic_caches_rails_session_cache'
-require 'stores/cachetastic_stores_base'
-require 'stores/cachetastic_stores_store_object'
-require 'stores/cachetastic_stores_memcache'
-require 'stores/cachetastic_stores_local_memory'
-require 'stores/cachetastic_stores_file'
+require 'adapters/cachetastic_adapters_base'
+require 'adapters/cachetastic_adapters_store_object'
+require 'adapters/cachetastic_adapters_memcache'
+require 'adapters/cachetastic_adapters_local_memory'
+require 'adapters/cachetastic_adapters_file'
 require 'helpers/cachetastic_helpers_active_record'
 require 'rails_extensions/cachetastic_active_record_base'
 require 'rails_extensions/cgi_session_cachetastic_store'

data/lib/cachetastic_connection.rb

@@ -1,4 +1,4 @@
-# This class caches store objects for each cache in the system.
+# This class caches adapter objects for each cache in the system.
 class Cachetastic::Connection
   include Singleton
   
@@ -8,15 +8,15 @@ class Cachetastic::Connection
     self.connections = {}
   end
   
-  # Takes the name of the cache, that's been methodized, and returns back the store object associated with the cache.
-  # If the store object doesn't exist or if the store is no longer valid (store.valid?) a new one is
+  # Takes the name of the cache, that's been methodized, and returns back the adapter object associated with the cache.
+  # If the adapter object doesn't exist or if the adapter is no longer valid (adapter.valid?) a new one is
   # created and returned.
   def get(name)
     name = name.to_sym
     conn = self.connections[name]
     return conn if conn && conn.valid?
-    store = Cachetastic::Stores::Base.get_options(name)["store"].camelcase
-    conn = "Cachetastic::Stores::#{store}".constantize.new(name)
+    adapter = Cachetastic::Adapters::Base.get_options(name)["adapter"].camelcase
+    conn = "Cachetastic::Adapters::#{adapter}".constantize.new(name)
     self.connections[name.to_sym] = conn
     return conn
   end

data/lib/cachetastic_logger.rb

@@ -1,4 +1,4 @@
-# This class handles logging for the caches and their stores.
+# This class handles logging for the caches and their adapters.
 class Cachetastic::Logger
   
   attr_accessor :options

data/lib/tasks/rubyforge_config.yml

@@ -2,4 +2,4 @@
 gem_name: cachetastic
 package: cachetastic
 project: magrathea
-version: 1.1.8
+version: 1.2.1

metadata

@@ -1,35 +1,27 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
-specification_version: 1
 name: cachetastic
 version: !ruby/object:Gem::Version 
-  version: 1.1.8
-date: 2008-01-16 00:00:00 -05:00
-summary: cachetastic
-require_paths: 
-- lib
-- lib
-email: 
-homepage: 
-rubyforge_project: magrathea
-description: "cachetastic was developed by: markbates"
-autorequire: 
-- cachetastic
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 1.2.1
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - markbates
+autorequire: 
+- cachetastic
+bindir: bin
+cert_chain: []
+
+date: 2008-01-29 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: "cachetastic was developed by: markbates"
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
 files: 
 - doc/classes/ActiveRecord/Base.html
 - doc/classes/ActiveRecord/Base.src
@@ -38,6 +30,40 @@ files:
 - doc/classes/ActiveRecord/Base.src/M000003.html
 - doc/classes/ActiveRecord/Base.src/M000004.html
 - doc/classes/ActiveRecord/Base.src/M000005.html
+- doc/classes/Cachetastic/Adapters/Base.html
+- doc/classes/Cachetastic/Adapters/Base.src
+- doc/classes/Cachetastic/Adapters/Base.src/M000023.html
+- doc/classes/Cachetastic/Adapters/Base.src/M000024.html
+- doc/classes/Cachetastic/Adapters/Base.src/M000025.html
+- doc/classes/Cachetastic/Adapters/File.html
+- doc/classes/Cachetastic/Adapters/File.src
+- doc/classes/Cachetastic/Adapters/File.src/M000026.html
+- doc/classes/Cachetastic/Adapters/File.src/M000027.html
+- doc/classes/Cachetastic/Adapters/File.src/M000028.html
+- doc/classes/Cachetastic/Adapters/File.src/M000029.html
+- doc/classes/Cachetastic/Adapters/File.src/M000030.html
+- doc/classes/Cachetastic/Adapters/File.src/M000031.html
+- doc/classes/Cachetastic/Adapters/LocalMemory.html
+- doc/classes/Cachetastic/Adapters/LocalMemory.src
+- doc/classes/Cachetastic/Adapters/LocalMemory.src/M000017.html
+- doc/classes/Cachetastic/Adapters/LocalMemory.src/M000018.html
+- doc/classes/Cachetastic/Adapters/LocalMemory.src/M000019.html
+- doc/classes/Cachetastic/Adapters/LocalMemory.src/M000020.html
+- doc/classes/Cachetastic/Adapters/LocalMemory.src/M000021.html
+- doc/classes/Cachetastic/Adapters/LocalMemory.src/M000022.html
+- doc/classes/Cachetastic/Adapters/Memcache.html
+- doc/classes/Cachetastic/Adapters/Memcache.src
+- doc/classes/Cachetastic/Adapters/Memcache.src/M000006.html
+- doc/classes/Cachetastic/Adapters/Memcache.src/M000007.html
+- doc/classes/Cachetastic/Adapters/Memcache.src/M000008.html
+- doc/classes/Cachetastic/Adapters/Memcache.src/M000009.html
+- doc/classes/Cachetastic/Adapters/Memcache.src/M000010.html
+- doc/classes/Cachetastic/Adapters/Memcache.src/M000011.html
+- doc/classes/Cachetastic/Adapters/Memcache.src/M000012.html
+- doc/classes/Cachetastic/Adapters/Memcache.src/M000013.html
+- doc/classes/Cachetastic/Adapters/Memcache.src/M000014.html
+- doc/classes/Cachetastic/Adapters/Memcache.src/M000015.html
+- doc/classes/Cachetastic/Adapters/Memcache.src/M000016.html
 - doc/classes/Cachetastic/Caches/Base/RegisteredCaches.html
 - doc/classes/Cachetastic/Caches/Base/RegisteredCaches.src
 - doc/classes/Cachetastic/Caches/Base/RegisteredCaches.src/M000043.html
@@ -63,43 +89,14 @@ files:
 - doc/classes/Cachetastic/Logger.html
 - doc/classes/Cachetastic/Logger.src
 - doc/classes/Cachetastic/Logger.src/M000046.html
-- doc/classes/Cachetastic/Stores/Base.html
-- doc/classes/Cachetastic/Stores/Base.src
-- doc/classes/Cachetastic/Stores/Base.src/M000023.html
-- doc/classes/Cachetastic/Stores/Base.src/M000024.html
-- doc/classes/Cachetastic/Stores/Base.src/M000025.html
-- doc/classes/Cachetastic/Stores/File.html
-- doc/classes/Cachetastic/Stores/File.src
-- doc/classes/Cachetastic/Stores/File.src/M000026.html
-- doc/classes/Cachetastic/Stores/File.src/M000027.html
-- doc/classes/Cachetastic/Stores/File.src/M000028.html
-- doc/classes/Cachetastic/Stores/File.src/M000029.html
-- doc/classes/Cachetastic/Stores/File.src/M000030.html
-- doc/classes/Cachetastic/Stores/File.src/M000031.html
-- doc/classes/Cachetastic/Stores/LocalMemory.html
-- doc/classes/Cachetastic/Stores/LocalMemory.src
-- doc/classes/Cachetastic/Stores/LocalMemory.src/M000017.html
-- doc/classes/Cachetastic/Stores/LocalMemory.src/M000018.html
-- doc/classes/Cachetastic/Stores/LocalMemory.src/M000019.html
-- doc/classes/Cachetastic/Stores/LocalMemory.src/M000020.html
-- doc/classes/Cachetastic/Stores/LocalMemory.src/M000021.html
-- doc/classes/Cachetastic/Stores/LocalMemory.src/M000022.html
-- doc/classes/Cachetastic/Stores/Memcache.html
-- doc/classes/Cachetastic/Stores/Memcache.src
-- doc/classes/Cachetastic/Stores/Memcache.src/M000006.html
-- doc/classes/Cachetastic/Stores/Memcache.src/M000007.html
-- doc/classes/Cachetastic/Stores/Memcache.src/M000008.html
-- doc/classes/Cachetastic/Stores/Memcache.src/M000009.html
-- doc/classes/Cachetastic/Stores/Memcache.src/M000010.html
-- doc/classes/Cachetastic/Stores/Memcache.src/M000011.html
-- doc/classes/Cachetastic/Stores/Memcache.src/M000012.html
-- doc/classes/Cachetastic/Stores/Memcache.src/M000013.html
-- doc/classes/Cachetastic/Stores/Memcache.src/M000014.html
-- doc/classes/Cachetastic/Stores/Memcache.src/M000015.html
-- doc/classes/Cachetastic/Stores/Memcache.src/M000016.html
 - doc/classes/CGI/Session/CachetasticStore.html
 - doc/created.rid
 - doc/files/init_rb.html
+- doc/files/lib/adapters/cachetastic_adapters_base_rb.html
+- doc/files/lib/adapters/cachetastic_adapters_file_rb.html
+- doc/files/lib/adapters/cachetastic_adapters_local_memory_rb.html
+- doc/files/lib/adapters/cachetastic_adapters_memcache_rb.html
+- doc/files/lib/adapters/cachetastic_adapters_store_object_rb.html
 - doc/files/lib/caches/cachetastic_caches_base_rb.html
 - doc/files/lib/caches/cachetastic_caches_page_cache_rb.html
 - doc/files/lib/caches/cachetastic_caches_rails_session_cache_rb.html
@@ -109,17 +106,17 @@ files:
 - doc/files/lib/helpers/cachetastic_helpers_active_record_rb.html
 - doc/files/lib/rails_extensions/cachetastic_active_record_base_rb.html
 - doc/files/lib/rails_extensions/cgi_session_cachetastic_store_rb.html
-- doc/files/lib/stores/cachetastic_stores_base_rb.html
-- doc/files/lib/stores/cachetastic_stores_file_rb.html
-- doc/files/lib/stores/cachetastic_stores_local_memory_rb.html
-- doc/files/lib/stores/cachetastic_stores_memcache_rb.html
-- doc/files/lib/stores/cachetastic_stores_store_object_rb.html
 - doc/fr_class_index.html
 - doc/fr_file_index.html
 - doc/fr_method_index.html
 - doc/index.html
 - doc/rdoc-style.css
 - init.rb
+- lib/adapters/cachetastic_adapters_base.rb
+- lib/adapters/cachetastic_adapters_file.rb
+- lib/adapters/cachetastic_adapters_local_memory.rb
+- lib/adapters/cachetastic_adapters_memcache.rb
+- lib/adapters/cachetastic_adapters_store_object.rb
 - lib/caches/cachetastic_caches_base.rb
 - lib/caches/cachetastic_caches_page_cache.rb
 - lib/caches/cachetastic_caches_rails_session_cache.rb
@@ -129,24 +126,34 @@ files:
 - lib/helpers/cachetastic_helpers_active_record.rb
 - lib/rails_extensions/cachetastic_active_record_base.rb
 - lib/rails_extensions/cgi_session_cachetastic_store.rb
-- lib/stores/cachetastic_stores_base.rb
-- lib/stores/cachetastic_stores_file.rb
-- lib/stores/cachetastic_stores_local_memory.rb
-- lib/stores/cachetastic_stores_memcache.rb
-- lib/stores/cachetastic_stores_store_object.rb
 - lib/tasks/rubyforge_config.yml
 - README
-test_files: []
-
+has_rdoc: true
+homepage: 
+post_install_message: 
 rdoc_options: []
 
-extra_rdoc_files: []
-
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
+rubyforge_project: magrathea
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: cachetastic
+test_files: []