ramaze 0.3.9.1 → 2008.06

data/doc/ProjectInfo

@@ -1,53 +0,0 @@
----
-project : ramaze
-version : '0.0.7'
-status  : alpha
-
-title    : Ramaze
-subtitle : A light and modular Web-Framework
-description : >
-  Ramaze is a very simple and straight-forward web-framework.
-  The philosophy of it could be expressed in a mix of KISS and POLS, trying to
-  make simple things simple and complex things possible.
-
-author     : Michael Fellinger <m.fellinger@gmail.com>
-created    : "2006-10-14"
-homepage   : "http://ramaze.rubyforge.org"
-download   : "https://rubyforge.org/frs/?group_id=3034"
-repository : "http://manveru.mine.nu/darcs/ramaze"
-slogan     : Ramaze, light and modular
-#signiture  : "../_privkey.pem"
-
-pack       : [gem, tgz, bz2]
-distribute : [ -scrap ]
-dependency :
-  - [ autorake, >= 0.5.1 ]
-executable : [ bin/ramaze ]
-
-#digest     : sha256
-#manifest   : MANIFEST.txt
-archive    : ~/ruby/ARCHIVE
-scm        : darcs
-scm_ignore : [ doc/allison ]
-changelog  : doc/CHANGELOG
-stamp      : doc/VERSION
-
-rdoc:
-  template : allison
-
-mail:
-  server   : smtp.gmail.com
-  account  : m.fellinger@gmail.com
-  mail_to  : m.fellinger@gmail.com
-
-rubyforge:
-  project  : ramaze
-  username : manveru
-  groupid  : 3034
-  package  : ramaze
-
-#host:
-#  domain   : rubyforge.org
-#  user     : transami
-#  root     : '/var/www/gforge-projects/ratchets'
-

data/doc/migrate/1110_to_1111.txt

@@ -1,131 +0,0 @@
-= Explanation of the changes of patch 1110-1111
-
-What this patch is all about.
-Due to a general cleanup and preparation for further extension there has been a
-lot of moving of code into more appropriate positions.
-Another goal was the reimplementation of Global, away from OpenStruct to the
-faster Struct.
-Some smaller improvments will follow on both areas, but as with the last
-Controller refactoring, this aimed to be finished as soon as possible to get
-Ramaze bulletproof again before the next release.
-
-
-== Ramaze
-=== What happened to the module
-
-The whole module has now only two methods, :startup and :shutdown
-
-startup sends .startup to the classes in
-Ramaze.trait[:essentials]
-shutdown sends .shutdown to these classes.
-
-Other methods changed:
-
-force_start
-  removed -> not used anywhere and easily done with a passed option.
-
-execute
-  removed -> there may be a replacement coming though.
-
-kill_threads
-  delegated -> this is handled over the shutdown of the responsible classes now.
-
-setup_controllers
-  delegated -> has been moved to Controller::startup
-
-init_sourcereload
-  delegated -> moved to SourceReload::startup
-
-init_global
-  delegated -> moved to Global::startup
-
-init_adapter, run_adapter, test_connections, connection_possible
-  delegated -> moved to Adapter::startup
-
-require_adapter
-  delegated -> is now the mask Global.adapter
-
-parse_port
-  delegated -> is now the mask Global.ports
-
-
-== Global
-=== New functionality and layout
-
-Global is now a Struct instead of an OpenStruct, which means two things:
-The general API is hardened now, assigning new accessors is not as simple as
-just setting them via method_missing anymore.
-The GlobalStruct::DEFAULT hash defines what contents the Struct has.
-This has on one hand a improved performance, on the other hand it unifies the
-API for further versions, collecting the setting of Global accessors into one
-place.
-We could add method_missing in further revisions if need arises.
-The other important improvement is the masking of internals of Global. This means
-that we can now define a method over the internal value and present something
-different than it actually contains. Also hooks on setting a value are now
-possible.
-
-Controller.trait[:ramaze_public] has moved here as Global.public_root to match
-the Controller.public_root setting.
-
-
-== Controller
-=== template_root and public_root
-
-These are no traits anymore. Now the resolution of templates should be a little
-bit faster, but more importantly they will give you a warning when setting a
-path that does not exist.
-To remove the 'self.' boilerplate they take an optional argument and act as
-getter only if no argument is given.
-
-
-== Cache
-=== Unified API for new Caches
-
-We now take advantage of the ages-old idea of having a unified Ramaze::Cache to
-spawn new instances of caches instead of relying on Global.cache.new which posed
-many problems with configuring them.
-To retrieve a new cache, simply use Cache.new now, setting Global.cache will
-define which class is used for this. You can set strings/symbols like :memory,
-:memcached or :yaml.
-
-Cache also specifies a unified API, at the moment consisting of:
-#[](key), #[]=(key, value), #clear, #delete(*keys)
-
-To make interacting easier, all keys are stored/retrieved as strings
-automatically so you can use either symbols or strings to access values.
-
-
-== Adapter
-=== Adapter::( startup | shutdown )
-
-The stuff from Ramaze has moved here, it basically still works the same way.
-However, we are now wrapping less threads around one adapter, which may or may
-not affect performance.
-
-
-== Request
-=== Outsourcing of methods to Rack
-
-Following methods have been moved to the latest version of Rack:
-#fullpath #[](key), #[]=(key, value), #values_at(*keys), #referer/#referer
-
-=== Change from module to subclass
-
-== Response
-=== Change from module to subclass
-
-Same as Request
-
-
-== STATUS_CODE
-=== Usage of Rack::Utils::HTTP_STATUS_CODES
-
-We are now using the hash from Rack, assigned to Ramaze::STATUS_CODE and have
-removed ramaze/http_status.rb
-The major change is that the keys are now strings like
-"Not Found" or "Internal Server Error". Most of the time guessing will work.
-
-
-== Informing
-=== Added #debug? for WEBrick, set to false.

data/lib/ramaze/contrib/route.rb

@@ -1,22 +0,0 @@
-#          Copyright (c) 2008 Michael Fellinger m.fellinger@gmail.com
-# All files in this distribution are subject to the terms of the Ruby license.
-
-module Ramaze
-  module Contrib
-    class Route
-      class << self
-        def startup
-          warn "Ramaze::Contrib::Route is being deprecated, use Ramaze::Route instead"
-        end
-
-        def [](key)
-          Ramaze::Route.trait[:routes][key]
-        end
-
-        def []=(key, value)
-          Ramaze::Route.trait[:routes][key] = value
-        end
-      end
-    end
-  end
-end

data/lib/ramaze/global.rb

@@ -1,116 +0,0 @@
-#          Copyright (c) 2008 Michael Fellinger m.fellinger@gmail.com
-# All files in this distribution are subject to the terms of the Ruby license.
-
-require 'ramaze/global/dsl'
-
-module Ramaze
-  GlobalDSL.option_dsl do
-    o "Set the adapter Ramaze will run on.",
-      :adapter => :webrick, :cli => [:webrick, :mongrel, :thin]
-
-    o "Set the size of Backtrace shown.",
-      :backtrace_size => 10, :cli => 10
-
-    o "Turn benchmarking every request on.",
-      :benchmarking => false, :cli => false, :short => :b
-
-    o "Do not log about these requests to static files, values as in Global.ignore",
-      # Example: [/\.(ico|gif|jpg|png)$/, '/robots.txt']
-      :boring => [ '/favicon.ico' ]
-
-    o "Use this for general caching and as base for Cache.new.",
-      :cache => :memory, :cli => [:memory, :memcached, :yaml]
-
-    o "Alternative caches",
-      :cache_alternative => {}
-
-    o "Turn on naive caching of all requests.",
-      :cache_all => false, :cli => false
-
-    o "Compile Templates",
-      :compile => false, :cli => false
-
-    o "Active contribs ",
-      :contribs => Set.new
-
-    o "All subclasses of Controller are collected here.",
-      :controllers => Set.new
-
-    o "Start Ramaze within an IRB session",
-      :console => false, :cli => false, :short => :c
-
-    o "Turn on customized error pages.",
-      :error_page => true, :cli => true
-
-    o "Caching actions to the filesystem in Global.public_root",
-      :file_cache => false, :cli => false
-
-    o "Specify what IP Ramaze will respond to - 0.0.0.0 for all",
-      :host => "0.0.0.0", :cli => '0.0.0.0'
-
-    o "Ignore requests to these paths if no file in public_root exists, absolute path or regex",
-      # Example: [/\.(ico|gif|jpg|png)$/, '/robots.txt']
-      :ignore => [ '/favicon.ico' ]
-
-    o "Body set on ignored paths",
-      :ignore_body => "File not found"
-
-    o "Status set on ignored paths",
-      :ignore_status => 404
-
-    o "Templating engines to load on startup",
-      :load_engines => []
-
-    o "All paths to controllers are mapped here.",
-      :mapping => {}
-
-    o "For your own modes to decide on",
-      :mode => :live, :cli => [:live, :dev]
-
-    o "The place ramaze was started from, useful mostly for debugging",
-      :origin => :main
-
-    o "Specify port",
-      :port => 7000, :cli => 7000, :short => :p
-
-    o "Specify directory to serve static files",
-      :public_root => 'public', :cli => 'public'
-
-    o "Record all Request objects by assigning a filtering Proc to me.",
-      :record => false
-
-    o "Don't wait until all adapter-threads are finished or killed.",
-      :run_loose => false, :cli => false
-
-    o "The running server will be put here from Adapter.",
-      :server => nil
-
-    o "Turn on session for all requests.",
-      :sessions => true, :cli => true
-
-    o "Turn on BF/DoS protection for error-responses",
-      :shield => false, :cli => false
-
-    o "What signal to trap to call Ramaze::shutdown",
-      :shutdown_trap => "SIGINT"
-
-    o "Interval in seconds of the background SourceReload",
-      :sourcereload => 3, :cli => 3
-
-    o "Test before start if adapters will be able to connect",
-      :test_connections => true, :cli => true
-
-    o "Specify directory to serve dynamic files",
-      :template_root => 'view', :cli => 'view'
-
-    o "Enable directory listing",
-      :list_directories => false, :cli => false
-
-    o "Disable templates without actions",
-      :actionless_templates => true, :cli => true
-  end
-
-  require 'ramaze/global/globalstruct'
-
-  Global = GlobalStruct.setup(OPTIONS) unless defined?(Global)
-end

data/lib/ramaze/global/dsl.rb

@@ -1,39 +0,0 @@
-#          Copyright (c) 2008 Michael Fellinger m.fellinger@gmail.com
-# All files in this distribution are subject to the terms of the Ruby license.
-
-module Ramaze
-  CLIOption = Struct.new('CLIOption', :name, :default, :doc, :cli, :short)
-  OPTIONS     = {}
-  CLI_OPTIONS = []
-
-  # DSL for specifying Globap options before initializing Global
-
-  module GlobalDSL
-    class << self
-
-      # The method that takes the block containing the DSL, used like in
-      # lib/ramaze/global.rb
-
-      def option_dsl(&block)
-        instance_eval(&block)
-      end
-
-      # Takes a doc-string and then the option as hash, another :cli key can
-      # be given that will expose this option via the bin/ramaze.
-
-      def o(doc, options = {})
-        cli_given = options.has_key?(:cli)
-        cli = options.delete(:cli)
-        short = options.delete(:short)
-        name, default = options.to_a.flatten
-
-        if cli_given
-          option = CLIOption.new(name, default, doc, cli, short)
-          CLI_OPTIONS << option
-        end
-
-        OPTIONS.merge!(options)
-      end
-    end
-  end
-end

data/lib/ramaze/global/globalstruct.rb

@@ -1,147 +0,0 @@
-#          Copyright (c) 2008 Michael Fellinger m.fellinger@gmail.com
-# All files in this distribution are subject to the terms of the Ruby license.
-
-module Ramaze
-  unless defined?(GlobalStruct) # prevent problems for SourceReload
-    class GlobalStruct < Struct.new('Global', *OPTIONS.keys)
-    end
-  end
-
-  # Class for Ramaze::Global instance.
-  class GlobalStruct
-
-    ENV_TRIGGER = {
-      'EVENT' => lambda{ require 'ramaze/adapter/evented_mongrel' },
-      'SWIFT' => lambda{ require 'ramaze/adapter/swiftiplied_mongrel' }
-    }
-
-    # mapping of :adapter => to the right class-name.
-    ADAPTER_ALIAS = {
-      :cgi                 => :Cgi,
-      :fcgi                => :Fcgi,
-      :scgi                => :Scgi,
-      :thin                => :Thin,
-      :ebb                 => :Ebb,
-      :lsws                => :Lsws,
-      :webrick             => :WEBrick,
-      :mongrel             => :Mongrel,
-      :evented_mongrel     => :Mongrel,
-      :swiftiplied_mongrel => :Mongrel,
-    }
-
-    # mapping of :cache => to the right class-name.
-    CACHE_ALIAS = {
-      :memcached => :MemcachedCache,
-      :memory    => :MemoryCache,
-      :yaml      => :YAMLStoreCache,
-    }
-
-    class << self
-      alias setup fill
-    end
-
-    # Called from Ramaze::start, sets all the options.
-    def startup(options = {})
-      options.each do |key, value|
-        if (method(key) rescue false)
-          send("#{key}=", value)
-        else
-          create_member(key, value)
-        end
-      end
-
-      ENV_TRIGGER.values_at(*ENV.keys).compact.each{|l| l.call}
-
-      engines = self[:load_engines]
-      (Symbol === engines ? [engines] : engines).each do |engine|
-        Ramaze::Template.const_get(engine)
-      end
-    end
-
-    # batch-assignment of key/value from hash, yields self if a block is given.
-    def setup(hash = {})
-      hash.each do |key, value|
-        self.send("#{key}=", value)
-      end
-      yield(self) if block_given?
-    end
-
-
-    # Object wraps
-
-    # get right classname, require the file for given adapter and answer with
-    # the actual class.
-    def adapter
-      if internal = self[:adapter]
-        class_name = ADAPTER_ALIAS.fetch(internal.to_sym, internal)
-        unless Ramaze::Adapter.const_defined?(class_name)
-          require("ramaze/adapter"/internal.to_s.downcase)
-        end
-        Ramaze::Adapter.const_get(class_name)
-      end
-    end
-
-    # get right classname, require the file for given cache and answer with
-    # the actual class.
-    def cache
-      cache_name = self[:cache].to_sym
-      class_name = CACHE_ALIAS[cache_name] || cache_name
-      cache = Ramaze.const_get(class_name)
-    end
-
-    # reassigns the interval in the instance of SourceReload that is running or
-    # just waiting.
-    def sourcereload=(interval)
-      self[:sourcereload] = interval
-      sri = Thread.main[:sourcereload]
-      sri.interval = interval if sri
-    end
-
-    def template_root
-      [ tr = self[:template_root],
-        APPDIR/tr,
-        APPDIR/'template',
-      ].find{|path| File.directory?(path) } || self[:template_root]
-    end
-
-    def public_root
-      [ pr = self[:public_root],
-        APPDIR/pr,
-      ].find{|path| File.directory?(path) } || self[:public_root]
-    end
-
-    def list_directories=(active)
-      require 'ramaze/dispatcher'
-      d = Ramaze::Dispatcher
-      self[:list_directories] = active
-      if active
-        d::FILTER.put_within(d::Directory, :after => d::File, :before => d::Action)
-      else
-        d::FILTER.delete(d::Directory)
-      end
-    end
-
-
-    # External helpers
-
-    # Answers with values for given keys by sending each to self
-    def values_at(*keys)
-      keys.map{|key| __send__(key)}
-    end
-
-    # Creates a new attr_accessor like method-pair.
-    def create_member key, value = nil
-      Log.warn "Create #{key}=#{value.inspect} on Global"
-
-      @table ||= {}
-      key = key.to_sym
-
-      (class << self; self; end).class_eval do
-        define_method(key){ @table[key] }
-        define_method("#{key}="){|val| @table[key] = val }
-      end
-
-      @table[key] = value
-    end
-  end
-end