nitro 0.18.1 → 0.19.0

data/CHANGELOG

@@ -1,4 +1,46 @@
-01-06-2005  George Moschovitis  <gm@navel.gr>
+17-06-2005  George Moschovitis <gm@navel.gr>
+
+	* README: updated.
+	
+	* doc/RELEASES: updated.
+	
+	* lib/nitro/dispatcher.rb (#controller_for_class): added 
+	SUPERB new support for reloading!!! I LOVE IT!
+	
+	* lib/nitro/runner.rb (#setup_debug): call autoreload by default,
+	dissable caching in debug mode.
+	
+	* lib/nitro/caching/*: small fixes.
+
+	* lib/nitro/caching.rb (#caching_enabled): introduced.
+
+16-06-2005  George Moschovitis <gm@navel.gr>
+
+	* doc/RELEASES: updated.
+
+15-06-2005  George Moschovitis <gm@navel.gr>
+
+	* test/nitro/tc_controller.rb: fixed to pass again.
+	
+	* lib/nitro/flash.rb (#flash): made private.
+
+08-06-2005  George Moschovitis <gm@navel.gr>
+
+	* lib/nitro/testing/testcase.rb: Og related fix.
+	
+	* lib/nitro/controller.rb: include flashing by default.
+	
+	* lib/nitro/flash.rb: introduced and implemented,
+	added aspects,
+	(#set_dirty): fixed flag.
+
+02-06-2005  George Moschovitis <gm@navel.gr>
+
+	* lib/nitro/element.rb: fixed a bug with capitalize.
+
+01-06-2005  George Moschovitis <gm@navel.gr>
+
+	* --- VERSION 0.18.0 ---
 
 	* test/*: some fixes to make the tests pass again.
 	

data/README

@@ -1,4 +1,4 @@
-= Nitro 0.17.0 README
+= Nitro 0.19.0 README
 
 Nitro is an efficient, yet simple engine for developing professional Web 
 Applications using the Ruby language. Nitro aims to provide a robust 
@@ -255,10 +255,16 @@ The latest version of Nitro can be found at
 
 * http://nitro.rubyforge.org
 
+== Documentation
+
 Documentation for Nitro can be found at
 
 * http://nitro.rubyforge.org
 
+Don't forget to read the file doc/RELEASES for usefull
+documentation bits. Also, have a look at the test cases in
+the test directory for examples of usage.
+
 
 == Requirements
 

data/doc/AUTHORS

@@ -9,6 +9,9 @@ IDEAS, ADDITIONAL CODING, SUPPORT:
 * Anastasios Koutoumanos <ak@navel.gr>
 	Design, additional coding.
 
+* Dan Yoder <dan@zeraweb.com>
+	Original 'Elements' implementation, bug reports.
+
 * James Britt <james_b@neurogami.com>
 	Additional code, design, bug reports.
 

data/doc/RELEASES

@@ -1,4 +1,155 @@
-== Version 0.18.0
+== Version 0.19.0
+
+Og reloaded part 2: Another superb release introducing a balanced 
+mix of innovative new features, common but useful stuff and bug 
+fixes. 
+
+Some notable changes:
+
+* Og polymorphic relations. A groundbreaking feature made possible
+	by Og's unique design and Ruby's power. Let's use an example 
+	to explain the concept:
+	
+	class Comment
+		...
+		belongs_to Object # polymorphic marker
+	end
+	
+	class User
+		...
+		has_many Comment
+	end
+	
+	class Article
+		...
+		has_many Comment
+	end
+	
+	u = User.new
+	u.comments << User::Comment('Hello')
+	
+	a = Article.new
+	a.comments << Article::Comment('Wow!')
+	
+	User::Comment and Article::Comment where automatically created
+	by Og and are serialized in different tables (also automatically
+	created by Og). This is the	next step in DRY!
+
+* Og now supports inheritance using the well known Single Table
+	Inheritance pattern. Thanks to Og's advanced design the pattern
+	is fully encapsulated:
+	
+	class Document
+		...
+		schema_inheritance
+	end
+	
+	class Article < Document
+		..
+	end
+	
+	class Photo < Document
+		..
+	end
+	
+	Document.all # => includes Articles and Photos
+	Article.all # => only Articles
+	
+	User.documents # => Articles and Photos
+	User.documents(:type => Photo) # => only photos.
+
+	Btw, this feature is orthogonal to the polymorphic relations
+	feature just described, giving the developer great 
+	flexibility.
+
+* Added SUPERB support for auto reloading, the new system 
+	can detect source changes everywhere! Based on original
+	code by Michael Neumann.
+		
+* Introduced the concept of Flash, a temporal store where
+	objects that should be kept alive for the next request are
+	saved.
+
+* Recoded the Blog example to use the Elements system for 
+	shading instead of XSLT. The new code runs easier under Windows
+	(so the no_xsl_blog example is now removed). Here comes an 
+	example:
+	
+	<Page>
+		<Box>
+			Please login as an author by entering the blog password.
+			<br />
+			The password is: <b>#{Blog.password}</b>.
+		</Box>
+		
+		<Error>#@error</Error>
+		...
+	</Page>
+
+	The <Page> tag is supported by the Page Ruby class to do the
+	programmatic rendering of templates or logic code:
+	
+	class Page
+		def render
+			...
+		end
+	end
+
+	This system can be used to create a library of useful 
+	components to abstract common tasks.
+	
+* The updated Blog example demonstrates how easy it is to write
+	webservices using Nitro and the experimental Service feature.
+	The code is so short, so lets paste it here:
+	
+	module BloggerApi
+		SBlog = Struct.new(:url, :blogid, :blogName)
+
+		def blogger__getUsersBlogs(appkey, username, password)
+			Blog.all.collect { |b| SBlog.new('http://www.gmosx.com', b.oid, b.title) }		
+		end
+	end
+
+	module MetaWeblogApi
+		def metaWeblog__newPost(blogid, username, password, content, publish)
+			entry = BlogEntry.new(content['title'], content['description'])
+			entry.blog = Blog[blogid]
+			entry.save
+			entry.oid
+		end	
+	end
+
+	module MovableTypeApi
+		SCategory = Struct.new(:categoryId, :categoryName)
+
+		def mt__getCategoryList(blogid, username, password)
+			blog = Blog[blogid]
+			blog.categories.collect { |c| SCategory.new(c.oid, c.title) }
+		end
+
+		def mt__setPostCategories(postid, username, password, categories)
+			cid = categories.first['categoryId']
+			BlogEntry.update(postid, "category_oid=#{cid}")
+			true
+		end
+	end
+	
+	class ApiController < Nitro::XmlRpcService
+		include BloggerApi
+		include MovableTypeApi
+		include MetaWeblogApi
+	end
+
+	That's all!
+	
+* Integrated an SQLite3 patch by Ghislain Mary.
+
+* Integrated PostgreSQL binary data patch by Michael Neumann.
+
+* Fixed all reported bugs.
+
+
+== Version 0.18.0 was released on 01/06/2005. 
 
 Mainly a bug fix release. Many small improvements were 
 implemented. All reported bugs were fixed, as well as bugs found 
@@ -47,7 +198,7 @@ Some notable changes:
 * Cleaned up some source files.
 
 
-== Version 0.17.0  was released on 16/05/2005. 
+== Version 0.17.0 was released on 16/05/2005. 
 
 The biggest release yet, featuring the brand new implementation
 of Og. Due to the many changes this should be considered a preview

data/lib/nitro.rb

@@ -25,7 +25,7 @@ module Nitro
 	
 	# The version.
 
-	Version = '0.18.1'
+	Version = '0.19.0'
 
 	# Library path.
 

data/lib/nitro/caching.rb

@@ -23,6 +23,12 @@ module Caching
 			cattr_accessor :caching_enabled, true
 		end
 	end
+	
+private 
+
+	def caching_enabled?
+		Caching.caching_enabled and self.class.caching_enabled
+	end
 
 end
 

data/lib/nitro/caching/actions.rb

@@ -1,7 +1,3 @@
-# * George Moschovitis  <gm@navel.gr>
-# (c) 2004-2005 Navel, all rights reserved.
-# $Id: actions.rb 1 2005-04-11 11:04:30Z gmosx $
-
 require 'fileutils'
 
 module Nitro
@@ -22,7 +18,7 @@ module Caching
 		module ClassMethods
 
 			def cache_action(*actions)
-				return unless caching_enabled
+				return unless caching_enabled?
 				
 				before_filter(
 					%{
@@ -53,7 +49,7 @@ module Caching
 		#++
 		
 		def expire_action(*actions)
-			return unless caching_enabled
+			return unless caching_enabled?
 
 			for action in [actions].flatten
 				expire_fragment(action)
@@ -65,3 +61,5 @@ module Caching
 end
 
 end
+
+# * George Moschovitis  <gm@navel.gr>

data/lib/nitro/caching/fragments.rb

@@ -1,7 +1,3 @@
-# * George Moschovitis  <gm@navel.gr>
-# (c) 2004-2005 Navel, all rights reserved.
-# $Id: fragments.rb 1 2005-04-11 11:04:30Z gmosx $
-
 require 'fileutils'
 
 require 'glue/attribute'
@@ -48,7 +44,7 @@ module Caching
 		end
 
 		def cache_fragment(block, name, options = {})
-			unless caching_enabled
+			unless caching_enabled?
 				block.call
 				return
 			end
@@ -70,3 +66,5 @@ module Caching
 end
 
 end
+
+# * George Moschovitis  <gm@navel.gr>

data/lib/nitro/caching/output.rb

@@ -30,7 +30,7 @@ module Caching
 			# Enable output caching for the given actions.
 
 			def cache_output(*actions)
-				return unless (caching_enabled and Caching.caching_enabled)
+				return unless caching_enabled?
 
 				str = actions.collect { |a| ":#{a}" }.join(', ')
 
@@ -53,7 +53,7 @@ module Caching
 		private
 
 		def do_cache_output
-			if caching_enabled and Caching.caching_enabled and caching_allowed?
+			if caching_enabled? and caching_allowed?
 				self.class.do_cache_output(@request.uri, @out)
 			end
 		end

data/lib/nitro/conf.rb

@@ -1,7 +1,3 @@
-# * George Moschovitis  <gm@navel.gr>
-# (c) 2004-2005 Navel, all rights reserved.
-# $Id: conf.rb 1 2005-04-11 11:04:30Z gmosx $
-
 require 'glue/flexob'
 
 require 'nitro/dispatcher'
@@ -41,3 +37,5 @@ class Conf < Flexob
 end
 
 end
+
+# * George Moschovitis <gm@navel.gr>

data/lib/nitro/controller.rb

@@ -4,6 +4,7 @@ require 'nitro'
 require 'nitro/render'
 require 'nitro/scaffold'
 require 'nitro/caching'
+require 'nitro/flash'
 
 module Nitro
 
@@ -78,6 +79,7 @@ class Controller
 	include Glue::Aspects
 	include Scaffolding
 	include Caching
+	include Flashing
 
 	# A hash containing metadata for the action
 	# methods.

data/lib/nitro/dispatcher.rb

@@ -140,44 +140,17 @@ class Dispatcher
 
 	# Get the controller for the given key.
 	# Also handles reloading of controllers.
-	#--
-	# gmosx, FIXME: this method is a NASTY hack, anyone can 
-	# help me fix this ?
-	#++
 
 	def controller_class_for(key, context)
 		klass = @controllers[key]
 
-		if (:full == Rendering.reload) and context and context[:__RELOADED__].nil? and klass
-#=begin	
-			ancestors = [c = klass]
-			while (c = c.superclass) != Nitro::Controller
-				ancestors.unshift(c)
+		if klass and (:full == Rendering.reload)
+			klass.instance_methods.grep(/(action$)|(template$)/).each do |m|
+				klass.send(:remove_method, m) rescue nil
 			end
-
-			for c in ancestors
-				actions = c.public_instance_methods.find_all { |m| m.to_s =~ /(_action$)|(_template$)/ }
-				actions += c.action_methods
-				actions.each { |m| c.send(:remove_method, m) rescue nil }
-				c.advices = []
-				
-				Object.send(:remove_const, c) rescue nil
-				load(c::DEF_FILE)
-				c = Object.const_get(klass.name.intern) 
-			end
-#=end
-=begin	
-			def_file = klass::DEF_FILE
-			# Object.send(:remove_const, klass) rescue nil
-			#	FIXME: also reload superclasses!
-			Controller.remove_subclasses
-			load(def_file)
-=end
-			klass = @controllers[key] = Object.const_get(klass.name.intern) 
-			context[:__RELOADED__] = true
 		end
-
-		return klass
+		
+		return klass		
 	end
 
 end

data/lib/nitro/element.rb

@@ -85,7 +85,7 @@ class ElementProcessor # :nodoc: all
 		end
 		
 		def tag_start(name, attributes)		
-			if name.capitalized?		
+			if name =~ /^[A-Z]/ # .capitalized?		
 				obj = Object.const_get(name).new
 				
 	    	attributes.each do | k, v | 
@@ -111,7 +111,7 @@ class ElementProcessor # :nodoc: all
 		end
 
 		def tag_end(name)		
-			if name.capitalized?		
+			if name =~ /^[A-Z]/ # .capitalized?		
 				obj, @buffer = @stack.pop
 				@buffer << obj.render
 			else

data/lib/nitro/flash.rb

@@ -0,0 +1,105 @@
+module Nitro
+
+	# This module adds flashing support to the Controllers. 
+	
+	module Flashing
+	
+		def self.append_features(base)
+			super			
+	    base.pre 'flash.discard'
+	    base.post 'flash.clean'
+    end
+    
+		# A Flash is a special hash object that lives in the session. 
+		# The values stored in the Flash are typically maintained 
+		# for the duration of one request. 
+		# 
+		# You may want to use the Flash to pass error messages or 
+		# other short lived objects.
+		
+		class Flash < Hash
+		
+			def initialize
+				super
+				@dirty = {}
+			end
+		
+			def []=(key, val)
+				super
+				keep(key)
+			end
+
+			# Keep the specific key or the whole Flash.
+						
+			def keep(key = nil)
+				set_dirty(key, false)
+			end
+			
+			# Discard the specific key or the whole Flash.
+			
+			def discard(key = nil)
+				set_dirty(key)
+			end			
+			
+      def clean # :nodoc:
+        keys.each do |k|
+          unless @dirty[k]
+            set_dirty(k)
+          else
+            delete(k)
+            @dirty.delete(k)
+          end
+        end
+        
+        # remove externaly updated keys.
+        
+        (@dirty.keys - keys).each { |k| @dirty.delete k } 
+      end
+      			
+		private
+			
+			def set_dirty(key = nil, flag = true)
+				if key
+			  	@dirty[key] = flag
+				else
+					keys.each { |k| @dirty[k] = flag }
+				end			
+			end
+			
+		end
+
+		# A Flash for the current request only.
+		#--
+		# gmosx: crap, not really needed!
+		#++
+		
+		class FlashNow
+		end
+	
+	private
+
+		def flash
+			session[:FLASH] ||= Flash.new
+		end
+				
+		# Some useful aspects.
+			
+    # Marks flash entries as used and expose the flash to the 
+    # view.
+    
+    def init_flash
+      flash.discard
+    end
+
+    # Deletes the flash entries that were not marked for 
+    # keeping.
+    
+    def clean_flash
+      flash.clean
+    end
+
+	end	
+
+end
+
+# * George Moschovitis <gm@navel.gr>

data/lib/nitro/render.rb

@@ -63,7 +63,7 @@ module Rendering
 		# template_root/action.xhtml
 
 		path = "#{template_root}/#{action.gsub(/__/, '/')}.#{ext}".squeeze('/')
-		
+
 		unless File.exist?(path)
 			# attempt to find a template of the form
 			# template_root/action/index.xhtml
@@ -75,7 +75,7 @@ module Rendering
 				path = nil
 			end
 		end
-		
+
 		return path
 	end
 	

data/lib/nitro/response.rb

@@ -1,7 +1,3 @@
-# * George Moschovitis  <gm@navel.gr>
-# (c) 2004-2005 Navel, all rights reserved.
-# $Id: response.rb 1 2005-04-11 11:04:30Z gmosx $
-
 module Nitro
 	
 # HTTP Response. This module is included in Context.
@@ -45,3 +41,5 @@ module Response
 end
 
 end
+
+# * George Moschovitis  <gm@navel.gr>

data/lib/nitro/runner.rb

@@ -201,6 +201,9 @@ class Runner
 	def setup_debug(conf)
 		$DBG = true
 		Rendering.reload = :full
+		require 'glue/autoreload'
+		autoreload(3)
+		Caching.caching_enabled = false
 	end
 
 	def setup_stage(conf)

data/lib/nitro/service.rb

@@ -10,6 +10,8 @@ class Service < Nitro::Controller
 		res = send(method, *args)
 		
 		response.content_type = 'text/xml'
+		
+		puts '--', encode_response(method, res)
 		print encode_response(method, res)
 
 		return :stop

data/lib/nitro/testing/testcase.rb

@@ -1,7 +1,3 @@
-# * George Moschovitis  <gm@navel.gr>
-# (c) 2004-2005 Navel, all rights reserved.
-# $Id: testcase.rb 1 2005-04-11 11:04:30Z gmosx $
-
 require 'test/unit'
 require 'test/unit/assertions'
 require 'rexml/document'
@@ -25,8 +21,6 @@ class TestCase
 		@conf.template_root ||= File.join(File.dirname(__FILE__), '..', 'public')
 		
 		begin
-			Og.db.get_connection if defined?(Og) and Og.db
-
 			context = Context.new(@conf)
 
 			# context.in = StringIO.new(req.body || "")
@@ -45,7 +39,7 @@ class TestCase
 
 			return context
 		ensure
-			Og.db.put_connection if defined?(Og) and Og.db
+			Og.manager.put_store if defined?(Og) and Og.manager
 		end
 	end
 	alias_method :process, :handle
@@ -53,3 +47,5 @@ class TestCase
 end
 
 end
+
+# * George Moschovitis <gm@navel.gr>

data/test/nitro/builder/tc_atom.rb

@@ -16,8 +16,6 @@ class TestCaseBuildersAtom < Test::Unit::TestCase # :nodoc: all
 		blogs << Blog.new('Hello3', 'World3', 'uri3', 'Renos');
 
 		rss = AtomBuilder.build(blogs, :link => 'http://www.navel.gr')
-
-		puts '--', rss
 =end
 		# assert_match %r{<link>http://www.navel.gr/uri1</link>}, rss
 		# assert_match %r{<link>http://www.navel.gr/uri2</link>}, rss

data/test/nitro/tc_caching.rb

@@ -12,7 +12,8 @@ class TC_Caching < Test::Unit::TestCase # :nodoc: all
 	end
 
 	def test_all
-		p Caching.public_instance_methods
-		p DummyCa.public_instance_methods
+		# bug:
+		assert_equal [], Caching.public_instance_methods
+		assert_equal [], DummyCa.public_instance_methods.grep(/caching/)
 	end
 end

data/test/nitro/tc_controller.rb

@@ -15,7 +15,7 @@ class TC_Controller < Test::Unit::TestCase # :nodoc: all
 	class Blog2Controller < Controller
 		attr_reader :aflag, :tflag
 
-		@template_root = 'test/public/blog'
+		@template_root = File.expand_path(Nitro::LibPath + '../../test/public/blog')
 
 		def list
 			@aflag = true 
@@ -26,7 +26,6 @@ class TC_Controller < Test::Unit::TestCase # :nodoc: all
 		@disp = Dispatcher.new({
 			'blog' => Blog2Controller,
 		})
-		@disp.template_root = 'test/public/root'
 		@conf = OpenStruct.new
 		@conf.dispatcher = @disp
 	end
@@ -36,13 +35,16 @@ class TC_Controller < Test::Unit::TestCase # :nodoc: all
 		ctx.headers = {}
 		ctx.params = {}
 		ctx.headers['REQUEST_URI'] = '/blog/list'
+		ctx.instance_eval '@session = {}'
 		klass, action = ctx.dispatcher.dispatch(ctx.path, ctx)
 		c = klass.new(ctx)
+
 		begin
 			c.send(action)
 		rescue RenderExit
 			# drink
 		end
+
 		assert_equal true, c.aflag
 		assert_equal true, $include1
 		assert_equal true, $include2

data/test/nitro/tc_element.rb

@@ -41,6 +41,5 @@ end
 class TC_Element < Test::Unit::TestCase # :nodoc: all
 	def test_all
 		res = ElementProcessor.render($source)
-		puts '---', res
 	end
 end

data/test/nitro/tc_flash.rb

@@ -0,0 +1,45 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', '..', 'lib')
+
+require 'test/unit'
+require 'ostruct'
+
+require 'nitro'
+require 'nitro/controller'
+require 'nitro/flash'
+
+class TC_Flash < Test::Unit::TestCase # :nodoc: all
+	include Nitro
+
+	class MyController < Controller
+		attr_accessor :flag
+		
+		def action1
+			flash[:msg] = 'Hello world!'
+		end
+		
+		def action2
+			@flag = flash[:msg]
+		end
+	end
+
+	def setup
+		@conf = OpenStruct.new
+	end
+
+	def teardown
+		@conf = nil
+	end
+	
+	def test_all
+		ctx = Context.new(@conf)
+		ctx.headers = {}
+		ctx.params = {}
+		ctx.instance_eval '@session = {}'
+		c = MyController.new(ctx)	
+		c.action1
+		c.action2
+		assert_equal 'Hello world!', c.flag
+		c.action2
+		assert_equal 'Hello world!', c.flag
+	end	
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: nitro
 version: !ruby/object:Gem::Version 
-  version: 0.18.1
-date: 2005-06-01
+  version: 0.19.0
+date: 2005-06-17
 summary: Nitro Web Engine
 require_paths: 
   - lib
@@ -111,6 +111,7 @@ files:
   - lib/nitro/element.rb
   - lib/nitro/service.rb
   - lib/nitro/service
+  - lib/nitro/flash.rb
   - lib/nitro/builder/xhtml.rb
   - lib/nitro/builder/xml.rb
   - lib/nitro/builder/form.rb
@@ -150,6 +151,7 @@ files:
   - test/nitro/tc_dispatcher.rb
   - test/nitro/tc_element.rb
   - test/nitro/tc_caching.rb
+  - test/nitro/tc_flash.rb
   - test/nitro/builder/tc_rss.rb
   - test/nitro/builder/tc_table.rb
   - test/nitro/builder/tc_xhtml.rb
@@ -192,7 +194,7 @@ dependencies:
         - 
           - "="
           - !ruby/object:Gem::Version 
-            version: 0.18.1
+            version: 0.19.0
       version: 
   - !ruby/object:Gem::Dependency 
     name: og
@@ -202,7 +204,7 @@ dependencies:
         - 
           - "="
           - !ruby/object:Gem::Version 
-            version: 0.18.1
+            version: 0.19.0
       version: 
   - !ruby/object:Gem::Dependency 
     name: facets