strelka 0.0.1pre4

data/lib/strelka/process.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require 'mongrel2/handler'
+require 'strelka' unless defined?( Strelka )
+
+
+# The process-style handler base class.
+class Strelka::Process < Mongrel2::Handler
+	include Strelka::Loggable,
+	        Strelka::Constants
+
+	### Create a new Process.
+	def initialize( * )
+		@
+	end
+
+
+end # class Strelka::Process
+

data/lib/strelka.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+require 'mongrel2'
+require 'configurability'
+
+# An application framework for Ruby-mongrel2
+# 
+# == Author/s
+#
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+module Strelka
+
+	# Library version constant
+	VERSION = '0.0.1'
+
+	# Version-control revision constant
+	REVISION = %q$Revision: 1e34f33f76af $
+
+
+	require 'strelka/logging'
+	extend Strelka::Logging
+
+	require 'strelka/constants'
+	include Strelka::Constants
+
+
+	### Get the library version. If +include_buildnum+ is true, the version string will
+	### include the VCS rev ID.
+	def self::version_string( include_buildnum=false )
+		vstring = "%s %s" % [ self.name, VERSION ]
+		vstring << " (build %s)" % [ REVISION[/: ([[:xdigit:]]+)/, 1] || '0' ] if include_buildnum
+		return vstring
+	end
+
+	require 'strelka/app'
+	require 'strelka/httprequest'
+
+end # module Strelka
+

data/spec/data/layout.tmpl

@@ -0,0 +1,3 @@
+A minimal layout template.
+<?attr body ?>
+

data/spec/data/main.tmpl

@@ -0,0 +1 @@
+A template for testing the Templating plugin.

data/spec/lib/constants.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'strelka' unless defined?( Strelka )
+
+
+### A collection of constants used in testing
+module Strelka::TestConstants # :nodoc:all
+
+	include Strelka::Constants
+
+	unless defined?( TEST_HOST )
+
+		TEST_HOST = 'localhost'
+
+		# App id for testing
+		TEST_APPID = 'BD17D85C-4730-4BF2-999D-9D2B2E0FCCF9'
+
+		# 0mq socket specifications for Handlers
+		TEST_SEND_SPEC = 'tcp://127.0.0.1:9998'
+		TEST_RECV_SPEC = 'tcp://127.0.0.1:9997'
+
+
+
+		# Freeze all testing constants
+		constants.each do |cname|
+			const_get(cname).freeze
+		end
+	end
+
+end
+
+

data/spec/lib/helpers.rb

@@ -0,0 +1,134 @@
+#!/usr/bin/ruby
+# coding: utf-8
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent.parent
+
+	srcdir = basedir.parent
+	mongrel2dir = srcdir + 'Mongrel2/lib'
+
+	libdir = basedir + "lib"
+
+	$LOAD_PATH.unshift( mongrel2dir.to_s ) unless $LOAD_PATH.include?( mongrel2dir.to_s )
+	$LOAD_PATH.unshift( basedir.to_s ) unless $LOAD_PATH.include?( basedir.to_s )
+	$LOAD_PATH.unshift( libdir.to_s ) unless $LOAD_PATH.include?( libdir.to_s )
+}
+
+# SimpleCov test coverage reporting; enable this using the :coverage rake task
+if ENV['COVERAGE']
+	$stderr.puts "\n\n>>> Enabling coverage report.\n\n"
+	require 'simplecov'
+	SimpleCov.start do
+		add_filter 'spec'
+		add_group "Needing tests" do |file|
+			file.covered_percent < 90
+		end
+	end
+end
+
+require 'configurability'
+require 'pathname'
+require 'tmpdir'
+
+require 'rspec'
+require 'mongrel2'
+require 'mongrel2/testing'
+
+require 'strelka'
+
+require 'spec/lib/constants'
+# require 'spec/lib/matchers'
+
+### RSpec helper functions.
+module Strelka::SpecHelpers
+	include Strelka::TestConstants
+
+	class ArrayLogger
+		### Create a new ArrayLogger that will append content to +array+.
+		def initialize( array )
+			@array = array
+		end
+
+		### Write the specified +message+ to the array.
+		def write( message )
+			@array << message
+		end
+
+		### No-op -- this is here just so Logger doesn't complain
+		def close; end
+
+	end # class ArrayLogger
+
+
+	unless defined?( LEVEL )
+		LEVEL = {
+			:debug => Logger::DEBUG,
+			:info  => Logger::INFO,
+			:warn  => Logger::WARN,
+			:error => Logger::ERROR,
+			:fatal => Logger::FATAL,
+		  }
+	end
+
+	###############
+	module_function
+	###############
+
+	### Make an easily-comparable version vector out of +ver+ and return it.
+	def vvec( ver )
+		return ver.split('.').collect {|char| char.to_i }.pack('N*')
+	end
+
+
+	### Reset the logging subsystem to its default state.
+	def reset_logging
+		Strelka.reset_logger
+		Mongrel2.reset_logger
+	end
+
+
+	### Alter the output of the default log formatter to be pretty in SpecMate output
+	def setup_logging( level=Logger::FATAL )
+
+		# Turn symbol-style level config into Logger's expected Fixnum level
+		if Strelka::Logging::LOG_LEVELS.key?( level.to_s )
+			level = Strelka::Logging::LOG_LEVELS[ level.to_s ]
+		end
+
+		logger = Logger.new( $stderr )
+		Strelka.logger = logger
+		Strelka.logger.level = level
+		Mongrel2.logger.level = level
+
+		# Only do this when executing from a spec in TextMate
+		if ENV['HTML_LOGGING'] || (ENV['TM_FILENAME'] && ENV['TM_FILENAME'] =~ /_spec\.rb/)
+			Thread.current['logger-output'] = []
+			logdevice = ArrayLogger.new( Thread.current['logger-output'] )
+			Strelka.logger = Logger.new( logdevice )
+			# Strelka.logger.level = level
+			Strelka.logger.formatter = Strelka::Logging::HtmlFormatter.new( logger )
+			Mongrel2.logger = Strelka.logger
+		end
+	end
+
+end
+
+
+abort "You need a version of RSpec >= 2.6.0" unless defined?( RSpec )
+
+### Mock with RSpec
+RSpec.configure do |c|
+	include Strelka::TestConstants
+
+	c.mock_with( :rspec )
+
+	c.extend( Strelka::TestConstants )
+	c.include( Strelka::TestConstants )
+	c.include( Mongrel2::SpecHelpers )
+	c.include( Strelka::SpecHelpers )
+	# c.include( Strelka::Matchers )
+end
+
+# vim: set nosta noet ts=4 sw=4:
+

data/spec/strelka/app/defaultrouter_spec.rb

@@ -0,0 +1,215 @@
+#!/usr/bin/env ruby
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent.parent.parent
+	$LOAD_PATH.unshift( basedir ) unless $LOAD_PATH.include?( basedir )
+}
+
+require 'rspec'
+
+require 'spec/lib/helpers'
+
+require 'strelka'
+require 'strelka/app/defaultrouter'
+
+
+#####################################################################
+###	C O N T E X T S
+#####################################################################
+
+describe Strelka::App::DefaultRouter do
+
+	before( :all ) do
+		setup_logging( :fatal )
+		@request_factory = Mongrel2::RequestFactory.new( route: '/user' )
+	end
+
+	before( :each ) do
+		@router = Strelka::App::DefaultRouter.new
+	end
+
+	after( :all ) do
+		reset_logging()
+	end
+
+	context "a router with routes for 'foo', 'foo/bar'" do
+
+		before( :each ) do
+			@router.add_route( :GET, ['foo'], :the_foo_action )
+			@router.add_route( :GET, ['foo','bar'], :the_foo_bar_action )
+		end
+
+		it "routes /user/foo/bar/baz to the foo/bar action" do
+			req = @request_factory.get( '/user/foo/bar/baz' )
+			@router.route_request( req ).should == :the_foo_bar_action
+		end
+
+		it "routes /user/foo/bar to the foo/bar action" do
+			req = @request_factory.get( '/user/foo/bar' )
+			@router.route_request( req ).should == :the_foo_bar_action
+		end
+
+		it "routes /user/foo to the foo action" do
+			req = @request_factory.get( '/user/foo' )
+			@router.route_request( req ).should == :the_foo_action
+		end
+
+		it "doesn't route /user" do
+			req = @request_factory.get( '/user' )
+			@router.route_request( req ).should be_nil()
+		end
+
+		it "doesn't route /user/other" do
+			req = @request_factory.get( '/user/other' )
+			@router.route_request( req ).should be_nil()
+		end
+
+	end
+
+	context "a router with routes for 'foo', 'foo/bar', and a fallback action" do
+
+		before( :each ) do
+			@router.add_route( :GET, [], :the_fallback_action )
+			@router.add_route( :GET, ['foo'], :the_foo_action )
+			@router.add_route( :GET, ['foo','bar'], :the_foo_bar_action )
+		end
+
+		it "routes /user/foo/bar/baz to the foo/bar action" do
+			req = @request_factory.get( '/user/foo/bar/baz' )
+			@router.route_request( req ).should == :the_foo_bar_action
+		end
+
+		it "routes /user/foo/bar to the foo/bar action" do
+			req = @request_factory.get( '/user/foo/bar' )
+			@router.route_request( req ).should == :the_foo_bar_action
+		end
+
+		it "routes /user/foo to the foo action" do
+			req = @request_factory.get( '/user/foo' )
+			@router.route_request( req ).should == :the_foo_action
+		end
+
+		it "routes /user to the fallback action" do
+			req = @request_factory.get( '/user' )
+			@router.route_request( req ).should == :the_fallback_action
+		end
+
+		it "routes /user/other to the fallback action" do
+			req = @request_factory.get( '/user/other' )
+			@router.route_request( req ).should == :the_fallback_action
+		end
+
+	end
+
+	context "a router with routes for 'foo', 'foo/\w{3}', and 'foo/\w{6}'" do
+
+		before( :each ) do
+			@router.add_route( :GET, ['foo'], :the_foo_action )
+			@router.add_route( :GET, ['foo',/\w{3}/], :the_foo_threeaction )
+			@router.add_route( :GET, ['foo',/\w{6}/], :the_foo_sixaction )
+		end
+
+		it "routes /user/foo/barbim/baz to the foo/\w{6} action" do
+			req = @request_factory.get( '/user/foo/barbim/baz' )
+			@router.route_request( req ).should == :the_foo_sixaction
+		end
+
+		it "routes /user/foo/barbat to the foo/\w{6} action" do
+			req = @request_factory.get( '/user/foo/barbat' )
+			@router.route_request( req ).should == :the_foo_sixaction
+		end
+
+		it "routes /user/foo/bar/baz to the foo/\w{3} action" do
+			req = @request_factory.get( '/user/foo/bar/baz' )
+			@router.route_request( req ).should == :the_foo_threeaction
+		end
+
+		it "routes /user/foo/bar to the foo/\w{3} action" do
+			req = @request_factory.get( '/user/foo/bar' )
+			@router.route_request( req ).should == :the_foo_threeaction
+		end
+
+		it "routes /user/foo to the foo action" do
+			req = @request_factory.get( '/user/foo' )
+			@router.route_request( req ).should == :the_foo_action
+		end
+
+		it "doesn't route /user" do
+			req = @request_factory.get( '/user' )
+			@router.route_request( req ).should be_nil()
+		end
+
+		it "doesn't route /user/other" do
+			req = @request_factory.get( '/user/other' )
+			@router.route_request( req ).should be_nil()
+		end
+
+	end
+
+	# get '/foo/\w{3}'
+		# get '/foo/\d+'
+
+	context "a router with routes for: 'foo/\w{3}', then 'foo/\d+'" do
+
+		before( :each ) do
+			@router.add_route( :GET, ['foo',/\w{3}/], :the_foo_threeaction )
+			@router.add_route( :GET, ['foo',/\d+/], :the_foo_digitaction )
+		end
+
+		it "routes /user/foo/1 to the foo/\d+ action" do
+			req = @request_factory.get( '/user/foo/1' )
+			@router.route_request( req ).should == :the_foo_digitaction
+		end
+
+		it "routes /user/foo/12 to the foo/\d+ action" do
+			req = @request_factory.get( '/user/foo/12' )
+			@router.route_request( req ).should == :the_foo_digitaction
+		end
+
+		it "routes /user/foo/123 to the foo/\w{3} action" do
+			req = @request_factory.get( '/user/foo/123' )
+			@router.route_request( req ).should == :the_foo_threeaction
+		end
+
+		it "routes /user/foo/1234 to the foo/\d+ action" do
+			req = @request_factory.get( '/user/foo/1234' )
+			@router.route_request( req ).should == :the_foo_digitaction
+		end
+
+	end
+
+	# get '/foo/\d+'
+	# get '/foo/\w{3}'
+
+	context "a router with routes for: 'foo/\d+', then 'foo/\w{3}'" do
+
+		before( :each ) do
+			@router.add_route( :GET, ['foo',/\d+/], :the_foo_digitaction )
+			@router.add_route( :GET, ['foo',/\w{3}/], :the_foo_threeaction )
+		end
+
+		it "routes /user/foo/1 to the foo/\d+ action" do
+			req = @request_factory.get( '/user/foo/1' )
+			@router.route_request( req ).should == :the_foo_digitaction
+		end
+
+		it "routes /user/foo/12 to the foo/\d+ action" do
+			req = @request_factory.get( '/user/foo/12' )
+			@router.route_request( req ).should == :the_foo_digitaction
+		end
+
+		it "routes /user/foo/123 to the foo/\d+ action" do
+			req = @request_factory.get( '/user/foo/123' )
+			@router.route_request( req ).should == :the_foo_digitaction
+		end
+
+		it "routes /user/foo/1234 to the foo/\d+ action" do
+			req = @request_factory.get( '/user/foo/1234' )
+			@router.route_request( req ).should == :the_foo_digitaction
+		end
+
+	end
+
+end
+

data/spec/strelka/app/parameters_spec.rb

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent.parent.parent
+	$LOAD_PATH.unshift( basedir ) unless $LOAD_PATH.include?( basedir )
+}
+
+require 'rspec'
+
+require 'spec/lib/helpers'
+
+require 'strelka'
+require 'strelka/app/plugins'
+require 'strelka/app/parameters'
+require 'strelka/behavior/plugin'
+
+
+#####################################################################
+###	C O N T E X T S
+#####################################################################
+
+describe Strelka::App::Parameters do
+
+	before( :all ) do
+		setup_logging( :fatal )
+	end
+
+	after( :all ) do
+		reset_logging()
+	end
+
+
+	it_should_behave_like( "A Strelka::App Plugin" )
+
+
+	describe "an including App" do
+
+		before( :each ) do
+			@app = Class.new( Strelka::App ) do
+				plugin :parameters
+			end
+		end
+
+		it "has a parameters Hash" do
+			@app.parameters.should be_a( Hash )
+		end
+
+		it "can declare a parameter with a validation pattern" do
+			@app.class_eval do
+				param :username, /\w+/i
+			end
+
+			@app.parameters.should have( 1 ).member
+			@app.parameters[ :username ].
+				should include( :constraint => /(?<username>(?i-mx:\w+))/ )
+		end
+
+		it "inherits parameters from its superclass" do
+			@app.class_eval do
+				param :username, /\w+/i
+			end
+			subapp = Class.new( @app )
+
+			subapp.parameters.should have( 1 ).member
+			subapp.parameters[ :username ].
+				should include( :constraint => /(?<username>(?i-mx:\w+))/ )
+		end
+
+	end
+
+
+end
+

data/spec/strelka/app/plugins_spec.rb

@@ -0,0 +1,167 @@
+#!/usr/bin/env ruby
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent.parent.parent
+	$LOAD_PATH.unshift( basedir ) unless $LOAD_PATH.include?( basedir )
+}
+
+require 'rspec'
+
+require 'spec/lib/helpers'
+
+require 'strelka'
+require 'strelka/app/plugins'
+
+
+#####################################################################
+###	C O N T E X T S
+#####################################################################
+
+describe Strelka::App::Plugins do
+
+	before( :all ) do
+		setup_logging( :fatal )
+		@original_plugin_registry = Strelka::App.loaded_plugins.dup
+	end
+
+	after( :all ) do
+		Strelka::App.loaded_plugins.clear
+		Strelka::App.loaded_plugins.replace( @original_plugin_registry )
+		reset_logging()
+	end
+
+
+	describe "Plugin module" do
+
+		it "registers itself with a plugin registry" do
+			plugin = Module.new do
+				extend Strelka::App::Plugin
+			end
+
+			Strelka::App.loaded_plugins.should include( plugin.plugin_name => plugin )
+		end
+
+
+		it "extends the object even if included" do
+			plugin = Module.new do
+				include Strelka::App::Plugin
+			end
+
+			Strelka::App.loaded_plugins.should include( plugin.plugin_name => plugin )
+		end
+
+
+		context "that declares that it should run before another" do
+
+			before( :each ) do
+				@other_mod = Module.new { include Strelka::App::Plugin }
+				modname = @other_mod.plugin_name
+				@before_mod = Module.new do
+					include Strelka::App::Plugin
+					run_before( modname )
+				end
+			end
+
+			it "knows that it isn't after the other plugin" do
+				@before_mod.should_not be_after( @other_mod )
+			end
+
+			it "knows that it is before the other plugin" do
+				@before_mod.should be_before( @other_mod )
+			end
+
+			it "sorts before the other plugin" do
+				[ @other_mod, @before_mod].sort.should == [ @before_mod, @other_mod ]
+			end
+
+		end
+
+		context "that declares that it should run after another" do
+
+			before( :each ) do
+				@other_mod = Module.new { include Strelka::App::Plugin }
+				modname = @other_mod.plugin_name
+				@after_mod = Module.new do
+					include Strelka::App::Plugin
+					run_after( modname )
+				end
+			end
+
+			it "knows that it is after the other plugin" do
+				@after_mod.should be_after( @other_mod )
+			end
+
+			it "knows that is isn't before the other plugin" do
+				@after_mod.should_not be_before( @other_mod )
+			end
+
+			it "sorts after the other plugin" do
+				[ @after_mod, @other_mod ].sort.should == [ @other_mod, @after_mod ]
+			end
+
+		end
+
+	end
+
+
+	context "loading" do
+		it "appends class methods if the plugin has them" do
+			plugin = Module.new do
+				include Strelka::App::Plugin
+				module ClassMethods
+					def a_class_method; return "yep."; end
+				end
+			end
+
+			app = Class.new( Strelka::App )
+			app.install_plugin( plugin )
+
+			app.a_class_method.should == "yep."
+		end
+
+		it "adds class-instance variables to the class if the plugin has them" do
+			plugin = Module.new do
+				include Strelka::App::Plugin
+				module ClassMethods
+					@testing_value = :default
+					attr_accessor :testing_value
+				end
+			end
+
+			app = Class.new( Strelka::App )
+			app.install_plugin( plugin )
+
+			app.testing_value.should == :default
+			app.testing_value = :not_the_default
+			app.testing_value.should == :not_the_default
+		end
+	end
+
+
+	context "plugin/plugins declarative" do
+
+		before( :each ) do
+			@including_class = Class.new { include Strelka::App::Plugins }
+		end
+
+		it "can declare a single plugin to load" do
+			klass = Class.new( @including_class ) do
+				plugin :routing
+			end
+
+			klass.ancestors.should include( Strelka::App::Routing )
+		end
+
+		it "can declare a list of plugins to load" do
+			klass = Class.new( @including_class ) do
+				plugins :templating, :routing
+			end
+
+			klass.ancestors.should include( Strelka::App::Routing, Strelka::App::Templating )
+		end
+
+	end
+
+end
+