nitro 0.20.0 → 0.21.0

data/lib/nitro/server.rb

@@ -1,89 +1,126 @@
 require 'glue/autoreload'
-require 'nitro/adapter/webrick'
+
+require 'nitro/server/runner'
 
 module Nitro
 
 class Server
 
-	# :nodoc: all
-	# A Helper class used for CherryPy-style publishing.
-	
-	class Mounter 
-		def initialize(parent, base = '')
-			@parent, @base = parent, base
-		end
-		
-		def method_missing(sym, *args)
-			sym = sym.to_s
-			if sym =~ /=$/
-				@parent.map["#@base/#{sym.gsub(/=/, '')}"] = args.first
-			else
-				Mounter.new(@parent, "#@base/#{sym}")
-			end
-		end
-	end
-	
-	# The server listening address. 
-	#--
-	# 0.0.0.0 may be a better default?
-	#++
-
-	setting :address, :default => '127.0.0.1', :doc => 'The server listening address'
-
-	# The server listening port.
-
-	setting :port, :default => 9999, :doc => 'The server listening port'
-
-	# The map.
-	
-	setting :map, :default => { '/' => SimpleController }, :doc => 'The server map'
-
-	# The name of the application.
-
-	attr_accessor :name
-	
-	# The sitemap. Defines how controller objects are published.
-	
-	attr_accessor :map
-
-	def initialize(name = 'Nitro')
-		@name = name
-		@map = self.class.map.dup
-	end
-	
-	# Start the server.
-	
-	def start(controller = nil)		
-		self.map['/'] = controller if controller
-		
-		$DBG = true
-		autoreload(3)
-		Rendering.reload = :full
-		
-		dispatcher = Dispatcher.new
-		dispatcher.publish(self.map)
-		conf = {
-			:dispatcher => dispatcher
-		}
-		
-		Webrick.start(Conf.new(conf))		
-	end
-
-	def root=(controller)
-		@map['/'] = controller
-	end
-	
-	def root
-		Mounter.new(self)
-	end
-
-	# Helper method.
-	
-	def self.run(controller = nil)
-		server = Server.new
-		server.start(controller)
-	end
-	
+  # The server listening address. 
+  #--
+  # 0.0.0.0 may be a better default?
+  #++
+
+  setting :address, :default => '127.0.0.1', :doc => 'The server listening address'
+
+  # The server listening port.
+
+  setting :port, :default => 9999, :doc => 'The server listening port'
+
+  # The map.
+  
+  setting :map, :default => { '/' => SimpleController }, :doc => 'The server map'
+
+  # The public files root directory.
+  
+  setting :public_root, :default => 'public', :doc => 'The public files root directory'
+
+  # The access log, can be a path to a file or an IO object.
+  
+  setting :access_log, :default => nil, :doc => 'The access log'
+
+  # The name of the application.
+
+  attr_accessor :name
+  
+  # The sitemap. Defines how controller objects are published.
+  
+  attr_accessor :map
+
+  # The public files root directory.
+  
+  attr_accessor :public_root
+
+  # The server listening address. 
+
+  attr_accessor :address
+
+  # The server listening port.
+
+  attr_accessor :port
+
+  # The dispatcher
+  
+  attr_accessor :dispatcher
+
+  # Additional server options. Useful to pass options to 
+  # Webrick for example.
+  
+  attr_accessor :options
+      
+  def initialize(name = 'Nitro', options = {})
+    @name = name
+    @map = self.class.map.dup
+    @address, @port = self.class.address, self.class.port
+    @public_root = self.class.public_root
+    @access_log = self.class.access_log
+    @options = options
+  end
+  
+  # Return the dispatcher.
+  
+  def dispatcher
+    unless @dispatcher
+      @dispatcher = Dispatcher.new(self.map)
+    end
+    @dispatcher
+  end
+  
+  # Start the server.
+  
+  def start(controller = nil)    
+    @map['/'] = controller if controller
+    @dispatcher = Dispatcher.new(@map)
+  end
+
+  def root=(controller)
+    @map['/'] = controller
+  end
+  
+  def root
+    Mounter.new(self)
+  end
+
+  # Helper method.
+  
+  def self.run(controller = nil)
+    runner = Runner.new
+    runner.setup_options
+    runner.setup_mode
+    runner.daemonize if runner.daemon  
+    server = Server.new
+    server.start(controller)
+    runner.invoke(server)        
+  end
+
+  # A Helper class used for CherryPy-style publishing.
+  
+  class Mounter # :nodoc: all
+    def initialize(parent, base = '')
+      @parent, @base = parent, base
+    end
+    
+    def method_missing(sym, *args)
+      sym = sym.to_s
+      if sym =~ /=$/
+        @parent.map["#@base/#{sym.gsub(/=/, '')}"] = args.first
+      else
+        Mounter.new(@parent, "#@base/#{sym}")
+      end
+    end
+  end
+  
+  
 end
 
 end

data/lib/nitro/server/runner.rb

@@ -0,0 +1,341 @@
+require 'optparse'
+
+require 'glue/misc'
+require 'glue/configuration'
+
+module Nitro
+
+# The Runner is a helper class that encapsulates a web 
+# application and is responsible for launching the 
+# application in different 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
+
+  # ...
+  
+  setting :adapter, :default => :webrick, :doc => 'The web adapter'
+  
+  # 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_accessor :mode
+  
+  # :start, :stop, :restart
+
+  attr_accessor :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_accessor :server
+
+  # Run as daemon.
+
+  attr_accessor :daemon
+
+  # Spidering mode. Acceptable values are :crawl, :render
+  # and false.
+
+  attr_accessor :spider 
+
+  # Parse the command line arguments and the environment 
+  # parameters to setup the application.
+  
+  def setup_options
+    @mode ||= :debug
+    @action ||= :start
+    @server ||= :webrick
+    @daemon = false
+    @spider = false
+
+    # Setup from environment
+
+    @mode = ENV.fetch('NITRO_MODE', 'debug').to_sym
+
+    # Setup from command line arguments.
+    
+    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"
+        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
+
+  # Setup the declared execution mode,
+  # using the passed configuration parameters.
+  
+  def setup_mode
+    case @mode
+      when :debug
+        setup_debug
+
+      when :stage
+        setup_stage
+        
+      when :live
+        setup_live
+    end
+  end
+
+  # Setup in debug mode.
+  
+  def setup_debug
+    $DBG = true
+    Compiler.reload = true
+    require 'glue/autoreload'
+    autoreload(3)
+    Caching.caching_enabled = false
+    
+    load_external_configuration(:debug)
+  end
+
+  def setup_stage
+    $DBG = false
+    Compiler.reload = true
+    Logger.set(Logger.new('log/app.log'))
+    
+    load_external_configuration(:stage)    
+  end
+
+  def setup_live
+    $DBG = false
+    Compiler.reload = false 
+    Logger.set(Logger.new('log/app.log'))
+    
+    load_external_configuration(:live)        
+    load_external_configuration(:production)        
+  end
+  alias_method :setup_production, :setup_live
+
+  # ...
+  
+  def invoke(server)
+    if 'fcgi_proc' == ENV['NITRO_INVOKE']
+      require 'nitro/adapter/fastcgi'
+      FastCGI.start(server)
+      
+    elsif 'cgi_proc' == ENV['NITRO_INVOKE']
+      require 'nitro/adapter/cgi'
+      Cgi.start(server)
+      
+    elsif 'irb' == ENV['NITRO_INVOKE']
+      $server = server
+      
+    else
+      invoke_server(server)
+    end
+  end
+  
+  # ...
+  
+  def invoke_server(server)
+    spider_thread = nil
+    
+    case @action
+    when :start
+      
+      case @spider
+        when :render
+          spider_thread = Thread.new do
+            sleep(6)
+            `wget -k -m -p #{server.address}:#{server.port} -directory-prefix=rendered`
+          end 
+        when :crawl
+          spider_thread = Thread.new do
+            sleep(6)
+            `wget -m --spider #{server.host}:#{server.port}`
+          end 
+      end
+
+      @server ||= Runner.adapter
+
+      puts "\n==> Listening at #{server.address}:#{server.port}. (#{@mode} mode)\n\n"
+
+      case @server
+        when :webrick
+          require 'nitro/adapter/webrick'
+          Webrick.start(server)
+
+        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
+
+  # :section: Utilities
+  
+  # Run this proccess as a daemon (UNIX only).
+  
+  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
+
+  # Attempt to load external configuration in Ruby or
+  # YAML format. The files:
+  #
+  #  * conf/mode.rb
+  # * conf/mode.yaml
+  #
+  # are considered.
+  
+  def load_external_configuration(mode = :debug)
+    begin
+      # gmosx: Workaround for an RDoc bug.
+      # require "conf/#{mode}.rb"
+      eval %|require 'conf/#{mode}.rb'|
+    rescue Object
+    end
+
+    # Try to configure from a yaml file.
+    begin
+      Configuration.load "conf/#{mode}.yml"
+    rescue Object => ex
+    end
+  end
+
+end
+
+end
+
+# * George Moschovitis <gm@navel.gr>
+# * James Britt <james_b@neurogami.com>