utopia 0.12.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 296a41faf645d12aa55672af9445a4f94f939da1
-  data.tar.gz: 53019aaae569b4191d3361d3d2a1094a9e52bcfe
+  metadata.gz: 2de92361694a0d93055b13141f7373bdca9ba4c8
+  data.tar.gz: abf743ebf57a07d8850fb22719ee62085e4c1166
 SHA512:
-  metadata.gz: 34aaf114f9917265dbe27b65379bb77cb66fda5310b27384d2edcae8dc21fc01d7d814d6ea79f98fca46be81cbf2c1b9dc0c1da9f40b6af20dffa7cfb5dd2557
-  data.tar.gz: 09e47aa4fd61d9d015c7aa836c734dda5f20570efd02bacdd745756b2e02c6fc4e32e413bd47dfd1d140d740adf340dd4f0682b08ad63b579352af2798b0fae7
+  metadata.gz: bdeeca349e075376b9a5a65c97195e92e4e67c3b6c21077ab93fbf86395dd4745b41c63cc0362371a9af1b8162ece2a7c65011c081b617ef6e1cd05c0920280d
+  data.tar.gz: 0a135fa1fd8069f1a8b90ea8f040bd1dad4f71891e37735099184a3579d2191f21a8e8bf0b87955ffe6d4835561ce28f9b21d97423ba7b423b9a8b0d4afaeec7

data/.travis.yml

@@ -1,5 +1,9 @@
 language: ruby
 rvm:
-  - "1.9.3"
   - "2.0"
-  - "2.1"
+  - "2.1"
+  - "2.2"
+  - "rbx-2"
+matrix:
+  allow_failures:
+    - rvm: "rbx-2"

data/Gemfile

@@ -2,3 +2,9 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in utopia.gemspec
 gemspec
+
+group :test do
+	gem 'rack-test'
+	gem 'simplecov'
+	gem 'coveralls', require: false
+end

data/README.md

@@ -2,38 +2,72 @@
 
 Utopia is a website generation framework which provides a robust set of tools
 to build highly complex dynamic websites. It uses the filesystem heavily for
-content and provides frameworks for interacting with files and directories as
+content and provides functions for interacting with files and directories as
 structure representing the website.
 
 Utopia builds on top of Rack with the following middleware:
 
-* `Utopia::Middleware::Static`: Serve static files with recursive lookup
-* `Utopia::Middleware::Requester`: Allow nesting of virtual requests
-* `Utopia::Middleware::Redirector`: Redirect URL patterns and status codes
-* `Utopia::Middleware::Logger`: Advanced rotating access log
-* `Utopia::Middleware::Localization`: Non-intrusive localization of resources
-* `Utopia::Middleware::DirectoryIndex`: Redirect directory requests to specific files
-* `Utopia::Middleware::Controller`: Dynamic behaviour with recursive execution
-* `Utopia::Middleware::Content`: XML-style template engine with powerful tag behaviours
-* `Utopia::Session::EncryptedCookie`: Session storage using an encrypted cookie
+- `Utopia::Static`: Serve static files with recursive lookup.
+- `Utopia::Redirector`: Redirect URL patterns and status codes.
+- `Utopia::Localization`: Non-intrusive localization of resources.
+- `Utopia::Controller`: Dynamic behaviour with recursive execution.
+- `Utopia::Content`: XML-style template engine with powerful tag behaviours.
+- `Utopia::Session::EncryptedCookie`: Session storage using an encrypted cookie.
 
 For more details please see the main [project page][1].
 
 [1]: http://www.oriontransfer.co.nz/gems/utopia
 
 [![Build Status](https://secure.travis-ci.org/ioquatix/utopia.png)](http://travis-ci.org/ioquatix/utopia)
+[![Coverage Status](https://coveralls.io/repos/ioquatix/utopia/badge.svg)](https://coveralls.io/r/ioquatix/utopia)
+
+## Middleware
+
+### Static
+
+This middleware serves static files using the `mime-types` library. By default, it works with `Rack::Sendfile` and `Rack::Cache` and supports `ETag` based caching.
+
+### Redirector
+
+A flexible high level URI rewriting system which includes support for string mappings, regular expressions and status codes (e.g. 404 errors).
+
+### Localization
+
+The localization middleware uses the `Accept-Language` header to guess the preferred locale out of the given options. If a request path maps to a resource, that resource is returned. Otherwise, a localized request is made.
+
+### Controller
+
+A simple recursive controller layer which works in isolation from the view rendering middleware. A controller consists of a set of actions which match against incoming paths and execute code accordingly.
+
+### Content
+
+A tag based content generation system which integrates nicely with HTML5. Supports structures which separate generic page templates from dynamically generated content in an easy and consistent way.
+
+### Session
+
+The encrypted cookie session management uses symmetric private key encryption to store data on the client and avoid tampering.
 
 ## Installation
 
 Install utopia:
 
-    $ gem install utopia
+	$ gem install utopia
 
 Create a new site:
 
-	$ utopia setup www.example.com
+	$ utopia create www.example.com
 	$ cd www.example.com
-	$ thin start -p 9000
+	$ rake server
+
+### Bower Integration
+
+If you create a site using the utopia generator, it includes a `.bowerrc` configuration which installs components into `public/_static/components`. To install jquery, for example:
+
+	bower install jquery
+
+Then add the appropriate `<script>` tags to `pages/_page.xnode`:
+
+	<script src="/_static/components/jquery/dist/jquery.min.js" type="text/javascript"></script>
 
 ## Usage
 
@@ -51,7 +85,7 @@ The default site includes documentation and examples.
 
 Released under the MIT license.
 
-Copyright, 2012, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
+Copyright, 2015, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Rakefile

@@ -4,3 +4,8 @@ require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+task :coverage do
+	ENV['COVERAGE'] = 'true'
+	Rake::Task['spec'].execute
+end

data/bin/utopia

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -21,27 +21,73 @@
 # THE SOFTWARE.
 
 require 'rubygems'
-require 'utopia/setup'
+require 'rake'
+
+require_relative '../lib/utopia/version'
+
+require 'fileutils'
+require 'find'
 require 'rake'
 
 $app = Rake.application = Rake::Application.new
 $app.init('Utopia')
 
-task :setup do
-	path = File.expand_path(ARGV.last, Dir.getwd)
-	FileUtils.mkdir_p path
+module Setup
+	DIRECTORIES = ["cache", "cache/meta", "cache/body", "lib", "pages", "public"]
+	SYMLINKS = {"public/_static" => "../pages/_static"}
+	
+	CONFIGURATION_FILES = ['config.ru', 'Gemfile', 'Rakefile']
+	
+	# Removed during upgrade process
+	OLD_DIRECTORIES = ["access_log"]
+end
 
-	Dir.chdir(path) do
-		Utopia::Setup.copy(path)
+task :create do
+	$stderr.puts("Usage: #{File.basename $0} create $path") & exit if ARGV.size != 2 
 	
-		if `which thin`.strip == ""
-			$stderr.puts "Next, please install thin: `sudo gem install thin'."
-		end
+	destination_root = File.expand_path(ARGV.last, Dir.getwd)
+	setup_root = File.expand_path("../../setup", __FILE__)
+	
+	$stderr.puts "Copying files from #{setup_root} to #{destination_root}..."
+	
+	Setup::DIRECTORIES.each do |directory|
+		FileUtils.mkdir_p(File.join(destination_root, directory))
+	end
 	
-		if `which git`.strip == ""
-			$stderr.puts "Now is a good time to learn about git : http://git-scm.com/"
+	Find.find(setup_root) do |source_path|
+		# What is this doing?
+		destination_path = File.join(destination_root, source_path[setup_root.size..-1])
+		
+		if File.directory?(source_path)
+			FileUtils.mkdir_p(destination_path)
+		else
+			if File.exist? destination_path
+				$stderr.puts "\tFile already exists: #{destination_path}!"
+			else
+				$stderr.puts "\tCopying #{source_path} to #{destination_path}..."
+				FileUtils.copy_entry(source_path, destination_path)
+			end
 		end
+	end
 	
+	Setup::SYMLINKS.each do |path, target|
+		FileUtils.ln_s(target, File.join(destination_root, path))
+	end
+	
+	Setup::CONFIGURATION_FILES.each do |configuration_file|
+		destination_path = File.join(destination_root, configuration_file)
+		
+		$stderr.puts "Updating #{destination_path}..."
+		
+		buffer = File.read(destination_path).gsub('$UTOPIA_VERSION', Utopia::VERSION)
+		File.open(destination_path, "w") { |file| file.write(buffer) }
+	end
+
+	if `which git`.strip == ""
+		$stderr.puts "Now is a good time to learn about git : http://git-scm.com/"
+	end
+	
+	Dir.chdir(destination_root) do
 		unless File.exist? '.git'
 			sh("git", "init")
 			sh("git", "add", ".")
@@ -49,12 +95,83 @@ task :setup do
 		end
 	end
 	
-	$stderr.puts "*** Thanks for trying out Utopia! ***"
+	$stderr.puts "*** Thanks for using Utopia! ***"
+	$stderr.puts "To start the server:\n\tcd #{ARGV.last}\n\trake server"
+end
+
+task :upgrade do
+	$stderr.puts("Usage: #{File.basename $0} upgrade $path") & exit if ARGV.size != 2 
+	
+	destination_root = File.expand_path(ARGV.last || '.', Dir.getwd)
+	setup_root = File.expand_path("../../setup", __FILE__)
+	directories = ["cache", "cache/meta", "cache/body", "lib", "pages", "public"]
+	symlinks = {"public/_static" => "../pages/_static"}
+	branch_name = "utopia-upgrade-#{Utopia::VERSION}"
+	
+	$stderr.puts "Upgrading #{destination_root}..."
+	
+	Dir.chdir(destination_root) do
+		sh('git', 'checkout', '-b', branch_name)
+	end
+	
+	Setup::DIRECTORIES.each do |directory|
+		FileUtils.mkdir_p(File.join(destination_root, directory))
+	end
+	
+	Setup::OLD_DIRECTORIES.each do |directory|
+		path = File.join(destination_root, directory)
+		$stderr.puts "\tRemoving #{path}..."
+		FileUtils.rm_rf(path)
+	end
+	
+	Setup::SYMLINKS.each do |path, target|
+		FileUtils.ln_s(target, File.join(destination_root, path), force: true)
+	end
+	
+	Setup::CONFIGURATION_FILES.each do |configuration_file|
+		source_path = File.join(setup_root, configuration_file)
+		destination_path = File.join(destination_root, configuration_file)
+		
+		$stderr.puts "Updating #{destination_path}..."
+		
+		FileUtils.copy_entry(source_path, destination_path)
+		buffer = File.read(destination_path).gsub('$UTOPIA_VERSION', Utopia::VERSION)
+		File.open(destination_path, "w") { |file| file.write(buffer) }
+	end
+	
+	begin
+		Dir.chdir(destination_root) do
+			# Stage any files that have been changed or removed:
+			sh("git", "add", "-u")
+			
+			# Stage any new files that we have explicitly added:
+			sh("git", "add", *Setup::CONFIGURATION_FILES, *Setup::SYMLINKS.keys)
+			
+			# Commit all changes:
+			sh("git", "commit", "-m", "Upgrade to utopia #{Utopia::VERSION}.")
+			
+			# Checkout master..
+			sh("git", "checkout", "master")
+			
+			# and merge:
+			sh("git", "merge", "--no-commit", "--no-ff", branch_name)
+		end
+	rescue RuntimeError
+		$stderr.puts "** Detected error with upgrade, reverting changes. Some new files may still exist in tree. **"
+		
+		sh("git", "checkout", "master")
+		sh("git", "branch", "-d", branch_name)
+	end
+	
+	$stderr.puts "*** Thanks for using Utopia! ***"
 end
 
 task :help do
-	$stderr.puts "To create a new site, use the setup task:"
-	$stderr.puts "$ #{File.basename($0)} setup www.example.com"
+	$stderr.puts "To create a new site, use the create task:"
+	$stderr.puts "\t#{File.basename($0)} create path/to/www.example.com"
+	
+	$stderr.puts "To upgrade an existing site, use the upgrade task:"
+	$stderr.puts "\t#{File.basename($0)} upgrade path/to/www.example.com"
 end
 
 task :default => :help

data/lib/utopia.rb

@@ -18,14 +18,17 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'utopia/version'
+require_relative 'utopia/version'
 
-require 'utopia/middleware/content'
-require 'utopia/middleware/controller'
-require 'utopia/middleware/directory_index'
-require 'utopia/middleware/exception_handler'
-require 'utopia/middleware/localization'
-require 'utopia/middleware/mail_exceptions'
-require 'utopia/middleware/redirector'
-require 'utopia/middleware/requester'
-require 'utopia/middleware/static'
+require_relative 'utopia/content'
+require_relative 'utopia/controller'
+require_relative 'utopia/exception_handler'
+require_relative 'utopia/localization'
+require_relative 'utopia/mail_exceptions'
+require_relative 'utopia/redirector'
+require_relative 'utopia/static'
+
+require_relative 'utopia/tags/deferred'
+require_relative 'utopia/tags/environment'
+require_relative 'utopia/tags/node'
+require_relative 'utopia/tags/override'

data/lib/utopia/content.rb

@@ -0,0 +1,140 @@
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'middleware'
+require_relative 'localization'
+
+require_relative 'content/node'
+require_relative 'content/processor'
+
+require 'trenni/template'
+
+module Utopia
+	class Content
+		def initialize(app, options = {})
+			@app = app
+
+			@root = File.expand_path(options[:root] || Utopia::default_root)
+
+			@templates = options[:cache_templates] ? {} : nil
+
+			@tags = options.fetch(:tags, {})
+		end
+
+		attr :root
+		attr :passthrough
+
+		def fetch_xml(path)
+			if @templates
+				@templates.fetch(path) do |key|
+					@templates[key] = Trenni::Template.load(path)
+				end
+			else
+				Trenni::Template.load(path)
+			end
+		end
+
+		# Look up a named tag such as <entry />
+		def lookup_tag(name, parent_path)
+			if @tags.key? name
+				return @tags[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_EXTENSION
+			else
+				name_path = name + XNODE_EXTENSION
+			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
+		
+		# The request_path is an absolute uri path, e.g. /foo/bar. If an xnode file exists on disk for this exact path, it is instantiated, otherwise nil.
+		def lookup_node(request_path)
+			name = request_path.last
+			name_xnode = name.to_s + XNODE_EXTENSION
+
+			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)
+			
+			# Check if the request is to a non-specific index. This only works for requests with a given name:
+			basename = path.basename
+			directory_path = File.join(@root, path.dirname.components, basename.name)
+
+			# If the request for /foo/bar{extensions} is actually a directory, rewrite it to /foo/bar/index{extensions}:
+			if File.directory? directory_path
+				index_path = [basename.name, basename.rename("index")]
+				
+				return [307, {"Location" => path.dirname.join(index_path).to_s}, []]
+			end
+
+			locale = env[Localization::CURRENT_LOCALE_KEY]
+			if link = Links.for(@root, path, locale)
+				if node = lookup_node(link.path)
+					response = Rack::Response.new
+					
+					attributes = nil
+					
+					if request.respond_to?(:controller)
+						attributes = request.controller
+					end
+					
+					node.process!(request, response, (attributes || {}).to_hash)
+					
+					return response.finish
+				end
+			end
+			
+			return @app.call(env)
+		end
+	end
+end