utopia 0.9.17

data/lib/utopia/link.rb

@@ -0,0 +1,243 @@
+# Copyright (c) 2010 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'utopia/extensions'
+
+module Utopia
+
+	class Link
+		XNODE_EXT = ".xnode"
+
+		def initialize(kind, path, info = nil)
+			@kind = kind
+
+			case @kind
+			when :file
+				@name = path.basename(XNODE_EXT)
+				@path = path
+			when :directory
+				@name = path.dirname.basename(XNODE_EXT)
+				@path = path
+			when :virtual
+				@name = path.to_s
+				@path = nil
+			end
+
+			@components = @name.split(".")
+			@locale = components[1..-1].join(".")
+			@title = components[0]
+
+			if info
+				@info = info.symbolize_keys
+			else
+				@info = {}
+			end
+		end
+
+		attr :kind
+		attr :name
+		attr :path
+		attr :locale
+		attr :info
+		attr :components
+
+		def [] (key)
+			if key == :title
+				return @title
+			end
+			
+			return @info[key]
+		end
+
+		def href
+			if @info[:uri]
+				return @info[:uri]
+			elsif @path
+				return @path.to_s
+			else
+				"\#"
+			end
+		end
+
+		def href?
+			return href != "\#"
+		end
+
+		def title
+			@info[:title] || @title.to_title
+		end
+
+		def external?
+			@info.key? :uri
+		end
+
+		def to_href(options = {})
+			options[:content] ||= title
+			options[:class] ||= "link"
+			
+			if href == "\#"
+				"<span class=#{options[:class].dump}>#{options[:content].to_html}</span>"
+			else
+				"<a class=#{options[:class].dump} href=\"#{href.to_html}\">#{options[:content].to_html}</a>"
+			end
+		end
+		
+		def eql? other
+			if other && self.class == other.class
+				return kind.eql?(other.kind) && 
+				       name.eql?(other.name) && 
+				       path.eql?(other.path) && 
+				       info.eql?(other.info)
+			else
+				return false
+			end
+		end
+
+		def == other
+			return other && kind == other.kind && name == other.name && path == other.path
+		end
+	end
+	
+	module Links
+		XNODE_FILTER = /^(.+)\.xnode$/
+		INDEX_XNODE_FILTER = /^(index(\..+)*)\.xnode$/
+		LINKS_YAML = "links.yaml"
+
+		def self.metadata(path)
+			links_path = File.join(path, LINKS_YAML)
+			if File.exist?(links_path)
+				return YAML::load(File.read(links_path))
+			else
+				return {}
+			end
+		end
+
+		def self.indices(path, &block)
+			entries = Dir.entries(path).delete_if{|filename| !filename.match(INDEX_XNODE_FILTER)}
+
+			if block_given?
+				entries.each &block
+			else
+				return entries
+			end
+		end
+
+		DEFAULT_OPTIONS = {
+			:directories => true,
+			:files => true,
+			:virtual => true,
+			:indices => false,
+			:sort => :order,
+			:hidden => :hidden,
+			:locale => nil
+		}
+		
+		def self.index(root, top, options = {})
+			options = DEFAULT_OPTIONS.merge(options)
+			path = File.join(root, top.components)
+			metadata = Links.metadata(path)
+
+			links = []
+
+			Dir.entries(path).each do |filename|
+				next if filename.match(/^[\._]/)
+
+				fullpath = File.join(path, filename)
+
+				if File.directory?(fullpath) && options[:directories]
+					name = filename
+					indices_metadata = Links.metadata(fullpath)
+
+					directory_metadata = metadata.delete(name) || {}
+					indices = 0
+					Links.indices(fullpath) do |index|
+						index_name = File.basename(index, ".xnode")
+						index_metadata = directory_metadata.merge(indices_metadata[index_name] || {})
+
+						links << Link.new(:directory, top + [filename, index_name], index_metadata)
+						indices += 1
+					end
+
+					if indices == 0
+						links << Link.new(:directory, top + [filename, ""], directory_metadata.merge(:uri => "\#"))
+					end
+				elsif filename.match(INDEX_XNODE_FILTER) && options[:indices] == false
+					name = $1
+					metadata.delete(name)
+
+					# We don't include indices in the list of pages.
+					next
+				elsif filename.match(XNODE_FILTER) && options[:files]
+					name = $1
+
+					links << Link.new(:file, top + name, metadata.delete(name))
+				end
+			end
+
+			if options[:virtual]
+				metadata.each do |name, details|
+					links << Link.new(:virtual, name, details)
+				end
+			end
+
+			if options[:hidden]
+				links = links.delete_if{|link| link[options[:hidden]]}
+			end
+
+			if options[:name]
+				case options[:name]
+				when Regexp
+					links.reject!{|link| !link.name.match(options[:name])}
+				when String
+					links.reject!{|link| link.name.index(options[:name]) != 0}
+				end
+			end
+
+			if options[:locale]
+				reduced = []
+
+				links.group_by(&:name).each do |name, links|
+					default = nil
+
+					link = links.reject{|link|
+						!(link.locale == options[:locale] || link.locale == "")
+					}.sort_by{|link| link.locale.size}.last
+
+					if link
+						reduced << link
+					end
+				end
+				
+				links = reduced
+			end
+			
+			if options[:sort]
+				links = links.sort do |a, b|
+					result = nil
+					begin
+						result ||= (a[options[:sort]] <=> b[options[:sort]])
+					rescue
+						# LOG.debug("Invalid comparison between #{a.path} and #{b.path} using key #{options[:sort]}!")
+					end
+					
+					result ||= (a.title <=> b.title)
+				end
+			end
+			
+			return links
+		end
+	end
+	
+end

data/lib/utopia/middleware.rb

@@ -0,0 +1,33 @@
+# Copyright (c) 2010 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'pathname'
+require 'logger'
+
+module Utopia
+	LOG = Logger.new($stderr)
+	LOG.level = Logger::DEBUG
+	
+	module Middleware
+		def self.default_root(subdir = "pages")
+			Pathname.new(Dir.pwd).join(subdir).realpath.to_s
+		end
+	end
+end
+
+require 'utopia/extensions'
+require 'utopia/path'
+require 'utopia/tag'
+

data/lib/utopia/middleware/all.rb

@@ -0,0 +1,24 @@
+# Copyright (c) 2010 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'pathname'
+
+Pathname.new(__FILE__).dirname.entries.grep(/\.rb$/).each do |path|
+	name = File.basename(path.to_s, ".rb")
+	
+	if name != "all"
+		require "utopia/middleware/#{name}"
+	end
+end

data/lib/utopia/middleware/benchmark.rb

@@ -0,0 +1,47 @@
+# Copyright (c) 2010 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'utopia/middleware'
+
+module Utopia
+	module Middleware
+
+		class Benchmark
+			def initialize(app, options = {})
+				@app = app
+				@tag = options[:tag] || "{{benchmark}}"
+			end
+
+			def call(env)
+				start = Time.now
+				response = @app.call(env)
+				finish = Time.now
+
+				time = "%0.4f" % (finish - start)
+				# LOG.debug "benchmark: Request #{env["PATH_INFO"]} took #{time}s"
+				buf = StringIO.new
+
+				response[2].each do |text|
+					buf.write(text.gsub(@tag, time))
+				end
+
+				buf.rewind
+
+				[response[0], response[1], buf]
+			end
+		end
+
+	end
+end

data/lib/utopia/middleware/content.rb

@@ -0,0 +1,139 @@
+# Copyright (c) 2010 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'utopia/middleware'
+require 'utopia/link'
+require 'utopia/path'
+require 'utopia/tags'
+
+require 'utopia/middleware/content/node'
+require 'utopia/etanni'
+
+module Utopia
+	module Middleware
+	
+		class Content
+			def initialize(app, options = {})
+				@app = app
+
+				@root = File.expand_path(options[:root] || Utopia::Middleware::default_root)
+				
+				LOG.info "#{self.class.name}: Running in #{@root}"
+
+				# Set to hash to enable caching
+				@nodes = {}
+				@files = nil
+
+				@tags = options[:tags] || {}
+			end
+
+			attr :root
+			attr :passthrough
+
+			def fetch_xml(path)
+				read_file = lambda { TemplateCache.new(path, Etanni) }
+				
+				if @files
+					@files.fetch(path) do
+						@files[path] = read_file.call
+					end
+				else
+					read_file.call
+				end
+			end
+
+			# Look up a named tag such as <entry />
+			def lookup_tag(name, parent_path)
+				if @tags.key? name
+					return @tags[name]
+				elsif Utopia::Tags.all.key? name
+					return Utopia::Tags.all[name]
+				end
+				
+				if String === name && name.index("/")
+					name = Path.create(name)
+				end
+				
+				if Path === name
+					name = parent_path + name
+					name_path = name.components.dup
+					name_path[-1] += ".xnode"
+				else
+					name_path = name + ".xnode"
+				end
+
+				parent_path.ascend do |dir|
+					tag_path = File.join(root, dir.components, name_path)
+
+					if File.exist? tag_path
+						return Node.new(self, dir + name, parent_path + name, tag_path)
+					end
+
+					if String === name_path
+						tag_path = File.join(root, dir.components, "_" + name_path)
+
+						if File.exist? tag_path
+							return Node.new(self, dir + name, parent_path + name, tag_path)
+						end
+					end
+				end
+				
+				return nil
+			end
+
+			def lookup_node(request_path)
+				name = request_path.basename
+				name_xnode = name + ".xnode"
+
+				node_path = File.join(@root, request_path.dirname.components, name_xnode)
+
+				if File.exist? node_path
+					return Node.new(self, request_path.dirname + name, request_path, node_path)
+				end
+
+				return nil
+			end
+
+			def call(env)
+				request = Rack::Request.new(env)
+				path = Path.create(request.path_info).to_absolute
+
+				# Check if the request is to a non-specific index.
+				name, extensions = path.basename.split(".", 2)
+				directory_path = File.join(@root, path.dirname.components, name)
+
+				if File.directory? directory_path
+					return [307, {"Location" => path.dirname.join([name, "index.#{extensions}"]).to_s}, []]
+				end
+
+				# Otherwise look up the node
+				node = lookup_node(path)
+
+				if node
+					if request.head?
+						return [200, {}, []]
+					else
+						response = Rack::Response.new
+						node.process!(request, response)
+						return response.finish
+					end
+				else
+					return @app.call(env)
+				end
+			end
+		end
+		
+	end
+end