padrino-cache 0.11.4 → 0.12.0.rc1

data/lib/padrino-cache/parser.rb

@@ -1,36 +0,0 @@
-module Padrino
-  module Cache
-    ##
-    # Defines a padrino parser for our cache store.
-    #
-    module Parser
-      ##
-      # With Parser::Plain we will store
-      # text and object in a text format.
-      #
-      module Plain
-        def self.decode(code)
-          code.to_s
-        end
-
-        def self.encode(code)
-          code.to_s
-        end
-      end
-
-      ##
-      # With Parser::Marshal we will store
-      # text and object in a marshaled format.
-      #
-      module Marshal
-        def self.decode(code)
-          ::Marshal.load(code.to_s)
-        end
-
-        def self.encode(code)
-          ::Marshal.dump(code)
-        end
-      end
-    end
-  end
-end

data/lib/padrino-cache/store.rb

@@ -1,18 +0,0 @@
-module Padrino
-  module Cache
-    ##
-    # Defines the available storage adapters for persisting the cache.
-    #
-    module Store
-      # The defined duration for the expiration edge.
-      EXPIRES_EDGE = 86400
-
-      autoload :Base,     'padrino-cache/store/base'
-      autoload :File,     'padrino-cache/store/file'
-      autoload :Memcache, 'padrino-cache/store/memcache'
-      autoload :Memory,   'padrino-cache/store/memory'
-      autoload :Redis,    'padrino-cache/store/redis'
-      autoload :Mongo,    'padrino-cache/store/mongo'
-    end
-  end
-end

data/lib/padrino-cache/store/base.rb

@@ -1,76 +0,0 @@
-module Padrino
-  module Cache
-    module Store
-      ##
-      # Abstract Cache Store
-      #
-      class Base
-        ##
-        # Get the cache parser strategy.
-        #
-        # By default is plain, otherwise you can set **Marshal** or write your own.
-        #
-        def parser
-          @_parser
-        end
-
-        ##
-        # Set the caching parser strategy.
-        #
-        # @param value
-        #   Module of Padrino::Cache::Parser or any that respond to encode/decode.
-        #
-        # @example
-        #   # shorter version:
-        #   Padrino.cache.parser = :plain
-        #   Padrino.cache.parser = :marshal
-        #   # longer version:
-        #   Padrino.cache.parser = Padrino::Cache::Parser::Plain
-        #   Padrino.cache.parser = Padrino::Cache::Parser::Marshal
-        #
-        # You can easily write your own:
-        #
-        # @example
-        #   require 'oj'
-        #   module FastJSONParser
-        #     def self.encode(value)
-        #       Oj.dump(value)
-        #     end
-        #
-        #     def self.decode(value)
-        #       Oj.load(value)
-        #     end
-        #   end
-        #
-        #   Padrino.cache_parser = FastJSONParser
-        #
-        def parser=(mod)
-          mod = Padrino::Cache::Parser.const_get(mod.to_s.camelize) unless mod.is_a?(Module)
-          raise "#{mod} should respond to encode" unless mod.respond_to?(:encode)
-          raise "#{mod} should respond to decode" unless mod.respond_to?(:decode)
-          @_parser=mod
-        end
-
-        def initialize(options={})
-          @never = -1
-          self.parser = options[:parser] || :plain
-        end
-
-        private
-        def get_expiry( opts )
-          if opts && opts[:expires_in] && opts[:expires_in] != -1
-            expires_in = opts[:expires_in].to_i
-            expires_in = EXPIRES_EDGE  if expires_in > EXPIRES_EDGE
-            Time.now.to_i + expires_in
-          else
-            @never
-          end
-        end
-
-        def now_before?( expiry )
-          expiry.to_i == @never || expiry.to_i > Time.now.to_i
-        end
-      end
-    end
-  end
-end

data/lib/padrino-cache/store/file.rb

@@ -1,112 +0,0 @@
-module Padrino
-  module Cache
-    module Store
-      ##
-      # File based Cache Store.
-      #
-      class File < Base
-        ##
-        # Initialize File store with File root.
-        #
-        # @param [String] root
-        #   path to cache file.
-        #
-        # @example
-        #   Padrino.cache = Padrino::Cache::Store::File.new("path/to")
-        #   # Or from your app
-        #   set :cache, Padrino::Cache::Store::File.new("path/to")
-        #   # You can provide a marshal parser (to store ruby objects)
-        #   set :cache, Padrino::Cache::Store::File.new("path/to", :parser => :marshal)
-        #
-        def initialize(root, options={})
-          @root = root
-          super(options)
-        end
-
-        ##
-        # Return the value for the given key.
-        #
-        # @param [String] key
-        #   cache key
-        #
-        # @example
-        #   # with MyApp.cache.set('records', records)
-        #   MyApp.cache.get('records')
-        #
-        def get(key)
-          init
-          if ::File.exist?(path_for_key(key))
-            read_method = ::File.respond_to?(:binread) ? :binread : :read
-            contents    = ::File.send(read_method, path_for_key(key))
-            expiry, body = contents.split("\n", 2)
-            if now_before? expiry
-              parser.decode(body) if body
-            else # expire the key
-              delete(key)
-              nil
-            end
-          else # key can't be found
-            nil
-          end
-        end
-
-        ##
-        # Set the value for a given key and optionally with an expire time.
-        # Default expiry time is 86400.
-        #
-        # @param [String] key
-        #   cache key
-        # @param value
-        #   value of cache key
-        #
-        # @example
-        #   MyApp.cache.set('records', records)
-        #   MyApp.cache.set('records', records, :expires_in => 30) # => 30 seconds
-        #
-        def set(key, value, opts = nil)
-          init
-          value = parser.encode(value) if value
-          ::File.open(path_for_key(key), 'wb') { |f| f << get_expiry(opts).to_s << "\n" << value } if value
-        end
-
-        ##
-        # Delete the value for a given key.
-        #
-        # @param [String] key
-        #   cache key
-        # @param value
-        #   value of cache key
-        #
-        # @example
-        #   # with: MyApp.cache.set('records', records)
-        #   MyApp.cache.delete('records')
-        #
-        def delete(key)
-          init
-          Array(key).each { |k| FileUtils.rm_rf(path_for_key(k)) }
-        end
-
-        ##
-        # Reinitialize your cache.
-        #
-        # @example
-        #   # with: MyApp.cache.set('records', records)
-        #   MyApp.cache.flush
-        #   MyApp.cache.get('records') # => nil
-        #
-        def flush
-          FileUtils.rm_rf(@root)
-        end
-
-        private
-        def path_for_key(key)
-          ::File.join(@root, Rack::Utils.escape(key.to_s))
-        end
-
-        def init
-          FileUtils.mkdir_p(@root) unless ::File.exist?(@root)
-        end
-      end
-    end
-  end
-end

data/lib/padrino-cache/store/memcache.rb

@@ -1,85 +0,0 @@
-module Padrino
-  module Cache
-    module Store
-      ##
-      # Memcache Cache Store
-      #
-      class Memcache < Base
-        ##
-        # Initialize Memcache store with client connection.
-        #
-        # @param client
-        #   instance of Memcache library
-        #
-        # @example
-        #   Padrino.cache = Padrino::Cache::Store::Memcache.new(::Memcached.new('127.0.0.1:11211'))
-        #   Padrino.cache = Padrino::Cache::Store::Memcache.new(::Memcached.new('127.0.0.1:11211', :exception_retry_limit => 1))
-        #   # or from your app
-        #   set :cache, Padrino::Cache::Store::Memcache.new(::Memcached.new('127.0.0.1:11211'))
-        #   set :cache, Padrino::Cache::Store::Memcache.new(::Memcached.new('127.0.0.1:11211', :exception_retry_limit => 1))
-        #
-        def initialize(client, options={})
-          @backend = client
-          super(options)
-          @never = 0  # never TTL in Memcache is 0
-        end
-
-        ##
-        # Return the value for the given key.
-        #
-        # @param [String] key
-        #   cache key to retrieve value
-        #
-        # @example
-        #   MyApp.cache.get('records')
-        #
-        def get(key)
-          @backend.get(key)
-        rescue Memcached::NotFound
-          nil
-        end
-
-        ##
-        # Set the value for a given key and optionally with an expire time.
-        # Default expiry time is 86400.
-        #
-        # @param [String] key
-        #   cache key
-        # @param value
-        #   value of cache key
-        #
-        # @example
-        #   MyApp.cache.set('records', records)
-        #   MyApp.cache.set('records', records, :expires_in => 30) # => 30 seconds
-        #
-        def set(key, value, opts = nil)
-          @backend.set(key, value, get_expiry(opts))
-        end
-
-        ##
-        # Delete the value for a given key.
-        #
-        # @param [String] key
-        #   cache key
-        #
-        # @example
-        #   MyApp.cache.delete('records')
-        #
-        def delete(key)
-          @backend.delete(key)
-        end
-
-        ##
-        # Reinitialize your cache.
-        #
-        # @example
-        #   MyApp.cache.flush
-        #   MyApp.cache.get('records') # => nil
-        #
-        def flush
-          @backend.respond_to?(:flush_all) ? @backend.flush_all : @backend.flush
-        end
-      end
-    end
-  end
-end

data/lib/padrino-cache/store/memory.rb

@@ -1,95 +0,0 @@
-module Padrino
-  module Cache
-    module Store
-      ##
-      # Memory Cache Store
-      #
-      class Memory < Base
-        ##
-        # Initialize Memory Store with memory size.
-        #
-        # @param [Integer] size
-        #   Size of memory cache.
-        #
-        # @example
-        #   Padrino.cache = Padrino::Cache::Store::Memory.new(10000)
-        #   # or from your app
-        #   set :cache, Padrino::Cache::Store::Memory.new(10000)
-        #
-        def initialize(size = 5000, options={})
-          @size, @entries, @index = size, [], {}
-          super(options)
-        end
-
-        ##
-        # Return the value for the given key.
-        #
-        # @param [String] key
-        #   cache key to retrieve value
-        #
-        # @example
-        #   MyApp.cache.get('records')
-        #
-        def get(key)
-          if @index.key?(key) and value = @index[key]
-            expiry, body = value
-            if now_before? expiry
-              body
-            else
-              delete(key)
-              nil
-            end
-          else
-            nil
-          end
-        end
-
-        ##
-        # Set the value for a given key and optionally with an expire time.
-        # Default expiry is 86400.
-        #
-        # @param [String] key
-        #   cache key
-        # @param value
-        #   value of cache key
-        #
-        # @example
-        #   MyApp.cache.set('records', records)
-        #   MyApp.cache.set('records', records, :expires_in => 30) # => 30 seconds
-        #
-        def set(key, value, opts = nil)
-          delete(key)
-          @entries.push(key)
-          @index[key] = [get_expiry(opts), value]
-          while @entries.size > @size
-            delete(@entries.shift)
-          end
-        end
-
-        ##
-        # Delete the value for a given key.
-        #
-        # @param [String] key
-        #   cache key
-        #
-        # @example
-        #   MyApp.cache.delete('records')
-        #
-        def delete(key)
-          @index.delete(key)
-        end
-
-        ##
-        # Reinitialize your cache.
-        #
-        # @example
-        #   MyApp.cache.flush
-        #   MyApp.cache.get('records') # => nil
-        #
-        def flush
-          @index = Hash.new
-        end
-      end
-    end
-  end
-end

data/lib/padrino-cache/store/mongo.rb

@@ -1,127 +0,0 @@
-module Padrino
-  module Cache
-    module Store
-      ##
-      # MongoDB Cache Store
-      #
-      class Mongo < Base
-        ##
-        # Initialize Mongo store with client connection and optional username and password.
-        #
-        # @param client
-        #   Instance of Mongo connection
-        # @param [Hash] opts
-        #   options to pass into Mongo connection
-        #
-        # @example
-        #   Padrino.cache = Padrino::Cache::Store::Mongo.new(::Mongo::Connection.new('127.0.0.1', 27017).db('padrino'), :username => 'username', :password => 'password', :size => 64, :max => 100, :collection => 'cache')
-        #   # or from your app
-        #   set :cache, Padrino::Cache::Store::Mongo.new(::Mongo::Connection.new('127.0.0.1', 27017).db('padrino'), :username => 'username', :password => 'password', :size => 64, :max => 100, :collection => 'cache')
-        #   # you can provide a marshal parser (to store ruby objects)
-        #   set :cache, Padrino::Cache::Store::Mongo.new(::Mongo::Connection.new('127.0.0.1', 27017).db('padrino'), :parser => :marshal)
-        #
-        def initialize(client, options={})
-          @client = client
-          @options = {
-            :capped => true,
-            :collection => 'cache',
-            :size => 64,
-            :max => 100
-          }.merge(options)
-
-          if @options[:username] && @options[:password]
-            @client.authenticate(@options[:username], @options[:password], true)
-          end
-          @backend = get_collection
-          super(options)
-        end
-
-        ##
-        # Return the value for the given key.
-        #
-        # @param [String] key
-        #   cache key
-        #
-        # @example
-        #   MyApp.cache.get('records')
-        #
-        def get(key)
-          doc = @backend.find_one( :_id => key, '$or' => [ { :expires_at => { '$gt' => Time.now.to_i } }, { :expires_at => -1 } ] )
-          return nil if doc.nil?
-          expiry = doc['expires_at']
-          if now_before? expiry
-            parser.decode(doc['value'].to_s)
-          else
-            delete(key)
-            nil
-          end
-        end
-
-        ##
-        # Set or update the value for a given key and optionally with an expire time.
-        # Default expiry is Time.now + 86400s.
-        #
-        # @param [String] key
-        #   cache key
-        # @param value
-        #   value of cache key
-        #
-        # @example
-        #   MyApp.cache.set('records', records)
-        #   MyApp.cache.set('records', records, :expires_in => 30) # => 30 seconds
-        #
-        def set(key, value, opts = nil)
-          key = key.to_s
-          value = BSON::Binary.new(parser.encode(value)) if value
-          @backend.update(
-            {:_id => key},
-            {:_id => key, :value => value, :expires_at => get_expiry(opts) },
-            {:upsert => true}
-          )
-        end
-
-        ##
-        # Delete the value for a given key.
-        #
-        # @param [String] key
-        #   cache key
-        #
-        # @example
-        #   MyApp.cache.delete('records')
-        #
-        def delete(key)
-          if not @options[:capped]
-            @backend.remove({:_id => key})
-          else
-            # Mongo will overwrite it with a simple object {_id: new ObjectId()}
-            @backend.update({:_id => key},{},{:upsert => true})
-          end
-        end
-
-        ##
-        # Reinitialize your cache.
-        #
-        # @example
-        #   # with: MyApp.cache.set('records', records)
-        #   MyApp.cache.flush
-        #   MyApp.cache.get('records') # => nil
-        #
-        def flush
-          @backend.drop
-          @backend = get_collection
-        end
-
-        private
-        def get_collection
-          if @client.collection_names.include?(@options[:collection]) or !@options[:capped]
-            @client.collection @options[:collection]
-          else
-            @client.create_collection(@options[:collection], { :capped => @options[:capped],
-                                                               :size => @options[:size]*1024**2,
-                                                               :max => @options[:max] })
-          end
-        end
-      end
-    end
-  end
-end