nitro 0.20.0 → 0.21.0

data/lib/nitro/runner.rb

@@ -1,348 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'optparse'
-
-require 'glue/misc'
-require 'glue/configuration'
-
-require 'nitro/conf'
-
-module Nitro
-
-# The Runner is a helper class that encapsulates a web 
-# application and is responsible for launching the 
-# application in differnt modes. 
-#
-# The runner provides default parsing of command line
-# and environment parameters. 
-#
-# The default execution modes are:
-#
-# :debug, :stage, :live
-#
-# You can implement your own, custom version of the Runner
-# to run your custom web applications.
-
-class Runner
-
-	# Execution mode = (:debug, :stage, :live) 
-	#
-	# [:debug]
-	#		useful when debugging, extra debug information
-	#		is emmited, actions, templates and shaders are
-	#		reloaded, etc. The execution speed of the application
-	#		is impaired.
-	#
-	# [:stage]
-	#		test the application with live parameters 
-	#		(typically on a staging server).
-	#
-	#	[:live]
-	#		use the parameters for the live (production)
-	#		server. Optimized for speed.
-	#
-	# The default mode is :debug
-
-	attr :mode
-	
-	# :start, :stop, :restart
-
-	attr :action
-	
-	# The server used to run this web application.
-	# :webrick, :nitro, :lhttp, :apache, :mod_apache 
-	#
-	# At the moment only :webrick and :lhttp are available.
-	
-	attr :server
-
-	# Run as daemon.
-
-	attr :daemon
-
-	# Spidering mode. Acceptable values are :crawl, :render
-	# and false.
-
-	attr :spider 
-
-	# Parse the command line arguments and the environment 
-	# parameters to setup the application.
-	
-	def setup
-
-		@mode = :debug
-		@action = :start
-		@server = :webrick
-		@daemon = false
-		@spider = false
-
-		parser = OptionParser.new do |opts|
-
-			opts.banner = 'Usage: run.rb [options]'
-			opts.separator ''
-			opts.separator 'Specific options:'
-
-			opts.on('-s', '--start', 'Start application.') do 
-				@action = :start	
-			end
-
-			opts.on('-S', '--stop', 'Stop application.') do
-				@action = :stop
-			end
-
-			opts.on('-r', '--restart', 'Restart application.') do
-				@action = :restart
-			end
-
-			opts.on('-d', '--daemon', 'Run application as a daemon.') do
-				@daemon = true
-			end
-			
-			opts.on('-D', '--debug', 'Run application in debug mode.') do
-				@mode = :debug
-			end
-
-			opts.on('-T', '--stage', 'Run application in stage mode.') do
-				@mode = :stage
-			end
-
-			opts.on('-L', '--live', 'Run application in live mode.') do
-				@mode = :live
-			end
-
-			opts.on('-w', '--webrick', 'Use a webrick server [default].') do
-				@server = :webrick
-			end
-
-			opts.on('-l', '--lhttpd', 'Use a lighttpd server.') do
-				@server = :lhttpd
-				Logger.set(Logger.new('log/app.log'))
-			end
-
-			opts.on('-a', '--apache', 'Use an apache server.') do
-				@server = :apache
-				Logger.set(Logger.new('log/app.log'))
-			end
-
-			opts.on('--apache-cgi', 'Run as CGI (Apache)') do
-				@server = :cgi
-				Logger.set(Logger.new('log/app.log'))
-			end
-			
-			opts.on('-C', '--console', 'Start a console attached to an instance of the application.') do
-				if RUBY_PLATFORM =~ /mswin32/
-					irb_name = 'irb.bat'
-				else
-					irb_name = 'irb'
-				end
-				ENV['NITRO_INVOKE'] = 'irb'
-				conf_file = File.basename(caller.last.split(':').first)
-#				exec "#{irb_name} -r #{conf_file} -r irb/completion --noinspect"
-				exec "#{irb_name} -r #{conf_file} --noinspect"
-				exit
-			end
-
-			opts.on('--crawl', 'Crawl the application.') do
-				@server = :webrick
-				@spider = :crawl
-			end
-
-			opts.on('--render', 'Crawl the application and render all pages as static html files.') do
-				@server = :webrick
-				@spider = :render
-			end
-
-			opts.on_tail('-v', '--version', 'Show version.') do 
-				puts "Nitro #{Nitro::Version}"
-				exit
-			end
-
-			opts.on_tail('-h', '--help', 'Show this message.') do
-				puts opts
-				exit
-			end
-			
-		end
-
-		parser.parse!(ARGV)
-
-		return self
-	end
-
-	# Run the application in the declared execution mode,
-	# using the passed configuration parameters.
-	
-	def run(conf)
-		if conf.is_a?(Hash)
-			conf = Conf.new(conf)
-		end
-
-		case @mode
-			when :debug
-				setup_debug(conf)
-
-			when :stage
-				setup_stage(conf)
-				
-			when :live
-				setup_live(conf)
-		end
-
-		if 'fcgi_proc' == ENV['NITRO_INVOKE']
-			invoke_fcgi_proc(conf)
-		elsif 'cgi_proc' == ENV['NITRO_INVOKE']
-			invoke_cgi_proc(conf)
-		elsif 'irb' == ENV['NITRO_INVOKE']
-			invoke_irb(conf)
-		else
-			invoke_server(conf)
-		end
-
-	end
-
-	def setup_debug(conf)
-		$DBG = true
-		Rendering.reload = :full
-		require 'glue/autoreload'
-		autoreload(3)
-		Caching.caching_enabled = false
-	end
-
-	def setup_stage(conf)
-		$DBG = false
-		Rendering.reload = false 
-		Logger.set(Logger.new('log/app.log'))
-	end
-
-	def setup_live(conf)
-		$DBG = false
-		Rendering.reload = false 
-		Logger.set(Logger.new('log/app.log'))
-	end
-	alias_method :setup_production, :setup_live
-	
-	def invoke_fcgi_proc(conf)
-		require 'nitro/adapter/fastcgi'
-		FastCGI.start(conf)
-	end
-
-  def invoke_cgi_proc(conf)
-		require 'nitro/adapter/cgi'
-		Cgi.start(conf)
-	end
-
-	def invoke_irb(conf)
-		$conf = conf
-	end
-
-	def invoke_server(conf)
-		spider_thread = nil
-		
-		case @action
-		when :start
-			
-			case @spider
-				when :render
-					spider_thread = Thread.new do
-						sleep(6)
-						`wget -k -m -p #{conf.host}:#{conf.port} -directory-prefix=rendered`
-					end 
-				when :crawl
-					spider_thread = Thread.new do
-						sleep(6)
-						`wget -m --spider #{conf.host}:#{conf.port}`
-					end 
-			end
-
-			puts "\n==> Listening at #{conf.host}:#{conf.port}.\n\n"
-
-			case @server
-				when :webrick
-					require 'nitro/adapter/webrick'
-					Webrick.start(conf)
-
-				when :lhttpd
-					require 'nitro/adapter/fastcgi'
-					`lighttpd -f conf/lhttpd.conf`
-
-				when :apache
-					require 'nitro/adapter/fastcgi'
-					`apachectl -d #{Dir.pwd} -f conf/apache.conf -k start`
-
-				when :cgi
-					require 'nitro/adapter/cgi'
-			end
-		
-		when :stop
-
-			case @server
-			when :webrick
-				
-			when :lhttpd
-
-			when :apache
-				`apachectl -d #{Dir.pwd} -f conf/apache.conf -k stop`
-			end
-
-		end
-	end
-
-	def daemonize
-		require 'daemons/daemonize'
-		pwd = Dir.pwd
-		Daemonize.daemonize(File.join(pwd, 'log/app.log'))
-		# Restore the original pwd (daemonize sets the 
-		# pwd to '/').
-		Dir.chdir(pwd)
-		# Set the logger to a file (daemonize closes the
-		# std streams).
-		Logger.set(Logger.new('log/app.log'))
-	end
-
-	# Helper method.
-
-	def self.run(conf)
-		runner = Runner.new.setup.run(conf)
-	end
-		
-end
-
-# Helper method to start applications.
-#
-# === Example
-#
-# Nitro.run do |conf|
-# 	conf.port = 8080
-# 	conf.template_root = 'root'
-#	end
-#
-# Nitro.run do |conf|
-#		conf.update(
-#			:template_root => root,
-#			:port => 8080
-#		)
-#	end
-
-def self.run(conf = nil)
-	runner = Runner.new.setup
-	runner.daemonize if runner.daemon
-	conf ||= Conf.new({})
-	$nitro_environment = conf
-	yield(conf) if block_given?
-	runner.run(conf)
-end
-
-#--
-# Experimental.
-#++
-
-def self.start(controller)
-#	require 'glue/autoreload'
-#	autoreload(3)
-	Server.run(controller)
-end
-
-end
-
-# * George Moschovitis <gm@navel.gr>
-# * James Britt <james_b@neurogami.com>

data/lib/nitro/shaders.rb

@@ -1,206 +0,0 @@
-require 'nitro/template'
-require 'nitro/element'
-
-module Nitro
-
-# A shader defines a transformation-pipeline that tansforms 
-# the .xhtml files to actual ruby code ready for evaluation 
-# (compilation) by the engine.
-#
-# Shaders employ a folded-filter design.
-#--
-# TODO: pipeline stage mixin to be reused in filters too.
-#++
-
-class Shader
-	
-	# the next stage in the Shader pipeline.
-	
-	attr :next_stage
-	
-	def initialize(next_stage = nil)
-		@next_stage = next_stage
-	end
-	
-	# Process the text and optionally update the hash.
-	# The hash is a short, unique representation of the 
-	# input text, typically used as a caching key.
-	
-	def process(hash, text)
-		process_next(hash, text)
-	end
-
-	# Set the next stage of the pipeline.
-	
-	def << (next_stage = nil)
-		@next_stage = next_stage
-		return self
-	end
-	
-	# Process the next stage of the pipeline.
-	
-	def process_next(hash, text)
-		if @next_stage
-			return @next_stage.process(hash, text)
-		else
-			return hash, text
-		end
-	end	
-end
-
-# Convert the xhtml script to actual Ruby code, ready 
-# to be evaluated.
-
-class RubyShader < Shader
-	include TemplateMixin
-
-	# Convert the xhtml script to actual Ruby code, ready 
-	# to be evaluated.
-	#--
-	# Investigate:
-	# perhaps xl:href should be used to be XLink compatible?
-	#++
-	
-	def process(hash, text)
-		text = compile_template(text) 
-		process_next(hash, text)
-	end
-
-	# Loads and statically includes a file.
-	
-	def load_statically_included(filename)
-		Logger.debug "Statically including '#{filename}'" if $DBG
-		
-		text = File.read(filename)
-		text.gsub!(/<\?xml.*\?>/, '')
-		text.gsub!(/<\/?root(.*?)>/m, ' ');
-		
-		return text
-	end
-	
-end
-
-# Apply an XSL transformation to the script code.
-# There is no need to keep post xsl. I can reuse the 
-# same xsl by calling transform again. 
-
-class XSLTShader < Shader
-	
-	# The name
-	
-	attr :name
-	
-	# The xslt filename.
-	
-	attr :xsl_filename
-	
-	# The xslt transformer.
-	
-	attr :xslt
-	
-	# Last modified time of the xslt.
-	
-	attr :mtime
-	
-	def initialize(xsl_filename, next_stage = nil)
-
-		# leave this require here. only inlcude the xslt 
-		# library if the project needs it.
-		
-		require "xml/xslt"
-
-		@name = File.basename(xsl_filename, '.*')
-		@xsl_filename = xsl_filename
-		@xslt = XML::XSLT.new
-		@next_stage = next_stage
-	end
-	
-	# Transform the given text.
-	
-	def process(hash, text)
-		parse_xsl()
-		@xslt.xml = text
-		hash += @name
-		Logger.debug "Applying xsl '#{@xsl_filename}' to template" if $DBG
-		process_next(hash, xslt.serve)
-	end
-	
-	private 
-	
-	# Parse the xsl.
-	
-	def parse_xsl
-		Logger.debug "Parsing xsl '#{@xsl_filename}'" if $DBG
-		@mtime = File.mtime(@xsl_filename)
-		@xslt.xsl = File.read(@xsl_filename)
-	end
-
-end
-
-# Compress the inline xhtml. Does not touch the ruby code.
- 
-class CompressShader < Shader
-	
-	# Compress the inline xhtml. Does not touch the ruby code.
-	 
-	def process(hash, text)
-		text.gsub!(/\@out \<\< \%\^(.*?)\^/m) do |match|
-			c = $1.gsub(/^(\s*)/m, '').squeeze(" \t").tr("\n", '').tr("\t", ' ')
-			"@out << %{#{c}}"
-		end
-		
-		process_next(hash, text)
-	end
-	
-end
-
-# MorphingShader
-
-class MorphingShader < Shader
-
-	def process(hash, text)
-
-		# <tag if="x">..</tag>
-		# <tag unless="x">..</tag>
-
-		text.gsub!(/<(\w*?)([^>]*?)(if|unless)=["|'](.*?)["|'](.*?)>(.*?)<\/\1>/m) do |match|
-			%{<?r #$3 #$4 ?>
-				<#$1#$2#$5>#$6</#$1>
-			<?r end ?>}
-		end
-
-		# <tag times="x">..</tag>
-
-		text.gsub!(/<(\w*?)([^>]*?)times=["|'](.*?)["|'](.*?)>(.*?)<\/\1>/m) do |match|
-			%{<?r #$3.times do ?>
-				<#$1#$2#$4>#$5</#$1>
-			<?r end ?>}
-		end
-
-		# <tag each="x">..</tag>
-
-		text.gsub!(/<(\w*?)([^>]*?)each=["|'](.*?)["|'](.*?)>(.*?)<\/\1>/m) do |match|
-			%{<?r for #$3 ?>
-				<#$1#$2#$4>#$5</#$1>
-			<?r end ?>}
-		end
-		
-		process_next(hash, text)
-	end
-
-end
-
-# ElementsShader
-
-class ElementsShader < Shader
-
-	def process(hash, text)
-		text = ElementProcessor.render(text)
-		process_next(hash, text)
-	end
-	
-end
-
-end
-
-# * George Moschovitis <gm@navel.gr>