arrow 1.0.7

data/Rakefile.local

@@ -0,0 +1,63 @@
+# 
+# Local project Rakefile tasks
+# $Id$
+# 
+# 
+
+APPLETSDIR              = DATADIR + 'applets'
+TEMPLATESDIR            = DATADIR + 'templates'
+
+DEMO_APPLETS            = Pathname.glob( APPLETSDIR + '**/*.rb' )
+DEMO_TEMPLATES          = Pathname.glob( TEMPLATESDIR + '**/*.tmpl' )
+
+DEMO_APPLETS_NAME       = 'arrow-demo-applets'
+DEMO_APPLETS_GEM_NAME   = "#{DEMO_APPLETS_NAME}-#{PKG_VERSION}"
+DEMO_APPLETS_GEM        = PKGDIR + "#{DEMO_APPLETS_GEM_NAME}.gem"
+
+DEMO_APPLETS_PKGDIR     = PKGDIR + "#{DEMO_APPLETS_NAME}-#{PKG_VERSION}"
+DEMO_APPLETS_DATADIR    = DEMO_APPLETS_PKGDIR + 'data'
+DEMO_APPLETS_GEM_FILES  = (DEMO_APPLETS + DEMO_TEMPLATES).collect {|pn|
+	DEMO_APPLETS_DATADIR + pn.relative_path_from(BASEDIR)
+}
+
+
+DEMO_APPLETS_GEMSPEC = Gem::Specification.new do |gem|
+	gem.name              = DEMO_APPLETS_NAME
+	gem.version           = PKG_VERSION
+
+	gem.summary           = "A collection of demo applets for Arrow"
+	gem.description       = <<-EOD
+	This is a collection of demo applets for exploring various features of
+	Arrow.
+	EOD
+
+	gem.authors           = 'Michael Granger'
+	gem.email             = 'ged@FaerieMUD.org'
+	gem.homepage          = 'http://deveiate.org/projects/Arrow/'
+
+	gem.has_rdoc          = false
+
+	gem.files             = DEMO_APPLETS + DEMO_TEMPLATES
+
+	gem.add_runtime_dependency( 'arrow', PKG_VERSION )
+end
+
+
+desc "Build a gem for the demo applets (#{DEMO_APPLETS_GEM})"
+task :demo_applets_gem => DEMO_APPLETS_GEM.to_s
+
+file DEMO_APPLETS_GEM.to_s => [PKGDIR.to_s] + DEMO_APPLETS_GEM_FILES do
+	when_writing( "Creating GEM" ) do
+		Gem::Builder.new( DEMO_APPLETS_GEMSPEC ).build
+		verbose( true ) do
+			mv GEM_FILE_NAME, gempath
+		end
+	end
+end
+
+
+configlib = LIBDIR + 'arrow/config.rb'
+file 'default.cfg'
+task 'default.cfg' => [configlib.to_s] do
+	Arrow::Logger[ self.class ].level = :debug
+end

data/data/arrow/applets/TEMPLATE.rb.tpl

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+# 
+# The (>>>class<<<) class, a derivative of Arrow::Applet. (>>>desc<<<)
+# 
+# == VCS Id
+# 
+# $Id$
+# 
+# == Authors
+# 
+# * (>>>USER_NAME<<<) <(>>>AUTHOR<<<)>
+# 
+
+require 'arrow/applet'
+
+
+### (>>>desc<<<)
+class (>>>class<<<) < Arrow::Applet
+
+
+	# Applet signature
+	Signature = {
+		:name => "(>>>name<<<)",
+		:description => "(>>>desc<<<)",
+		:maintainer => "(>>>AUTHOR<<<)",
+		:default_action => 'display',
+	}
+
+
+
+	######
+	public
+	######
+
+	def_action :display do |txn, *args|
+		self.log.debug "In the 'display' action of the '%s' app." %
+			self.signature.name 
+
+		txn.print( "" )
+
+		return true
+	end
+
+
+end # class (>>>class<<<)
+
+
+>>>TEMPLATE-DEFINITION-SECTION<<<
+("class" "App class: ")
+("name" "App name (for the signature): ")
+("desc" "Description: ")
+
+

data/data/arrow/applets/args.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby/usr/bin/ruby
+# 
+# The ArgumentTester class, a derivative of
+# Arrow::Applet. This applet is for testing/debugging/demonstrating the argument
+# validator.
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+
+require 'arrow/applet'
+
+
+### An applet for testing/debugging the argument validator.
+class ArgumentTester < Arrow::Applet
+
+	# Applet signature
+	applet_name "Argument Tester"
+	applet_description "This app is for testing/debugging the argument validator."
+	applet_maintainer "ged@FaerieMUD.org"
+
+	default_action :display
+
+
+
+	### All of the applet's functionality is handled by the default action
+	### (action_missing_action), which loads the 'display' template and renders
+	### it.
+	template :display => 'args-display.tmpl'
+    validator :display => {
+		:required		=> :name,
+		:optional		=> [:email, :description],
+		:filters		=> [:strip, :squeeze],
+		:untaint_all_constraints => true,
+		:descriptions	=> {
+			:email			=> "Customer Email",
+			:description	=> "Issue Description",
+			:name			=> "Customer Name",
+		},
+		:constraints	=> {
+			:email	=> :email,
+			:name	=> /^[\x20-\x7f]+$/,
+			:description => /^[\x20-\x7f]+$/,
+		},
+	}
+
+end # class ArgumentTester
+
+

data/data/arrow/applets/config.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+# 
+# The ConfigApplet class, a derivative of Arrow::Applet. It
+# can be used to view/edit Arrow configurations.
+# 
+# == VCS Id
+# 
+# $Id$
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+
+require 'arrow/applet'
+require 'arrow/config'
+
+
+### An Arrow applet class for viewing/editing Arrow configurations.
+class ConfigApplet < Arrow::Applet
+
+	# Applet signature
+	Signature = {
+		:name => "ConfigApplet",
+		:description => "view/edit Arrow configuration",
+		:maintainer => "ged@FaerieMUD.org",
+		:default_action => 'display',
+		:templates => {
+			:display	=> 'config/display.tmpl',
+			:display_table => 'config/display-table.tmpl',
+		},
+	}
+
+
+
+	######
+	public
+	######
+
+	def display_action( txn, *args )
+		templ = self.load_template( :display )
+
+		templ.txn = txn
+		templ.applet = self
+		templ.config = @config
+
+		return templ
+	end
+
+
+
+
+end # class ConfigApplet
+
+

data/data/arrow/applets/error.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+# 
+# The ErrorHandler class, a derivative of
+# Arrow::Applet. It's an example of an error-handler applet.
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+# Please see the file LICENSE in the top-level directory for licensing details.
+#
+
+require 'arrow/applet'
+
+
+### An error-handling applet.
+class ErrorHandler < Arrow::Applet
+
+
+	# Applet signature
+	Signature = {
+		:name => "Appserver Error Handler",
+		:description => "Displays errors which occur in other applets in a "\
+			"readable fashion. Cannot be called directly; it is used internally "\
+			"by the appserver to handle errors which happen in applets.",
+		:maintainer => "ged@FaerieMUD.org",
+		:config => {},
+		:templates => {
+			:display	=> 'error-display.tmpl',
+		},
+		:vargs => {},
+		:monitors => {},
+		:default_action => 'default',
+	}
+
+
+
+	######
+	public
+	######
+
+	def_action :default do |*args|
+		intentional_undefined_local_variable_or_method
+		return "Hmmm... that didn't work"
+	end
+
+	def report_error_action( txn, re, err )
+		self.log.debug "Loading 'display' template"
+		template = self.load_template( :display )
+		self.log.debug "'display' template: %p" % template
+
+		template.re = re
+		template.txn = txn
+		template.err = err
+
+		txn.print( template )
+
+		return true
+	end
+	
+
+
+end # class ErrorHandler

data/data/arrow/applets/files.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+# 
+# The LoadedFiles class, a derivative of Arrow::Applet. It
+# displays the disposition of all the files that are being monitored by Arrow.
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+
+require 'arrow/applet'
+
+
+### It displays the disposition
+class LoadedFiles < Arrow::Applet
+
+
+	# Applet signature
+	Signature = {
+		:name => "FileMap",
+		:description => "It displays the disposition of all the file that are" +
+			" being monitored by Arrow.",
+		:maintainer => "ged@FaerieMUD.org",
+		:default_action => 'filemap',
+		:templates => {
+			:filemap => 'filemap.tmpl',
+		}
+	}
+
+
+
+	######
+	public
+	######
+
+	def_action :filemap do |txn, *args|
+		templ = self.load_template( :filemap )
+		templ.txn = txn
+
+		return templ
+	end
+
+
+end # class LoadedFiles
+
+

data/data/arrow/applets/inspect.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+# 
+# The InspectorApplet class, a derivative of
+# Arrow::Applet. It dumps data that might be useful to applet developers.
+# 
+# == VCS Id
+# 
+# $Id$
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+
+require 'arrow/applet'
+
+
+### An applet that displays introspection information that might be useful to
+### applet developers.
+class InspectorApplet < Arrow::Applet
+
+
+	# Applet signature
+	Signature = {
+		:name => "Inspector",
+		:description => "It dumps data that might be useful to applet developers.",
+		:maintainer => "ged@FaerieMUD.org",
+		:default_action => 'display',
+		:templates => {
+			:display => 'inspect/display.tmpl',
+		},
+	}
+
+
+	def display_action( txn, *args )
+		templ = self.load_template( :display )
+
+		templ.txn = txn
+		templ.applet = self
+
+		return templ
+	end
+
+end # class InspectorApplet
+
+

data/data/arrow/applets/nosuchapplet.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# 
+# The NoSuchAppletHandler class, a derivative of
+# Arrow::Applet. It is an example 'noSuchAppletHandler' applet.
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+
+require 'arrow/applet'
+
+
+### An example missingApplet applet.
+class NoSuchAppletHandler < Arrow::Applet
+
+
+	# Applet signature
+	applet_name "No-such-applet handler"
+	applet_description "An example 'noSuchAppletHandler' applet. If Arrow is configured " +
+						"with the uri of this applet as the noSuchAppletHandler value, " +
+						"it will run this applet instead of declining requests for " +
+						"URIs that don't match a registered applet."
+	applet_maintainer "ged@FaerieMUD.org"
+	
+	default_action :display
+	template :display	=> 'nosuchapplet.tmpl'
+
+end # class NoSuchAppletHandler
+
+

data/data/arrow/applets/status.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+# 
+# The ServerStatus class, a derivative of Arrow::Applet. An
+# appserver status applet.
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+# Please see the file LICENSE in the top-level directory for licensing details.
+#
+
+require 'arrow/applet'
+
+
+### An Arrow appserver status applet.
+class ServerStatus < Arrow::Applet
+
+
+	# Applet signature
+	Signature = {
+		:name => "Appserver Status",
+		:description => "Displays a list of all loaded applets or information " +
+			"about a particular one.",
+		:maintainer => "ged@FaerieMUD.org",
+		:config => {},
+		:templates => {
+			:status	=> 'status.tmpl',
+			:applet	=> 'applet-status.tmpl',
+		},
+		:vargs => {},
+		:monitors => {},
+		:default_action => 'display',
+	}
+
+
+	######
+	public
+	######
+
+	def_action :display do |txn, *args|
+		self.log.debug "In the 'display' action of the '%s' applet." %
+			self.signature.name 
+
+		templ = self.load_template( :status )
+		templ.registry = txn.broker.registry
+		templ.transaction = txn
+		templ.txn = txn
+		templ.pid = Process.pid
+		templ.ppid = Process.ppid
+		templ.currentApplet = self
+
+		self.log.debug "About to return from the 'display' action."
+		return templ
+	end
+
+
+	def_action :applet do |txn, *args|
+		self.log.debug "In the 'applet' action of the '%s' applet." %
+			self.signature.name
+
+		applet = txn.broker.registry[ args.join("/") ]
+		if applet.nil?
+			self.log.error "%s: no such applet to inspect. Registry contains: %p" % 
+				[ args[0], txn.broker.registry.keys.sort ]
+			return self.run( txn, 'display' )
+		end
+
+		templ = self.load_template( :applet )
+		templ.uri = args.join("/")
+		templ.applet = applet
+		templ.txn = txn
+		templ.pid = Process.pid
+		templ.ppid = Process.ppid
+		templ.currentApplet = self
+		
+		return templ
+	end
+
+
+	def decline_action( txn, *args )
+		return nil
+	end
+
+	alias_method :css_action, :decline_action
+	alias_method :images_action, :decline_action
+	alias_method :js_action, :decline_action
+	alias_method :javascript_action, :decline_action
+
+end # class ServerStatus
+
+