strelka 0.0.1.pre.203 → 0.0.1.pre.214

data.tar.gz.sig

@@ -1,2 +1,6 @@
-*�,��Č�j|��̛Z��g��]�w��� �x\CW�b��_�ϕ�V�F�Ѫuqj�\����_����5i�N�@!�l��d$P{��"U}q�I
-�5Aq:�!�r>�y�4�s0\P��V��k"�ͽ�<�|X�-�Y�qۉ%��~�s>��7(H���R�����K%]�J�bF�gb_�W���J)
+"�߾7�jC�W���Hk�~d
+�n�C�f��V9w:
+Z���B}V���b�7T����� mL��
ewҲ��2^f{(��S���BmV
+L�D�΀���(6�/L�>'?�b�?:�?�LÖ��o�@�;��i���4�s�z�T�E-��P�p�>¥BJE��Iȸ��Z<�?�]�Q�ŋ�
+X
+��Br	+�R!

data/ChangeLog

@@ -1,8 +1,89 @@
+2012-05-02  Michael Granger  <ged@FaerieMUD.org>
+
+	* MILESTONES.rdoc, Manifest.txt:
+	Adding a MILESTONES file.
+
+	We'll use this as a checklist of what needs to be done for the next
+	release.
+	[d8e74e3bf97b] [tip]
+
+	* lib/strelka/logging.rb:
+	Change fatal output color to be more readable
+	[403cf0ef01f0]
+
+2012-04-25  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/strelka/app.rb, lib/strelka/plugins.rb,
+	spec/strelka/httpresponse/negotiation_spec.rb,
+	spec/strelka/plugins_spec.rb:
+	Add an #application_stack method to the PluginLoader mixin
+	[7427a74ae313] [github/master]
+
+	* lib/strelka/app.rb, spec/strelka/app_spec.rb:
+	Add configurable ::devmode? setting to Strelka::App
+	[c94cf810fdf7]
+
+	* lib/strelka/plugins.rb, spec/strelka/plugins_spec.rb:
+	Fix plugins clobbering their Class ivars if registered more than
+	once
+	[d9ff6bdd0177]
+
+	* lib/strelka/mixins.rb:
+	Add a 'singleton_method_alias' declarative to MethodUtilities
+	[e33e97ad96bd]
+
+	* lib/strelka/app/errors.rb, lib/strelka/mixins.rb,
+	spec/strelka/app/errors_spec.rb:
+	Add an exception-handler to the :errors plugin.
+	[53001e8ff327]
+
+2012-04-24  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/strelka/app/templating.rb, spec/strelka/app/templating_spec.rb:
+	Refactored on of the big methods in :templating.
+	[f933118fb9db]
+
+2012-04-23  Michael Granger  <ged@FaerieMUD.org>
+
+	* .rvm.gems:
+	Bumped hoe-deveiate in the dev gemset
+	[2a0529c51350]
+
+	* Rakefile:
+	Activate deveiate Hoe plugin
+	[74927b62af8f]
+
+	* lib/strelka/app/parameters.rb, lib/strelka/paramvalidator.rb,
+	spec/strelka/paramvalidator_spec.rb:
+	Clean up ParamValidator specs,
+	[90ca23f958cd]
+
+2012-04-21  Mahlon E. Smith  <mahlon@martini.nu>
+
+	* lib/strelka/paramvalidator.rb, spec/strelka/app/parameters_spec.rb,
+	spec/strelka/paramvalidator_spec.rb:
+	Ensure form data is revalidated when its profile is changed.
+
+	This also fixes some Symbol/String bugs in the internals.
+	[f343990cae18]
+
 2012-04-21  Michael Granger  <ged@FaerieMUD.org>
 
+	* lib/strelka/mixins.rb, spec/lib/helpers.rb,
+	spec/strelka/authprovider/basic_spec.rb,
+	spec/strelka/authprovider_spec.rb, spec/strelka/httprequest_spec.rb,
+	spec/strelka/router/default_spec.rb,
+	spec/strelka/router/exclusive_spec.rb:
+	Add the backtrace to the finish_with status_info.
+
+	This release also adds a 'finish_with' matcher that will eliminate
+	the need to duplicate the status_info struct exactly to test
+	abnormal status responses.
+	[8f6441fd0751]
+
 	* lib/strelka/app/parameters.rb:
 	Add some better docs for the :parameters plugin
-	[f0c8f37e24d7] [tip]
+	[f0c8f37e24d7]
 
 2012-04-20  Michael Granger  <ged@FaerieMUD.org>
 
@@ -80,7 +161,7 @@
 
 	* Strelka::App::Plugin is now Strelka::Plugin
 	* Strelka::App::Plugins is now Strelka::PluginLoader
-	[ea4c4358a943] [github/master]
+	[ea4c4358a943]
 
 2012-04-16  Mahlon E. Smith  <mahlon@martini.nu>
 
@@ -163,18 +244,16 @@
 	* Merging with ssh://hg@deveiate.org/Strelka@8f1c27819e70
 	[5fcd76455aad]
 
+	* Manifest.txt:
+	Updating the manifest
+	[35165b3d01cc]
+
 2012-04-11  Mahlon E. Smith  <mahlon@martini.nu>
 
 	* lib/strelka/session/default.rb:
 	Use the built-in securerandom method for obtaining a hex value.
 	[8f1c27819e70]
 
-2012-04-11  Michael Granger  <ged@FaerieMUD.org>
-
-	* Manifest.txt:
-	Updating the manifest
-	[35165b3d01cc]
-
 2012-04-10  Michael Granger  <ged@FaerieMUD.org>
 
 	* lib/strelka/app/auth.rb, lib/strelka/app/parameters.rb,
@@ -245,6 +324,22 @@
 	Add the ChangeLog to the ignorefile
 	[cc8c30d38652]
 
+	* lib/strelka/app/templating.rb:
+	Add API docs to the :templating plugin module
+	[3c160d996320]
+
+	* README.rdoc:
+	Add more URLs
+	[060962556bd1]
+
+	* Rakefile:
+	Oops. Fix typo
+	[5a8aa207860b]
+
+	* .rvm.gems, Rakefile:
+	Update dependencies
+	[787e523777d1]
+
 2012-04-06  Mahlon E. Smith  <mahlon@martini.nu>
 
 	* lib/strelka/app/sessions.rb, lib/strelka/cookie.rb,
@@ -262,24 +357,6 @@
 	Add a persistent DB session store, using sequel.
 	[99f3c3f5d6ca]
 
-2012-04-06  Michael Granger  <ged@FaerieMUD.org>
-
-	* lib/strelka/app/templating.rb:
-	Add API docs to the :templating plugin module
-	[3c160d996320]
-
-	* README.rdoc:
-	Add more URLs
-	[060962556bd1]
-
-	* Rakefile:
-	Oops. Fix typo
-	[5a8aa207860b]
-
-	* .rvm.gems, Rakefile:
-	Update dependencies
-	[787e523777d1]
-
 2012-04-04  Michael Granger  <ged@FaerieMUD.org>
 
 	* manual/src/tutorial.page:

data/MILESTONES.rdoc

@@ -0,0 +1,16 @@
+= Strelka Milestones
+
+== v0.0.1
+
+* Ensure the README is up to date
+* Update the IDEAS doc
+* Finish the 'setup' task in bin/strelka
+* Extract the rest of the manual out into RDoc for the app classes
+* Lay out the framework for the 'cookbook' section of the manual
+* Mix in the 18pt awesomesauce.
+
+
+== v0.1.0
+
+* Add WebSocketService and plugins
+

data/Manifest.txt

@@ -2,6 +2,7 @@
 ChangeLog
 History.rdoc
 IDEAS.rdoc
+MILESTONES.rdoc
 Manifest.txt
 README.rdoc
 Rakefile

data/Rakefile

@@ -11,6 +11,7 @@ end
 Hoe.plugin :mercurial
 Hoe.plugin :signing
 Hoe.plugin :manualgen
+Hoe.plugin :deveiate
 
 Hoe.plugins.delete :rubyforge
 

data/lib/strelka/app.rb

@@ -4,6 +4,7 @@
 
 require 'rubygems' # For the Rubygems API
 
+require 'configurability'
 require 'mongrel2/handler'
 require 'strelka' unless defined?( Strelka )
 require 'strelka/mixins'
@@ -12,18 +13,22 @@ require 'strelka/plugins'
 
 # The application base class.
 class Strelka::App < Mongrel2::Handler
-	extend Strelka::MethodUtilities,
+	extend Configurability,
+	       Strelka::MethodUtilities,
 	       Strelka::PluginLoader
 	include Strelka::Loggable,
 	        Strelka::Constants,
 	        Strelka::ResponseHelpers
 
 
+	# Configurability API -- use the 'app' section of the config file.
+	config_key :app
+
 	# Glob for matching Strelka apps relative to a gem's data directory
 	APP_GLOB_PATTERN = '{apps,handlers}/**/*'
 
-
 	# Class instance variables
+	@devmode      = false
 	@default_type = nil
 	@loading_file = nil
 	@subclasses   = Hash.new {|h,k| h[k] = [] }
@@ -34,6 +39,10 @@ class Strelka::App < Mongrel2::Handler
 	# loaded from, or +nil+ if they weren't loaded via ::load.
 	singleton_attr_reader :subclasses
 
+	##
+	# 'Developer mode' flag.
+	singleton_attr_writer :devmode
+
 
 	### Inheritance callback -- add subclasses to @subclasses so .load can figure out which
 	### classes correspond to which files.
@@ -43,13 +52,14 @@ class Strelka::App < Mongrel2::Handler
 	end
 
 
+
 	### Overridden from Mongrel2::Handler -- use the value returned from .default_appid if
 	### one is not specified, and automatically install the config DB if it hasn't been
 	### already.
 	def self::run( appid=nil )
 		appid ||= self.default_appid
 
-		Strelka.logger.level = Logger::DEBUG if $VERBOSE
+		Strelka.logger.level = Logger::DEBUG if self.devmode?
 		Strelka.logger.formatter = Strelka::Logging::ColorFormatter.new( Strelka.logger ) if $stderr.tty?
 
 		Strelka.log.info "Starting up with appid %p." % [ appid ]
@@ -157,6 +167,29 @@ class Strelka::App < Mongrel2::Handler
 	end
 
 
+	### Configure the App. Override this if you wish to add additional configuration
+	### to the 'app' section of the config that will be passed to you when the config
+	### is loaded.
+	def self::configure( config=nil )
+		if config
+			self.devmode = true if config[:devmode]
+		else
+			self.devmode = $DEBUG ? true : false
+		end
+
+		Strelka.log.info "Enabled developer mode." if self.devmode?
+	end
+
+
+	### Returns +true+ if the application has been configured to run in 'developer mode'.
+	### Developer mode is mostly informational by default (it just makes logging more
+	### verbose), but plugins and such might alter their behavior based on this setting.
+	def self::devmode?
+		return @devmode
+	end
+	singleton_method_alias :in_devmode?, :devmode?
+
+
 	#
 	# :section: Application declarative methods
 	#
@@ -175,7 +208,7 @@ class Strelka::App < Mongrel2::Handler
 
 	### Dump the application stack when a new instance is created.
 	def initialize( * )
-		self.dump_application_stack
+		self.class.dump_application_stack
 		super
 	end
 
@@ -221,8 +254,7 @@ class Strelka::App < Mongrel2::Handler
 
 		return response
 	rescue => err
-		msg = "%s: %s %s" % [ err.class.name, err.message, err.backtrace.first ]
-		self.log.error( msg )
+		self.log.error "%s: %s %s" % [ err.class.name, err.message, err.backtrace.first ]
 		err.backtrace[ 1..-1 ].each {|frame| self.log.debug('  ' + frame) }
 
 		status_info = { :status => HTTP::SERVER_ERROR, :message => 'internal server error' }
@@ -325,8 +357,6 @@ class Strelka::App < Mongrel2::Handler
 
 	### Create a response to specified +request+ based on the specified +status_code+
 	### and +message+.
-	### :TODO: Document and test the :content_type status_info field.
-	### :TODO: Implement a way to set headers from the status_info.
 	def prepare_status_response( request, status_info )
 		status_code, message = status_info.values_at( :status, :message )
 		self.log.info "Non-OK response: %d (%s)" % [ status_code, message ]
@@ -338,7 +368,7 @@ class Strelka::App < Mongrel2::Handler
 
 		# Some status codes allow explanatory text to be returned; some forbid it. Append the
 		# message for those that allow one.
-		unless request.verb == :HEAD || HTTP::BODILESS_HTTP_RESPONSE_CODES.include?( status_code )
+		unless request.verb == :HEAD || response.bodiless?
 			response.content_type = 'text/plain'
 			response.puts( message )
 		end
@@ -353,18 +383,5 @@ class Strelka::App < Mongrel2::Handler
 		return response
 	end
 
-
-	### Output the application stack into the logfile.
-	def dump_application_stack
-		stack = self.class.ancestors.
-			reverse.
-			drop_while {|mod| mod != Strelka::App }.
-			select {|mod| mod.respond_to?(:plugin_name) }.
-			reverse.
-			collect {|mod| mod.plugin_name }
-
-		self.log.info "Application stack: request -> %s" % [ stack.join(" -> ") ]
-	end
-
 end # class Strelka::App
 

data/lib/strelka/app/errors.rb

@@ -77,9 +77,15 @@ require 'strelka/app' unless defined?( Strelka::App )
 #
 module Strelka::App::Errors
 	extend Strelka::Plugin
+	include Strelka::Constants
 
+
+	# The range of status codes to delegate to an on_status handler that doesn't
+	# specify one
 	DEFAULT_HANDLER_STATUS_RANGE = 400..599
 
+
+	# Plugin load order
 	run_before :routing
 
 
@@ -141,7 +147,22 @@ module Strelka::App::Errors
 
 		# Catch a finish_with; the status_response will only be non-nil
 		status_response = catch( :finish ) do
-			response = super
+
+			# Provide our own exception-handling and translate them into server errors
+			begin
+				response = super
+			rescue => err
+				self.log.error "%s: %s %s" % [ err.class.name, err.message, err.backtrace.first ]
+				err.backtrace[ 1..-1 ].each {|frame| self.log.debug('  ' + frame) }
+
+				finish_with(
+					status:    HTTP::SERVER_ERROR,
+					message:   err.message,
+					headers:   {},
+					backtrace: err.backtrace,
+					exception: err
+				)
+			end
 			nil
 		end
 

data/lib/strelka/app/parameters.rb

@@ -20,12 +20,11 @@ require 'strelka/paramvalidator'
 #
 #   class UserManager < Strelka::App
 #
-#       plugins :routing, :parameters
+#       plugin :parameters
 #
-#       param :username, /\w+/, "User login", :required
 #       param :email
 #       param :id, /\d+/, "The user's numeric ID"
-#       param :mode, ['add', 'remove']
+#       param :mode, /^\s*(?<prefix>[A-Z]{2})-(?<sku>\p{Print}+)/
 #
 # The first item is the parameter _key_, which corresponds to the field 'name' attribute for
 # a form, or the key for JSON or YAML data.
@@ -68,7 +67,7 @@ require 'strelka/paramvalidator'
 #
 #   end # class UserManager
 #
-# [:FIXME:] Add more docs
+# [:FIXME:] Add more docs.
 module Strelka::App::Parameters
 	extend Strelka::Plugin
 

data/lib/strelka/app/templating.rb

@@ -185,52 +185,73 @@ module Strelka::App::Templating
 		response = super
 
 		self.log.debug "Templating: examining %p response." % [ response.class ]
-		template = nil
+		template = self.extract_template_from_response( response ) or
+			return response
+
+		# Wrap the template in a layout if there is one
+		template = self.wrap_in_layout( template )
+
+		# Set some default stuff on the top-level template
+		self.set_common_attributes( template, request )
+
+		# Now render the response body
+		self.log.debug "  rendering the template into the response body"
+		response = request.response unless response.is_a?( Mongrel2::Response )
+		response.body = template.render
+		response.status ||= HTTP::OK
+
+		return response
+	end
+
+
+	### Fetch the template from the +response+ (if there is one) and return it. If
+	### +response+ itself is a template.
+	def extract_template_from_response( response )
 
 		# Response is a template name
 		if response.is_a?( Symbol ) && self.template_map.key?( response )
 			self.log.debug "  response is a template name (Symbol); using the %p template" % [ response ]
-			template = self.template( response )
-			response = request.response
+			return self.template( response )
 
 		# Template object
-		elsif response.is_a?( Inversion::Template )
-			self.log.debug "  response is an %p; wrapping it in a Response object" % [ response.class ]
-			template = response
-			response = request.response
+		elsif response.respond_to?( :render )
+			self.log.debug "  response is a #renderable %p; returning it as-is" % [ response.class ]
+			return response
 
 		# Template object already in a Response
-		elsif response.is_a?( Mongrel2::Response ) && response.body.is_a?( Inversion::Template )
-			template = response.body
-			self.log.debug "  response is a %p in the body of a %p" % [ template.class, response.class ]
+		elsif response.is_a?( Mongrel2::Response ) && response.body.respond_to?( :render )
+			self.log.debug "  response is a %p in the body of a %p" % [ response.body.class, response.class ]
+			return response.body
 
 		# Not templated; returned as-is
 		else
-			self.log.debug "  response isn't templated; returning it as-is"
-			return response
+			self.log.debug "  response isn't templated; returning nil"
+			return nil
 		end
+	end
 
-		# 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
-			template = l_template
-		end
 
-		# Set some default stuff on the top-level template
+	### Wrap the specified +content+ template in the layout template and
+	### return it. If there isn't a layout declared, just return +content+ as-is.
+	def wrap_in_layout( content )
+		return content unless 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 = content
+
+		return l_template
+	end
+
+
+	### Set some default values from the +request+ in the given top-level +template+.
+	def set_common_attributes( template, request )
 		template.request          = request
+		template.app              = self
 		template.strelka_version  = Strelka.version_string( true )
 		template.mongrel2_version = Mongrel2.version_string( true )
 		template.route            = request.notes[:routing][:route]
-
-		# Now render the response body
-		self.log.debug "  rendering the template into the response body"
-		response.body = template.render
-		response.status ||= HTTP::OK
-
-		return response
 	end
 
 end # module Strelka::App::Templating