utopia 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fb046791da67c397e853162649620dc2b530d3e
-  data.tar.gz: 390a488937297cec03a267206d4a096d4c74a497
+  metadata.gz: 452905bf411c5f82c5fe02c778c50a27b25234cb
+  data.tar.gz: 43df0cc23493c453bddf7d19b58b02e65bb15619
 SHA512:
-  metadata.gz: 9bd0a3820ebe9422484bb3c1bf048c99b7f7d0e9907eb0cdfccf292ecb6c55e8927cbdeacf87f96b4ad759b7047290f7622639438997d2fa53c96ced3fd24e26
-  data.tar.gz: 9cca58be165173f26f72cee8bde2b7b5b1052018c2a1fff7946476228cc09c63eb48e4d51a85da50893e59894b33c504afede627b5cfeb51dd15c466af3b94fa
+  metadata.gz: 0ab0769846592da4bb8ce571d48cfc7465d3b773b64739781bae3fd4c6900603d162ad0a7e72d49ad049ca011858256a87191d9d13a9027fc703934bccf2224f
+  data.tar.gz: 2988e596315c47ee2026d8fe5f64d075bb3b99e3fe3fdf35e3ab0217716cee83cb9f472f16dface2e2526d4c086b21fe9a7732f1f535126e3ebfc47667094c21

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.tags*

data/.travis.yml

@@ -1,12 +1,16 @@
 language: ruby
 sudo: false
+before_install:
+  # For testing purposes:
+  - git config --global user.email "you@example.com"
+  - git config --global user.name "Your Name"
 rvm:
   - 2.1.8
   - 2.2.4
   - 2.3.0
   - ruby-head
   - rbx-2
-env: COVERAGE=true
+env: COVERAGE=true BENCHMARK=true
 matrix:
   allow_failures:
     - rvm: rbx-2

data/Gemfile

@@ -11,6 +11,9 @@ group :development do
 end
 
 group :test do
+	gem 'benchmark-ips'
+	gem 'ruby-prof'
+	
 	gem 'rack-test'
 	gem 'simplecov'
 	gem 'coveralls', require: false

data/README.md

@@ -74,6 +74,17 @@ Then, Nginx is configured like so:
 		rewrite ^ http://www.example.com$uri permanent;
 	}
 
+#### Compression
+
+We suggest [enabling gzip compression](https://zoompf.com/blog/2012/02/lose-the-wait-http-compression):
+
+	gzip on;
+	gzip_vary on;
+	gzip_comp_level 6;
+	gzip_http_version 1.1;
+	gzip_proxied any;
+	gzip_types text/* image/svg+xml application/json application/javascript;
+
 ## Usage
 
 Utopia builds on top of Rack with the following middleware:

data/benchmarks/hash_vs_openstruct.rb

@@ -0,0 +1,52 @@
+require 'benchmark/ips'
+require 'ostruct'
+
+# This benchmark compares accessing an instance variable vs accessing a struct member (via a function). The actual method dispatch is about 25% slower.
+
+puts "Ruby #{RUBY_VERSION} at #{Time.now}"
+
+NAME = "Test Name"
+EMAIL = "test@example.org"
+
+test = nil
+
+class ObjectHash
+	def []= key, value
+		instance_variable_set(key, value)
+	end
+	
+	def [] key
+		instance_variable_get(key)
+	end
+end
+
+# There IS a measuarble difference:
+Benchmark.ips do |x|
+	x.report("Hash") do |i|
+		i.times do
+			p = {name: NAME, email: EMAIL}
+			
+			test = p[:name] + p[:email]
+		end
+	end
+	
+	x.report("OpenStruct") do |i|
+		i.times do
+			p = OpenStruct.new(name: NAME, email: EMAIL)
+			
+			test = p.name + p.email
+	 end
+	end
+	
+	x.report("ObjectHash") do |i|
+		i.times do
+			o = ObjectHash.new
+			o[:@name] = NAME
+			o[:@email] = EMAIL
+			
+			test = o[:@name] + o[:@email]
+		end
+	end
+	
+	x.compare!
+end

data/benchmarks/struct_vs_class.rb

@@ -0,0 +1,89 @@
+require 'benchmark/ips'
+
+# This benchmark compares accessing an instance variable vs accessing a struct member (via a function). The actual method dispatch is about 25% slower.
+
+puts "Ruby #{RUBY_VERSION} at #{Time.now}"
+
+ItemsStruct = Struct.new(:items) do
+	def initialize
+		super []
+	end
+	
+	def push_me_pull_you(value = :x)
+		items = self.items
+		
+		items << value
+		items.pop
+	end
+	
+	def empty?
+		self.items.empty?
+	end
+end
+
+class ItemsClass
+	def initialize
+		@items = []
+	end
+	
+	def push_me_pull_you(value = :x)
+		items = @items
+		
+		items << value
+		items.pop
+	end
+	
+	def empty?
+		@items.empty?
+	end
+end
+
+# There IS a measuarble difference:
+Benchmark.ips do |x|
+	x.report("Struct#empty?") do |times|
+		i = 0
+		instance = ItemsStruct.new
+		
+		while i < times
+			break unless instance.empty?
+			i += 1
+		end
+	end
+	
+	x.report("Class#empty?") do |times|
+		i = 0
+		instance = ItemsClass.new
+		
+		while i < times
+			break unless instance.empty?
+			i += 1
+		end
+	end
+	
+	x.compare!
+end
+
+# This shows that in the presence of additional work, the difference is neglegible.
+Benchmark.ips do |x|
+	x.report("Struct#push_me_pull_you") do |times|
+		i = 0
+		a = A.new
+		
+		while i < times
+			a.push_me_pull_you(i)
+			i += 1
+		end
+	end
+	
+	x.report("Class#push_me_pull_you") do |times|
+		i = 0
+		b = B.new
+		
+		while i < times
+			b.push_me_pull_you(i)
+			i += 1
+		end
+	end
+	
+	x.compare!
+end

data/bin/utopia

@@ -20,14 +20,11 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'rubygems'
-require 'rake'
-
 require_relative '../lib/utopia/version'
 
+require 'rake'
 require 'fileutils'
 require 'find'
-require 'rake'
 
 $app = Rake.application = Rake::Application.new
 $app.init(File.basename($0))
@@ -61,7 +58,7 @@ desc "Create a local utopia instance which includes a basic website template.\n"
 task :create do
 	destination_root = File.expand_path(ARGV.last || '.', Dir.getwd)
 	
-	$stderr.puts "Setting up initial site in #{destination_root}..."
+	$stderr.puts "Setting up initial site in #{destination_root} for Utopia v#{Utopia::VERSION}..."
 	
 	Setup::Site::DIRECTORIES.each do |directory|
 		FileUtils.mkdir_p(File.join(destination_root, directory))
@@ -93,6 +90,8 @@ task :create do
 	end
 	
 	Dir.chdir(destination_root) do
+		puts "Setting up site in #{destination_root}..."
+		
 		if `which bundle`.strip != ''
 			puts "Generating initial package list with bundle..."
 			sh("bundle", "install", "--quiet")

data/lib/utopia.rb

@@ -26,6 +26,7 @@ require_relative 'utopia/localization'
 require_relative 'utopia/exceptions'
 require_relative 'utopia/redirection'
 require_relative 'utopia/static'
+require_relative 'utopia/content_length'
 
 require_relative 'utopia/tags/deferred'
 require_relative 'utopia/tags/environment'

data/lib/utopia/content.rb

@@ -57,22 +57,18 @@ module Utopia
 
 		attr :root
 
-		def fetch_xml(path)
+		def fetch_template(path)
 			if @template_cache
 				@template_cache.fetch_or_store(path.to_s) do
-					Trenni::Template.load(path)
+					Trenni::Template.load_file(path)
 				end
 			else
-				Trenni::Template.load(path)
+				Trenni::Template.load_file(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
-			
+		# This function looks up a named tag in a given path. It's a hotspot and needs improvement.
+		private def fetch_tag(name, parent_path)
 			if String === name && name.index('/')
 				name = Path.create(name)
 			end
@@ -84,26 +80,39 @@ module Utopia
 			else
 				name_path = name + XNODE_EXTENSION
 			end
-
-			parent_path.ascend do |dir|
-				tag_path = File.join(root, dir.components, name_path)
+			
+			components = parent_path.components.dup
+			
+			while components.any?
+				tag_path = File.join(root, components, name_path)
 
 				if File.exist? tag_path
-					return Node.new(self, dir + name, parent_path + name, tag_path)
+					return Node.new(self, Path[components] + name, parent_path + name, tag_path)
 				end
 
 				if String === name_path
-					tag_path = File.join(root, dir.components, '_' + name_path)
+					tag_path = File.join(root, components, '_' + name_path)
 
 					if File.exist? tag_path
-						return Node.new(self, dir + name, parent_path + name, tag_path)
+						return Node.new(self, Path[components] + name, parent_path + name, tag_path)
 					end
 				end
+				
+				components.pop
 			end
 			
 			return nil
 		end
 		
+		# Look up a named tag such as <entry />
+		def lookup_tag(name, parent_path)
+			if @tags.key? name
+				return @tags[name]
+			end
+			
+			return fetch_tag(name, parent_path)
+		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

data/lib/utopia/content/node.rb

@@ -107,14 +107,80 @@ module Utopia
 			end
 
 			def call(transaction, state)
-				xml_data = @controller.fetch_xml(@file_path).evaluate(transaction)
+				template = @controller.fetch_template(@file_path)
 				
-				transaction.parse_xml(xml_data)
+				context = Context.new(transaction, state)
+				markup = template.evaluate(context)
+				
+				transaction.parse_markup(markup)
 			end
 
 			def process!(request, response, attributes = {})
 				transaction = Transaction.new(request, response)
-				response.write(transaction.render_node(self, attributes))
+				output = transaction.render_node(self, attributes)
+				response.write(output)
+			end
+		end
+		
+		# This is a special context in which a limited set of well defined methods are exposed in the content view.
+		Node::Context = Struct.new(:transaction, :state) do
+			def initialize(transaction, state)
+				# We expose all attributes as instance variables within the context:
+				state.attributes.each do |key, value|
+					self.instance_variable_set("@#{key}".to_sym, value)
+				end
+				
+				super
+			end
+			
+			def partial(*args, &block)
+				if block_given?
+					state.defer(&block)
+				else
+					state.defer do |transaction|
+						transaction.tag(*args)
+					end
+				end
+			end
+			
+			alias deferred_tag partial
+			
+			def controller
+				transaction.controller
+			end
+			
+			def localization
+				transaction.localization
+			end
+			
+			def request
+				transaction.request
+			end
+			
+			def response
+				transaction.response
+			end
+			
+			def attributes
+				state.attributes
+			end
+			
+			def [] key
+				state.attributes.fetch(key) {transaction.attributes[key]}
+			end
+			
+			alias current state
+			
+			def content
+				transaction.content
+			end
+
+			def parent
+				transaction.parent
+			end
+
+			def first
+				transaction.first
 			end
 		end
 	end

data/lib/utopia/content/processor.rb

@@ -25,11 +25,34 @@ require_relative 'tag'
 
 module Utopia
 	class Content
+		class SymbolicHash < Hash
+			def [] key
+				raise KeyError.new("attribute #{key} is a string, prefer a symbol") if key.is_a? String
+				super key.to_sym
+			end
+			
+			def []= key, value
+				super key.to_sym, value
+			end
+			
+			def fetch(key, *args, &block)
+				key = key.to_sym
+				
+				super
+			end
+			
+			def include? key
+				key = key.to_sym
+				
+				super
+			end
+		end
+		
 		class Processor
-			def self.parse_xml(xml_data, delegate)
+			def self.parse_markup(markup, delegate)
 				processor = self.new(delegate)
 				
-				processor.parse(xml_data)
+				processor.parse(markup)
 			end
 
 			class UnbalancedTagError < StandardError
@@ -73,6 +96,10 @@ module Utopia
 			def begin_parse(scanner)
 				@scanner = scanner
 			end
+			
+			def doctype(attributes)
+				@delegate.cdata("<!DOCTYPE#{attributes}>")
+			end
 
 			def text(text)
 				@delegate.cdata(text)
@@ -83,12 +110,12 @@ module Utopia
 			end
 
 			def comment(text)
-				@delegate.cdata("<!#{text}>")
+				@delegate.cdata("<!--#{text}-->")
 			end
 
 			def begin_tag(tag_name, begin_tag_type)
 				if begin_tag_type == :opened
-					@stack << [Tag.new(tag_name, {}), @scanner.pos]
+					@stack << [Tag.new(tag_name, SymbolicHash.new), @scanner.pos]
 				else
 					current_tag, current_position = @stack.pop
 			
@@ -116,7 +143,7 @@ module Utopia
 			end
 
 			def attribute(name, value)
-				@stack.last[0].attributes[name] = value
+				@stack.last[0].attributes[name.to_sym] = value
 			end
 
 			def instruction(content)