nitro 0.19.0 → 0.20.0

data/lib/nitro/{ui → mixin}/pager.rb

@@ -1,78 +1,58 @@
-# * George Moschovitis  <gm@navel.gr>
-# (c) 2004-2005 Navel, all rights reserved.
-# $Id: pager.rb 1 2005-04-11 11:04:30Z gmosx $
+require 'glue/uri'
+require 'glue/configuration'
 
-require 'nitro/uri'
-
-module Nitro; module UI
+module Nitro
 
 # Displays a collection of entitities in multiple pages.
 #
 # === Design
 #
-# The new version is carefully designed for scaleability. It stores 
+# This pager is carefully designed for scaleability. It stores 
 # only the items for one page. The name parameter is needed, multiple 
 # pagers can coexist in a single page. Unlike older pagers this 
-# pager leverages the SQL LIMIT option to optimize database interaction.
-#
-# === Example
-#
-#	@pager = UI::Pager.new('entries', @request, 5)
-#	@entries = BlogEntry.all("ORDER BY oid #{@pager.sql_limit}")
-#	@pager.set(BlogEntry.count)
-#
-# default navigation (customize with css):
-#	<div class="pager">#{@pager.navigation}</div>
-#
-# custom navigation:
-#
-# <table cellspacing="0" width="100%" border="1">
-#		<tr>
-#			<td width="64"><x:pager-prev>Previous</x:pager-prev></td>
-#			<td width="100%"></td>
-#			<td width="64"><x:pager-next>Next</x:pager-next></td>
-#		</tr>
-# </table>
-#--
-# INVESTIGATE:
-# mysql> SELECT SQL_CALC_FOUND_ROWS * FROM tbl_name
-#    -> WHERE id > 100 LIMIT 10;
-#	mysql> SELECT FOUND_ROWS();
-#++
-
-class Pager < Array
-	
-	attr_accessor :name, :idx, :page, :page_count 
-	
-	# Total count of items
-	attr_accessor :total_count
+# pager leverages the SQL LIMIT option to optimize database 
+# interaction.
+
+class Pager
+	# Items per page.
 	
-	# Page items
-	attr_accessor :page_items
+	setting :per_page, :default => 10, :doc => 'Items per page'	
 	
-	# Read needed variables from the request.
-	attr_accessor :request
+	# The request key.
 	
-	def initialize(name, request, items_per_page = 10, items = nil)
-		raise "items_per_page should be > 0" unless items_per_page > 0
+	setting :key, :default => '_page', :doc => 'The request key'
+
+	# The current page.
+	
+	attr_accessor :page
+
+	# Items per page.
+	
+	attr_accessor :per_page 
 	
-		@request, @name = request, name
-		@page = request.query.fetch("__pg#{@name}", 1).to_i
-		@items_per_page = items_per_page
-		@start_idx = (@page - 1) * items_per_page
+	# The total number of pages.
+	
+	attr_accessor :page_count 
+	
+	# Total count of items.
+	
+	attr_accessor :total_count
 		
-		if items
-			set(items.size())			
-			# gmosx, FIXME: not exactly what i want!
-			items.slice!(@start_idx, @items_per_page)
-		end
-	end
+	def initialize(request, per_page, total_count, key = Pager.key)
+		raise 'per_page should be > 0' unless per_page > 0
 	
-	def set(total_count)
+		@request, @key = request, key
+		@page = request.query.fetch(key, 1).to_i
+		@per_page = per_page
+		set_count(total_count)
+		@start_idx = (@page - 1) * per_page		
+	end
+
+	def set_count(total_count)
 		@total_count = total_count
-		@page_count = (@total_count.to_f() / @items_per_page).ceil()
+		@page_count = (@total_count.to_f / @per_page).ceil
 	end
-	
+
 	def first_page
 		return 1
 	end
@@ -135,10 +115,33 @@ class Pager < Array
 		
 		return (s..e)
 	end
+
+	# To be used with Og queries.
+		
+	def limit
+		{ :limit => @per_page, :offset => @start_idx }
+	end
+
+	def offset 
+		@start_idx
+	end
+
+	# Create an appropriate SQL limit clause.
+	# Returns postgres/mysql compatible limit.
 	
-	# Override this method in your application
-	# if needed.
+	def to_sql
+		if @start_idx > 0
+			return "LIMIT #{@per_page} OFFSET #{@start_idx}"
+		else
+			# gmosx: perhaps this is optimized ? naaaaaah...
+			return "LIMIT #{@per_page}"
+		end
+	end	
+
+	# Override this method in your application if needed.
+	#--
 	# TODO: better markup.
+	#++
 	
 	def navigation
 		nav = ""
@@ -175,32 +178,57 @@ class Pager < Array
 		
 		return nav
 	end
+	alias_method :links, :navigation
+
+private
 
-	# Create an appropriate SQL limit clause.
-	# Returns postgres/mysql compatible limit.
-	
-	def sql_limit
-		if @start_idx > 0
-			return "LIMIT #{@items_per_page} OFFSET #{@start_idx}"
-		else
-			# gmosx: perhaps this is optimized ? naaaaaah...
-			return "LIMIT #{@items_per_page}"
-		end
-	end
-	
-	# Returns the current offset. The offset is zero-based.
-	
-	def offset
-		(@page-1) * @items_per_page
-	end
-	
 	# Generate the target URI.
-	# 
+	 
 	def target_uri(page)
-		params = {"__pg#{@name}" => page}
+		params = { @key => page }
 		return UriUtils.update_query_string(@request.uri.to_s, params)
 	end
 
 end
 
-end; end 
+# Pager related helper methods.
+
+module PagerMixin
+
+private
+	
+	# Helper method that generates a collection of items and the
+	# asorted pager object.
+	#
+	# === Example
+	#
+	# entries, pager = paginate(Article, :condition => 'title LIKE %Ab%', :per_page => 10)
+	# 
+	# <ul>
+	# <?r for entry in entries ?>
+	#		<li>#{entry.to_link}</li>
+	# <?r end ?>
+	#	</ul>
+	#	#{pager.links}
+	
+	def paginate(klass_or_array, options = {})
+		per_page = options.delete(:per_page) || Pager.per_page
+		
+		if klass_or_array.is_a? Array
+			items = klass_or_array.dup
+			pager = Pager.new(request, per_page, items.size, key = Pager.key)
+			items = items.slice(pager.offset, pager.per_page)
+			return items, pager			
+		else
+			pager = Pager.new(request, per_page, klass_or_array.count(options), key = Pager.key)
+			options.update(pager.limit)
+			items = klass_or_array.all(options)
+			return items, pager
+		end
+	end
+	
+end
+
+end
+
+# * George Moschovitis <gm@navel.gr>

data/lib/nitro/render.rb

@@ -1,8 +1,11 @@
 require 'sync'
 
+require 'facet/string/blank%3F'
+
 require 'glue/attribute'
 require 'glue/misc'
 require 'glue/object'
+require 'glue/settings'
 
 require 'nitro/shaders'
 require 'nitro/buffering'
@@ -27,12 +30,12 @@ module Rendering
 	@@sync = Sync.new
 
 	# The default template root
-	
-	mattr_accessor :default_template_root, 'public'
-	
+
+	setting :default_template_root, :default => 'public', :doc => 'The default template root'
+		
 	# The default template name (no extension).
 
-	mattr_accessor :default_template, 'index'
+	setting :default_template, :default => 'index', :doc => 'The default template name (no extension).'
 
 	# The shader used for transforming templates.
 	# The default shader is very simple, here is a 
@@ -48,11 +51,12 @@ module Rendering
 	# </tt>
 
 	mattr_accessor :shader; @@shader = RubyShader.new
+#	setting :shader, :default => RubyShader.new, :doc => 'The shader used for transforming templates'
 
 	# If set to :full, reloads all controllers. Useful in 
 	# development.
 
-	mattr_accessor :reload, false
+	setting :reload, :default => false, :doc => 'If set to :full reloads everything, useful in development'
 	
 	# Given the action try find the matching template.
 	# Can search for xhtml or xml templates.
@@ -133,15 +137,17 @@ module Rendering
 
 				param_count = klass.instance_method(action.intern).arity 
 				
+				# gmosx, FIXME: REIMPLEMENT THIS!!!!
+				
 				if param_count > 0
 					code << %{
+						params = []
 						qs = context.query_string.split(/[&;]/)
 						
-						params = []
 						#{param_count}.times do |i|
 							params << qs.shift.split(/=/).last
 						end
-
+						
 						unless :stop == #{action}(*params)
 					}
 				else
@@ -272,7 +278,11 @@ module Render
 	# The name of the currently executing action.
 
 	attr_accessor :action_name
-
+	
+	# The name of the current controller.
+	
+	attr_accessor :controller_name
+	
 	# Initialize the render.
 	#
 	# [+context+]
@@ -280,6 +290,7 @@ module Render
 
 	def initialize(context, base = nil)
 		@request = @response = @context = context
+		@controller_name = base
 		@out = context.out
 	end
 
@@ -324,6 +335,7 @@ private
 	def redirect(url, status = 303)
 		url = url.to_s
   	url = "#{@context.host_url}/#{url.gsub(/^\//, '')}" unless url =~ /http/
+
 		@context.status = status
 		@context.out = "<html><a href=\"#{url}\">#{url}</a>.</html>\n"
 		@context.response_headers['location'] = url

data/lib/nitro/request.rb

@@ -152,6 +152,12 @@ module Request
 	def []=(param, value)
 		@params[param] = value
 	end
+	
+	# Fetch a parameter with default value.
+	
+	def fetch(param, default = nil)
+		@params.fetch(param, default)
+	end
 end
 
 end

data/lib/nitro/routing.rb

@@ -1,10 +1,8 @@
-# * George Moschovitis  <gm@navel.gr>
-# (c) 2004-2005 Navel, all rights reserved.
-# $Id: routing.rb 1 2005-04-11 11:04:30Z gmosx $
-
 module Nitro
 
-# Router mixin.
+# Router mixin. Typically used to generate 'nice' urls.
+# Nice urls are considered (?) more Search Engine 
+# friendly.
 	
 module Router
 	
@@ -31,3 +29,6 @@ module Router
 end
 
 end
+
+# * George Moschovitis  <gm@navel.gr>
+

data/lib/nitro/runner.rb

@@ -3,6 +3,8 @@
 require 'optparse'
 
 require 'glue/misc'
+require 'glue/configuration'
+
 require 'nitro/conf'
 
 module Nitro
@@ -135,7 +137,8 @@ class Runner
 				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} -r irb/completion --noinspect"
+				exec "#{irb_name} -r #{conf_file} --noinspect"
 				exit
 			end
 
@@ -170,20 +173,19 @@ class Runner
 	# 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 :debug
+				setup_debug(conf)
 
-		when :stage
-			setup_stage(conf)
-			
-		when :live
-			setup_live(conf)
+			when :stage
+				setup_stage(conf)
+				
+			when :live
+				setup_live(conf)
 		end
 
 		if 'fcgi_proc' == ENV['NITRO_INVOKE']
@@ -330,6 +332,16 @@ def self.run(conf = nil)
 	runner.run(conf)
 end
 
+#--
+# Experimental.
+#++
+
+def self.start(controller)
+#	require 'glue/autoreload'
+#	autoreload(3)
+	Server.run(controller)
+end
+
 end
 
 # * George Moschovitis <gm@navel.gr>

data/lib/nitro/server.rb

@@ -0,0 +1,95 @@
+require 'glue/autoreload'
+require 'nitro/adapter/webrick'
+
+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
+	
+end
+
+end
+
+# Alias for the Server class.
+
+App = Nitro::Server unless Object.const_defined?(:App)
+
+# * George Moschovitis <gm@navel.gr>