arrow 1.0.7

data/data/arrow/applets/test.rb

@@ -0,0 +1,133 @@
+#!/usr/bin/env ruby
+# 
+# The UnitTester class, a derivative of
+# Arrow::Applet. The UnitTest applet can be used to define and run tests for
+# another applet by chaining through it.
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+
+require 'arrow/applet'
+
+require 'bdb'
+require 'test/unit'
+
+# Prevent Test::Unit from autorunning from its own at_exit
+at_exit { Test::Unit.run = true }
+
+
+### The UnitTest applet can be used to define and run tests for another applet
+### by chaining through it.
+class UnitTester < Arrow::Applet
+
+
+	# Default options for the BDB::Env object
+	EnvOptions = {
+		:set_timeout	=> 50,
+		:set_lk_detect	=> 1,
+		:set_verbose	=> true,
+	}
+
+	# Default flags for the BDB::Env object
+	EnvFlags = BDB::CREATE|BDB::INIT_TRANSACTION|BDB::RECOVER
+
+	# Applet signature
+	Signature = {
+		:name => "Unit testing applet",
+		:description => "The UnitTest applet can be used to define and run " +
+			"tests for another applet by chaining through it.",
+		:uri => "/test",
+		:maintainer => "ged@FaerieMUD.org",
+		:default_action => 'list',
+		:templates => {
+			:list			=> 'test/list.tmpl',
+			:testharness	=> "test/harness.tmpl",
+			:problem		=> "test/problem.tmpl",
+		},
+	}
+
+
+	### Create a new instance of the UnitTester applet with the specified
+	### +config+. It will look for its configuration values in the top-level
+	### 'unittester' key if there is one.
+	def initialize( *args )
+		super
+
+		@dbenv = nil
+		@initError = nil
+
+		# If the app is configured in the config file, then load the database.
+		if @config.respond_to?( :unittester ) && false
+			begin
+				envdir = @config.unittester.dbenv
+				Dir.mkdir( envdir, 0755 ) if !File.exists?( envdir )
+				@dbenv = BDB::Env.create( envdir, EnvFlags, EnvOptions )
+			rescue Exception => err
+				@initError = err
+			end
+		else
+			@initError = [
+				"Not Configured",
+				"The 'unittester' section was not present or malformed in " +
+				@config.name + ". It should contain, at a minimum, a 'dbenv' item " +
+				"which specifies the path to the test database."
+			]
+		end
+
+	end
+
+
+
+	######
+	public
+	######
+
+	# Run tests for the applet/s next in the chain
+	def delegate( txn, chain, *args )
+		return reportProblem( txn ) unless @dbenv
+
+		app = chain.last
+		tests = @dbenv.open_db( BDB::Hash, app[0].signature.name.gsub(/\W+/, '_'), nil, BDB::CREATE )
+
+		templ = self.load_template( :testharness )
+		templ.txn = txn
+		templ.tests = tests
+
+		return templ
+	end
+
+
+	# List the applets for which tests have been defined so far.
+	def_action :list do |txn, *args|
+		return reportProblem( txn ) unless @dbenv
+
+		templ = self.load_template( :list )
+		templ.txn = txn
+		return templ
+	end
+
+	
+	# Auxilliary action: report a problem while loading the test harness.
+	def reportProblem( txn )
+		templ = self.load_template( :problem )
+		templ.err = @initErr
+
+		return templ
+	end
+
+
+
+	#################################################################
+	###	T E S T   H A R N E S S   C L A S S E S
+	#################################################################
+
+	class TestRunner
+		extend Test::Unit::UI::TestRunnerUtilities
+
+		
+	end
+
+end # class UnitTester
+

data/data/arrow/applets/tutorial/counter.rb

@@ -0,0 +1,96 @@
+#!/usr/bin/env ruby
+# 
+# The AccessCounter class, a derivative of
+# Arrow::Applet. It's a little applet for testing session persistance. It just
+# increments and displays a counter which is held in a session object.
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+# Please see the file LICENSE in the top-level directory for licensing details.
+#
+
+require 'arrow/applet'
+
+
+### An applet for testing session persistance and applet-chaining.
+class AccessCounter < Arrow::Applet
+
+	# Applet signature
+	Signature = {
+		:name => "Session Access Counter",
+		:description => "Increments and displays a counter contained in a session object.",
+		:maintainer => "ged@FaerieMUD.org",
+		:config => {},
+		:templates => {
+			:counter	=> 'counter.tmpl',
+			:deleted	=> 'counter-deleted.tmpl',
+		},
+		:vargs => {},
+		:monitors => {},
+		:default_action => 'display',
+	}
+
+
+
+	######
+	public
+	######
+
+	### When called as a chained applet, just increment two session counters and
+	### hand off control to the next applet in the chain.
+	def delegate( txn, chain, *args )
+		begin
+			# Set up and increment this app's execution counter
+			txn.session[:counter] ||= 0
+			txn.session[:counter] += 1
+			
+			# Set up and increment the delegation counter
+			txn.session[:delegations] ||= 0
+			txn.session[:delegations] += 1
+		rescue ::Exception => err
+			self.log.error "Error while setting up session: #{err.message}"
+		end
+
+		yield( chain )
+	end
+
+
+	### The 'display' (default) action. Increments and displays the counter.
+	def_action :display do |txn, *args|
+		self.log.debug "In the 'display' action of the '%s' applet." %
+			self.signature.name 
+
+		templ = self.load_template( :counter )
+		txn.session[:counter] ||= 0
+		txn.session[:counter] += 1
+
+		txn.session[:lastChild] = Process.pid
+
+		templ.session = txn.session
+		templ.txn = txn
+
+		txn.print( templ )
+
+		return true
+	end
+
+	### Deletes the session
+	def_action :delete do |txn, *args|
+		self.log.debug "In the 'delete' action of the '%s' applet." %
+			self.signature.name 
+
+		templ = self.load_template( :deleted )
+		txn.session.remove
+
+		templ.txn = txn
+		txn.print( templ )
+
+		return true
+	end
+
+
+end # class AccessCounter
+
+

data/data/arrow/applets/tutorial/dingus.rb

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+# 
+# The BlueClothDingus class, a derivative of
+# Arrow::Applet. It presents a text box into which one can input Markdown text,
+# which when submitted will be transformed into HTML via the BlueCloth library
+# and displayed.
+# 
+# == VCS Id
+# 
+# $Id$
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+
+require 'arrow/applet'
+require 'bluecloth'
+
+
+### It presents a text box into which
+class BlueClothDingus < Arrow::Applet
+
+	# Applet signature
+	applet_name "BlueCloth Dingus"
+	applet_description "It presents a text box into which one can input " \
+			"Markdown text, which when submitted will be transformed into " \
+			"HTML via the BlueCloth library and displayed."
+	applet_maintainer "ged@FaerieMUD.org"
+	
+	default_action :display
+
+
+
+	######
+	public
+	######
+
+	def_action :display do |txn, *args|
+		templ = self.load_template( :display )
+
+		if (( source = txn.vargs.valid["source"] ))
+			self.log.debug "Got valid source argument: %s" % source
+			templ.source = source
+			templ.output = BlueCloth.new( source ).to_html
+		else
+			self.log.debug "No valid source argument: %p" % txn.vargs
+		end
+
+		templ.txn = txn
+		templ.app = self
+		templ.bcmod = BlueCloth
+
+		return templ
+	end
+	template  :display => 'dingus.tmpl'
+	validator :display => {
+		:required	=> :source,
+		:constraints	=> {
+			:source	=> /^[\x20-\x7f\r\n]+$/,
+		},
+	}
+
+
+end # class BlueClothDingus
+
+

data/data/arrow/applets/tutorial/hello.rb

@@ -0,0 +1,34 @@
+#
+# A "hello world" Arrow applet
+#
+
+require 'arrow/applet'
+
+# Define the applet class; inherit from the base applet class.
+class Hello < Arrow::Applet
+
+	# Applet signature
+	Signature = {
+		:name => "Hello World",
+		:description => "This is yet another implementation of Hello World",
+		:maintainer => "ged@FaerieMUD.org",
+		:default_action => 'greet',
+	}
+
+	# Define the 'greet' (default) action
+	def greet_action( txn, name=nil )
+		name ||= "world"
+
+		return <<-EOF
+        <html>
+		<head><title>Hello</title></head>
+		<body><p>Hello, #{name}.</p></body>
+        </html>
+	    EOF
+	end
+
+end
+
+
+
+

data/data/arrow/applets/tutorial/hello2.rb

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+# 
+# The HelloWorld class, a derivative of Arrow::Applet. A
+# "hello world" applet.
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+
+require 'arrow/applet'
+
+
+### A "hello world" applet.
+class HelloWorld < Arrow::Applet
+
+
+	# Applet signature
+	Signature = {
+		:name => "Hello World",
+		:description => %{A 'hello world' applet.},
+		:maintainer => "ged@FaerieMUD.org",
+		:default_action => 'templated',
+		:templates => {
+			:templated		=> 'hello-world.tmpl',
+			:printsource	=> 'hello-world-src.tmpl',
+		},
+	}
+
+
+
+	######
+	public
+	######
+
+	def display_action( txn, *args )
+		self.log.debug "In the 'display' action of the '%s' applet." %
+			self.signature.name 
+
+		txn.content_type = "text/plain"
+		return "Hello world."
+	end
+
+
+	def_action :templated do |txn, *args|
+		self.log.debug "In the 'templated' action of the %s applet." %
+			self.signature.name
+			
+		templ = self.load_template( :templated )
+		templ.txn = txn
+		templ.applet = self
+
+		return templ
+	end
+
+
+	def_action :printsource do |txn, *args|
+		self.log.debug "In the 'printsource' action of the %s applet." %
+			self.signature.name
+
+		src = File.read( __FILE__ ).gsub(/\t/, '    ')
+
+		templ = self.load_template( :printsource )
+		templ.txn = txn
+		templ.applet = self
+		templ.source = src
+
+		return templ
+	end
+
+end # class HelloWorld
+
+

data/data/arrow/applets/tutorial/imgtext.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+# 
+# The ImageText class, a derivative of Arrow::Applet. It is
+# an applet which generates an image from one or more characters of text.
+# 
+# == VCS Id
+# 
+# $Id$
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+
+require 'GD'
+require 'arrow/applet'
+
+### It is an applet which generates an image from one or more characters of text.
+class ImageText < Arrow::Applet
+
+
+	# Applet signature
+	Signature = {
+		:name => "imagetext",
+		:description => "Generates an image from one or more characters of text.",
+		:maintainer => "ged@FaerieMUD.org",
+		:default_action => 'form',
+		:templates => {
+			:form	=> 'imgtext.tmpl',
+		},
+		:vargs => {
+		}
+	}
+
+
+
+	######
+	public
+	######
+
+	# PNG-creation action
+	def_action :png do |txn,*rest|
+		text = $1 if /([\x20-\x7e]+)/.match( rest.first )
+		text ||= "No text specified."
+
+		img = make_image( text )
+
+		txn.content_type = 'image/png'
+		return img.pngStr
+	end
+
+	# JPEG-creation action
+	def_action :jpeg do |txn,*rest|
+		text = $1 if /([\x20-\x7e]+)/.match( rest.first )
+		text ||= "No text specified."
+
+		img = make_image( text )
+
+		txn.content_type = 'image/jpeg'
+		return img.jpegStr( -1 )
+	end
+
+
+	#########
+	protected
+	#########
+
+	def make_image( text )
+		# Fetch the font and calculate the image dimensions from the text.
+		font = GD::Font.new( "Medium" )
+		width = font.width * text.length + 10
+		height = font.height + 10
+
+		# Make the image and colors
+		img = GD::Image.newTrueColor( width, height )
+		background= GD::Image.trueColor( 255, 255, 240 )
+		foreground = GD::Image.trueColor( 0, 0, 0 )
+
+		# Fill the image with the background and draw the text and a border with
+		# the foreground color.
+		img.fill( 1, 1, background )
+		img.string( font, 5, 5, text, foreground )
+		img.rectangle( 0,0, width-1, height-1, foreground )
+
+		return img
+	end
+
+end # class ImageText
+
+