joe-merb-core 0.9.8

data/lib/merb-core/dispatch/session/memcached.rb

@@ -0,0 +1,68 @@
+module Merb
+
+  # Sessions stored in memcached.
+  #
+  # Requires setup in your +init.rb+.
+  # 
+  # This for the 'memcache-client' gem:
+  #
+  #   Merb::BootLoader.after_app_loads do
+  #     require 'memcache'
+  #     Merb::MemcacheSession.store = 
+  #        MemCache.new('127.0.0.1:11211', :namespace => 'my_app')
+  #   end
+  #
+  # Or this for the 'memcached' gem:
+  #
+  #   Merb::BootLoader.after_app_loads do
+  #     require 'memcache'
+  #     Merb::MemcacheSession.store = 
+  #        Memcached.new('127.0.0.1:11211', :namespace => 'my_app')
+  #   end
+  
+  class MemcacheSession < SessionStoreContainer
+    
+    # The session store type
+    self.session_store_type = :memcache
+    
+  end
+  
+  module MemcacheStore
+
+    # Make the Memcached gem conform to the SessionStoreContainer interface
+
+    # ==== Parameters
+    # session_id<String>:: ID of the session to retrieve.
+    #
+    # ==== Returns
+    # ContainerSession:: The session corresponding to the ID.
+    def retrieve_session(session_id)
+      get("session:#{session_id}")
+    end
+
+    # ==== Parameters
+    # session_id<String>:: ID of the session to set.
+    # data<ContainerSession>:: The session to set.
+    def store_session(session_id, data)
+      set("session:#{session_id}", data)
+    end
+
+    # ==== Parameters
+    # session_id<String>:: ID of the session to delete.
+    def delete_session(session_id)
+      delete("session:#{session_id}")
+    end
+
+  end
+
+end
+
+# For the memcached gem.
+class Memcached
+  include Merb::MemcacheStore
+end
+
+# For the memcache-client gem.
+class MemCache
+  include Merb::MemcacheStore
+end

data/lib/merb-core/dispatch/session/memory.rb

@@ -0,0 +1,99 @@
+module Merb
+  
+  # Sessions stored in memory.
+  #
+  # Set it up by adding the following to your init file:
+  #
+  #  Merb::Config.use do |c|
+  #    c[:session_store]      = :memory
+  #    c[:memory_session_ttl] = 3600 # in seconds, one hour
+  #  end
+  #
+  # Sessions will remain in memory until the server is stopped or the time
+  # as set in :memory_session_ttl expires. Expired sessions are cleaned up in the
+  # background by a separate thread. Every time reaper
+  # cleans up expired sessions, garbage collection is scheduled start.
+  #
+  # Memory session is accessed in a thread safe manner.
+  class MemorySession < SessionStoreContainer
+    
+    # The session store type
+    self.session_store_type = :memory
+    
+    # Bypass normal implicit class attribute reader - see below.
+    def store
+      self.class.store
+    end
+    
+    # Lazy load/setup of MemorySessionStore.
+    def self.store
+      @_store ||= MemorySessionStore.new(Merb::Config[:memory_session_ttl])
+    end
+    
+  end
+  
+  # Used for handling multiple sessions stored in memory.
+  class MemorySessionStore
+
+    # ==== Parameters
+    # ttl<Fixnum>:: Session validity time in seconds. Defaults to 1 hour.
+    def initialize(ttl=nil)
+      @sessions = Hash.new
+      @timestamps = Hash.new
+      @mutex = Mutex.new
+      @session_ttl = ttl || Merb::Const::HOUR # defaults 1 hour
+      start_timer
+    end
+    
+    # ==== Parameters
+    # session_id<String>:: ID of the session to retrieve.
+    #
+    # ==== Returns
+    # ContainerSession:: The session corresponding to the ID.
+    def retrieve_session(session_id)
+      @mutex.synchronize {
+        @timestamps[session_id] = Time.now
+        @sessions[session_id]
+      }
+    end
+
+    # ==== Parameters
+    # session_id<String>:: ID of the session to set.
+    # data<ContainerSession>:: The session to set.
+    def store_session(session_id, data)
+      @mutex.synchronize {
+        @timestamps[session_id] = Time.now
+        @sessions[session_id] = data
+      }
+    end
+
+    # ==== Parameters
+    # session_id<String>:: ID of the session to delete.
+    def delete_session(session_id)
+      @mutex.synchronize {
+        @timestamps.delete(session_id)
+        @sessions.delete(session_id)
+      }
+    end
+
+    # Deletes any sessions that have reached their maximum validity.
+    def reap_expired_sessions
+      @timestamps.each do |session_id,stamp|
+        delete_session(session_id) if (stamp + @session_ttl) < Time.now 
+      end
+      GC.start
+    end
+
+    # Starts the timer that will eventually reap outdated sessions.
+    def start_timer
+      Thread.new do
+        loop {
+          sleep @session_ttl
+          reap_expired_sessions
+        } 
+      end  
+    end
+    
+  end
+
+end

data/lib/merb-core/dispatch/session/store_container.rb

@@ -0,0 +1,150 @@
+module Merb
+  
+  class SessionStoreContainer < SessionContainer
+    
+    class_inheritable_accessor :store
+    attr_accessor  :_fingerprint
+    
+    # The class attribute :store holds a reference to an object that implements 
+    # the following interface:
+    #
+    # - retrieve_session(session_id) # returns a Hash
+    # - store_session(session_id, data) # expects data to be Hash
+    # - delete_session(session_id)
+    #
+    # You can use session store classes directly by assigning to :store in your
+    # config/init.rb after_app_loads step, for example:
+    #
+    #   Merb::BootLoader.after_app_loads do
+    #     SessionStoreContainer.store = MemorySession.new
+    #   end
+    #
+    # Or you can inherit from SessionStoreContainer to create a SessionContainer
+    # that delegates to aggregated store.
+    #
+    #   class MemorySession < SessionStoreContainer
+    #     self.session_store_type = :memory
+    #   end
+    #
+    #   class MemoryContainer
+    #   
+    #     def self.retrieve_session(session_id)
+    #       ...
+    #     end
+    #   
+    #     def self.store_session(session_id, data)
+    #       ...
+    #     end
+    #   
+    #     def self.delete_session(session_id)
+    #       ...
+    #     end
+    #   
+    #   end    
+    # When used directly, report as :store store
+    self.session_store_type = :store
+    
+    class << self
+
+      # Generates a new session ID and creates a new session.
+      #
+      # ==== Returns
+      # SessionStoreContainer:: The new session.
+      def generate
+        session = new(Merb::SessionMixin.rand_uuid)
+        session.needs_new_cookie = true
+        session
+      end
+
+      # Setup a new session.
+      #
+      # ==== Parameters
+      # request<Merb::Request>:: The Merb::Request that came in from Rack.
+      #
+      # ==== Returns
+      # SessionContainer:: a SessionContainer. If no sessions were found, 
+      # a new SessionContainer will be generated.
+      def setup(request)
+        session = retrieve(request.session_id)
+        request.session = session
+        # TODO Marshal.dump is slow - needs optimization
+        session._fingerprint = Marshal.dump(request.session.to_hash).hash
+        session
+      end
+            
+      private
+      
+      # ==== Parameters
+      # session_id<String:: The ID of the session to retrieve.
+      #
+      # ==== Returns
+      # SessionStoreContainer:: SessionStoreContainer instance with the session data. If no
+      #   sessions matched session_id, a new SessionStoreContainer will be generated.
+      #
+      # ==== Notes
+      # If there are persisted exceptions callbacks to execute, they all get executed
+      # when Memcache library raises an exception.
+      def retrieve(session_id)
+        unless session_id.blank?
+          begin
+            session_data = store.retrieve_session(session_id)
+          rescue => err
+            Merb.logger.warn!("Could not retrieve session from #{self.name}: #{err.message}")
+          end
+          # Not in container, but assume that cookie exists
+          session_data = new(session_id) if session_data.nil?
+        else
+          # No cookie...make a new session_id
+          session_data = generate
+        end
+        if session_data.is_a?(self)
+          session_data
+        else
+          # Recreate using the existing session as the data, when switching 
+          # from another session type for example, eg. cookie to memcached
+          # or when the data is just a hash
+          new(session_id).update(session_data)
+        end
+      end
+
+    end
+    
+    # Teardown and/or persist the current session.
+    #
+    # If @_destroy is true, clear out the session completely, including
+    # removal of the session cookie itself.
+    #
+    # ==== Parameters
+    # request<Merb::Request>:: The Merb::Request that came in from Rack.
+    #
+    # ==== Notes
+    # The data (self) is converted to a Hash first, since a container might 
+    # choose to do a full Marshal on the data, which would make it persist 
+    # attributes like 'needs_new_cookie', which it shouldn't.
+    def finalize(request)
+      if @_destroy
+        store.delete_session(self.session_id)
+        request.destroy_session_cookie
+      else
+        if _fingerprint != Marshal.dump(data = self.to_hash).hash
+          begin
+            store.store_session(request.session(self.class.session_store_type).session_id, data)
+          rescue => err
+            Merb.logger.warn!("Could not persist session to #{self.class.name}: #{err.message}")
+          end
+        end
+        if needs_new_cookie || Merb::SessionMixin.needs_new_cookie?
+          request.set_session_id_cookie(self.session_id)
+        end
+      end
+    end
+
+    # Regenerate the session ID.
+    def regenerate
+      store.delete_session(self.session_id)
+      self.session_id = Merb::SessionMixin.rand_uuid
+      store.store_session(self.session_id, self)
+    end
+    
+  end
+end

data/lib/merb-core/dispatch/worker.rb

@@ -0,0 +1,28 @@
+module Merb
+  class Worker
+    
+    attr_accessor :thread
+    
+    def initialize
+      @thread = Thread.new { loop { process_queue } }
+    end
+    
+    def process_queue
+      begin
+        while blk = Merb::Dispatcher.work_queue.pop
+           # we've been blocking on the queue waiting for an item sleeping.
+           # when someone pushes an item it wakes up this thread so we 
+           # immediately pass execution to the scheduler so we don't 
+           # accidentally run this block before the action finishes 
+           # it's own processing
+          Thread.pass
+          blk.call
+        end
+      rescue Exception => e
+        Merb.logger.warn! %Q!Worker Thread Crashed with Exception:\n#{Merb.exception(e)}\nRestarting Worker Thread!
+        retry
+      end    
+    end
+    
+  end
+end    

data/lib/merb-core/gem_ext/erubis.rb

@@ -0,0 +1,77 @@
+require 'erubis'
+module Erubis
+  module Basic::Converter
+    def convert_input(src, input)
+      pat = @pattern
+      regexp = pat.nil? || pat == '<% %>' ? DEFAULT_REGEXP : pattern_regexp(pat)
+      pos = 0
+      is_bol = true     # is beginning of line
+      input.scan(regexp) do |indicator, code, tailch, rspace|
+        match = Regexp.last_match()
+        len  = match.begin(0) - pos
+        text = input[pos, len]
+        pos  = match.end(0)
+        ch   = indicator ? indicator[0] : nil
+        lspace = ch == ?= ? nil : detect_spaces_at_bol(text, is_bol)
+        is_bol = rspace ? true : false
+        add_text(src, text) if text && !text.empty?
+        ## * when '<%= %>', do nothing
+        ## * when '<% %>' or '<%# %>', delete spaces iff only spaces are around '<% %>'
+        if ch == ?=              # <%= %>
+          rspace = nil if tailch && !tailch.empty?
+          add_text(src, lspace) if lspace
+          add_expr(src, code, indicator)
+          add_text(src, rspace) if rspace
+        elsif ch == ?\#          # <%# %>
+          n = code.count("\n") + (rspace ? 1 : 0)
+          if @trim && lspace && rspace
+            add_stmt(src, "\n" * n)
+          else
+            add_text(src, lspace) if lspace
+            add_stmt(src, "\n" * n)
+            add_text(src, rspace) if rspace
+          end
+        elsif ch == ?%           # <%% %>
+          s = "#{lspace}#{@prefix||='<%'}#{code}#{tailch}#{@postfix||='%>'}#{rspace}"
+          add_text(src, s)
+        else                     # <% %>
+          if @trim && lspace && rspace
+            if respond_to?(:add_stmt2)
+              add_stmt2(src, "#{lspace}#{code}#{rspace}", tailch)
+            else
+              add_stmt(src, "#{lspace}#{code}#{rspace}")
+            end
+          else
+            add_text(src, lspace) if lspace
+            if respond_to?(:add_stmt2)
+              add_stmt2(src, code, tailch)
+            else
+              add_stmt(src, code)
+            end
+            add_text(src, rspace) if rspace
+          end
+        end
+      end
+      #rest = $' || input                        # ruby1.8
+      rest = pos == 0 ? input : input[pos..-1]   # ruby1.9
+      add_text(src, rest)
+    end
+    
+  end
+  
+  class MEruby < Erubis::Eruby
+    include PercentLineEnhancer
+    include StringBufferEnhancer
+  end
+
+  # Loads a file, runs it through Erubis and parses it as YAML.
+  #
+  # ===== Parameters
+  # file<String>:: The name of the file to load.
+  # binding<Binding>::
+  #   The binding to use when evaluating the ERB tags. Defaults to the current
+  #   binding.
+  def self.load_yaml_file(file, binding = binding)
+    YAML::load(Erubis::MEruby.new(IO.read(File.expand_path(file))).result(binding))
+  end
+end

data/lib/merb-core/logger.rb

@@ -0,0 +1,215 @@
+# Merb::Logger = Extlib::Logger
+
+class Merb::Logger < Extlib::Logger
+  def verbose!(message, level = :warn)
+    send("#{level}!", message) if Merb::Config[:verbose]
+  end
+
+  def verbose(message, level = :warn)
+    send(level, message) if Merb::Config[:verbose]
+  end
+end
+
+# require "time" # httpdate
+# ==== Public Merb Logger API
+#
+# To replace an existing logger with a new one:
+#  Merb::Logger.set_log(log{String, IO},level{Symbol, String})
+#
+# Available logging levels are
+#   Merb::Logger::{ Fatal, Error, Warn, Info, Debug }
+#
+# Logging via:
+#   Merb.logger.fatal(message<String>,&block)
+#   Merb.logger.error(message<String>,&block)
+#   Merb.logger.warn(message<String>,&block)
+#   Merb.logger.info(message<String>,&block)
+#   Merb.logger.debug(message<String>,&block)
+#
+# Logging with autoflush:
+#   Merb.logger.fatal!(message<String>,&block)
+#   Merb.logger.error!(message<String>,&block)
+#   Merb.logger.warn!(message<String>,&block)
+#   Merb.logger.info!(message<String>,&block)
+#   Merb.logger.debug!(message<String>,&block)
+#
+# Flush the buffer to 
+#   Merb.logger.flush
+#
+# Remove the current log object
+#   Merb.logger.close
+# 
+# ==== Private Merb Logger API
+# 
+# To initialize the logger you create a new object, proxies to set_log.
+#   Merb::Logger.new(log{String, IO},level{Symbol, String})
+module Merb
+
+  class Logger
+
+    attr_accessor :level
+    attr_accessor :delimiter
+    attr_accessor :auto_flush
+    attr_reader   :buffer
+    attr_reader   :log
+    attr_reader   :init_args
+
+    # ==== Notes
+    # Ruby (standard) logger levels:
+    # :fatal:: An unhandleable error that results in a program crash
+    # :error:: A handleable error condition
+    # :warn:: A warning
+    # :info:: generic (useful) information about system operation
+    # :debug:: low-level information for developers
+    Levels = 
+    {
+      :fatal => 7, 
+      :error => 6, 
+      :warn  => 4,
+      :info  => 3,
+      :debug => 0
+    } unless const_defined?(:Levels)
+
+    @@mutex = {}
+
+    private
+
+    # Readies a log for writing.
+    #
+    # ==== Parameters
+    # log<IO, String>:: Either an IO object or a name of a logfile.
+    def initialize_log(log)
+      close if @log # be sure that we don't leave open files laying around.
+
+      if log.respond_to?(:write)
+        @log = log
+      elsif File.exist?(log)
+        @log = open(log, (File::WRONLY | File::APPEND))
+        @log.sync = true
+      else
+        FileUtils.mkdir_p(File.dirname(log)) unless File.directory?(File.dirname(log))
+        @log = open(log, (File::WRONLY | File::APPEND | File::CREAT))
+        @log.sync = true
+        @log.write("#{Time.now.httpdate} #{delimiter} info #{delimiter} Logfile created\n")
+      end
+    end
+
+    public
+
+    # To initialize the logger you create a new object, proxies to set_log.
+    #
+    # ==== Parameters
+    # *args:: Arguments to create the log from. See set_logs for specifics.
+    def initialize(*args)
+      set_log(*args)
+    end
+
+    # Replaces an existing logger with a new one.
+    # 
+    # ==== Parameters
+    # log<IO, String>:: Either an IO object or a name of a logfile.
+    # log_level<~to_sym>::
+    #   The log level from, e.g. :fatal or :info. Defaults to :error in the
+    #   production environment and :debug otherwise.
+    # delimiter<String>::
+    #   Delimiter to use between message sections. Defaults to " ~ ".
+    # auto_flush<Boolean>::
+    #   Whether the log should automatically flush after new messages are
+    #   added. Defaults to false.
+    def set_log(stream = Merb::Config[:log_stream],
+      log_level = Merb::Config[:log_level], 
+      delimiter = Merb::Config[:log_delimiter], 
+      auto_flush = Merb::Config[:log_auto_flush])
+      
+      @buffer                   = []
+      @delimiter                = delimiter
+      @auto_flush               = auto_flush
+      
+      if Levels[log_level]
+        @level                  = Levels[log_level]
+      else
+        @level                  = log_level
+      end
+
+      @log                      = stream
+      @mutex = (@@mutex[@log] ||= Mutex.new)
+    end
+
+    # Flush the entire buffer to the log object.
+    def flush
+      return unless @buffer.size > 0
+      @mutex.synchronize do
+        @log.write(@buffer.slice!(0..-1).to_s)
+      end
+    end
+
+    # Close and remove the current log object.
+    def close
+      flush
+      @log.close if @log.respond_to?(:close) && !@log.tty?
+      @log = nil
+    end
+
+    # Appends a message to the log. The methods yield to an optional block and
+    # the output of this block will be appended to the message.
+    #
+    # ==== Parameters
+    # string<String>:: The message to be logged. Defaults to nil.
+    #
+    # ==== Returns
+    # String:: The resulting message added to the log file.
+    def <<(string = nil)
+      message = ""
+      message << delimiter
+      message << string if string
+      message << "\n" unless message[-1] == ?\n
+      @buffer << message
+      flush if @auto_flush
+
+      message
+    end
+    alias :push :<<
+
+    # Generate the logging methods for Merb.logger for each log level.
+    Levels.each_pair do |name, number|
+      class_eval <<-LEVELMETHODS, __FILE__, __LINE__
+
+      # Appends a message to the log if the log level is at least as high as
+      # the log level of the logger.
+      #
+      # ==== Parameters
+      # string<String>:: The message to be logged. Defaults to nil.
+      #
+      # ==== Returns
+      # self:: The logger object for chaining.
+      def #{name}(message = nil)
+        self << message if #{number} >= level
+        self
+      end
+
+      # Appends a message to the log if the log level is at least as high as
+      # the log level of the logger. The bang! version of the method also auto
+      # flushes the log buffer to disk.
+      #
+      # ==== Parameters
+      # string<String>:: The message to be logged. Defaults to nil.
+      #
+      # ==== Returns
+      # self:: The logger object for chaining.
+      def #{name}!(message = nil)
+        self << message if #{number} >= level
+        flush if #{number} >= level
+        self
+      end
+
+      # ==== Returns
+      # Boolean:: True if this level will be logged by this logger.
+      def #{name}?
+        #{number} >= level
+      end
+      LEVELMETHODS
+    end
+
+  end
+  
+end