utopia 1.9.11 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d1fd4dea2d181c046c412089844360517e6f423
-  data.tar.gz: 2a778d65e0224bdb6415e5db6c3967e417913749
+  metadata.gz: 944c3e8fb35114656d9bf4f5628d6c4ecf569015
+  data.tar.gz: b34c396bc981f396faee6d49ace329141d3c5d20
 SHA512:
-  metadata.gz: 460ef64a197ce840c44b42cc0239249fc003e039daa5cec56b8676882b3a5b63e1b7d7a433c20f5a01a7d62f2117a46887f871267265091205d07bc44725d453
-  data.tar.gz: c26adcc4d5cba8e030ed842e6d329caec9f118565e328520135b635641cee559a67726dc459371c57f71c41f792f5f23751de0f26016112c3c341bbb1ebf8556
+  metadata.gz: 969bb2a0804488b5f72ea3b1d5652a5219cd1f865a6e3652dcb3bd0794f67de48b1d0ddaf8f2df4796ccc396b92b85d0205ed1e8c800528857b3edb28de22a42
+  data.tar.gz: '022596c8e3262206412bd534e3c78fbeb127f310081381971e2567e51a42a7af91b6a64d60bb78226b940280fe0e274787c98352462081bcfc3c3edf76f2ac09'

data/.codeclimate.yml

@@ -1,3 +1,4 @@
 exclude_paths:
-- "documentation"
-- "setup"
+- "documentation/**/*"
+- "setup/**/*"
+- "benchmarks/*"

data/.gitignore

@@ -15,4 +15,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-.tags*
+.tags*
+documentation/run/*
+documentation/public/code/*
+.rspec_status

data/.rspec

@@ -1,4 +1,5 @@
 --color
 --format documentation
 --backtrace
+--require spec_helper
 --warnings

data/.travis.yml

@@ -1,5 +1,7 @@
 language: ruby
 sudo: false
+dist: trusty
+cache: bundler
 before_install:
   # For testing purposes:
   - git config --global user.email "samuel@oriontransfer.net"
@@ -8,6 +10,7 @@ rvm:
   - 2.2.4
   - 2.3.2
   - 2.4.0
+  - jruby-head
   - ruby-head
   - rbx-3.65
 env: COVERAGE=true BENCHMARK=true
@@ -15,3 +18,4 @@ matrix:
   allow_failures:
     - rvm: rbx-3.65
     - rvm: ruby-head
+    - rvm: jruby-head

data/.yardopts

@@ -0,0 +1,2 @@
+--markup markdown
+--asset materials:materials

data/Gemfile

@@ -7,16 +7,23 @@ group :development do
 	gem 'pry'
 	gem 'pry-coolline'
 	
+	gem 'yard'
+	
 	gem 'kramdown'
 	
 	gem 'json'
+	gem 'msgpack'
 end
 
 group :test do
 	gem 'benchmark-ips'
-	gem 'ruby-prof'
+	gem 'ruby-prof', platforms: :mri
+	
+	gem 'guard-puma'
 	
 	gem 'rack-test'
+	gem 'rack-freeze', '~> 1.2'
+	
 	gem 'simplecov'
 	gem 'coveralls', require: false
 end

data/README.md

@@ -1,4 +1,4 @@
-# ![Utopia](materials/utopia.png?raw=true)
+# ![Utopia Logo](materials/utopia.png?raw=true)
 
 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 functions for interacting with files and directories as structure representing the website.
 
@@ -45,7 +45,7 @@ There is an excellent documentation wiki included with the source code. Simply c
 
 Released under the MIT license.
 
-Copyright, 2015, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
+Copyright, 2017, 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

@@ -1,17 +1,17 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec) do |task|
-	begin
-		require('simplecov/version')
-		task.rspec_opts = %w{--require simplecov} if ENV['COVERAGE']
-	rescue LoadError
-	end
-end
+RSpec::Core::RakeTask.new(:test)
 
 task :documentation do
-	sh('bundle install')
-	sh('cd documentation && rake')
+	sh('yard', '-o', "documentation/public/code")
+	
+	Bundler.with_clean_env do	
+		Dir.chdir('documentation') do
+			sh('bundle', 'install', '--quiet')
+			sh('bundle', 'exec', 'rake')
+		end
+	end
 end
 
-task :default => :spec
+task :default => :test

data/benchmarks/call_vs_check.rb

@@ -0,0 +1,36 @@
+require 'benchmark/ips'
+
+class A
+end
+
+class B
+	def self.do
+	end
+end
+
+class C
+	def self.do
+	end
+end
+
+Benchmark.ips do |x|
+	x.report("responds_to? (nothing)") do |times|
+		while (times -= 1) >= 0
+			A.do if A.respond_to?(:do)
+		end
+	end
+	
+	x.report("B (empty method)") do |times|
+		while (times -= 1) >= 0
+			B.do
+		end
+	end
+	
+	x.report("responds_to? (empty method)") do |times|
+		while (times -= 1) >= 0
+			C.do if C.respond_to?(:do)
+		end
+	end
+	
+	x.compare!
+end

data/benchmarks/const_vs_hash.rb

@@ -0,0 +1,33 @@
+require 'benchmark/ips'
+
+module Foo
+	class Bar
+	end
+end
+
+
+THINGS = {
+	'Bar' => Foo::Bar
+}
+
+Benchmark.ips do |x|
+	x.report("const_get('Bar')") do |i|
+		while (i -= 1) > 0
+			Foo.const_get('Bar')
+		end
+	end
+
+	x.report("const_get(:Bar)") do |i|
+		while (i -= 1) > 0
+			Foo.const_get(:Bar)
+		end
+	end
+
+	x.report("Hash\#[]") do |i|
+		while (i -= 1) > 0
+			THINGS['Bar']
+		end
+	end
+	
+	x.compare!
+end

data/documentation/Gemfile

@@ -3,6 +3,8 @@ source "https://rubygems.org"
 
 gem "utopia", path: File.expand_path("../", __dir__)
 
+gem "rack-freeze", "~> 1.2"
+
 gem "rake"
 gem "bundler"
 
@@ -11,6 +13,7 @@ gem "kramdown"
 group :development do
 	# For `rake server`:
 	gem "puma"
+	gem "guard-puma"
 	
 	# For `rake console`:
 	gem "pry"
@@ -19,6 +22,8 @@ group :development do
 	# For `rspec` testing:
 	gem "rspec"
 	gem "simplecov"
+	
+	gem "launchy"
 end
 
 group :production do

data/documentation/Guardfile

@@ -0,0 +1,20 @@
+
+group :development do
+	guard :puma, port: 4000 do
+		watch('Gemfile.lock')
+		watch('config.ru')
+		watch(%r{^config|lib|pages/.*})
+	end
+	
+	# Open the documentation website when the command is run, once puma has started:
+	require 'launchy'
+	$first_time = true
+	
+	url_path = 'run/url.txt'
+	watch(url_path) do
+		if $first_time
+			$first_time = false
+			Launchy.open(File.read(url_path))
+		end
+	end
+end

data/documentation/config.ru

@@ -2,6 +2,8 @@
 
 require_relative 'config/environment'
 
+require 'rack/freeze'
+
 if RACK_ENV == :production
 	# Handle exceptions in production with a error page and send an email notification:
 	use Utopia::Exceptions::Handler
@@ -19,7 +21,7 @@ use Rack::Sendfile
 use Utopia::ContentLength
 
 use Utopia::Redirection::Rewrite,
-	'/' => '/welcome/index'
+	'/' => '/wiki/index'
 
 use Utopia::Redirection::DirectoryIndex
 
@@ -29,22 +31,13 @@ use Utopia::Redirection::Errors,
 use Utopia::Localization,
 	:default_locale => 'en',
 	:locales => ['en', 'de', 'ja', 'zh'],
-	:nonlocalized => ['/_static/', '/_cache/']
+	:ignore => ['/_static/', '/_cache/']
 
-use Utopia::Controller,
-	cache_controllers: (RACK_ENV == :production),
-	base: Utopia::Controller::Base
+use Utopia::Controller
 
 use Utopia::Static
 
 # Serve dynamic content
-use Utopia::Content,
-	cache_templates: (RACK_ENV == :production),
-	tags: {
-		'deferred' => Utopia::Tags::Deferred,
-		'override' => Utopia::Tags::Override,
-		'node' => Utopia::Tags::Node,
-		'environment' => Utopia::Tags::Environment.for(RACK_ENV)
-	}
+use Utopia::Content
 
 run lambda { |env| [404, {}, []] }

data/documentation/config/puma.rb

@@ -0,0 +1,20 @@
+
+# Configure "min" to be the minimum number of threads to use to answer
+# requests and "max" the maximum.
+threads 0,4
+
+# Preload the application before starting the workers; this conflicts with
+# phased restart feature. (off by default)
+preload_app!
+
+# This writes run/url.txt which allows us to watch and load the URL once puma has started.
+get(:binds).tap do |binds|
+	urls = binds.grep(/tcp:\/\/0.0.0.0:(\d+)/).collect do
+		"http://localhost:#{$1}"
+	end
+	
+	run_path = File.expand_path('../run', __dir__)
+	
+	FileUtils.mkdir_p run_path
+	File.write(File.join(run_path, 'url.txt'), urls.first)
+end

data/documentation/pages/_editor.xnode

@@ -0,0 +1,64 @@
+<!DOCTYPE html>
+<html>
+	<head>
+		<?r response.do_not_cache! ?>
+		
+		<?r if title = self[:title] ?>
+			<title>Editing #{title.gsub(/<.*?>/, "")}</title>
+		<?r else ?>
+			<title>Utopia</title>
+		<?r end ?>
+		
+		<link rel="icon" type="image/png" href="/_static/icon.png" />
+		<link rel="stylesheet" href="/_static/site.css" type="text/css" media="screen" />
+		
+		<script src="/_components/jquery/jquery.min.js"></script>
+		
+		<style type="text/css">
+			.editor form {
+				position: absolute;
+				
+				display: flex;
+				flex-direction: column;
+				align-items: center;
+				
+				width: 100%;
+				height: 100%;
+			}
+			
+			.editor .header {
+				flex-grow: 0;
+				width: 100%;
+				
+				display: flex;
+				justify-content: space-between;
+				align-items: center;
+				
+				box-shadow: 0px 1px 0.5rem rgba(0, 0, 0, 0.5);
+				z-index: 10;
+			}
+			
+			.editor .header * {
+				margin: 0.5rem;
+			}
+			
+			.editor textarea {
+				flex-grow: 1;
+				width: 100%;
+
+				resize: none;
+				outline: none;
+				
+				box-sizing: border-box;
+				margin: 0; padding: 0.5rem;
+				
+				border: none;
+				background: none;
+			}
+		</style>
+	</head>
+
+	<body class="editor">
+		<utopia:content/>
+	</body>
+</html>

data/documentation/pages/_heading.xnode

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

data/documentation/pages/_page.xnode

@@ -1,7 +1,6 @@
 <!DOCTYPE html>
 <html>
 	<head>
-		<?r response.content_type = "text/html; charset=utf-8" ?>
 		<?r response.cache! ?>
 		
 		<?r if title = self[:title] ?>
@@ -33,7 +32,7 @@
 		</header>
 
 		<div id="page">
-			<content />
+			<utopia:content/>
 		</div>
 	</body>
 </html>

data/documentation/pages/errors/exception.xnode

@@ -1,5 +1,5 @@
-<page>
-	<heading>Exception</heading>
+<content:page>
+	<content:heading>Exception</content:heading>
 	
 	<p>It seems like something didn't quite work out as expected!</p>
-</page>
+</content:page>

data/documentation/pages/errors/file-not-found.xnode

@@ -1,5 +1,5 @@
-<page>
-	<heading>File Not Found</heading>
+<content:page>
+	<content:heading>File Not Found</content:heading>
 	
 	<p>The file you requested is unfortunately not available at this time!</p>
-</page>
+</content:page>

data/documentation/pages/wiki/bower-integration/content.md

@@ -22,4 +22,4 @@ Then add the appropriate `<script>` tags to `pages/_page.xnode`:
 
 This task copies only the contents of the dist directory. This ensures that you only get files intended for distribution. If the bower package doesn't have a `dist` directory, the entire contents is copied.
 
-<listing rel="site" src="tasks/bower.rake" brush="ruby" />
+<fragment:listing rel="site" src="tasks/bower.rake" brush="ruby" />

data/documentation/pages/wiki/content.md

@@ -1,6 +1,6 @@
 # Utopia Documentation Wiki
 
-This wiki includes documentation and examples showing how to use Utopia.
+This wiki includes documentation and examples showing how to use Utopia. You can also browse the [code documentation](/code/index.html) for more detail.
 
 ## Introduction Guide
 
@@ -8,9 +8,10 @@ Reading these pages in order will give you an overview of the design of Utopia,
 
 - [Development Environment Setup](development-environment-setup/)
 - [Server Setup](server-setup/)
-- [Your first page](your-first-page/)
+- [Your First Page](your-first-page/)
 - [Installing JavaScript Libraries](bower-integration/)
 - [Website Tests](testing/)
+- [Updating Your Site](updating-utopia/)
 
 ## Middleware
 
@@ -18,10 +19,7 @@ Reading these pages in order will give you an overview of the design of Utopia,
 - [Redirection](middleware/redirection/) — Redirect URL patterns and status codes.
 - [Localization](middleware/localization/) — Non-intrusive localization of resources.
 - [Controller](middleware/controller/) — Flexible nested controllers with efficient behaviour. 
+  - [Controller Actions](middleware/controller/actions/) — Invoke named actions.
+  - [Controller Rewrite](middleware/controller/rewrite/) — Pattern match requests.
 - [Content](middleware/content/) — XML-style template engine with dynamic markup.
-- [Session](middleware/session/) — Session storage using encrypted client-side cookies.
-
-## Controller Layers
-
-- [Controller Actions](controller/actions/)
-- [Controller Rewrite](controller/rewrite/)
+- [Session](middleware/session/) — Session storage using encrypted client-side cookies.