cachetastic 2.1.4 → 3.0.0

data/lib/cachetastic/cacheable.rb

@@ -1,4 +1,4 @@
-module Cachetastic
+module Cachetastic # :nodoc:
   # Include this module into an Object to achieve simplistic Object level caching.
   # 
   # Example:
@@ -21,31 +21,37 @@ module Cachetastic
   module Cacheable
     
     module ClassAndInstanceMethods
-      # Returns the Cachetastic::Caches::Base object associated with the object.
+      # Returns the Cachetastic::Cache object associated with the object.
       # If a cache hasn't been defined the one will be created on the fly.
       # The cache for the object is expected to be defined as:
       # Cachetastic::Cacheable::{CLASS_NAME_HERE}Cache
       # 
-      # Example:
+      # Examples:
       #   class Person
       #     include Cachetastic::Cacheable
-      #     attr_accessor :name
-      #     def cachetastic_key
-      #       self.name
-      #     end
       #   end
       # 
       #  Person.cache_class # => Cachetastic::Cacheable::PersonCache
+      # 
+      #   class Admin::Person
+      #     include Cachetastic::Cacheable
+      #   end
+      # 
+      #  Admin::Person.cache_class # => Cachetastic::Cacheable::Admin_PersonCache
       def cache_class
         n = self.class.name
         n = self.name if n == "Class"
-        n.gsub!('::', '_')
-        c_name = "Cachetastic::Cacheable::#{n}Cache"
+        c_name = "Cachetastic::Cacheable::#{n.gsub('::', '_')}Cache"
         begin
           return c_name.constantize
         rescue NameError => e
           eval %{
-            class #{c_name} < Cachetastic::Caches::Base
+            class #{c_name} < Cachetastic::Cache
+              
+              def self.cache_klass
+                #{n}
+              end
+              
             end
           }
           return c_name.constantize
@@ -62,10 +68,7 @@ module Cachetastic
       # Example:
       #   class Person
       #     include Cachetastic::Cacheable
-      #     attr_accessor :name
-      #     def cachetastic_key
-      #       self.name
-      #     end
+      # 
       #     def always_the_same(x,y)
       #       cacher("always_the_same") do
       #         x + y
@@ -83,7 +86,7 @@ module Cachetastic
       #   Person.cacher("say_hi") {"Hi There"} # => "Hi There"
       #   Person.get_from_cache("say_hi") # => "Hi There"
       #   Cachetastic::Cacheable::PersonCache.get("say_hi") # => "Hi There"
-      def cacher(key, expiry = 0)
+      def cacher(key, expiry = nil)
         cache_class.get(key) do
           if block_given?
             res = yield
@@ -114,6 +117,7 @@ module Cachetastic
       def expire_all
         cache_class.expire_all
       end
+      
     end
     
     # --------------------------

data/lib/cachetastic/extensions/string.rb

@@ -0,0 +1,8 @@
+require 'digest'
+class String # :nodoc:
+  
+  def hexdigest # :nodoc:
+    Digest::SHA1.hexdigest(self)
+  end
+  
+end

data/lib/cachetastic/logger.rb

@@ -1,49 +1,49 @@
-# This class handles logging for the caches and their adapters.
-class Cachetastic::Logger
+module Cachetastic # :nodoc:
+  # This class handles logging for the caches and their adapters.
+  # This class exists simply to supply the ability to write to 
+  # multiple loggers simultaneously from a single call. It also 
+  # creates a standardized message to write to those loggers.
+  # 
+  # It is important that any logger type of class you decide to use
+  # reponds to the following methods:
+  #   fatal(message)
+  #   error(message)
+  #   warn(message)
+  #   info(message)
+  #   debug(message)
+  class Logger
   
-  # attr_accessor :options
-  # attr_accessor :cache_name
-  attr_accessor :loggers
+    # An <tt>Array</tt> of 'real' loggers to write to.
+    attr_accessor :loggers
   
-  def initialize(loggers)
-    @loggers = [loggers].flatten
-    # self.options = options
-    # self.cache_name = cache_name
-    # self.options.each_pair do |n, opts|
-    #   opts["level"] = (opts["level"] ||= "info").to_sym
-    # end
-  end
+    # The <tt>initialize</tt> method takes an <tt>Array</tt>
+    # of your favorite logger style classes to write to.
+    def initialize(*loggers)
+      @loggers = [loggers].flatten
+    end
   
-  LOG_LEVELS = [:fatal, :error, :warn, :info, :debug]
+    LOG_LEVELS = [:fatal, :error, :warn, :info, :debug] # :nodoc:
   
-  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")}"
-      exs = []
-      args.each do |arg|
-        if arg.is_a?(Exception)
-          exs << arg
-          continue
+    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")}"
+        exs = []
+        args.each do |arg|
+          if arg.is_a?(Exception)
+            exs << arg
+            continue
+          end
+          lm << "\t" << arg.to_s 
+        end
+        exs.each do |ex|
+          lm << "\n#{ex.message}\n" << ex.backtrace.join("\n")
+        end
+        # puts "lm: #{lm}"
+        self.loggers.each do |log|
+          log.send(level, lm)
         end
-        lm << "\t" << arg.to_s 
-      end
-      exs.each do |ex|
-        lm << "\n#{ex.message}\n" << ex.backtrace.join("\n")
-      end
-      self.loggers.each do |log|
-        log.send(level, lm)
       end
-      # self.options.each_pair do |n, opts|
-      #   if LOG_LEVELS.index(opts["level"]) >= LOG_LEVELS.index(level)
-      #     case opts["type"]
-      #     when "file"
-      #       File.open(opts["file"], "a") {|f| f.puts(lm)} 
-      #     when "console"
-      #       puts lm
-      #     end
-      #   end
-      # end
     end
-  end
   
-end
+  end # Logger
+end # Cachetastic

data/lib/cachetastic/store_object.rb

@@ -0,0 +1,22 @@
+module Cachetastic # :nodoc:
+  class Cache
+    
+    class StoreObject # :nodoc:
+      attr_accessor :expires_at
+      attr_accessor :key
+      attr_accessor :value
+      
+      def initialize(key, value, expires_at)
+        self.key = key
+        self.value = value
+        self.expires_at = expires_at
+      end
+      
+      def expired?
+        return Time.now > self.expires_at
+      end
+      
+    end # StoreObject
+    
+  end # Cache
+end # Cachetastic

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: cachetastic
 version: !ruby/object:Gem::Version 
-  version: 2.1.4
+  version: 3.0.0
 platform: ruby
 authors: 
-- markbates
+- Mark Bates
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-02-27 00:00:00 -05:00
+date: 2009-06-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,85 +20,72 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.2.2
+        version: 2.3.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: memcache-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
     version: 
 description: A very simple, yet very powerful caching framework for Ruby.
 email: mark@mackframework.com
-executables: 
-- cachetastic_drb_server
+executables: []
+
 extensions: []
 
 extra_rdoc_files: 
 - README
+- LICENSE
 files: 
 - lib/cachetastic/adapters/base.rb
-- lib/cachetastic/adapters/drb.rb
 - lib/cachetastic/adapters/file.rb
-- lib/cachetastic/adapters/file_base.rb
-- lib/cachetastic/adapters/html_file.rb
 - lib/cachetastic/adapters/local_memory.rb
-- lib/cachetastic/adapters/memcache.rb
-- lib/cachetastic/adapters/store_object.rb
+- lib/cachetastic/adapters/memcached.rb
+- lib/cachetastic/cache.rb
 - lib/cachetastic/cacheable.rb
-- lib/cachetastic/caches/base.rb
-- lib/cachetastic/caches/mack_session_cache.rb
-- lib/cachetastic/caches/page_cache.rb
-- lib/cachetastic/caches/rails_session_cache.rb
-- lib/cachetastic/connection.rb
-- lib/cachetastic/errors/unsupported_adapter.rb
+- lib/cachetastic/extensions/string.rb
 - lib/cachetastic/logger.rb
-- lib/cachetastic/rails_extensions/active_record_base.rb
-- lib/cachetastic/rails_extensions/cgi_session_store.rb
-- lib/cachetastic/ruby_extensions/kernel.rb
-- lib/cachetastic/ruby_extensions/object.rb
-- lib/cachetastic/ruby_extensions/string.rb
+- lib/cachetastic/store_object.rb
 - lib/cachetastic.rb
 - README
-- doc/classes/ActiveRecord/Base.html
+- LICENSE
 - doc/classes/Cachetastic/Adapters/Base.html
-- doc/classes/Cachetastic/Adapters/Drb.html
 - doc/classes/Cachetastic/Adapters/File.html
-- doc/classes/Cachetastic/Adapters/FileBase.html
-- doc/classes/Cachetastic/Adapters/HtmlFile.html
 - doc/classes/Cachetastic/Adapters/LocalMemory.html
-- doc/classes/Cachetastic/Adapters/Memcache.html
+- doc/classes/Cachetastic/Adapters/Memcached.html
+- doc/classes/Cachetastic/Adapters.html
+- doc/classes/Cachetastic/Cache.html
 - doc/classes/Cachetastic/Cacheable/ClassAndInstanceMethods.html
 - doc/classes/Cachetastic/Cacheable/ClassOnlyMethods.html
 - doc/classes/Cachetastic/Cacheable.html
-- doc/classes/Cachetastic/Caches/Base/RegisteredCaches.html
-- doc/classes/Cachetastic/Caches/Base.html
-- doc/classes/Cachetastic/Caches/MackSessionCache.html
-- doc/classes/Cachetastic/Caches/PageCache.html
-- doc/classes/Cachetastic/Caches/RailsSessionCache.html
-- doc/classes/Cachetastic/Connection.html
-- doc/classes/Cachetastic/Errors/UnsupportedAdapter.html
 - doc/classes/Cachetastic/Logger.html
-- doc/classes/CGI/Session/CachetasticStore.html
-- doc/classes/Object.html
-- doc/classes/String.html
 - doc/created.rid
 - doc/files/lib/cachetastic/adapters/base_rb.html
-- doc/files/lib/cachetastic/adapters/drb_rb.html
-- doc/files/lib/cachetastic/adapters/file_base_rb.html
 - doc/files/lib/cachetastic/adapters/file_rb.html
-- doc/files/lib/cachetastic/adapters/html_file_rb.html
 - doc/files/lib/cachetastic/adapters/local_memory_rb.html
-- doc/files/lib/cachetastic/adapters/memcache_rb.html
-- doc/files/lib/cachetastic/adapters/store_object_rb.html
+- doc/files/lib/cachetastic/adapters/memcached_rb.html
+- doc/files/lib/cachetastic/cache_rb.html
 - doc/files/lib/cachetastic/cacheable_rb.html
-- doc/files/lib/cachetastic/caches/base_rb.html
-- doc/files/lib/cachetastic/caches/mack_session_cache_rb.html
-- doc/files/lib/cachetastic/caches/page_cache_rb.html
-- doc/files/lib/cachetastic/caches/rails_session_cache_rb.html
-- doc/files/lib/cachetastic/connection_rb.html
-- doc/files/lib/cachetastic/errors/unsupported_adapter_rb.html
+- doc/files/lib/cachetastic/extensions/string_rb.html
 - doc/files/lib/cachetastic/logger_rb.html
-- doc/files/lib/cachetastic/rails_extensions/active_record_base_rb.html
-- doc/files/lib/cachetastic/rails_extensions/cgi_session_store_rb.html
-- doc/files/lib/cachetastic/ruby_extensions/kernel_rb.html
-- doc/files/lib/cachetastic/ruby_extensions/object_rb.html
-- doc/files/lib/cachetastic/ruby_extensions/string_rb.html
+- doc/files/lib/cachetastic/store_object_rb.html
 - doc/files/lib/cachetastic_rb.html
+- doc/files/LICENSE.html
 - doc/files/README.html
 - doc/fr_class_index.html
 - doc/fr_file_index.html
@@ -106,13 +93,12 @@ files:
 - doc/index.html
 - doc/rdoc-style.css
 has_rdoc: true
-homepage: http://www.mackframework.com
+homepage: http://www.metabates.com
 post_install_message: 
 rdoc_options: []
 
 require_paths: 
 - lib
-- lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
@@ -132,12 +118,5 @@ rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: A very simple, yet very powerful caching framework for Ruby.
-test_files: 
-- test/active_record_test.rb
-- test/cacheable_test.rb
-- test/cachetastic_unit_test.rb
-- test/config.rb
-- test/drb_adapter_test.rb
-- test/file_adapter_test.rb
-- test/memcache_adapter_test.rb
-- test/test_helper.rb
+test_files: []
+

data/bin/cachetastic_drb_server

@@ -1,115 +0,0 @@
-#!/usr/local/bin/ruby
-require 'thread'
-require 'drb'
-require 'singleton'
-require 'optparse'
-require 'optparse/time'
-require 'ostruct'
-
-# require the necessary gems:
-require 'rubygems'
-gem 'mack-facets'
-require 'mack-facets'
-gem 'configatron'
-require 'configatron'
-gem 'cachetastic'
-require 'cachetastic'
-
-$SAFE = 1
-
-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|
-  
-  opts.on("-h [HOST]") do |v|
-    SERVER_OPTIONS.host = v
-  end
-  
-  opts.on("-p [PORT]", Integer) do |v|
-    SERVER_OPTIONS.port = v
-  end
-  
-  opts.on("-c [CONFIG_FILE]") do |v|
-    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)
-
-if SERVER_OPTIONS.config_file
-  configatron.configure_from_yaml(SERVER_OPTIONS.config_file)
-end
-
-module Cachetastic
-  module Drb
-    class Server
-      include Singleton
-
-      def initialize
-        DRb.start_service("druby://#{SERVER_OPTIONS.host}:#{SERVER_OPTIONS.port}", self)
-        puts "Cachetastic::Drb::Server listening for connection..."
-        DRb.thread.join
-      end # initialize
-
-      def get(ns, key)
-        puts "get: #{ns}.#{key}" if SERVER_OPTIONS.verbose
-        puts cache_for_namespace(ns).inspect if SERVER_OPTIONS.really_verbose
-        value = cache_for_namespace(ns).get(key)
-        puts "\tvalue.class: #{value.class}" if SERVER_OPTIONS.verbose
-        value
-      end
-
-      def set(ns, key, value, expiry = 0)
-        puts "set: #{ns}.#{key}: #{value}" if SERVER_OPTIONS.verbose
-        cache_for_namespace(ns).set(key, value)
-        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 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
-
-      def ping
-        true
-      end
-
-      private
-      def cache_for_namespace(ns)
-        # puts "@store_for_#{ns}"
-        c = instance_variable_get("@store_for_#{ns}")
-        if c.nil?
-          instance_variable_set("@store_for_#{ns}", Cachetastic::Adapters::LocalMemory.new("store_for_#{ns}"))
-          c = instance_variable_get("@store_for_#{ns}")
-        end
-        c
-      end
-
-    end # Server
-  end # Drb
-end # Cachetastic
-
-# let's start `er up!
-Cachetastic::Drb::Server.instance