ramaze 2011.07.25 → 2011.10.23

data/lib/ramaze/bin/start.rb

@@ -7,11 +7,11 @@ module Ramaze
     # directory this command will look for a Rackup file in that directory,
     # otherwise it assumes the specified file is a Rackup file.
     #
-    # == Usage
+    # Usage:
     #
-    #  ramaze start
-    #  ramaze start /home/foobar/projects/blog/config.ru
-    #  ramaze start /home/foobar/projects/blog
+    #    ramaze start
+    #    ramaze start /home/foobar/projects/blog/config.ru
+    #    ramaze start /home/foobar/projects/blog
     #
     # @author Yorick Peterse
     # @since  21-07-2011
@@ -199,6 +199,21 @@ Example:
           params.push("#{opt}#{value}")
         end
 
+        start_server(rackup_path, rackup_config, *params)
+      end
+
+      ##
+      # Starts a server baed on the rackup path, rackup configuration file and
+      # additional parameters.
+      #
+      # @author Yorick Peterse
+      # @since  21-10-2011
+      # @param  [String] rackup_path The path to the Rackup executable.
+      # @param  [String] rackup_config The path to the config.ru file to use.
+      # @param  [Array] *params Additional parameters to pass to the ``exec()``
+      #  method.
+      #
+      def start_server(rackup_path, rackup_config, *params)
         exec('ruby', rackup_path, rackup_config, *params)
       end
     end # Start

data/lib/ramaze/bin/status.rb

@@ -5,10 +5,10 @@ module Ramaze
     # The status command can be used to show the details, such as the PID and
     # the CPU usage, of a running Ramaze application.
     #
-    # == Usage
+    # Usage:
     #
-    #  ramaze status
-    #  ramaze status /home/projects/ramaze/ramaze.pid
+    #    ramaze status
+    #    ramaze status /home/projects/ramaze/ramaze.pid
     #
     # @author Yorick Peterse
     # @author TJ Vanderpoel

data/lib/ramaze/bin/stop.rb

@@ -8,10 +8,10 @@ module Ramaze
     # case this command tries to find a file of which the name matches the name
     # of the current directory.
     #
-    # == Usage
+    # Usage:
     #
-    #  ramaze stop
-    #  ramaze stop /home/foobar/projects/ramaze/ramaze.pid
+    #    ramaze stop
+    #    ramaze stop /home/foobar/projects/ramaze/ramaze.pid
     #
     # @author Yorick Peterse
     # @author TJ Vanderpoel

data/lib/ramaze/cache.rb

@@ -11,6 +11,7 @@ module Ramaze
     autoload :LocalMemCache, 'ramaze/cache/localmemcache'
     autoload :MemCache,      'ramaze/cache/memcache'
     autoload :Sequel,        'ramaze/cache/sequel'
+    autoload :Redis,         'ramaze/cache/redis'
 
     ##
     # Clears the cache after a file has been reloaded.

data/lib/ramaze/cache/lru.rb

@@ -4,9 +4,13 @@
 module Ramaze
   class Cache
     ##
-    # Cache class that uses Ramaze::LRUHash as a storage engine. This cache has
-    # the advantage that unlike Innate::Cache::Memory it does not leak memory
-    # over time.
+    # Cache class that uses {Ramaze::LRUHash} as a storage engine. This cache
+    # has the advantage that unlike Innate::Cache::Memory it does not leak
+    # memory over time when using the cache for sessions.
+    #
+    # @example
+    #  Ramaze::Cache.options.session = Ramaze::Cache::LRU
+    #  Ramaze.setup_dependencies
     #
     # @author Michael Fellinger
     # @since  17-07-2009
@@ -28,7 +32,7 @@ module Ramaze
 
       ##
       # Prepares the cache by creating a new instance of Ramaze::LRUHash using
-      # the options set in Ramaze::Cache::LRU::OPTIONS.
+      # the options set in {Ramaze::Cache::LRU::OPTIONS}.
       #
       # @author Michael Fellinger
       # @since  17-07-2009

data/lib/ramaze/cache/memcache.rb

@@ -1,4 +1,6 @@
-require 'dalli'
+Ramaze.setup(:verbose => false) do
+  gem 'dalli'
+end
 
 # Kgio gives a nice performance boost but it isn't required
 begin; require 'kgio'; rescue LoadError => e; end
@@ -11,7 +13,7 @@ module Ramaze
     # Cache driver for the Memcache storage engine. Memcache is a key/value
     # store that's extremely useful for caching data such as views or API
     # responses. More inforamtion about Memcache can be found on it's website:
-    # http://memcached.org/.
+    # <http://memcached.org/>.
     #
     # Note that this cache driver requires the Dalli gem rather than Memcache
     # Client. The reason for this is that the Memcache client hasn't been
@@ -23,10 +25,27 @@ module Ramaze
     # This driver works similar to Ramaze::Cache::Sequel in that it allows you
     # to specify instance specific options uisng the using() method:
     #
-    #  Ramaze::Cache.options.view = Ramaze::Cache::Memcache.using(:compression => false)
+    #     Ramaze::Cache.options.session = Ramaze::Cache::MemCache.using(
+    #       :compression => false
+    #     )
     #
     # All options sent to the using() method will be sent to Dalli.
     #
+    # @example Using the default options
+    #  Ramaze::Cache.options.view = Ramaze::Cache::MemCache
+    #  Ramaze.setup_dependencies
+    #
+    #  Ramaze::Cache.view.store(:my_view, 'Hello Ramaze')
+    #
+    # @example Using custom options
+    #  Ramaze::Cache.options.view = Ramaze::Cache::MemCache.using(
+    #    :compression => false,
+    #    :servers     => ['localhost:11211', 'localhost:112112']
+    #  )
+    #
+    #  Ramaze.setup_dependencies
+    #  Ramaze::Cache.view.store(:my_view, 'Hello Ramaze')
+    #
     # @author Yorick Peterse
     # @since  04-05-2011
     #
@@ -49,7 +68,7 @@ module Ramaze
         :servers => ['localhost:11211']
       }
 
-      # Hash containing all the default options merged with the user specified 
+      # Hash containing all the default options merged with the user specified
       # ones
       attr_accessor :options
 
@@ -72,7 +91,7 @@ module Ramaze
         #    :compression => false,
         #    :username    => 'ramaze',
         #    :password    => 'ramaze123',
-        #    :servers     => ['othermachine.com:12345'] # Overwrites the default server
+        #    :servers     => ['othermachine.com:12345']
         #  )
         #
         # @author Yorick Peterse
@@ -86,31 +105,31 @@ module Ramaze
           merged = Ramaze::Cache::MemCache.trait[:default].merge(options)
           Class.new(self) { @options = merged }
         end
-      end
+      end # class << self
 
       ##
       # Creates a new instance of the cache class.
       #
       # @author Michael Fellinger
       # @since  04-05-2011
-      # @param  [Hash] options A hash with custom options, see 
+      # @param  [Hash] options A hash with custom options, see
       #  Ramaze::Cache::MemCache.using for all available options.
       #
       def initialize(options = {})
         self.class.options ||= Ramaze::Cache::MemCache.trait[:default].merge(
           options
         )
-        
+
         @options = options.merge(self.class.options)
       end
 
       ##
-      # Prepares the cache by creating the namespace and an instance of a Dalli 
+      # Prepares the cache by creating the namespace and an instance of a Dalli
       # client.
       #
       # @author Yorick Peterse
       # @since  04-05-2011
-      # @param  [String] hostname  The hostname of the machine running the 
+      # @param  [String] hostname  The hostname of the machine running the
       #  application.
       # @param  [String] username  The name of the user executing the process
       # @param  [String] appname   Unique identifier for the application.
@@ -125,7 +144,7 @@ module Ramaze
         options[:namespace] = [
           hostname, username, appname, cachename
         ].compact.join('-')
-        
+
         @client = ::Dalli::Client.new(options[:servers], options)
       end
 
@@ -153,7 +172,7 @@ module Ramaze
       end
 
       ##
-      # Fetches the specified key from the cache. It the value was nil the 
+      # Fetches the specified key from the cache. It the value was nil the
       # default value will be returned instead.
       #
       # @author Yorick Peterse
@@ -182,7 +201,7 @@ module Ramaze
       # @param  [String] key The name of the key to store.
       # @param  [Mixed] value The value to store in Memcache.
       # @param  [Fixnum] ttl The Time To Live to use for the current key.
-      # @param  [Hash] options A hash containing options specific for the 
+      # @param  [Hash] options A hash containing options specific for the
       #  specified key.
       # @return [Mixed]
       #

data/lib/ramaze/cache/redis.rb

@@ -0,0 +1,164 @@
+Ramaze.setup(:verbose => false) do
+  gem 'redis'
+end
+
+module Ramaze
+  class Cache
+    ##
+    # The Redis cache is a cache driver for Redis (http://redis.io/). Redis is a
+    # key/value store similar to Memcached but with the ability to flush data to
+    # a file among various other features.
+    #
+    # The usage of this cache is very similar to the Memcache driver. You load
+    # it by simply specifying the class:
+    #
+    #     Ramaze::Cache.options.session = Ramaze::Cache::Redis
+    #
+    # If you want to specify custom options you can do so by calling {.using} on
+    # the class:
+    #
+    #     Ramaze::Cache.options.session = Ramaze::Cache::Redis.using(...)
+    #
+    # @example Using a custom Redis host
+    #  Ramaze::Cache.options.names.push(:redis)
+    #  Ramaze::Cache.options.redis = Ramaze::Cache::Redis.using(
+    #    :host => '123.124.125.126',
+    #    :port => 6478
+    #  )
+    #
+    # @author Michael Fellinger
+    # @since  09-10-2011
+    #
+    class Redis
+      include Cache::API
+      include Innate::Traited
+
+      # Hash containing all the default options to use when no custom ones are
+      # specified in .using().
+      trait :default => {
+        :expires_in => 604800,
+        :host       => 'localhost',
+        :port       => 6379
+      }
+
+      # Hash containing all the default options merged with the user specified
+      # ones.
+      attr_accessor :options
+
+      class << self
+        attr_accessor :options
+
+        ##
+        # Creates a new instance of the cache class and merges the default
+        # options with the custom ones.
+        #
+        # Using this method you can specify custom options for various caches.
+        # For example, the Redis cache for your sessions could be located at
+        # server #1 while a custom cache is located on server #2.
+        #
+        # @author Yorick Peterse
+        # @since  09-10-2011
+        # @param  [Hash] options A hash containing custom options.
+        # @option options [Fixnum] :expires_in The default time after which a
+        #  key should expire.
+        # @option options [String] :host The hostname of the machine on which
+        #  Redis is running.
+        # @option options [Fixnum] :port The port number to connect to.
+        #
+        def using(options = {})
+          merged = Ramaze::Cache::Redis.trait[:default].merge(options)
+          Class.new(self) { @options = merged }
+        end
+      end # class << self
+
+      ##
+      # Creates a new instance of the cache and merges the options if they
+      # haven't already been set.
+      #
+      # @author Michael Fellinger
+      # @param  [Hash] options A hash with custom options. See
+      #  Ramaze::Cache::Redis.using() and the trait :default for more
+      #  information.
+      #
+      def initialize(options = {})
+        self.class.options ||= Ramaze::Cache::Redis.trait[:default].merge(
+          options
+        )
+
+        @options = options.merge(self.class.options)
+      end
+
+      ##
+      # Prepares the cache by setting up the namespace and loading Redis.
+      #
+      # @author Michael Fellinger
+      # @since  09-10-2011
+      # @param  [String] hostname The host of the machine that's running the
+      #  Ramaze application.
+      # @param  [String] username The name of the user that's running the
+      #  application.
+      # @param  [String] appname The name of the application (:pristine by
+      #  default).
+      # @param  [String] cachename The namespace to use for this cache instance.
+      #
+      def cache_setup(hostname, username, appname, cachename)
+        options[:namespace] = [
+          hostname, username, appname, cachename
+        ].compact.join('-')
+
+        @client = ::Redis.new(options)
+      end
+
+      ##
+      # Clears the entire cache.
+      #
+      # @author Michael Fellinger
+      # @since  09-10-2011
+      #
+      def cache_clear
+        @client.flushall
+      end
+
+      ##
+      # Removes a number of keys from the cache.
+      #
+      # @author Michael Fellinger
+      # @param  [Array] *keys An array of key names to remove.
+      #
+      def cache_delete(*keys)
+        @client.del(*keys)
+      end
+
+      ##
+      # Retrieves the value of the given key. If no value could be retrieved the
+      # default value (set to nil by default) will be returned instead.
+      #
+      # @author Michael Fellinger
+      # @param  [String] key The name of the key to retrieve.
+      # @param  [Mixed] default The default value.
+      # @return [Mixed]
+      #
+      def cache_fetch(key, default = nil)
+        value = @client.get(key)
+        value.nil? ? default : value
+      end
+
+      ##
+      # Stores a new value under the given key.
+      #
+      # @author Michael Fellinger
+      # @param  [String] key The name of the key to store.
+      # @param  [Mixed] value The value of the key.
+      # @param  [Fixnum] ttl The Time To Live of the key.
+      # @param  [Hash] options A hash containing key specific options.
+      # @option options :expires_in The time after which the key should expire.
+      #
+      def cache_store(key, value, ttl = nil, options = {})
+        ttl = options[:ttl] || @options[:expires_in]
+        @client.setex(key, ttl, value)
+
+        return value
+      end
+    end # Redis
+  end # Cache
+end # Ramaze

data/lib/ramaze/cache/sequel.rb

@@ -1,4 +1,6 @@
-require 'sequel'
+Ramaze.setup(:verbose => false) do
+  gem 'sequel'
+end
 
 module Ramaze
   class Cache
@@ -8,15 +10,15 @@ module Ramaze
     # databases are MySQL, SQLite3 and so on. In order to use this cache you'd
     # have to do the following:
     #
-    #  Ramaze::Cache.options.view = Ramaze::Cache::Sequel.using(
-    #    :connection => Sequel.mysql(
-    #      :host     => 'localhost', 
-    #      :user     => 'user',
-    #      :password => 'password', 
-    #      :database => 'blog'
-    #    ),
-    #    :table => :blog_sessions
-    #  )
+    #     Ramaze::Cache.options.view = Ramaze::Cache::Sequel.using(
+    #       :connection => Sequel.mysql(
+    #         :host     => 'localhost',
+    #         :user     => 'user',
+    #         :password => 'password',
+    #         :database => 'blog'
+    #       ),
+    #       :table => :blog_sessions
+    #     )
     #
     # If you already have an existing connection you can just pass the object to
     # the :connection option instead of creating a new connection manually.
@@ -24,6 +26,18 @@ module Ramaze
     # Massive thanks to Lars Olsson for patching the original Sequel cache so
     # that it supports multiple connections and other useful features.
     #
+    # @example Setting a custom database connection
+    #  Ramaze::Cache.options.names.push(:sequel)
+    #  Ramaze::Cache.options.sequel = Ramaze::Cache::Sequel.using(
+    #    :connection => Sequel.connect(
+    #      :adapter  => 'mysql2',
+    #      :host     => 'localhost',
+    #      :username => 'cache',
+    #      :password => 'cache123',
+    #      :database => 'ramaze_cache'
+    #    )
+    #  )
+    #
     # @author Lars Olsson
     # @since  18-04-2011
     #
@@ -46,7 +60,7 @@ module Ramaze
         :ttl => nil
       }
 
-      # Hash containing all the default options merged with the user specified 
+      # Hash containing all the default options merged with the user specified
       # ones
       attr_accessor :options
 
@@ -71,9 +85,9 @@ module Ramaze
         #  #
         #  Ramaze.options.cache.session = Ramaze::Cache::Sequel.using(
         #    :connection => Sequel.mysql(
-        #      :host     =>'localhost', 
+        #      :host     =>'localhost',
         #      :user     =>'user',
-        #      :password =>'password', 
+        #      :password =>'password',
         #      :database =>'blog'
         #    ),
         #    :table => :blog_sessions
@@ -117,21 +131,21 @@ module Ramaze
       #
       # @author Michael Fellinger
       # @since  04-05-2011
-      # @param  [Hash] options A hash with custom options, see 
+      # @param  [Hash] options A hash with custom options, see
       #  Ramaze::Cache::Sequel.using for all available options.
       #
       def initialize(options = {})
         self.class.options ||= Ramaze::Cache::Sequel.trait[:default].merge(
           options
         )
-        
+
         @options = options.merge(self.class.options)
       end
 
       ##
       # Executed after #initialize and before any other method.
       #
-      # Some parameters identifying the current process will be passed so caches 
+      # Some parameters identifying the current process will be passed so caches
       # that act in one global name-space can use them as a prefix.
       #
       # @author Lars Olsson
@@ -159,7 +173,7 @@ module Ramaze
       end
 
       ##
-      # Remove all key/value pairs from the cache. Should behave as if #delete 
+      # Remove all key/value pairs from the cache. Should behave as if #delete
       # had been called with all +keys+ as argument.
       #
       # @author Lars Olsson
@@ -173,7 +187,7 @@ module Ramaze
       # Remove the corresponding key/value pair for each key passed. If removing
       # is not an option it should set the corresponding value to nil.
       #
-      # If only one key was deleted, answer with the corresponding value. If 
+      # If only one key was deleted, answer with the corresponding value. If
       # multiple keys were deleted, answer with an Array containing the values.
       #
       # @author Lars Olsson
@@ -207,12 +221,12 @@ module Ramaze
 
           @dataset.filter(:key => nkeys).delete
         end
-        
+
         return result
       end
 
       ##
-      # Answer with the value associated with the +key+, +nil+ if not found or 
+      # Answer with the value associated with the +key+, +nil+ if not found or
       # expired.
       #
       # @author Lars Olsson
@@ -251,7 +265,7 @@ module Ramaze
       # @param  [Object] key The value is stored with this key
       # @param  [Object] value The key points to this value
       # @param  [Hash] options for now, only :ttl => Fixnum is used.
-      # @option options [Fixnum] :ttl The time in seconds after which the cache 
+      # @option options [Fixnum] :ttl The time in seconds after which the cache
       #  item should be expired.
       #
       def cache_store(key, value, options = {})
@@ -263,9 +277,9 @@ module Ramaze
         else
           ttl = Ramaze::Cache::Sequel.options[:ttl]
         end
- 
+
         expires = Time.now + ttl if ttl
-        
+
         # The row already exists, update it.
         if @dataset.filter(:key => nkey).count == 1
           serialized_value = serialize(value)
@@ -284,9 +298,10 @@ module Ramaze
           end
         end
 
-        # Try to deserialize the value. If this fails we'll return a different 
+        # Try to deserialize the value. If this fails we'll return a different
         # value
-        deserialized = deserialize(@dataset.select(:value).filter(:key => nkey)
+        deserialized = deserialize(@dataset.select(:value) \
+          .filter(:key => nkey) \
           .limit(1).first[:value])
 
         if deserialized
@@ -295,7 +310,7 @@ module Ramaze
           return value
         end
       end
-      
+
       ##
       # Prefixes the given key with current namespace.
       #
@@ -307,7 +322,7 @@ module Ramaze
       def namespaced(key)
         return [@namespace, key].join(':')
       end
-      
+
       ##
       # Deserialize method, adapted from Sequels serialize plugin
       # This method will try to deserialize a value using Marshal.load
@@ -329,7 +344,7 @@ module Ramaze
               Ramaze::Log::warn("Failed to deserialize #{value.inspect}")
             end
 
-            return nil            
+            return nil
           end
         end
       end