utopia 1.4.0 → 1.5.0

data/lib/utopia/localization.rb

@@ -24,13 +24,9 @@ module Utopia
 	# If you request a URL which has localized content, a localized redirect would be returned based on the content requested.
 	class Localization
 		# A wrapper to provide easy access to locale related data in the request.
-		class RequestWrapper
-			def initialize(request)
-				if request.is_a? Rack::Request
-					@env = request.env
-				else
-					@env = request
-				end
+		class Wrapper
+			def initialize(env)
+				@env = env
 			end
 			
 			def localization
@@ -54,7 +50,7 @@ module Utopia
 		end
 		
 		def self.[] request
-			RequestWrapper.new(request)
+			Wrapper.new(request.env)
 		end
 		
 		RESOURCE_NOT_FOUND = [400, {}, []].freeze

data/lib/utopia/path.rb

@@ -203,14 +203,16 @@ module Utopia
 		end
 
 		def +(other)
-			if other.kind_of? Array
-				return join(other)
-			elsif other.kind_of? Path
+			if other.kind_of? Path
 				if other.absolute?
 					return other
 				else
 					return join(other.components)
 				end
+			elsif other.kind_of? Array
+				return join(other)
+			elsif other.kind_of? String
+				return join(other.split(SEPARATOR, -1))
 			else
 				return join([other.to_s])
 			end
@@ -268,27 +270,25 @@ module Utopia
 		def descend(&block)
 			return to_enum(:descend) unless block_given?
 			
-			parent_path = []
+			components = []
 			
 			@components.each do |component|
-				parent_path << component
+				components << component
 				
-				yield self.class.new(parent_path.dup)
+				yield self.class.new(components.dup)
 			end
 		end
 		
 		def ascend(&block)
 			return to_enum(:ascend) unless block_given?
 			
-			next_parent = self
+			components = self.components.dup
 			
-			begin
-				parent = next_parent
+			while components.any?
+				yield self.class.new(components.dup)
 				
-				yield parent
-				
-				next_parent = parent.dirname
-			end until next_parent.eql?(parent)
+				components.pop
+			end
 		end
 
 		def split(at)

data/lib/utopia/static.rb

@@ -144,10 +144,12 @@ module Utopia
 				File.mtime(full_path).httpdate
 			end
 
-			def size
+			def bytesize
 				File.size(full_path)
 			end
 
+			alias size bytesize
+
 			def each
 				File.open(full_path, "rb") do |file|
 					file.seek(@range.begin)
@@ -176,6 +178,9 @@ module Utopia
 				return true
 			end
 
+			CONTENT_LENGTH = Rack::CONTENT_LENGTH
+			CONTENT_RANGE = 'Content-Range'.freeze
+			
 			def serve(env, response_headers)
 				ranges = Rack::Utils.byte_ranges(env, size)
 				response = [200, response_headers, self]
@@ -186,7 +191,7 @@ module Utopia
 					# No ranges, or multiple ranges (which we don't support).
 					# TODO: Support multiple byte-ranges, for now just send entire file:
 					response[0] = 200
-					response[1]["Content-Length"] = size.to_s
+					response[1][CONTENT_LENGTH] = size.to_s
 					@range = 0...size
 				else
 					# Partial content:
@@ -194,25 +199,25 @@ module Utopia
 					partial_size = @range.count
 					
 					response[0] = 206
-					response[1]["Content-Length"] = partial_size.to_s
-					response[1]["Content-Range"] = "bytes #{@range.min}-#{@range.max}/#{size}"
+					response[1][CONTENT_LENGTH] = partial_size.to_s
+					response[1][CONTENT_RANGE] = "bytes #{@range.min}-#{@range.max}/#{size}"
 				end
-
-				# puts "Serving file #{full_path.inspect}, range #{@range.inspect}"
-
+				
 				return response
 			end
 		end
 
 		public
 
+		DEFAULT_CACHE_CONTROL = 'public, max-age=3600'.freeze
+
 		def initialize(app, **options)
 			@app = app
 			@root = (options[:root] || Utopia::default_root).freeze
 
 			@extensions = MimeTypeLoader.extensions_for(options[:types] || MIME_TYPES[:default])
 
-			@cache_control = (options[:cache_control] || "public, max-age=3600")
+			@cache_control = (options[:cache_control] || DEFAULT_CACHE_CONTROL)
 			
 			self.freeze
 		end
@@ -237,7 +242,13 @@ module Utopia
 		end
 
 		attr :extensions
-
+		
+		LAST_MODIFIED = 'Last-Modified'.freeze
+		CONTENT_TYPE = HTTP::CONTENT_TYPE
+		CACHE_CONTROL = HTTP::CACHE_CONTROL
+		ETAG = 'ETag'.freeze
+		ACCEPT_RANGES = 'Accept-Ranges'.freeze
+		
 		def call(env)
 			path_info = env[Rack::PATH_INFO]
 			extension = File.extname(path_info)
@@ -251,11 +262,11 @@ module Utopia
 				
 				if file = fetch_file(path)
 					response_headers = {
-						"Last-Modified" => file.mtime_date,
-						"Content-Type" => @extensions[extension],
-						"Cache-Control" => @cache_control,
-						"ETag" => file.etag,
-						"Accept-Ranges" => "bytes"
+						LAST_MODIFIED => file.mtime_date,
+						CONTENT_TYPE => @extensions[extension],
+						CACHE_CONTROL => @cache_control,
+						ETAG => file.etag,
+						ACCEPT_RANGES => "bytes"
 					}
 
 					if file.modified?(env)

data/lib/utopia/tags/environment.rb

@@ -33,7 +33,7 @@ module Utopia
 				only = state[:only].split(",").collect(&:to_sym) rescue []
 
 				if defined?(@environment) and only.include?(@environment)
-					transaction.parse_xml(state.content)
+					transaction.parse_markup(state.content)
 				end
 			end
 		end

data/lib/utopia/tags/override.rb

@@ -26,7 +26,7 @@ module Utopia
 			end
 			
 			def self.call(transaction, state)
-				transaction.parse_xml(state.content)
+				transaction.parse_markup(state.content)
 			end
 		end
 	end

data/lib/utopia/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Utopia
-	VERSION = "1.4.0"
+	VERSION = "1.5.0"
 end

data/setup/server/git/hooks/post-receive

@@ -26,43 +26,51 @@ require 'etc'
 # Users in group wheel can execute all commands as user http with no password.
 # %wheel ALL=(http) NOPASSWD: ALL
 
-def sh(*args)
-	puts args.join(' ')
-	system(*args)
-end
+GIT_WORK_TREE = `git config core.worktree`.chomp
 
-working_tree = `git config core.worktree`.chomp
+# We convert GIT_DIR to an absolute path:
+ENV['GIT_DIR'] = File.join(Dir.pwd, ENV['GIT_DIR'])
 
-puts "Updating Site #{working_tree}..."
+# We deploy the site as the user and group of the directory for the working tree:
+File.stat(GIT_WORK_TREE).tap do |stat|
+	ENV['DEPLOY_USER'] = DEPLOY_USER = Etc.getpwuid(stat.uid).name
+	ENV['DEPLOY_GROUP'] = DEPLOY_GROUP = Etc.getgrgid(stat.gid).name
+end
 
-# Figure out the user and group of the working tree:
-working_tree_stat = File.stat(working_tree)
-deploy_user = Etc.getpwuid(working_tree_stat.uid).name
-deploy_group = Etc.getgrgid(working_tree_stat.gid).name
+WHOAMI = `whoami`.chomp!
 
-puts "Updating permissions..."
+# We should find out if we need to use sudo or not:
+SUDO = if WHOAMI != DEPLOY_USER
+	["sudo", "-u", "DEPLOY_USER"]
+end
 
-Dir.chdir(working_tree) do
-	sh("chmod -Rf ug+rwX .")
-	sh("chown -Rf #{deploy_user}:#{deploy_group} .")
+def sh(command)
+	puts command.join(' ')
+	system(*command) or abort("Deployment failed!")
+end
 
-	puts "Updating site #{Dir.pwd} as #{deploy_user}:#{deploy_group}..."
+def sudo(command)
+	sh([*SUDO, *command])
+end
+
+puts "Deploying to #{GIT_WORK_TREE} as #{DEPLOY_USER}:#{DEPLOY_GROUP}..."
+Dir.chdir(GIT_WORK_TREE) do
+	# Pass on our rights to the files we just uploaded to the deployment user/group:
+	sh %W{chmod -Rf ug+rwX .}
+	sh %W{chown -Rf #{DEPLOY_USER}:#{DEPLOY_GROUP} .}
 	
-	sh("sudo -u #{deploy_user} git checkout -f")
-	sh("sudo -u #{deploy_user} git submodule update -i")
+	sudo %W{git checkout -f}
+	sudo %W{git submodule update -i}
 	
 	if File.exist? 'Gemfile'
-		sh("sudo -u #{deploy_user} bundle install --deployment") or abort("Could not setup bundle!")
+		sudo %W{bundle install --deployment --clean --jobs=4 --retry=2 --quiet}
 	end
 	
-	ENV['DEPLOY_USER'] = deploy_user
-	ENV['DEPLOY_GROUP'] = deploy_group
-	
 	if File.exist? 'Rakefile'
-		sh("sudo -u #{deploy_user} bundle exec rake deploy") or abort("Deploy task failed!")
+		sudo %W{bundle exec rake deploy}
 	end
 	
 	puts "Restarting server..."
-	sh("sudo -u #{deploy_user} mkdir -p tmp") unless File.exist?('tmp')
-	sh("sudo -u #{deploy_user} touch tmp/restart.txt")
+	sudo %W{mkdir -p tmp} unless File.exist?('tmp')
+	sudo %W{touch tmp/restart.txt}
 end

data/setup/site/Gemfile

@@ -5,6 +5,14 @@ gem "utopia", "~> $UTOPIA_VERSION"
 # gem "utopia-tags-gallery"
 # gem "utopia-tags-google-analytics"
 
+gem "rake"
+gem "bundler"
+
 group :development do
+	# For `rake server`:
 	gem "puma"
+	
+	# For `rake console`:
+	gem "pry"
+	gem "rack-test"
 end

data/setup/site/Rakefile

@@ -1,9 +1,32 @@
 
-task :server do
-	system('puma')
-end
-
+desc 'Run by git post-update hook when deployed to a web server'
 task :deploy do
 	# This task is typiclly run after the site is updated but before the server is restarted.
-	puts "Preparing to deploy site in #{Dir.pwd.inspect}..."
-end
+end
+
+desc 'Set up the environment for running your web application'
+task :environment do
+	RACK_ENV = (ENV['RACK_ENV'] ||= 'development').to_sym
+end
+
+desc 'Run a server for testing your web application'
+task :server => :environment do
+	port = ENV.fetch('SERVER_PORT', 9292)
+	system('puma', '-p', port)
+end
+
+desc 'Start an interactive console for your web application'
+task :console => :environment do
+	require 'pry'
+	require 'rack/test'
+	
+	include Rack::Test::Methods
+	
+	def app
+		@app ||= Rack::Builder.parse_file(File.expand_path("config.ru", __dir__)).first
+	end
+	
+	Pry.start
+end
+
+task :default => :server

data/setup/site/config.ru

@@ -14,23 +14,28 @@ require 'utopia'
 require 'rack/cache'
 
 if RACK_ENV == :production
+	# Handle exceptions in production with a error page and send an email notification:
 	use Utopia::Exceptions::Handler
 	use Utopia::Exceptions::Mailer
-elsif RACK_ENV == :development
-	use Rack::ShowExceptions
+else
+	# We want to propate exceptions up when running tests:
+	use Rack::ShowExceptions unless RACK_ENV == :test
+	
+	# Serve the public directory in a similar way to the web server:
 	use Utopia::Static, root: 'public'
 end
 
 use Rack::Sendfile
 
 if RACK_ENV == :production
+	# Cache dynamically generated content where possible:
 	use Rack::Cache,
 		metastore: "file:#{Utopia::default_root("cache/meta")}",
 		entitystore: "file:#{Utopia::default_root("cache/body")}",
 		verbose: RACK_ENV == :development
 end
 
-use Rack::ContentLength
+use Utopia::ContentLength
 
 use Utopia::Redirection::Rewrite,
 	'/' => '/welcome/index'
@@ -50,11 +55,6 @@ use Utopia::Controller,
 
 use Utopia::Static
 
-if RACK_ENV != :production
-	# Serve static files from public/ when not running in a production environment:
-	use Utopia::Static, root: 'public'
-end
-
 # Serve dynamic content
 use Utopia::Content,
 	cache_templates: (RACK_ENV == :production),

data/setup/site/pages/_heading.xnode

@@ -1,2 +1,2 @@
-<?r @title ||= content ?>
+<?r transaction.attributes[:title] ||= content ?>
 <h1><content/></h1>

data/setup/site/pages/_page.xnode

@@ -4,7 +4,7 @@
 		<?r response.content_type = "text/html; charset=utf-8" ?>
 		<?r response.cache! ?>
 		
-		<?r if title = (attributes["title"] || @title) ?>
+		<?r if title = self[:title] ?>
 			<title>#{title.gsub(/<.*?>/, "")} - Utopia</title>
 		<?r else ?>
 			<title>Utopia</title>
@@ -14,7 +14,7 @@
 		<link rel="stylesheet" href="/_static/site.css" type="text/css" media="screen" />
 	</head>
 
-	<body class="#{attributes['class']}">
+	<body class="#{attributes[:class]}">
 		<div id="header">
 			<img src="/_static/utopia.svg" />
 		</div>

data/spec/utopia/content_spec.rb

@@ -79,15 +79,15 @@ module Utopia::ContentSpec
 			expect(output.string).to be == '<h1>Hello World</h1>'
 		end
 		
-		it "should fetch xml and use cache" do
+		it "should fetch template and use cache" do
 			node_path = File.expand_path('../pages/index.xnode', __FILE__)
 			
-			template = content.fetch_xml(node_path)
+			template = content.fetch_template(node_path)
 			
 			expect(template).to be_kind_of Trenni::Template
 			
 			# Check that the same object is returned:
-			expect(template).to be content.fetch_xml(node_path)
+			expect(template).to be content.fetch_template(node_path)
 		end
 	end
 end

data/spec/utopia/controller/sequence_spec.rb

@@ -93,7 +93,7 @@ module Utopia::Controller::SequenceSpec
 		
 			result = controller.process!(request, Utopia::Path["/variable"])
 			expect(result).to be == nil
-			expect(variables.to_hash).to be == {"variable" => :value}
+			expect(variables.to_hash).to be == {:variable => :value}
 		end
 		
 		it "should call direct controller methods" do

data/spec/utopia/controller/variables_spec.rb

@@ -53,6 +53,6 @@ RSpec.describe Utopia::Controller::Variables do
 	it "should convert to hash" do
 		subject << a << b
 		
-		expect(subject.to_hash).to be == {'x' => 10, 'y' => 20}
+		expect(subject.to_hash).to be == {x: 10, y: 20}
 	end
 end

data/spec/utopia/pages/node/index.xnode

@@ -1 +1 @@
-#{local_path}
+#{current.node.local_path}

data/spec/utopia/performance_spec.rb

@@ -0,0 +1,90 @@
+# Copyright, 2016, 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 'rack_helper'
+
+require 'benchmark/ips' if ENV['BENCHMARK']
+require 'ruby-prof' if ENV['PROFILE']
+require 'flamegraph' if ENV['FLAMEGRAPH']
+
+RSpec.describe "Utopia Performance" do
+	include_context "rack app", "performance_spec/config.ru"
+	
+	if defined? Benchmark
+		def benchmark(name = nil)
+			Benchmark.ips do |benchmark|
+				benchmark.report(name) do |i|
+					yield i
+				end
+				
+				benchmark.compare!
+			end
+		end
+	elsif defined? RubyProf
+		def benchmark(name)
+			result = RubyProf.profile do
+				yield 1000
+			end
+			
+			result.eliminate_methods!([/^((?!Utopia).)*$/])
+			printer = RubyProf::FlatPrinter.new(result)
+			printer.print($stderr, min_percent: 1.0)
+			
+			printer = RubyProf::GraphHtmlPrinter.new(result)
+			filename = name.gsub('/', '_') + '.html'
+			File.open(filename, "w") do |file|
+				printer.print(file)
+			end
+		end
+	elsif defined? Flamegraph
+		def benchmark(name)
+			filename = name.gsub('/', '_') + '.html'
+			Flamegraph.generate(filename) do
+				yield 1
+			end
+		end
+	else
+		def benchmark(name)
+			yield 1
+		end
+	end
+	
+	it "should be fast to access basic page" do
+		env = Rack::MockRequest.env_for("/welcome/index")
+		status, headers, response = app.call(env)
+		
+		expect(status).to be == 200
+		
+		benchmark("/welcome/index") do |i|
+			i.times { app.call(env) }
+		end
+	end
+	
+	it "should be fast to invoke a controller" do
+		env = Rack::MockRequest.env_for("/api/fetch")
+		status, headers, response = app.call(env)
+		
+		expect(status).to be == 200
+		
+		benchmark("/api/fetch") do |i|
+			i.times { app.call(env) }
+		end
+	end
+end