cachetastic 1.2.3 → 1.2.7.1

data/README

@@ -11,10 +11,9 @@
     debug: true # true | false (default: false)
     # this is the type of file store to be used for this cache.
     # more adapters can be developed and plugged in as desired
-    adapter: local_memory # local_memory | memcache | file | drb (default: local_memory)
+    adapter: local_memory # local_memory | memcache | file | drb | html_file (default: local_memory)
     # this will marshall objects into and out of the store.
-    # so far yaml is the only supported marshall format.
-    marshall_method: none # none | yaml (default: none)
+    marshall_method: none # none | yaml | ruby (default: none)
     # this sets how long objects will live in the cache before they are auto expired.
     default_expiry: <%= 24.hours %> # time in seconds (default: 24 hours)
     # when setting objects into the cache the expiry_swing is +/- to the expiry time.
@@ -53,9 +52,6 @@
     # set the servers to be used for memcache
     servers:
       - 127.0.0.1:11211 # ip:port used for memcache
-
-# if using the mongrel_page_cache_handler gem, you can configure it to use cachetastic.
-  page_cache_storage: cachetastic # disk | cachetastic (default: cachetastic)
   
 # example of how to override options for page cacheing:
   cachetastic_caches_page_cache_options:
@@ -71,7 +67,7 @@ If you want to use Drb and the Cachetastic::Adapters::Drb adapter, you'll have t
 
   $ cachetastic_drb_server # that will start the drb server on the host 127.0.0.1 on the port 61676
   
-The server takes to command line parameters: -h <host> -p <port>
+The server takes to command line parameters: -h <host> -p <port> -v <verbose> -rv <really verbose>
     
 =Examples:
 

data/bin/cachetastic_drb_server

@@ -20,6 +20,8 @@ SERVER_OPTIONS = OpenStruct.new
 SERVER_OPTIONS.host = "127.0.0.1"
 SERVER_OPTIONS.port = "61676"
 SERVER_OPTIONS.config_file = nil
+SERVER_OPTIONS.verbose = false
+SERVER_OPTIONS.really_verbose = false
 
 opts = OptionParser.new do |opts|
   
@@ -35,6 +37,15 @@ opts = OptionParser.new do |opts|
     SERVER_OPTIONS.config_file = v
   end
   
+  opts.on("-v") do |v|
+    SERVER_OPTIONS.verbose = true
+  end
+  
+  opts.on("-rv") do |v|
+    SERVER_OPTIONS.verbose = true
+    SERVER_OPTIONS.really_verbose = true
+  end
+  
 end
 
 opts.parse!(ARGV)
@@ -55,22 +66,26 @@ module Cachetastic
       end # initialize
 
       def get(ns, key)
-        # puts cache_for_namespace(ns).inspect
+        puts "get: #{ns}.#{key}" if SERVER_OPTIONS.verbose
+        puts cache_for_namespace(ns).inspect if SERVER_OPTIONS.really_verbose
         cache_for_namespace(ns).get(key)
       end
 
       def set(ns, key, value, expiry = 0)
+        puts "set: #{ns}.#{key}" if SERVER_OPTIONS.verbose
         cache_for_namespace(ns).set(key, value)
-        # puts cache_for_namespace(ns).inspect
+        puts cache_for_namespace(ns).inspect if SERVER_OPTIONS.really_verbose
         value
       end
 
       def delete(ns, key, delay = 0)
+        puts "delete: #{ns}.#{key}" if SERVER_OPTIONS.verbose
         cache_for_namespace(ns).delete(key, delay = 0)
-        # puts cache_for_namespace(ns).inspect
+        puts cache_for_namespace(ns).inspect if SERVER_OPTIONS.really_verbose
       end
 
       def expire_all(ns)
+        puts "expire_all: #{ns}" if SERVER_OPTIONS.verbose
         instance_variable_set("@store_for_#{ns}", Cachetastic::Adapters::LocalMemory.new("store_for_#{ns}"))
       end
 

data/lib/adapters/cachetastic_adapters_base.rb

@@ -30,7 +30,8 @@ class Cachetastic::Adapters::Base
       self.logger.debug(self.name, :options, self.all_options.inspect)
     end
   end
-
+  
+  # foo bar
   [:setup, :set, :get, :delete, :expire_all, :stats, "valid?"].each do |meth|
     define_method(meth) do |*args|
       raise MethodNotImplemented.new(meth)

data/lib/adapters/cachetastic_adapters_drb.rb

@@ -18,6 +18,7 @@ class Cachetastic::Adapters::Drb < Cachetastic::Adapters::Base
   end
 
   def setup
+    self.all_options["marshall_method"] = "ruby"
     self.drb_store = DRbObject.new_with_uri(self.store_options["host"])
   end
   
@@ -27,30 +28,15 @@ class Cachetastic::Adapters::Drb < Cachetastic::Adapters::Base
   
   # See Cachetastic::Adapters::Base
   def get(key)
-    so = self.drb_store.get(self.name, key.to_s)
-    if so
-      if so.invalid?
-        self.delete(key)
-        return nil
-      end
-      return so.value
-    end
-    return nil
+    Cachetastic::Caches::Base.unmarshall(self.drb_store.get(self.name, key))
   end
   
   def set(key, value, expiry = 0)
-    self.drb_store.set(self.name, key.to_s, Cachetastic::Adapters::StoreObject.new(key.to_s, value, expiry))
+    self.drb_store.set(self.name, key, Cachetastic::Caches::Base.marshall(value), expiry)
   end
   
   def delete(key, delay = 0)
-    if delay <= 0
-      self.drb_store.delete(self.name, key.to_s)
-    else
-      so = self.get(key)
-      if so
-        self.set(so.key, so.value, delay)
-      end
-    end
+    self.drb_store.delete(self.name, key)
   end
   
 end

data/lib/adapters/cachetastic_adapters_file.rb

@@ -41,12 +41,9 @@ class Cachetastic::Adapters::File < Cachetastic::Adapters::Base
         return nil
       end
       if so.value.is_a?(YAML::Object)
-        puts "require #{so.value.class.underscore}"
         require so.value.class.underscore
         so = YAML::load(File.open(full_path).read)
       end
-      puts so.value.class
-      pp so.value
       return so.value
     end
     return nil

data/lib/adapters/cachetastic_adapters_html_file.rb

@@ -0,0 +1,119 @@
+# This adapter uses the file system as it's backing.
+# Caches are stored in files called index.html.
+# At the beginning of the html the following html comments are pre-pended:
+#   <!-- cachetastic: expires_at: Fri Feb 01 20:51:45 -0500 2008 -->
+#   <!-- cachetastic: key: /channels/1-arts-humanities --> 
+# Obviously the expires_at date will be the ACTUAL expire date,
+# same goes for the key.
+# The configuration for this should look something like this:
+#  my_awesome_cache_options:
+#    debug: false
+#    adapter: html_file
+#    marshall_method: none
+#    default_expiry: <%= 24.hours %>
+#    store_options:  
+#      dir: /usr/local/caches/
+#    logging:
+#      logger_1:
+#        type: file
+#        file: log/file_store_cache.log
+require 'time'
+class Cachetastic::Adapters::HtmlFile < Cachetastic::Adapters::Base
+  
+  attr_reader :directory
+  attr_reader :hashed_keys
+  
+  def valid?
+    File.exists?(self.directory)
+  end
+
+  def setup
+    @directory = File.join(self.store_options["dir"], self.name.to_s)
+    FileUtils.mkdir_p(self.directory, :verbose => self.debug?)
+    @hashed_keys = {}
+  end
+  
+  def expire_all
+    FileUtils.rm_rf(self.directory, :verbose => self.debug?)
+    setup
+  end
+  
+  def get(key)
+    full_path = full_path_from_dir(get_key_directoy(key, false))
+    return nil unless File.exists?(full_path)
+    so = html_to_store_object(File.open(full_path).read)
+    if so
+      if so.invalid?
+        self.delete(key)
+        return nil
+      end
+      return so.value
+    end
+    return nil
+  end
+  
+  def set(key, value, expiry = 0)
+    so = Cachetastic::Adapters::StoreObject.new(key.to_s, value, expiry)
+    File.open(full_path_from_key(key), "w") do |f|
+      f.puts store_object_to_html(so)
+    end
+  end
+  
+  def delete(key, delay = 0)
+    if delay <= 0
+      FileUtils.rm_rf(get_key_directoy(key), :verbose => self.debug?)
+    else
+      so = self.get(key)
+      if so
+        self.set(so.key, so.value, delay)
+      end
+    end
+  end
+  
+  private
+  def get_key_directoy(key, mkdir = true)
+    hkey = self.hashed_keys[key.to_sym]
+    if hkey.nil?
+      hkey = key.to_s.hexdigest.hash
+      hkey = hkey * -1 if hkey < 0
+      hkey = hkey.to_s
+      i = 0
+      path = self.directory
+      until i == hkey.length do
+        path = File.join(path, hkey[i..i])
+        i += 1
+      end
+      self.hashed_keys[key.to_sym] = path
+      hkey = path
+    end
+    FileUtils.mkdir_p(hkey, :verbose => self.debug?) if mkdir
+    hkey
+  end
+  
+  def full_path_from_key(key)
+    full_path_from_dir(get_key_directoy(key))
+  end
+  
+  def full_path_from_dir(dir)
+    File.join(dir, STORE_FILE_NAME)
+  end
+  
+  def html_to_store_object(html)
+    key = html.match(/<!-- cachetastic: key: (.*) -->/).captures.first
+    expires_at = html.match(/<!-- cachetastic: expires_at: (.*) -->/).captures.first
+    html.gsub!(/<!-- cachetastic: key: .* -->/, '')
+    html.gsub!(/<!-- cachetastic: expires_at: .* -->/, '')
+    so = Cachetastic::Adapters::StoreObject.new(key, html, 0)
+    so.expires_at = Time.parse(expires_at)
+    so
+  end
+  
+  def store_object_to_html(so)
+    x = "<!-- cachetastic: expires_at: #{so.expires_at} -->\n"
+    x << "<!-- cachetastic: key: #{so.key} -->\n"
+    x << so.value
+  end
+  
+  STORE_FILE_NAME = "index.html"
+  
+end

data/lib/caches/cachetastic_caches_base.rb

@@ -164,6 +164,30 @@ class Cachetastic::Caches::Base
       return !unsupported_adapters.include?(a)
     end
     
+    def marshall(value)
+      return value if value.nil?
+      return case adapter.all_options["marshall_method"]
+      when "yaml"
+        YAML.dump(value)
+      when "ruby"
+        Marshal.dump(value)
+      else
+        value
+      end
+    end
+    
+    def unmarshall(value)
+      return value if value.nil?
+      return case adapter.all_options["marshall_method"]
+      when "yaml"
+        YAML.load(value)
+      when "ruby"
+        Marshal.load(value)
+      else
+        value
+      end
+    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.
@@ -187,24 +211,6 @@ class Cachetastic::Caches::Base
       # puts "all_registered_caches: #{all_registered_caches.inspect}"
     end
     
-    def marshall(value)
-      return case adapter.all_options["marshall_method"]
-      when "yaml"
-        YAML.dump(value)
-      else
-        value
-      end
-    end
-    
-    def unmarshall(value)
-      return case adapter.all_options["marshall_method"]
-      when "yaml"
-        YAML.load(value)
-      else
-        value
-      end
-    end
-    
     def cache_conn_instance
       Cachetastic::Connection.instance
     end

data/lib/caches/cachetastic_caches_mack_session_cache.rb

@@ -0,0 +1,3 @@
+# Used for storing Mack sessions.
+class Cachetastic::Caches::MackSessionCache < Cachetastic::Caches::Base
+end

data/lib/cachetastic.rb

@@ -29,12 +29,14 @@ require 'cachetastic_logger'
 require 'caches/cachetastic_caches_base'
 require 'caches/cachetastic_caches_page_cache'
 require 'caches/cachetastic_caches_rails_session_cache'
+require 'caches/cachetastic_caches_mack_session_cache'
 require 'errors/cachetastic_errors_unsupported_adapter'
 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 'adapters/cachetastic_adapters_html_file'
 require 'adapters/cachetastic_adapters_drb'
 require 'helpers/cachetastic_helpers_active_record'
 require 'rails_extensions/cachetastic_active_record_base'

data/lib/cachetastic_logger.rb

@@ -16,7 +16,7 @@ class Cachetastic::Logger
   
   LOG_LEVELS.each do |level|
     define_method(level) do |*args|
-      lm = "[CACHE] [#{level.to_s.upcase}]\t#{Time.now.strftime("%m/%d/%y %H:%m:%S")}"
+      lm = "[CACHE] [#{level.to_s.upcase}]\t#{Time.now.strftime("%m/%d/%y %H:%M:%S")}"
       exs = []
       args.each do |arg|
         if arg.is_a?(Exception)

data/lib/tasks/rubyforge_config.yml

@@ -2,4 +2,4 @@
 gem_name: cachetastic
 package: cachetastic
 project: magrathea
-version: 1.2.3
+version: 1.2.7.1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cachetastic
 version: !ruby/object:Gem::Version 
-  version: 1.2.3
+  version: 1.2.7.1
 platform: ruby
 authors: 
 - markbates
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-01-31 00:00:00 -05:00
+date: 2008-02-18 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -20,122 +20,19 @@ executables:
 - cachetastic_drb_server
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README
 files: 
 - README
-- doc/classes/ActiveRecord/Base.html
-- doc/classes/ActiveRecord/Base.src
-- doc/classes/ActiveRecord/Base.src/M000001.html
-- doc/classes/ActiveRecord/Base.src/M000002.html
-- 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/M000024.html
-- doc/classes/Cachetastic/Adapters/Base.src/M000025.html
-- doc/classes/Cachetastic/Adapters/Base.src/M000026.html
-- doc/classes/Cachetastic/Adapters/Drb.html
-- doc/classes/Cachetastic/Adapters/Drb.src
-- doc/classes/Cachetastic/Adapters/Drb.src/M000027.html
-- doc/classes/Cachetastic/Adapters/Drb.src/M000028.html
-- doc/classes/Cachetastic/Adapters/Drb.src/M000029.html
-- doc/classes/Cachetastic/Adapters/Drb.src/M000030.html
-- doc/classes/Cachetastic/Adapters/Drb.src/M000031.html
-- doc/classes/Cachetastic/Adapters/Drb.src/M000032.html
-- doc/classes/Cachetastic/Adapters/File.html
-- doc/classes/Cachetastic/Adapters/File.src
-- doc/classes/Cachetastic/Adapters/File.src/M000033.html
-- doc/classes/Cachetastic/Adapters/File.src/M000034.html
-- doc/classes/Cachetastic/Adapters/File.src/M000035.html
-- doc/classes/Cachetastic/Adapters/File.src/M000036.html
-- doc/classes/Cachetastic/Adapters/File.src/M000037.html
-- doc/classes/Cachetastic/Adapters/File.src/M000038.html
-- doc/classes/Cachetastic/Adapters/LocalMemory.html
-- doc/classes/Cachetastic/Adapters/LocalMemory.src
-- 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/LocalMemory.src/M000023.html
-- doc/classes/Cachetastic/Adapters/Memcache.html
-- doc/classes/Cachetastic/Adapters/Memcache.src
-- 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/Adapters/Memcache.src/M000017.html
-- doc/classes/Cachetastic/Caches/Base/RegisteredCaches.html
-- doc/classes/Cachetastic/Caches/Base/RegisteredCaches.src
-- doc/classes/Cachetastic/Caches/Base/RegisteredCaches.src/M000053.html
-- doc/classes/Cachetastic/Caches/Base.html
-- doc/classes/Cachetastic/Caches/Base.src
-- doc/classes/Cachetastic/Caches/Base.src/M000040.html
-- doc/classes/Cachetastic/Caches/Base.src/M000041.html
-- doc/classes/Cachetastic/Caches/Base.src/M000042.html
-- doc/classes/Cachetastic/Caches/Base.src/M000043.html
-- doc/classes/Cachetastic/Caches/Base.src/M000044.html
-- doc/classes/Cachetastic/Caches/Base.src/M000045.html
-- doc/classes/Cachetastic/Caches/Base.src/M000046.html
-- doc/classes/Cachetastic/Caches/Base.src/M000047.html
-- doc/classes/Cachetastic/Caches/Base.src/M000048.html
-- doc/classes/Cachetastic/Caches/Base.src/M000049.html
-- doc/classes/Cachetastic/Caches/Base.src/M000050.html
-- doc/classes/Cachetastic/Caches/Base.src/M000051.html
-- doc/classes/Cachetastic/Caches/Base.src/M000052.html
-- doc/classes/Cachetastic/Caches/PageCache.html
-- doc/classes/Cachetastic/Caches/RailsSessionCache.html
-- doc/classes/Cachetastic/Caches/RailsSessionCache.src
-- doc/classes/Cachetastic/Caches/RailsSessionCache.src/M000039.html
-- doc/classes/Cachetastic/Connection.html
-- doc/classes/Cachetastic/Connection.src
-- doc/classes/Cachetastic/Connection.src/M000054.html
-- doc/classes/Cachetastic/Connection.src/M000055.html
-- doc/classes/Cachetastic/Errors/UnsupportedAdapter.html
-- doc/classes/Cachetastic/Errors/UnsupportedAdapter.src
-- doc/classes/Cachetastic/Errors/UnsupportedAdapter.src/M000006.html
-- doc/classes/Cachetastic/Logger.html
-- doc/classes/Cachetastic/Logger.src
-- doc/classes/Cachetastic/Logger.src/M000056.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_drb_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
-- doc/files/lib/cachetastic_connection_rb.html
-- doc/files/lib/cachetastic_logger_rb.html
-- doc/files/lib/cachetastic_rb.html
-- doc/files/lib/errors/cachetastic_errors_unsupported_adapter_rb.html
-- 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/fr_class_index.html
-- doc/fr_file_index.html
-- doc/fr_method_index.html
-- doc/index.html
-- doc/rdoc-style.css
 - lib/adapters/cachetastic_adapters_base.rb
 - lib/adapters/cachetastic_adapters_drb.rb
 - lib/adapters/cachetastic_adapters_file.rb
+- lib/adapters/cachetastic_adapters_html_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_mack_session_cache.rb
 - lib/caches/cachetastic_caches_page_cache.rb
 - lib/caches/cachetastic_caches_rails_session_cache.rb
 - lib/cachetastic.rb
@@ -149,8 +46,13 @@ files:
 has_rdoc: true
 homepage: 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --title
+- Cachetastic-RDoc
+- --main
+- README
+- --line-numbers
+- --inline-source
 require_paths: 
 - lib
 - lib