nitro 0.8.0 → 0.9.3

data/lib/nitro/ui/pager.rb

@@ -1,18 +1,14 @@
-# code:
 # * George Moschovitis  <gm@navel.gr>
-#
-# (c) 2004 Navel, all rights reserved.
-# $Id: pager.rb 185 2004-12-10 13:29:09Z gmosx $
+# (c) 2004-2005 Navel, all rights reserved.
+# $Id: pager.rb 223 2005-01-26 17:07:40Z gmosx $
 
 require 'nitro/uri'
 
 module N; module UI
 
-# = Pager
-#
 # Displays a collection of entitities in multiple pages.
 #
-# === Design:
+# === Design
 #
 # The new version is carefully designed for scaleability. It stores 
 # only the items for one page. The name parameter is needed, multiple 
@@ -23,7 +19,7 @@ module N; module UI
 # avoid a concat() in the initialization step. 
 #
 #
-# === Example:
+# === Example
 #
 #	@pager = N::UI::Pager.new('entries', @request, 5)
 #	@entries = N::BlogEntry.all("ORDER BY oid #{@pager.sql_limit}")
@@ -41,21 +37,24 @@ module N; module UI
 #			<td width="64"><x:pager-next>Next</x:pager-next></td>
 #		</tr>
 # </table>
-#
-# === Investigate:
-#
+#--
 # 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
+	
+	# Total count of items
 	attr_accessor :total_count
-	# page items
+	
+	# Page items
 	attr_accessor :page_items
-	# read needed variables from the request.
+	
+	# Read needed variables from the request.
 	attr_accessor :request
 	
 	def initialize(name, request, items_per_page = 10, items = nil)
@@ -95,14 +94,14 @@ class Pager < Array
 	end
 	
 	# Iterator
-	#
+	
 	def each(&block)
 		@page_items.each(&block)
 	end
 	
 	# Iterator
 	# Returns 1-based index.
-	#
+	
 	def each_with_index
 		idx = @start_idx
 		for item in @page_items
@@ -120,7 +119,7 @@ class Pager < Array
 	end
 	
 	# Returns the range of the current page.
-	#
+	
 	def page_range
 		s = @idx
 		e = [@idx + @items_per_page - 1, all_total_count].min
@@ -129,7 +128,7 @@ class Pager < Array
 	end
 	
 	# Override if needed.
-	#
+	
 	def nav_range
 		# effective range = 10 pages.
 		s = [@page - 5, 1].max()
@@ -144,7 +143,7 @@ class Pager < Array
 	# Override this method in your application
 	# if needed.
 	# TODO: better markup.
-	#
+	
 	def navigation
 		nav = ""
 		
@@ -183,7 +182,7 @@ class Pager < Array
 
 	# 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}"
@@ -194,20 +193,18 @@ class Pager < Array
 	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}
-		return N::UriUtils.update_query_string(@request.request_uri.to_s, params)
+		return N::UriUtils.update_query_string(@request.uri.to_s, params)
 	end
 
 end
 
-end; end # module
+end; end 

data/lib/nitro/{sitemap.rb → ui/sitemap.rb}

@@ -1,21 +1,13 @@
-# = SiteMap
-#
-# Encapsulates the page structure and additional metadata.
-#
-# code: 
-# George Moschovitis  <gm@navel.gr>
-#
-# (c) 2004 Navel, all rights reserved.
-# $Id: sitemap.rb 167 2004-11-23 14:03:10Z gmosx $
+# * George Moschovitis  <gm@navel.gr>
+# (c) 2004-2005 Navel, all rights reserved.
+# $Id: sitemap.rb 229 2005-01-27 12:55:29Z gmosx $
 
 require "glue/hash"
 
 module N
 
-# = SitePage
-#
 # A single page in the page map.
-#
+
 class SitePage
 	# the uri for this page
 	attr_accessor :uri

data/lib/nitro/uri.rb

@@ -2,7 +2,7 @@
 # * George Moschovitis  <gm@navel.gr>
 #
 # (c) 2004 Navel, all rights reserved.
-# $Id: uri.rb 167 2004-11-23 14:03:10Z gmosx $
+# $Id: uri.rb 202 2005-01-17 10:44:13Z gmosx $
 
 require "uri"
 require "cgi"

data/lib/nitro/version.rb

@@ -1,13 +1,15 @@
-#--
-# George Moschovitis  <gm@navel.gr>
+# * George Moschovitis  <gm@navel.gr>
 # (c) 2004-2005 Navel, all rights reserved.
-# $Id: version.rb 194 2004-12-20 20:23:57Z gmosx $
-#++
+# $Id: version.rb 247 2005-01-28 16:15:52Z gmosx $
 
-# The name of the server.
+module Nitro
+	
+	# The name of the engine.
 
-$srv_name = 'Nitro'
+	Name = 'Nitro'
 
-# The version of the server.
+	# The version of the server.
 
-$srv_version = '0.8.0'
+	Version = '0.9.3'
+
+end

data/lib/og.rb

@@ -1,18 +1,15 @@
-# code:
 # * George Moschovitis  <gm@navel.gr>
-#
-# (c) 2004 Navel, all rights reserved.
-# $Id: og.rb 197 2004-12-21 13:50:17Z gmosx $
+# (c) 2004-2005 Navel, all rights reserved.
+# $Id: og.rb 248 2005-01-31 13:38:34Z gmosx $
 
 require 'glue/logger'
+require 'glue/attribute'
 require 'glue/property'
 require 'glue/array'
 require 'glue/hash'
 require 'glue/time'
 require 'glue/pool'
 
-# = Og
-#
 # Og (ObjectGraph) is an efficient, yet simple Object-Relational 
 # mapping library. 
 #
@@ -36,7 +33,7 @@ require 'glue/pool'
 # + Works safely as part of distributed application.
 # + Simple implementation.
 #
-# === Meta language
+# == Meta language
 #
 # primary_key :pid (NOT IMPLEMENTED)
 # name_key :name (NOT IMPLEMENTED)
@@ -45,7 +42,7 @@ require 'glue/pool'
 # many_to_many Role, :roles
 # sql_index :pid
 #
-# === Design
+# == Design
 #
 # Keep the main classes backend agnostic. 
 #--
@@ -69,7 +66,7 @@ require 'glue/pool'
 # The og.xxx methods are more flexible and allow you to use
 # multiple databases for example.
 # 
-# === Managed Objects Lifecycle Callbacks
+# == Managed Objects Lifecycle Callbacks
 #
 # * og_pre_insert
 # * og_post_insert
@@ -82,53 +79,58 @@ require 'glue/pool'
 # A class level callback is used for delete because typically you call
 # delete with an oid and not an object to avoid a deserialization.
 #
-# === Future 
+# == Future 
 # 
 # * Support prepared statements (pgsql)
 # * Support stored procedures (pgsql)
 # * Support caching.
 # * Deserialize to OpenStruct.
 # * Better documentation.
-#
+
 class Og
-	class << self
-		# If true, only allow reading from the database. Usefull
-		# for maintainance.
-		attr_accessor :read_only_mode
-
-		# If true, the library automatically 'enchants' managed classes.
-		# In enchant mode, special db aware methods are added to 
-		# managed classes and instances.
-		attr_accessor :enchant_managed_classes
-		
-		# If true, use Ruby's advanced introspection capabilities to 
-		# automatically manage classes tha define properties.
-		attr_accessor :auto_manage_classes
 
-		# If true, automatically include the Og meta-language into Module. 
-		attr_accessor :include_meta_language
-		
-		# Attach the following prefix to all generated SQL table names.
-		# Usefull on hosting scenarios where you have to run multiple
-		# web applications/sites on a single database.
-		attr_accessor :table_prefix
-
-		# The active database. Og allows you to access multiple
-		# databases from a single application.
-		attr_accessor :db
-
-		def use(db)
-			@db = db
-			@db.get_connection
-		end
-	end
+	# If true, only allow reading from the database. Usefull
+	# for maintainance.
+	
+	cattr_accessor :read_only_mode, false
+
+	# If true, the library automatically 'enchants' managed classes.
+	# In enchant mode, special db aware methods are added to 
+	# managed classes and instances.
+	
+	cattr_accessor :enchant_managed_classes, true
+	
+	# If true, use Ruby's advanced introspection capabilities to 
+	# automatically manage classes tha define properties.
+	
+	cattr_accessor :auto_manage_classes, true
+
+	# If true, automatically include the Og meta-language into Module. 
+	#
+	# By default this is FALSE, to avoid polution of the Module object.
+	# However if you include a prop_accessor or a managed Mixin in your
+	# object MetaLanguage gets automatically extended in the class.
+	
+	cattr_accessor :include_meta_language, true
+	
+	# Attach the following prefix to all generated SQL table names.
+	# Usefull on hosting scenarios where you have to run multiple
+	# web applications/sites on a single database.
 	
-	# set default options:
-	self.read_only_mode = false
-	self.enchant_managed_classes = true
-	self.auto_manage_classes = true
-	self.include_meta_language = true
-	self.table_prefix = nil
+	cattr_accessor :table_prefix, nil
+
+	# The active database. Og allows you to access multiple
+	# databases from a single application.
+	
+	cattr_accessor :db
+
+	# Set the active database.
+
+	def self.use(db)
+		@@db = db
+		@@db.get_connection
+	end
+
 end
 
 # gmosx: leave this here.
@@ -137,22 +139,18 @@ require 'og/meta'
 
 class Og
 	
-# = Unmanageable
-#
 # Marker module. If included this in a class, the Og automanager
 # ignores this class.
-#
+
 module Unmanageable; end
 
-# = Database
-#
 # Encapsulates an Og Database.
-#
+
 class Database
 	include Og::Enchant
 
 	# Managed class metadata
-	#
+	
 	class ManagedClassMeta
 		# The managed class.
 		attr_accessor :klass
@@ -167,16 +165,19 @@ class Database
 	end
 
 	# hash of configuration options.
+
 	attr_accessor :config
 
 	# Pool of connections to the backend.
+	
 	attr_accessor :connection_pool
 
 	# Managed classes.
+	
 	attr_accessor :managed_classes
 
 	# Initialize the database interface.
-	#
+	
 	def initialize(config)
 		@config = config
 
@@ -199,7 +200,7 @@ class Database
 	
 		# gmosx, FIXME: this automanage code is not elegant and slow
 		# should probably recode this, along with glue/property.rb
-		#
+		
 		if Og.auto_manage_classes
 			# automatically manage classes with properties and metadata.
 			# gmosx: Any idea how to optimize this?
@@ -219,7 +220,7 @@ class Database
 	end
 		
 	# Shutdown the database interface.
-	#
+	
 	def shutdown
 		for con in @connection_pool
 			con.close()
@@ -229,7 +230,7 @@ class Database
 
 	# Get a connection from the pool to access the database.
 	# Stores the connection in a thread-local variable.
-	#
+
 	def get_connection
 		thread = Thread.current
 		
@@ -243,7 +244,7 @@ class Database
 	alias_method :connection, :get_connection
 	
 	# Restore an unused connection to the pool.
-	#
+	
 	def put_connection
 		thread = Thread.current
 		
@@ -254,7 +255,7 @@ class Database
 	end	
 	
 	# Utility method, automatically restores a connection to the pool.
-	#
+	
 	def connect(deserialize = nil, &block)
 		result = nil
 		
@@ -275,7 +276,7 @@ class Database
 	
 	
 	# Register a standard Ruby class as managed.
-	#
+	
 	def manage(klass)
 		return if managed?(klass) or klass.ancestors.include?(Og::Unmanageable)
 		
@@ -289,7 +290,7 @@ class Database
 	end
 	
 	# Helper method to set multiple managed classes.
-	#
+	
 	def manage_classes(*klasses)
 		for klass in klasses
 			manage(klass)
@@ -297,7 +298,7 @@ class Database
 	end
 	
 	# Stop managing a Ruby class
-	#
+	
 	def unmanage(klass)
 		@managed_classes.delete(klass)
 	end
@@ -309,7 +310,7 @@ class Database
 	end
 	
 	# Add standard og functionality to the class
-	#
+	
 	def convert(klass)
 		# Grab backend class
 		backend = @config[:backend]
@@ -393,4 +394,4 @@ class Database
 	end
 end
 
-end # namespace
+end