strelka 0.0.1.pre.324 → 0.0.1.pre.328

data/ChangeLog

@@ -1,8 +1,85 @@
+2012-10-11  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/strelka/app.rb, lib/strelka/app/templating.rb,
+	spec/lib/helpers.rb, spec/strelka/app/templating_spec.rb,
+	spec/strelka/app_spec.rb:
+	Add template-directory discovery to the :templating plugin.
+	[cde8aaae8b47] [tip]
+
+2012-10-03  Michael Granger  <ged@FaerieMUD.org>
+
+	* Rakefile:
+	Don't load the manualgen Hoe plugin
+	[da2c8cd59ba9]
+
+2012-10-09  Michael Granger  <ged@FaerieMUD.org>
+
+	* bin/leash, contrib/hoetemplate/.autotest.erb,
+	contrib/hoetemplate/data/file_name/apps/file_name_app,
+	contrib/hoetemplate/data/file_name/templates/layout.tmpl.erb,
+	contrib/hoetemplate/data/file_name/templates/top.tmpl.erb,
+	data/strelka/apps/hello-world, lib/strelka/app/defaultrouter.rb,
+	lib/strelka/app/exclusiverouter.rb,
+	lib/strelka/app/paramvalidator.rb, lib/strelka/app/plugins.rb,
+	lib/strelka/app/router.rb, lib/strelka/logging.rb,
+	manual/layouts/default.erb, manual/lib/api-filter.rb, manual/lib
+	/editorial-filter.rb, manual/lib/examples-filter.rb, manual/lib
+	/links-filter.rb, manual/resources/css/manual.css,
+	manual/resources/fonts/GraublauWeb.otf,
+	manual/resources/fonts/GraublauWebBold.otf,
+	manual/resources/fonts/Inconsolata.otf,
+	manual/resources/images/arrow_225_small.png,
+	manual/resources/images/arrow_315_small.png,
+	manual/resources/images/arrow_skip.png, manual/resources/images/cc-
+	by.png, manual/resources/images/dialog-error.png,
+	manual/resources/images/dialog-information.png,
+	manual/resources/images/dialog-warning.png, manual/resources/images
+	/emblem-important.png, manual/resources/images/help.png,
+	manual/resources/images/information.png,
+	manual/resources/images/magnifier.png,
+	manual/resources/images/magnifier_left.png,
+	manual/resources/images/page_white_code.png,
+	manual/resources/images/page_white_copy.png,
+	manual/resources/images/printer.png, manual/resources/images
+	/project-layout.png, manual/resources/images/question.png,
+	manual/resources/images/scripts_code.png, manual/resources/images
+	/strelka-dogs/doggie6.svg, manual/resources/images/strelka-
+	dogs/doggie7.svg, manual/resources/images/wrap.png,
+	manual/resources/images/wrapping.png,
+	manual/resources/js/jquery-1.4.4.min.js,
+	manual/resources/js/manual.js, manual/resources/js/sh.js,
+	manual/resources/swf/clipboard.swf, manual/src/cookbook.page,
+	manual/src/deploying.page, manual/src/index.page,
+	manual/src/plugins.page, manual/src/writing.page,
+	spec/strelka/app/defaultrouter_spec.rb,
+	spec/strelka/app/exclusiverouter_spec.rb,
+	spec/strelka/app/paramvalidator_spec.rb,
+	spec/strelka/app/plugins_spec.rb, spec/strelka/app/router_spec.rb,
+	spec/strelka/logging_spec.rb:
+	Merge: Resurrect the strelka doggies under contrib/
+	[a38210d27bbd]
+
+	* contrib/strelka-dogs/doggie6.svg, contrib/strelka-dogs/doggie7.svg:
+	Oops, didn't mean to delete these
+	[d9cde3c8a778]
+
+2012-10-08  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/strelka/authprovider.rb, spec/strelka/authprovider_spec.rb:
+	Fix the documentation and specs for AuthProvider#authorize.
+	[accb655c57b4]
+
+2012-10-03  Michael Granger  <ged@FaerieMUD.org>
+
+	* .rvm.gems, Rakefile:
+	Bump dependency to the latest version of Mongrel2.
+	[a11bf994ae39]
+
 2012-10-02  Michael Granger  <ged@FaerieMUD.org>
 
 	* bin/strelka:
 	Don't fork for 'strelka start'.
-	[8882a71efc41] [tip]
+	[8882a71efc41]
 
 2012-09-28  Michael Granger  <ged@FaerieMUD.org>
 

data/lib/strelka/app/templating.rb

@@ -19,6 +19,7 @@ require 'strelka/plugins'
 # * a mechanism for fetching templates from the table
 # * a global layout template which is automatically wrapped around responses
 #
+#
 # == Usage
 #
 # To use it, just load the <tt>:templating</tt> plugin in your app:
@@ -88,14 +89,63 @@ require 'strelka/plugins'
 #
 #   <?import request, strelka_version, route ?>
 #
+#
+# == Template Locations
+#
+# Inversion looks for templates in a load path much like Ruby does for libraries that
+# you 'require'. It contains just the current working directory by default. You can add
+# your own template directories via the config file (under +template_paths+ in
+# the +templates+ section), or programmatically from your application, but very often you'll
+# want to distribute templates with the application gem.
+#
+# The plugin supports this by looking for a +templates/+ directory under your gem's
+# data directory. If it finds such a directory for any loaded gem that has a Strelka dependency,
+# it appends it to Inversion's +template_paths+. This also works for plugins, should you
+# write your own, and want to provide some default templates. See the 'laika-fancyerrors'
+# gem for an example of this.
+#
 module Strelka::App::Templating
 	include Strelka::Constants
-	extend Strelka::Plugin
+	extend Strelka::Plugin,
+	       Loggability
 
+
+	# Loggability API -- log to strelka's logger
+	log_to :strelka
+
+	# Run order
 	run_before :routing, :negotiation, :errors
 	run_after :filters
 
 
+	### Return an Array of Pathnames to all directories named 'templates' under the
+	### data dirctories of loaded gems which have a dependency on Strelka.
+	def self::discover_template_dirs
+		directories = Strelka::App.discover_data_dirs.values.flatten
+
+		self.log.debug "Discovered data directories: %p" % [ directories ]
+
+		return directories.inject( [] ) do |array, dir|
+			pattern = File.join( dir, 'templates' )
+			self.log.debug "  adding: %s" % [ pattern ]
+			array += Pathname.glob( pattern )
+		end
+	end
+
+
+	### Inclusion callback -- add the plugin's templates directory right before activation
+	### so loading the config doesn't clobber it.
+	def self::included( mod )
+
+		# Add the plugin's template directory to Inversion's template path
+		dirs = self.discover_template_dirs
+		self.log.info "Discovered template directories: %p" % [ dirs ]
+		Inversion::Template.template_paths.concat( dirs )
+
+		super
+	end
+
+
 	# Class methods to add to classes with templating.
 	module ClassMethods
 

data/lib/strelka/app.rb

@@ -138,11 +138,12 @@ class Strelka::App < Mongrel2::Handler
 	end
 
 
-	### Return a Hash of Strelka app files as Pathname objects from installed gems,
-	### keyed by gemspec name .
-	def self::discover_paths
-		appfiles = {
-			'' => Pathname.glob( File.join(self.local_data_dirs, self.app_glob_pattern) )
+	### Return a Hash of glob patterns for matching data directories for the latest
+	### versions of all installed gems which have a dependency on Strelka, keyed
+	### by gem name.
+	def self::discover_data_dirs
+		datadirs = {
+			'' => self.local_data_dirs
 		}
 
 		# Find all the gems that depend on Strelka
@@ -156,15 +157,23 @@ class Strelka::App < Mongrel2::Handler
 		# pattern
 		gems.sort.reverse.each do |gemspec|
 			# Only look at the latest version of the gem
-			next if appfiles.key?( gemspec.name )
-			appfiles[ gemspec.name ] = []
-
-			self.log.debug "  checking %s for apps in its datadir" % [ gemspec.name ]
-			pattern = File.join( gemspec.full_gem_path, "data", gemspec.name, APP_GLOB_PATTERN )
-			self.log.debug "    glob pattern is: %p" % [ pattern ]
-			gemapps = Pathname.glob( pattern )
-			self.log.debug "    found %d app files" % [ gemapps.length ]
-			appfiles[ gemspec.name ] += gemapps
+			next if datadirs.key?( gemspec.name )
+			datadirs[ gemspec.name ] = File.join( gemspec.full_gem_path, "data", gemspec.name )
+		end
+
+		self.log.debug "  returning data directories: %p" % [ datadirs ]
+		return datadirs
+	end
+
+
+	### Return a Hash of Strelka app files as Pathname objects from installed gems,
+	### keyed by gemspec name .
+	def self::discover_paths
+		appfiles = {}
+
+		self.discover_data_dirs.each do |gemname, dir|
+			pattern = File.join( dir, self.app_glob_pattern )
+			appfiles[ gemname ] = Pathname.glob( pattern )
 		end
 
 		return appfiles

data/lib/strelka/authprovider.rb

@@ -83,12 +83,17 @@ class Strelka::AuthProvider
 	end
 
 
-	### If the +callback+ is set, call it with the specified +credentials+, and +request. Override
-	### this in your own AuthProvider to provide +additional_arguments+ to the +callback+, and/or
-	### to provide additional generic authorization.
-	def authorize( credentials, request, *additional_arguments, &callback )
-		return true unless callback
-		return true if callback.call( credentials, request, *additional_arguments )
+	### You should override this method if you want to provide authorization in your
+	### provider. The +credentials+ will be the same object as the one returned by #authenticate,
+	### the +request+ is the current Strelka::HTTPRequest, and +perms+ is the Array of Symbols
+	### the represents the permissions that apply to the request as specified by the
+	### application's +require_perms_for+ and +no_perms_for+ declarations, as an Array of
+	### Symbols.
+	###
+	### The default behavior is to throw an 403 FORBIDDEN response if any +perms+ were
+	### required.
+	def authorize( credentials, request, perms )
+		return true if perms.empty?
 		self.require_authorization
 	end
 

data/spec/lib/helpers.rb

@@ -90,6 +90,16 @@ module Strelka::SpecHelpers
 		return tempdir
 	end
 
+
+	### Make and return a dummy gemspec with the given +name+ and +version+, and inject a
+	### dependency on 'strelka' if +strelka_dep+ is true.
+	def make_gemspec( name, version, strelka_dep=true )
+		spec = Gem::Specification.new( name, version )
+		spec.add_runtime_dependency( 'strelka', '~> 0.0' ) if strelka_dep
+		return spec
+	end
+
+
 end
 
 

data/spec/strelka/app/templating_spec.rb

@@ -27,11 +27,13 @@ require 'strelka/behavior/plugin'
 describe Strelka::App::Templating do
 
 	before( :all ) do
-		setup_logging( :fatal )
+		setup_logging()
 		@request_factory = Mongrel2::RequestFactory.new( route: '/user' )
+		@original_template_paths = Inversion::Template.template_paths.dup
 	end
 
 	after( :all ) do
+		Inversion::Template.template_paths.replace( @original_template_paths )
 		reset_logging()
 	end
 
@@ -39,6 +41,78 @@ describe Strelka::App::Templating do
 	it_should_behave_like( "A Strelka::App Plugin" )
 
 
+	describe "template discovery" do
+
+		before( :each ) do
+			Inversion::Template.template_paths.replace( @original_template_paths )
+		end
+
+		it "can discover template directories for loaded gems that depend on Strelka" do
+			specs = {}
+			specs[:gymnastics]  = make_gemspec( 'gymnastics',  '1.0.0' )
+			specs[:cycling_old] = make_gemspec( 'cycling',  '1.0.0' )
+			specs[:cycling_new] = make_gemspec( 'cycling',  '1.0.8' )
+			specs[:karate]      = make_gemspec( 'karate',    '1.0.0', false )
+			specs[:javelin]     = make_gemspec( 'javelin', '1.0.0' )
+
+			expectation = Gem::Specification.should_receive( :each )
+			specs.values.each {|spec| expectation.and_yield(spec) }
+
+			gymnastics_path  = specs[:gymnastics].full_gem_path
+			cycling_path  = specs[:cycling_new].full_gem_path
+			javelin_path = specs[:javelin].full_gem_path
+
+			Dir.should_receive( :glob ).with( 'data/*/templates' ).
+				and_return([ "data/foom/templates" ])
+			Dir.should_receive( :glob ).with( "#{javelin_path}/data/javelin/templates" ).
+				and_return([ "#{javelin_path}/data/javelin/templates" ])
+			Dir.should_receive( :glob ).with( "#{gymnastics_path}/data/gymnastics/templates" ).
+				and_return([ "#{gymnastics_path}/data/gymnastics/templates" ])
+
+			Dir.should_receive( :glob ).with( "#{cycling_path}/data/cycling/templates" ).
+				and_return([])
+
+			template_dirs = described_class.discover_template_dirs
+
+			# template_dirs.should have( 4 ).members
+			template_dirs.should include(
+				Pathname("data/foom/templates"),
+				Pathname("#{javelin_path}/data/javelin/templates"),
+				Pathname("#{gymnastics_path}/data/gymnastics/templates")
+			)
+		end
+
+
+		it "injects template directories from loaded gems into Inversion's template path" do
+			specs = {}
+			specs[:gymnastics]  = make_gemspec( 'gymnastics',  '1.0.0' )
+			specs[:javelin]     = make_gemspec( 'javelin', '1.0.0' )
+
+			expectation = Gem::Specification.should_receive( :each )
+			specs.values.each {|spec| expectation.and_yield(spec) }
+
+			gymnastics_path = specs[:gymnastics].full_gem_path
+			javelin_path    = specs[:javelin].full_gem_path
+
+			Dir.should_receive( :glob ).with( 'data/*/templates' ).
+				and_return([ "data/foom/templates" ])
+			Dir.should_receive( :glob ).with( "#{javelin_path}/data/javelin/templates" ).
+				and_return([ "#{javelin_path}/data/javelin/templates" ])
+			Dir.should_receive( :glob ).with( "#{gymnastics_path}/data/gymnastics/templates" ).
+				and_return([ "#{gymnastics_path}/data/gymnastics/templates" ])
+
+			Module.new { include Strelka::App::Templating }
+
+			Inversion::Template.template_paths.should include(
+				Pathname("data/foom/templates"),
+				Pathname("#{javelin_path}/data/javelin/templates"),
+				Pathname("#{gymnastics_path}/data/gymnastics/templates")
+			)
+		end
+
+	end
+
+
 	describe "an including App" do
 
 		before( :each ) do

data/spec/strelka/app_spec.rb

@@ -62,17 +62,6 @@ describe Strelka::App do
 	end
 
 
-	#
-	# Helpers
-	#
-
-	def make_gemspec( name, version, strelka_dep=true )
-		spec = Gem::Specification.new( name, version )
-		spec.add_runtime_dependency( 'strelka', '~> 0.0' ) if strelka_dep
-		return spec
-	end
-
-
 	#
 	# Examples
 	#

data/spec/strelka/authprovider_spec.rb

@@ -45,9 +45,17 @@ describe Strelka::AuthProvider do
 
 	describe "a subclass" do
 
+		before( :all ) do
+			@appclass = Class.new( Strelka::App ) do
+				def initialize( appid='authprovider-test', sspec=TEST_SEND_SPEC, rspec=TEST_RECV_SPEC )
+					super
+				end
+			end
+		end
+
 		before( :each ) do
 			@subclass = Class.new( described_class )
-			@app = mock( "Application" )
+			@app = @appclass.new
 			@provider = @subclass.new( @app )
 		end
 
@@ -69,25 +77,18 @@ describe Strelka::AuthProvider do
 
 		context "Authorization" do
 
-			it "doesn't fail if the application doesn't provide an authz callback" do
-				req = @request_factory.get( '/admin/console' )
-				expect {
-					@provider.authorize( 'anonymous', req )
-				}.to_not throw_symbol()
-			end
-
-			it "doesn't fail if the application's authz callback returns true" do
+			it "doesn't fail if the application doesn't require any perms" do
 				req = @request_factory.get( '/admin/console' )
 				expect {
-					@provider.authorize( 'anonymous', req ) { true }
+					@provider.authorize( 'anonymous', req, [] )
 				}.to_not throw_symbol()
 			end
 
-			it "fails with a 403 (Forbidden) if the app's authz callback returns false" do
+			it "fails with a 403 (Forbidden) if the app does require perms" do
 				req = @request_factory.get( '/admin/console' )
 
 				expect {
-					@provider.authorize( 'anonymous', req ) { false }
+					@provider.authorize( 'anonymous', req, [:write] )
 				}.to finish_with( HTTP::FORBIDDEN, /you are not authorized/i )
 			end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strelka
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre.324
+  version: 0.0.1.pre.328
   prerelease: 
 platform: ruby
 authors:
@@ -36,7 +36,7 @@ cert_chain:
   YUhDS0xaZFNLai9SSHVUT3QrZ2JsUmV4OEZBaDhOZUEKY21saFhlNDZwWk5K
   Z1dLYnhaYWg4NWpJang5NWhSOHZPSStOQU01aUg5a09xSzEzRHJ4YWNUS1Bo
   cWo1UGp3RgotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
-date: 2012-10-03 00:00:00.000000000 Z
+date: 2012-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: configurability