mack 0.8.1 → 0.8.2

data/lib/gems/configatron-2.1.5/lib/configatron.rb

@@ -0,0 +1,6 @@
+base = File.join(File.dirname(__FILE__), 'configatron')
+require 'yaml'
+require File.join(base, 'kernel')
+require File.join(base, 'configatron')
+require File.join(base, 'store')
+require File.join(base, 'errors')

data/lib/gems/configatron-2.1.5/lib/configatron/configatron.rb

@@ -0,0 +1,52 @@
+require 'singleton'
+
+class Configatron
+  include Singleton
+  
+  def initialize # :nodoc:
+    @_namespace = :default
+    reset!
+  end
+  
+  # Forwards the method call onto the 'namespaced' Configatron::Store
+  def method_missing(sym, *args)
+    @_store[@_namespace].send(sym, *args)
+  end
+  
+  # Removes ALL configuration parameters
+  def reset!
+    @_store = {:default => Configatron::Store.new}
+  end
+  
+  # Allows for the temporary overriding of parameters in a block.
+  # Takes an optional Hash of parameters that will be applied before
+  # the block gets called. At the end of the block, the temporary
+  # settings are deleted and the original settings are reinstated.
+  def temp(options = nil)
+    begin
+      temp_start(options)
+      yield
+    rescue Exception => e
+      raise e
+    ensure
+      temp_end
+    end
+  end
+  
+  def temp_start(options = nil)
+    @_namespace = rand
+    @_store[@_namespace] = @_store[:default].deep_clone
+    if options
+      self.method_missing(:configure_from_hash, options)
+    end
+  end
+  
+  def temp_end
+    @_store.delete(@_namespace)
+    @_namespace = :default
+  end
+  
+  undef :inspect # :nodoc:
+  undef :nil? # :nodoc:
+  
+end

data/lib/gems/configatron-2.1.5/lib/configatron/errors.rb

@@ -0,0 +1,7 @@
+class Configatron
+  class ProtectedParameter < StandardError
+    def intialize(name)
+      super("Can not modify protected parameter: '#{name}'")
+    end
+  end
+end

data/lib/gems/configatron-2.1.5/lib/configatron/kernel.rb

@@ -0,0 +1,8 @@
+module Kernel
+  
+  # Provides access to the Configatron storage system.
+  def configatron
+    Configatron.instance
+  end
+  
+end

data/lib/gems/configatron-2.1.5/lib/configatron/store.rb

@@ -0,0 +1,224 @@
+class Configatron
+  class Store
+    
+    # Takes an optional Hash of parameters
+    def initialize(options = {}, name = nil, parent = nil)
+      @_name = name
+      @_parent = parent
+      @_store = {}
+      configure_from_hash(options)
+      @_protected = []
+    end
+    
+    # Returns a Hash representing the configurations
+    def to_hash
+      @_store
+    end
+    
+    def inspect
+      path = [@_name]
+      parent = @_parent
+      until parent.nil?
+        path << parent.instance_variable_get('@_name')
+        parent = parent.instance_variable_get('@_parent')
+      end
+      path << 'configatron'
+      path.compact!
+      path.reverse!
+      f_out = []
+      @_store.each do |k, v|
+        if v.is_a?(Configatron::Store)
+          v.inspect.each do |line|
+            if line.match(/\n/)
+              line.each do |l|
+                l.strip!
+                f_out << l
+              end
+            else
+              line.strip!
+              f_out << line
+            end
+          end
+        else
+          f_out << "#{path.join('.')}.#{k} = #{v.inspect}"
+        end
+      end
+      f_out.compact.sort.join("\n")
+    end
+
+    # Allows for the configuration of the system via a Hash
+    def configure_from_hash(options)
+      parse_options(options)
+    end
+
+    # Allows for the configuration of the system from a YAML file.
+    # Takes the path to the YAML file.  Also takes an optional parameter,
+    # <tt>:hash</tt>, that indicates a specific hash that should be
+    # loaded from the file. 
+    def configure_from_yaml(path, opts = {})
+      begin
+        yml = YAML.load(File.read(path))
+        yml = yml[opts[:hash]] unless opts[:hash].nil?
+        configure_from_hash(yml)
+      rescue Errno::ENOENT => e
+        puts e.message
+      end
+    end
+
+    # Returns true if there are no configuration parameters
+    def nil?
+      return @_store.empty?
+    end
+
+    # Retrieves a certain parameter and if that parameter
+    # doesn't exist it will return the default_value specified.
+    def retrieve(name, default_value = nil)
+      @_store[name.to_sym] || default_value
+    end
+    
+    # Removes a parameter. In the case of a nested parameter
+    # it will remove all below it.
+    def remove(name)
+      @_store.delete(name.to_sym)
+    end
+
+    # Sets a 'default' value. If there is already a value specified
+    # it won't set the value.
+    def set_default(name, default_value)
+      unless @_store[name.to_sym]
+        @_store[name.to_sym] = parse_options(default_value)
+      end
+    end
+    
+    def method_missing(sym, *args) # :nodoc:
+      if sym.to_s.match(/(.+)=$/)
+        name = sym.to_s.gsub("=", '').to_sym
+        raise Configatron::ProtectedParameter.new(name) if @_protected.include?(name) || self.methods.include?(name.to_s)
+        @_store[name] = parse_options(*args)
+      elsif @_store.has_key?(sym)
+        return @_store[sym]
+      else
+        store = Configatron::Store.new({}, sym, self)
+        @_store[sym] = store
+        return store
+      end
+    end
+    
+    def ==(other) # :nodoc:
+      self.to_hash == other
+    end
+    
+    # Prevents a parameter from being reassigned. If called on a 'namespace' then
+    # all parameters below it will be protected as well.
+    def protect(name)
+      @_protected << name.to_sym
+    end
+    
+    # Prevents all parameters from being reassigned.
+    def protect_all!
+      @_protected.clear
+      @_store.keys.each do |k|
+        val = self.send(k)
+        val.protect_all! if val.class == Configatron::Store
+        @_protected << k
+      end
+    end
+    
+    # Removes the protection of a parameter.
+    def unprotect(name)
+      @_protected.reject! { |e| e == name.to_sym }
+    end
+    
+    def unprotect_all!
+      @_protected.clear
+      @_store.keys.each do |k|
+        val = self.send(k)
+        val.unprotect_all! if val.class == Configatron::Store
+      end
+    end
+    
+    # = DeepClone
+    #
+    # == Version
+    #  1.2006.05.23 (change of the first number means Big Change)
+    #
+    # == Description
+    #  Adds deep_clone method to an object which produces deep copy of it. It means
+    #  if you clone a Hash, every nested items and their nested items will be cloned.
+    #  Moreover deep_clone checks if the object is already cloned to prevent endless recursion.
+    #
+    # == Usage
+    #
+    #  (see examples directory under the ruby gems root directory)
+    #
+    #   require 'rubygems'
+    #   require 'deep_clone'
+    #
+    #   include DeepClone
+    #
+    #   obj = []
+    #   a = [ true, false, obj ]
+    #   b = a.deep_clone
+    #   obj.push( 'foo' )
+    #   p obj   # >> [ 'foo' ]
+    #   p b[2]  # >> []
+    #
+    # == Source
+    # http://simplypowerful.1984.cz/goodlibs/1.2006.05.23
+    #
+    # == Author
+    #  jan molic (/mig/at_sign/1984/dot/cz/)
+    #
+    # == Licence
+    #  You can redistribute it and/or modify it under the same terms of Ruby's license;
+    #  either the dual license version in 2003, or any later version.
+    #
+    def deep_clone( obj=self, cloned={} )
+      if cloned.has_key?( obj.object_id )
+        return cloned[obj.object_id]
+      else
+        begin
+          cl = obj.clone
+        rescue Exception
+          # unclonnable (TrueClass, Fixnum, ...)
+          cloned[obj.object_id] = obj
+          return obj
+        else
+          cloned[obj.object_id] = cl
+          cloned[cl.object_id] = cl
+          if cl.is_a?( Hash )
+            cl.clone.each { |k,v|
+              cl[k] = deep_clone( v, cloned )
+            }
+          elsif cl.is_a?( Array )
+            cl.collect! { |v|
+              deep_clone( v, cloned )
+            }
+          end
+          cl.instance_variables.each do |var|
+            v = cl.instance_eval( var )
+            v_cl = deep_clone( v, cloned )
+            cl.instance_eval( "#{var} = v_cl" )
+          end
+          return cl
+        end
+      end
+    end
+    
+    private
+    def parse_options(options)
+      if options.is_a?(Hash)
+        options.each do |k,v|
+          if v.is_a?(Hash)
+            self.method_missing(k.to_sym).configure_from_hash(v)
+          else
+            self.method_missing("#{k.to_sym}=", v)
+          end
+        end
+      else
+        return options
+      end
+    end
+    
+  end
+end

data/lib/gems/daemons-1.0.10/lib/daemons.rb

@@ -0,0 +1,283 @@
+require 'optparse'
+require 'optparse/time'
+
+
+require 'daemons/pidfile'  
+require 'daemons/cmdline'
+require 'daemons/exceptions'
+require 'daemons/monitor'
+
+
+require 'daemons/application'
+require 'daemons/application_group'
+require 'daemons/controller'
+
+
+# All functions and classes that Daemons provides reside in this module.
+#
+# Daemons is normally invoked by one of the following four ways:
+#
+# 1.  <tt>Daemons.run(script, options)</tt>:
+#     This is used in wrapper-scripts that are supposed to control other ruby scripts or
+#     external applications. Control is completely passed to the daemons library.
+#     Such wrapper script need to be invoked with command line options like 'start' or 'stop'
+#     to do anything useful.
+#
+# 2.  <tt>Daemons.run_proc(app_name, options) { (...) }</tt>:
+#     This is used in wrapper-scripts that are supposed to control a proc. 
+#     Control is completely passed to the daemons library.
+#     Such wrapper script need to be invoked with command line options like 'start' or 'stop'
+#     to do anything useful.
+#
+# 3.  <tt>Daemons.call(options) { block }</tt>:
+#     Execute the block in a new daemon. <tt>Daemons.call</tt> will return immediately
+#     after spawning the daemon with the new Application object as a return value.
+#
+# 4.  <tt>Daemons.daemonize(options)</tt>:
+#     Daemonize the currently runnig process, i.e. the calling process will become a daemon.
+#
+# == What does daemons internally do with my daemons?
+# *or*:: why do my daemons crash when they try to open a file?
+# *or*:: why can I not see any output from the daemon on the console (when using for example +puts+)?
+#
+# From a technical aspect of view, daemons does the following when creating a daemon:
+#
+# 1.  Forks a child (and exits the parent process, if needed)
+# 2.  Becomes a session leader (which detaches the program from
+#     the controlling terminal).
+# 3.  Forks another child process and exits first child. This prevents
+#     the potential of acquiring a controlling terminal.
+# 4.  Changes the current working directory to "/".
+# 5.  Clears the file creation mask (sets +umask+ to 0000).
+# 6.  Closes file descriptors (reopens +STDOUT+ and +STDERR+ to point to a logfile if
+#     possible).
+#
+# So what does this mean for your daemons:
+# - the current directory is '/'
+# - you cannot receive any input from the console (for example no +gets+)
+# - you cannot output anything from the daemons with +puts+/+print+ unless a logfile is used
+#
+# == How do PidFiles work? Where are they stored?
+#
+# Also, you are maybe interested in reading the documentation for the class PidFile.
+# There you can find out about how Daemons works internally and how and where the so
+# called <i>PidFiles</i> are stored.
+#
+module Daemons
+
+  VERSION = "1.0.10"
+  
+  require 'daemons/daemonize'
+  
+  
+  # Passes control to Daemons.
+  # This is used in wrapper-scripts that are supposed to control other ruby scripts or
+  # external applications. Control is completely passed to the daemons library.
+  # Such wrapper script should be invoked with command line options like 'start' or 'stop'
+  # to do anything useful.
+  #
+  # +script+::  This is the path to the script that should be run as a daemon.
+  #             Please note that Daemons runs this script with <tt>load <script></tt>.
+  #             Also note that Daemons cannot detect the directory in which the controlling
+  #             script resides, so this has to be either an absolute path or you have to run
+  #             the controlling script from the appropriate directory.
+  #
+  # +options+:: A hash that may contain one or more of the options listed below
+  #
+  # === Options:
+  # <tt>:app_name</tt>::  The name of the application. This will be
+  #                       used to contruct the name of the pid files
+  #                       and log files. Defaults to the basename of
+  #                       the script.
+  # <tt>:ARGV</tt>::      An array of strings containing parameters and switches for Daemons.
+  #                       This includes both parameters for Daemons itself and the controlled scripted.
+  #                       These are assumed to be separated by an array element '--', .e.g.
+  #                       ['start', 'f', '--', 'param1_for_script', 'param2_for_script'].
+  #                       If not given, ARGV (the parameters given to the Ruby process) will be used.
+  # <tt>:dir_mode</tt>::  Either <tt>:script</tt> (the directory for writing the pid files to 
+  #                       given by <tt>:dir</tt> is interpreted relative
+  #                       to the script location given by +script+) or <tt>:normal</tt> (the directory given by 
+  #                       <tt>:dir</tt> is interpreted as a (absolute or relative) path) or <tt>:system</tt> 
+  #                       (<tt>/var/run</tt> is used as the pid file directory)
+  #
+  # <tt>:dir</tt>::       Used in combination with <tt>:dir_mode</tt> (description above)
+  # <tt>:multiple</tt>::  Specifies whether multiple instances of the same script are allowed to run at the
+  #                       same time
+  # <tt>:ontop</tt>::     When given (i.e. set to true), stay on top, i.e. do not daemonize the application 
+  #                       (but the pid-file and other things are written as usual)
+  # <tt>:mode</tt>::      <tt>:load</tt> Load the script with <tt>Kernel.load</tt>;
+  #                       <tt>:exec</tt> Execute the script file with <tt>Kernel.exec</tt>
+  # <tt>:backtrace</tt>:: Write a backtrace of the last exceptions to the file '[app_name].log' in the 
+  #                       pid-file directory if the application exits due to an uncaught exception
+  # <tt>:monitor</tt>::   Monitor the programs and restart crashed instances
+  # <tt>:log_output</tt>:: When given (i.e. set to true), redirect both STDOUT and STDERR to a logfile named '[app_name].output' in the pid-file directory
+  # <tt>:keep_pid_files</tt>:: When given do not delete lingering pid-files (files for which the process is no longer running).
+  # <tt>:hard_exit</tt>:: When given use exit! to end a daemons instead of exit (this will for example
+  #                       not call at_exit handlers).
+  # -----
+  # 
+  # === Example:
+  #   options = {
+  #     :app_name   => "my_app",
+  #     :ARGV       => ['start', '-f', '--', 'param_for_myscript']
+  #     :dir_mode   => :script,
+  #     :dir        => 'pids',
+  #     :multiple   => true,
+  #     :ontop      => true,
+  #     :mode       => :exec,
+  #     :backtrace  => true,
+  #     :monitor    => true
+  #   }
+  #
+  #   Daemons.run(File.join(File.dirname(__FILE__), 'myscript.rb'), options)
+  #
+  def run(script, options = {})
+    options[:script] = script
+    @controller = Controller.new(options, options[:ARGV] || ARGV)
+    
+    @controller.catch_exceptions {
+      @controller.run
+    }
+    
+    # I don't think anybody will ever use @group, as this location should not be reached under non-error conditions
+    @group = @controller.group
+  end
+  module_function :run
+  
+  
+  # Passes control to Daemons.
+  # This function does the same as Daemons.run except that not a script but a proc
+  # will be run as a daemon while this script provides command line options like 'start' or 'stop'
+  # and the whole pid-file management to control the proc.
+  #
+  # +app_name+::  The name of the application. This will be
+  #               used to contruct the name of the pid files
+  #               and log files. Defaults to the basename of
+  #               the script.
+  # 
+  # +options+::   A hash that may contain one or more of the options listed in the documentation for Daemons.run
+  #
+  # A block must be given to this function. The block will be used as the :proc entry in the options hash.
+  # -----
+  # 
+  # === Example:
+  #
+  #   Daemons.run_proc('myproc.rb') do
+  #     loop do
+  #       accept_connection()
+  #       read_request()
+  #       send_response()
+  #       close_connection()
+  #     end
+  #   end
+  #
+  def run_proc(app_name, options = {}, &block)
+    options[:app_name] = app_name
+    options[:mode] = :proc
+    options[:proc] = block
+    
+    # we do not have a script location so the the :script :dir_mode cannot be used, change it to :normal
+    if [nil, :script].include? options[:dir_mode]
+      options[:dir_mode] = :normal
+      options[:dir] = File.expand_path('.')
+    end
+    
+    @controller = Controller.new(options, options[:ARGV] || ARGV)
+    
+    @controller.catch_exceptions {
+      @controller.run
+    }
+    
+    # I don't think anybody will ever use @group, as this location should not be reached under non-error conditions
+    @group = @controller.group
+  end
+  module_function :run_proc
+  
+  
+  # Execute the block in a new daemon. <tt>Daemons.call</tt> will return immediately
+  # after spawning the daemon with the new Application object as a return value.
+  #
+  # +options+:: A hash that may contain one or more of the options listed below
+  #
+  # +block+::   The block to call in the daemon.
+  #
+  # === Options:
+  # <tt>:multiple</tt>::  Specifies whether multiple instances of the same script are allowed to run at the
+  #                       same time
+  # <tt>:ontop</tt>::     When given, stay on top, i.e. do not daemonize the application 
+  # <tt>:backtrace</tt>:: Write a backtrace of the last exceptions to the file '[app_name].log' in the 
+  #                       pid-file directory if the application exits due to an uncaught exception
+  # -----
+  # 
+  # === Example:
+  #   options = {
+  #     :backtrace  => true,
+  #     :monitor    => true,
+  #     :ontop      => true
+  #   }
+  #
+  #   Daemons.call(options) begin
+  #     # Server loop:
+  #     loop {
+  #       conn = accept_conn()
+  #       serve(conn)
+  #     }
+  #   end
+  #
+  def call(options = {}, &block)
+    unless block_given?
+      raise "Daemons.call: no block given"
+    end
+    
+    options[:proc] = block
+    options[:mode] = :proc
+    
+    @group ||= ApplicationGroup.new('proc', options)
+    
+    new_app = @group.new_application(options)
+    new_app.start
+
+    return new_app
+  end
+  module_function :call
+  
+  
+  # Daemonize the currently runnig process, i.e. the calling process will become a daemon.
+  #
+  # +options+:: A hash that may contain one or more of the options listed below
+  #
+  # === Options:
+  # <tt>:ontop</tt>::     When given, stay on top, i.e. do not daemonize the application 
+  # <tt>:backtrace</tt>:: Write a backtrace of the last exceptions to the file '[app_name].log' in the 
+  #                       pid-file directory if the application exits due to an uncaught exception
+  # -----
+  # 
+  # === Example:
+  #   options = {
+  #     :backtrace  => true,
+  #     :ontop      => true
+  #   }
+  #
+  #   Daemons.daemonize(options)
+  #
+  #   # Server loop:
+  #   loop {
+  #     conn = accept_conn()
+  #     serve(conn)
+  #   }
+  #
+  def daemonize(options = {})
+    @group ||= ApplicationGroup.new('self', options)
+    
+    @group.new_application(:mode => :none).start
+  end
+  module_function :daemonize
+  
+  # Return the internal ApplicationGroup instance.
+  def group; @group; end
+  module_function :group
+  
+  # Return the internal Controller instance.
+  def controller; @controller; end
+  module_function :controller
+end