strelka 0.0.1.pre129 → 0.0.1.pre148

data/lib/strelka/app/plugins.rb

@@ -1,12 +1,16 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# vim: set nosta noet ts=4 sw=4:
+# encoding: utf-8
 
 require 'set'
 require 'tsort'
 
 require 'strelka' unless defined?( Strelka )
 require 'strelka/app' unless defined?( Strelka::App )
+require 'strelka/mixins'
 
 class Strelka::App
+	extend Strelka::MethodUtilities
 
 	# A topologically-sorted hash for plugin management
 	class PluginRegistry < Hash
@@ -22,9 +26,11 @@ class Strelka::App
 		end
 	end
 
-	# The Hash of loaded plugin modules, keyed by their downcased and symbolified 
+
+	##
+	# The Hash of loaded plugin modules, keyed by their downcased and symbolified
 	# name (e.g., Strelka::App::Templating => :templating)
-	class << self; attr_reader :loaded_plugins; end
+	singleton_attr_reader :loaded_plugins
 	@loaded_plugins = PluginRegistry.new
 
 
@@ -37,7 +43,7 @@ class Strelka::App
 		end
 
 
-		### Extension hook -- Extend the given object with methods for setting it 
+		### Extension hook -- Extend the given object with methods for setting it
 		### up as a plugin for Strelka::Apps.
 		def self::extended( object )
 			Strelka.log.debug "Extending %p as a Strelka::App::Plugin" % [ object ]
@@ -73,7 +79,7 @@ class Strelka::App
 		end
 
 
-		### Register the receiver as needing to be run before +other_plugins+ for requests, and 
+		### Register the receiver as needing to be run before +other_plugins+ for requests, and
 		### *after* them for responses.
 		def run_before( *other_plugins )
 			name = self.plugin_name
@@ -91,7 +97,7 @@ class Strelka::App
 		end
 
 
-		### Register the receiver as needing to be run after +other_plugins+ for requests, and 
+		### Register the receiver as needing to be run after +other_plugins+ for requests, and
 		### *before* them for responses.
 		def run_after( *other_plugins )
 			Strelka.log.debug "  %p will run after %p" % [ self, other_plugins ]
@@ -104,7 +110,7 @@ class Strelka::App
 	# Plugin system
 	module Plugins
 
-		### Inclusion callback -- add class methods and instance variables without 
+		### Inclusion callback -- add class methods and instance variables without
 		### needing a separate call to #extend.
 		def self::included( klass )
 			klass.extend( ClassMethods )
@@ -197,7 +203,7 @@ class Strelka::App
 
 		### The main extension-point for the plugin system. Strelka::App supers to this method
 		### with a block that processes the actual request, and the plugins implement this
-		### method to add their own functionality. 
+		### method to add their own functionality.
 		def handle_request( request, &block )
 			raise LocalJumpError,
 				"no block given; plugin supering without preserving arguments?" unless block

data/lib/strelka/app/restresources.rb

@@ -1,4 +1,6 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# vim: set nosta noet ts=4 sw=4:
+# encoding: utf-8
 
 require 'set'
 require 'sequel'

data/lib/strelka/app/routing.rb

@@ -1,16 +1,18 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# vim: set nosta noet ts=4 sw=4:
+# encoding: utf-8
 
 require 'strelka' unless defined?( Strelka )
 require 'strelka/app' unless defined?( Strelka::App )
 
-require 'strelka/app/router'
+require 'strelka/router'
 require 'strelka/exceptions'
 require 'strelka/app/plugins'
 
 # Sinatra-ish routing logic for Strelka::Apps
 #
 # This plugin adds the ability to declare hooks for requests based on their
-# attributes. The default router (Strelka::App::DefaultRouter) uses only the
+# attributes. The default router (Strelka::Router::Default) uses only the
 # HTTP verb and the path, but you can also define your own router class if
 # you want to include other attributes.
 #
@@ -74,7 +76,7 @@ require 'strelka/app/plugins'
 #
 # == Custom Routers
 #
-# See the Strelka::App::Router for information on how to define your own
+# See the Strelka::Router for information on how to define your own
 # routing strategies.
 #
 module Strelka::App::Routing
@@ -175,7 +177,7 @@ module Strelka::App::Routing
 			patternparts = self.split_route_pattern( pattern )
 			Strelka.log.debug "Split pattern %p into parts: %p" % [ pattern, patternparts ]
 
-			# Make a method name from the directories and the named captures of the patterns 
+			# Make a method name from the directories and the named captures of the patterns
 			# in the route
 			patternparts.each do |part|
 				if part.is_a?( Regexp )
@@ -207,7 +209,7 @@ module Strelka::App::Routing
 		end
 
 
-		### Split the given +pattern+ into its path components and 
+		### Split the given +pattern+ into its path components and
 		def split_route_pattern( pattern )
 			pattern.slice!( 0, 1 ) if pattern.start_with?( '/' )
 
@@ -237,7 +239,7 @@ module Strelka::App::Routing
 	### Create a new router object for each class with Routing.
 	def initialize( * )
 		super
-		@router ||= Strelka::App::Router.create( self.class.routerclass, self.class.routes )
+		@router ||= Strelka::Router.create( self.class.routerclass, self.class.routes )
 	end
 
 

data/lib/strelka/app/sessions.rb

@@ -0,0 +1,175 @@
+#!/usr/bin/env ruby
+
+require 'strelka' unless defined?( Strelka )
+require 'strelka/app' unless defined?( Strelka::App )
+
+require 'strelka/mixins'
+require 'strelka/exceptions'
+require 'strelka/app/plugins'
+
+require 'strelka/httprequest/session'
+require 'strelka/httpresponse/session'
+
+# Sessions for Strelka apps
+#
+# This plugin adds a persistant storage mechanism to Strelka applications
+# that can be used to store data about a user's session.
+#
+# == Examples
+#
+#   class HelloWorld < Strelka::App
+#
+#       # Use the default session store and id-generator
+#       plugins :routing, :sessions
+#
+#       session_namespace :foo  # defaults to the app's ID
+#
+#       get '' do
+#           finish_with HTTP::FORBIDDEN, "no session!" unless req.session?
+#
+#           username = req.session[:username]
+#       end
+#
+#   end # class HelloWorld
+#
+# == Components
+#
+# This plugin is split up into four parts:
+#
+# [Strelka::Session]
+#   The abstract base class for the session object;
+#   provides the interface for getting and setting session data,
+#   writing the resulting data structure to permanent storage (if
+#   necessary), and generating the token that associates the request
+#   with the session.
+# [Strelka::HTTPRequest::Session]
+#   A mixin module that's added to HTTPRequest when the :sessions plugin
+#   is installed. Provides the API on HTTPRequest for fetching and
+#   interacting with the Session object.
+# [Strelka::HTTPResponse::Session]
+#   A mixin module that's added to HTTPResponse when the :sessions plugin
+#   is installed. Provides the API on HTTPResponse for fetching and
+#   interacting with the Session object.
+# [Strelka::App::Sessions]
+#   This module; stitches the whole system together in your application.
+#
+# == Configuration
+#
+# To specify which Session class to use with your application, add a
+# ':sessions' section with at least the 'type' key to your config.yml:
+#
+#   # Use the default session class, but change the name of the cookie
+#   # it uses
+#   sessions:
+#     session_class: default
+#     options:
+#       cookie_name: acme-session
+#
+#   # Load a (hypothetical) Sequel-backed session type and point it
+#   # at a database
+#   sessions:
+#     session_class: sequel
+#     options:
+#       db: "postgres://pg.example.com/db01"
+#       table: sessions
+#
+# The +type+ value will be used to look up the class (see Strelka::Session
+# for more information about how this works), and the +options+ section
+# is passed to the session class's ::configure method (if it has one).
+#
+module Strelka::App::Sessions
+	extend Strelka::App::Plugin,
+	       Strelka::MethodUtilities,
+	       Configurability
+	include Strelka::Loggable,
+	        Strelka::Constants
+
+	# Default options to pass to the session object
+	DEFAULT_OPTIONS = {
+		:cookie_name => 'strelka-session',
+	}
+
+	# Configurability API -- specify which section of the config this class gets
+	config_key :sessions
+
+	# Specify load order; run as late as possible so other plugins can use the session
+	run_after :templating, :filters, :parameters
+
+
+	##
+	# What session class to use (Class object)
+	singleton_attr_writer :session_class
+
+
+	# Class methods and instance variables to add to classes with routing.
+	module ClassMethods # :nodoc:
+
+		# The namespace of the session that will be exposed to instances of this
+		# application
+		@session_namespace = nil
+
+		### Get/set the key that will determine which namespace in the session object
+		### the application will see.
+		def session_namespace( new_namespace=nil )
+			@session_namespace = new_namespace if new_namespace
+			@session_namespace ||= self.default_appid
+			return @session_namespace
+		end
+
+	end # module ClassMethods
+
+
+
+	### Get the configured session class (Strelka::Session subclass)
+	def self::session_class
+		@session_class ||= Strelka::Session.get_subclass( :default )
+	end
+
+
+	### Configurability API -- set up session type and options with values from
+	### the +config+.
+	def self::configure( config )
+		options = DEFAULT_OPTIONS.dup
+
+		# Figure out which session class is going to be used, or choose a default one
+		if config
+			self.session_class = Strelka::Session.get_subclass( config[:session_class] ) if
+				config.key?( :session_class )
+			options.merge!( config[:options] ) if config[:options]
+		else
+			self.session_class = Strelka::Session.get_subclass( :default )
+		end
+
+		# Configure the session class if it can be
+		self.session_class.configure( options ) if self.session_class.respond_to?( :configure )
+	end
+
+
+	### Extension callback -- extend the HTTPRequest classes with Session
+	### support when this plugin is loaded.
+	def self::included( object )
+		Strelka.log.debug "Extending Request with Session mixin"
+		Strelka::HTTPRequest.class_eval { include Strelka::HTTPRequest::Session }
+		Strelka::HTTPResponse.class_eval { include Strelka::HTTPResponse::Session }
+		super
+	end
+
+
+	### Set the session namespace on the HTTPRequest before running the application.
+	def fixup_request( request )
+		request.session_namespace = self.class.session_namespace
+		return super
+	end
+
+
+	### Save the session after the app and plugins are done with the HTTPResponse.
+	def fixup_response( response )
+		self.log.debug "Saving the session in the response."
+		response.save_session
+		return super
+	end
+
+
+end # module Strelka::App::Sessions
+
+

data/lib/strelka/app/templating.rb

@@ -1,4 +1,6 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# vim: set nosta noet ts=4 sw=4:
+# encoding: utf-8
 
 require 'inversion'
 
@@ -28,7 +30,7 @@ module Strelka::App::Templating
 		attr_accessor :layout_template
 
 
-		### Get/set the templates declared for the App. 
+		### Get/set the templates declared for the App.
 		def templates( newhash=nil )
 			if newhash
 				self.template_map.merge!( newhash )
@@ -67,7 +69,7 @@ module Strelka::App::Templating
 
 
 	### Return the template keyed by the given +name+.
-	### :TODO: Add auto-reloading, 
+	### :TODO: Add auto-reloading,
 	def template( name )
 		template = self.template_map[ name ] or
 			raise ArgumentError, "no %p template registered!" % [ name ]
@@ -141,6 +143,7 @@ module Strelka::App::Templating
 
 		# Wrap the template in a layout if there is one
 		if self.layout
+			self.layout.reload if self.layout.changed?
 			l_template = self.layout.dup
 			self.log.debug "  wrapping response in layout %p" % [ l_template ]
 			l_template.body = template

data/lib/strelka/app.rb

@@ -1,13 +1,17 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# vim: set nosta noet ts=4 sw=4:
+# encoding: utf-8
 
 require 'rubygems' # For the Rubygems API
 
 require 'mongrel2/handler'
 require 'strelka' unless defined?( Strelka )
+require 'strelka/mixins'
 
 
 # The application base class.
 class Strelka::App < Mongrel2::Handler
+	extend Strelka::MethodUtilities
 	include Strelka::Loggable,
 	        Strelka::Constants
 
@@ -26,9 +30,10 @@ class Strelka::App < Mongrel2::Handler
 	@subclasses   = Hash.new {|h,k| h[k] = [] }
 
 
-	# The Hash of Strelka::App subclasses, keyed by the Pathname of the file they were 
+	##
+	# The Hash of Strelka::App subclasses, keyed by the Pathname of the file they were
 	# loaded from, or +nil+ if they weren't loaded via ::load.
-	class << self; attr_reader :subclasses; end
+	singleton_attr_reader :subclasses
 
 
 	### Inheritance callback -- add subclasses to @subclasses so .load can figure out which
@@ -46,13 +51,14 @@ class Strelka::App < Mongrel2::Handler
 		appid ||= self.default_appid
 
 		Strelka.logger.level = Logger::DEBUG if $VERBOSE
+		Strelka.logger.formatter = Strelka::Logging::ColorFormatter.new( Strelka.logger ) if $stderr.tty?
 
 		super( appid )
 
 	end
 
 
-	### Calculate a default application ID for the class based on either its ID 
+	### Calculate a default application ID for the class based on either its ID
 	### constant or its name and return it.
 	def self::default_appid
 		Strelka.log.info "Looking up appid for %p" % [ self.class ]
@@ -74,7 +80,9 @@ class Strelka::App < Mongrel2::Handler
 	### Return a Hash of Strelka app files as Pathname objects from installed gems,
 	### keyed by gemspec name .
 	def self::discover_paths
-		appfiles = {}
+		appfiles = {
+			'strelka' => Pathname.glob( DATADIR + APP_GLOB_PATTERN )
+		}
 
 		# Find all the gems that depend on Strelka
 		gems = Gem::Specification.find_all do |gemspec|
@@ -110,7 +118,7 @@ class Strelka::App < Mongrel2::Handler
 		Strelka.log.debug "Loading apps from %d discovered paths" % [ app_paths.length ]
 		app_paths.each do |gemname, paths|
 			Strelka.log.debug "  loading gem %s" % [ gemname ]
-			gem( gemname )
+			gem( gemname ) unless gemname == 'strelka'
 
 			Strelka.log.debug "  loading apps from %s: %d handlers" % [ gemname, paths.length ]
 			paths.each do |path|
@@ -214,8 +222,8 @@ class Strelka::App < Mongrel2::Handler
 	protected
 	#########
 
-	### Make any changes to the +request+ that are necessary before handling it and 
-	### return it. This is an alternate extension-point for plugins that 
+	### Make any changes to the +request+ that are necessary before handling it and
+	### return it. This is an alternate extension-point for plugins that
 	### wish to modify or replace the request before the request cycle is
 	### started.
 	def fixup_request( request )
@@ -240,8 +248,8 @@ class Strelka::App < Mongrel2::Handler
 	end
 
 
-	### Make any changes to the +response+ that are necessary before handing it to 
-	### Mongrel and return it. This is an alternate extension-point for plugins that 
+	### Make any changes to the +response+ that are necessary before handing it to
+	### Mongrel and return it. This is an alternate extension-point for plugins that
 	### wish to modify or replace the response after the whole request cycle is
 	### completed.
 	def fixup_response( response )
@@ -301,7 +309,7 @@ class Strelka::App < Mongrel2::Handler
 	end
 
 
-	### Create a response to specified +request+ based on the specified +status_code+ 
+	### Create a response to specified +request+ based on the specified +status_code+
 	### and +message+.
 	def prepare_status_response( request, status_info )
 		status_code, message = status_info.values_at( :status, :message )

data/lib/strelka/behavior/plugin.rb

@@ -1,4 +1,6 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+# vim: set nosta noet ts=4 sw=4:
+# encoding: utf-8
 
 require 'rspec'
 
@@ -11,7 +13,7 @@ require 'strelka/app/plugins'
 # plugins share in common. If you're creating a Strelka::App plugin,
 # you can test its conformity to the expectations placed on them by
 # adding this to your spec:
-# 
+#
 #    require 'strelka/behavior/plugin'
 #
 #    describe YourPlugin do

data/lib/strelka/constants.rb

@@ -11,6 +11,15 @@ module Strelka::Constants
 	# Import Mongrel2's constants, too
 	include Mongrel2::Constants
 
+	# The data directory in the project if that exists, otherwise the gem datadir
+	DATADIR = if File.directory?( 'data/strelka' )
+			Pathname( 'data/strelka' )
+		elsif path = Gem.datadir('strelka')
+			Pathname( path )
+		else
+			raise ScriptError, "can't find the data directory!"
+		end
+
 	# Extend Mongrel2's HTTP constants collection
 	module HTTP
 		include Mongrel2::Constants::HTTP