utopia 1.8.3 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5095d35222a513f2daa3c4b93e1a03490fa89654
-  data.tar.gz: 6d71788ce9d2d1cd24e65ccb1314946e3d2c692f
+  metadata.gz: 92b8e6466b0a5eea4cb1e6009734e9cea5c76160
+  data.tar.gz: 9854cb98bf4f4ac5794fe19370c3af2e28aec456
 SHA512:
-  metadata.gz: 6ba7fadd9730016d29fdefb2ff26ca2911867daa811290bd40a76f7cd640af4ea534e3ab8f040f97fc75b1f445bb81cf133295a77d9bf4a5c519014c077299a4
-  data.tar.gz: cc97dcf681d73a609e2adfd1d6422403340a2708e0763f1229ec34d4bc7ddd67e1491932da42c9df801f719ada966432068092a5437a8c0a51eca122847dcd4b
+  metadata.gz: fdc050063c8b3b7ece0d94ee388fec013f52adc0cc2f63f92a7e4bb94eb849a8ecbfb41664a183047475adc88f5959b019077edc5cdbb9061eb8b8a8057a2a60
+  data.tar.gz: 781fe07c015abd3d777f2b4cd0340d43deee4846ca05ec2171c882569bd56add14604cc54ae5276b414dc778be77d2be7c86e90835a4793abb1df52b462b4117

data/Gemfile

@@ -7,6 +7,8 @@ group :development do
 	gem 'pry'
 	gem 'pry-coolline'
 	
+	gem 'kramdown'
+	
 	gem 'json'
 end
 

data/documentation/.bowerrc

@@ -0,0 +1,4 @@
+{
+  "directory" : "public/_static/components"
+}
+

data/documentation/.rspec

@@ -0,0 +1,4 @@
+--color
+--format documentation
+--backtrace
+--warnings

data/documentation/Gemfile

@@ -0,0 +1,27 @@
+
+source "https://rubygems.org"
+
+gem "utopia", path: File.expand_path("../", __dir__)
+
+gem "rake"
+gem "bundler"
+
+gem "kramdown"
+
+group :development do
+	# For `rake server`:
+	gem "puma"
+	
+	# For `rake console`:
+	gem "pry"
+	gem "rack-test"
+	
+	# For `rspec` testing:
+	gem "rspec"
+	gem "simplecov"
+end
+
+group :production do
+	# Used for passenger-config to restart server after deployment:
+	gem "passenger"
+end

data/documentation/Rakefile

@@ -0,0 +1,5 @@
+
+# Load all rake tasks:
+import(*Dir.glob('tasks/*.rake'))
+
+task :default => :server

data/documentation/config.ru

@@ -0,0 +1,50 @@
+#!/usr/bin/env rackup
+
+require_relative 'config/environment'
+
+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
+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
+
+use Utopia::ContentLength
+
+use Utopia::Redirection::Rewrite,
+	'/' => '/welcome/index'
+
+use Utopia::Redirection::DirectoryIndex
+
+use Utopia::Redirection::Errors,
+	404 => '/errors/file-not-found'
+
+use Utopia::Localization,
+	:default_locale => 'en',
+	:locales => ['en', 'de', 'ja', 'zh'],
+	:nonlocalized => ['/_static/', '/_cache/']
+
+use Utopia::Controller,
+	cache_controllers: (RACK_ENV == :production),
+	base: Utopia::Controller::Base
+
+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)
+	}
+
+run lambda { |env| [404, {}, []] }

data/documentation/config/README.md

@@ -0,0 +1,7 @@
+# Utopia Config
+
+This directory contains `environment.rb` which is used to initialize the running environment for tasks and servers.
+
+## Setting Environment Variables
+
+If you wish to set environment variables on a per-deployment basis, you can do so by creating an `config/environment.yaml` and populating it with key-value pairs.

data/documentation/config/environment.rb

@@ -0,0 +1,10 @@
+
+require 'bundler/setup'
+Bundler.setup
+
+require 'utopia/setup'
+Utopia.setup
+
+RACK_ENV = ENV.fetch('RACK_ENV', :development).to_sym unless defined? RACK_ENV
+
+require 'kramdown'

data/documentation/lib/readme.txt

@@ -0,0 +1 @@
+You can add additional code for your application in this directory, and require it directly from the config.ru.

data/documentation/pages/_heading.xnode

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

data/documentation/pages/_page.xnode

@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html>
+	<head>
+		<?r response.content_type = "text/html; charset=utf-8" ?>
+		<?r response.cache! ?>
+		
+		<?r if title = self[:title] ?>
+			<title>#{title.gsub(/<.*?>/, "")} - Utopia</title>
+		<?r else ?>
+			<title>Utopia</title>
+		<?r end ?>
+		
+		<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous" />
+		
+		<link rel="icon" type="image/png" href="/_static/icon.png" />
+		<link rel="stylesheet" href="/_static/site.css" type="text/css" media="screen" />
+	</head>
+
+	<body class="#{attributes[:class]}">
+		<header>
+			<img src="/_static/utopia.svg" />
+		</header>
+
+		<div id="page">
+			<content />
+		</div>
+	</body>
+</html>

data/documentation/pages/errors/exception.xnode

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

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

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

data/documentation/pages/links.yaml

@@ -0,0 +1,2 @@
+errors:
+    display: false

data/documentation/pages/welcome/index.xnode

@@ -0,0 +1,41 @@
+<page class="front">
+	<heading>Welcome to Utopia...</heading>
+	
+	<section class="features">
+		<div>
+			<i class="fa fa-bolt"></i>
+			<h2>Low latency and high throughput</h2>
+			<p>Utopia has been carefully tuned for low-latency and algorithmic efficiency. During development, requests reload the entire stack, while in production everything is cached using <a href="http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/Map.html">thread-safe data-structures</a>. Serve thousands of requests per second with ease.</p>
+		</div>
+		
+		<div>
+			<i class="fa fa-cubes"></i>
+			<h2>Modular code and structure</h2>
+			<p>Utopia provides independently useful <a href="https://github.com/rack/rack">Rack</a> middleware and has been designed with simplicify in mind. Several fully-featured webapps and a ton of commercial websites have guided the development of the Utopia stack. It is capable of handling a diverse range of requirements.</p>
+		</div>
+		
+		<div>
+			<i class="fa fa-code"></i>
+			<h2>Well tested and maintained</h2>
+			<p>Utopia comprises a <a href="https://github.com/ioquatix/utopia">core gem</a> and several supporting libraries, the main ones being <a href="https://github.com/ioquatix/trenni">trenni</a> for templates and parsing, and <a href="https://github.com/ioquatix/http-accept">http-accept</a> for HTTP header processing. Together, these gems have over 90% test coverage.</p>
+		</div>
+		
+		<div>
+			<i class="fa fa-server"></i>
+			<h2>Batteries included</h2>
+			<p>Utopia includes both a recommended development model and a server deployment model out of the box. This is exposed via the <code>utopia</code> command. We recommend use of <a href="https://www.nginx.com">Nginx</a> and <a href="https://www.phusionpassenger.com">Passenger</a> for server side deployment.</p>
+		</div>
+		
+		<div>
+			<i class="fa fa-globe"></i>
+			<h2>Standards compliant localization</h2>
+			<p>Utopia supports the <code>Accept-Language</code> header and transparently selects the correct view to render. Build multi-lingual websites and webapps easily: translate content incrementally as required, or not at all.</p>
+		</div>
+	</section>
+	
+	<section>
+		<h2>Documentation</h2>
+		
+		<p>For up-to-date documentation, please browse the included <a href="/wiki/">wiki</a>. Feel free to improve it and submit a PR :)</p>
+	</section>
+</page>

data/documentation/pages/wiki/content.md

@@ -0,0 +1,7 @@
+# Welcome to Utopia
+
+This wiki includes documentation and examples showing how to use Utopia.
+
+- [Development Environment Setup](development-environment-setup/)
+- [Server Setup](server-setup/)
+- [Your first page](your-first-page/)

data/{setup/examples → documentation/pages}/wiki/controller.rb

@@ -4,18 +4,20 @@ prepend Actions
 on '**' do |request, path|
 	@page_path = path.components[0..-2]
 	
-	if @page_path.empty?
-		goto! "welcome/index"
-	end
-	
 	@page_file = File.join(BASE_PATH, @page_path, "content.md")
-	@page_title = Trenni::Strings::to_title @page_path.last
+	
+	if last_path_component = @page_path.last
+		@page_title = Trenni::Strings::to_title(last_path_component)
+	else
+		@page_title = "Wiki"
+	end
 end
 
 def read_contents
 	if File.exist? @page_file
 		File.read(@page_file)
 	else
+		"\# #{@page_title}\n\n" +
 		"This page is empty."
 	end
 end
@@ -37,5 +39,5 @@ end
 on '**/index' do |request, path|
 	@content = read_contents
 	
-	path.components = ["index"]
+	path.components = ["show"]
 end

data/documentation/pages/wiki/development-environment-setup/content.md

@@ -0,0 +1,14 @@
+# Development Environment Setup
+
+Utopia is built on Ruby and Rack. Therefore, Ruby (suggested 2.0+) should be installed and working. Then, simply run:
+
+	$ gem install utopia
+
+To install all required dependencies.
+
+Utopia and it's dependencies are built on Linux and Mac by default, and therefore compatibility with Windows is not guaranteed.
+
+## Atom Integration
+
+Utopia uses [Trenni](https://github.com/ioquatix/trenni) for templates and it has a syntax slightly different from ERB. However, there is a [package for Atom](https://atom.io/packages/language-trenni) which provides accurate syntax highlighting.
+

data/{setup/examples → documentation/pages}/wiki/edit.xnode

@@ -5,7 +5,7 @@
 	<form action="#" method="post">
 		<fieldset>
 			<legend>Page Content</legend>
-			<textarea name="content">#{Strings::to_html self[:content]}</textarea>
+			<textarea name="content">#{self[:content]}</textarea>
 		</fieldset>
 		
 		<fieldset class="footer">

data/documentation/pages/wiki/server-setup/content.md

@@ -0,0 +1,40 @@
+# Server Setup
+
+The best deployment platform for Utopia is Linux. Specifically, [Arch Linux](https://www.archlinux.org/) with the following packages:
+
+- [nginx-mainline-passenger](https://aur.archlinux.org/packages/nginx-mainline-passenger/)
+- [passenger-nginx-module](https://aur.archlinux.org/packages/passenger-nginx-module/)
+
+There have been issues with the official packages and thus these packages were developed and tested with Utopia deployment in mind.
+
+## Sample Nginx Configuration
+
+Create a configuration file for your site, e.g. `/etc/nginx/sites/www.example.com`:
+
+	server {
+		listen 80;
+		server_name www.example.com;
+		root /srv/http/www.example.com/public;
+		passenger_enabled on;
+	}
+
+	server {
+		listen 80;
+		server_name example.com;
+		rewrite ^ http://www.example.com$uri permanent;
+	}
+
+## Deployment via Git
+
+The preferred method of deployment to a production server is via git. The `utopia` command assists with setup of a remote git repository on the server. It will setup a `git` `post-update` hook which will deploy the site correctly and restart passenger for that site.
+
+To setup a server for deployment:
+
+	$ mkdir /srv/http/www.example.com
+	$ cd /srv/http/www.example.com
+	$ sudo -u http utopia server create
+
+On your development machine, you should setup the git remote:
+
+	$ git remote add production ssh://remote/srv/http/www.example.com
+	$ git push --set-upstream production master

data/documentation/pages/wiki/show.xnode

@@ -0,0 +1,12 @@
+<page>
+	<?r 
+		transaction.attributes[:title] ||= @page_title
+	?>
+	
+	#{MarkupString.raw Kramdown::Document.new(self[:content]).to_html}
+	
+	<footer>
+		Last Modified: #{File.mtime(self[:page_file]) rescue "N/A"} &mdash;
+		<a href="edit">Edit</a>
+	</footer>
+</page>

data/documentation/pages/wiki/your-first-page/content.md

@@ -0,0 +1,31 @@
+# Your First Page
+
+To setup the default site, simply create a directory and use the `utopia` command:
+
+	$ mkdir www.example.com
+	$ cd www.example.com
+	$ utopia site create
+	$ rake server
+
+You will now have a basic template site running on http://localhost:9292.
+
+## Welcome Page
+
+Utopia includes a redirection middleware to redirect all root-level requests to a given URI. The default being `/welcome/index`:
+
+	use Utopia::Redirection::Rewrite,
+		'/' => '/welcome/index'
+
+This page includes a basic overview of Utopia. Most of it's standard HTML, except for the outer `<page>` tag. Utopia uses the name `page` to lookup the file-system hierarchy. First, it looks for `/welcome/_page.xnode`, and then it looks for `/_page.xnode` which it finds. This page template includes a tag `<content/>` which is replaced with the inner body of the `<page>` tag. This recursive lookup is the heart of Utopia.
+
+## Links
+
+Utopia is a content-centric web application platform. It leverages the file-system to provide a mapping between logical resources and files on disk. The primary mode of mapping incoming requests to specific nodes (content) is done using the `links.yaml` file.
+
+The links file associates metadata with node names for a given directory. This can include things like redirects, titles, descriptions, etc. You can add any metadata you like, to support your specific use-case. The primary use of the links files is to provide site structure, e.g. menus. In addition, they can function as a rudimentary data-store for static information, e.g. a list of applications (each with it's own page), a list of features, etc.
+
+You'll notice that there is a file `/links.yaml`. This file contains important metadata relating to the `errors` subdirectory. As we don't want these nodes showing up in a top level menu, we mark them as `display: false`
+
+	errors:
+	    display: false 
+

data/documentation/public

@@ -0,0 +1 @@
+../setup/site/public

data/documentation/spec/website_context.rb

@@ -0,0 +1,11 @@
+
+require 'rack/test'
+
+RSpec.shared_context "website" do
+	include Rack::Test::Methods
+	
+	let(:rackup_path) {File.expand_path('../config.ru', __dir__)}
+	let(:rackup_directory) {File.dirname(rackup_path)}
+	
+	let(:app) {Rack::Builder.parse_file(rackup_path).first}
+end

data/documentation/spec/website_spec.rb

@@ -0,0 +1,15 @@
+
+require_relative 'website_context'
+
+# Learn about best practice specs from http://betterspecs.org
+RSpec.describe "my website" do
+	include_context "website"
+	
+	it "should have an accessible front page" do
+		get "/"
+		
+		follow_redirect!
+		
+		expect(last_response.status).to be == 200
+	end
+end

data/documentation/tasks/test.rake

@@ -0,0 +1,10 @@
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:test) do |task|
+	task.rspec_opts = %w{--require simplecov} if ENV['COVERAGE']
+end
+
+task :coverage do
+	ENV['COVERAGE'] = 'y'
+end