utopia 1.9.11 → 2.0.0

data/lib/utopia/redirection.rb

@@ -23,6 +23,7 @@ require_relative 'middleware'
 module Utopia
 	# A middleware which assists with redirecting from one path to another.
 	module Redirection
+		# An error handler fails to redirect to a valid page.
 		class RequestFailure < StandardError
 			def initialize(resource_path, resource_status, error_path, error_status)
 				@resource_path = resource_path
@@ -35,30 +36,26 @@ module Utopia
 			end
 		end
 		
+		# A middleware which performs internal redirects based on error status codes.
 		class Errors
-			# Maps an error code to a given string
+			# @param codes [Hash<Integer,String>] The redirection path for a given error code.
 			def initialize(app, codes = {})
-				@codes = codes
-				
 				@app = app
+				@codes = codes
 			end
 			
 			def freeze
+				return self if frozen?
+				
 				@codes.freeze
 				
 				super
 			end
 			
-			CONTENT_TYPE = 'Content-Type'.freeze
-			
-			def unhandled_error?(response)
-				response[0] >= 400 && !response[1].include?(CONTENT_TYPE)
-			end
-			
 			def call(env)
 				response = @app.call(env)
 				
-				if unhandled_error?(response) && location = @codes[response[0]]
+				if response[0] >= 400 and location = @codes[response[0]]
 					error_request = env.merge(Rack::PATH_INFO => location, Rack::REQUEST_METHOD => Rack::GET)
 					error_response = @app.call(error_request)
 
@@ -75,15 +72,10 @@ module Utopia
 			end
 		end
 		
-		class FileNotFound < Errors
-			def initialize(uri = '/errors/file-not-found')
-				super(404 => uri)
-			end
-		end
-		
 		# We cache 301 redirects for 24 hours.
 		DEFAULT_MAX_AGE = 3600*24
 		
+		# A basic client-side redirect.
 		class ClientRedirect
 			def initialize(app, status: 307, max_age: DEFAULT_MAX_AGE)
 				@app = app
@@ -92,6 +84,8 @@ module Utopia
 			end
 			
 			def freeze
+				return self if frozen?
+				
 				@status.freeze
 				@max_age.freeze
 				
@@ -129,6 +123,7 @@ module Utopia
 			end
 		end
 		
+		# Redirect urls that end with a `/`, e.g. directories.
 		class DirectoryIndex < ClientRedirect
 			def initialize(app, index: 'index')
 				@app = app
@@ -144,6 +139,7 @@ module Utopia
 			end
 		end
 		
+		# Rewrite requests that match the given pattern to a single destination.
 		class Rewrite < ClientRedirect
 			def initialize(app, patterns, status: 301)
 				@patterns = patterns
@@ -158,6 +154,7 @@ module Utopia
 			end
 		end
 		
+		# Rewrite requests that match the given pattern to a new prefix.
 		class Moved < ClientRedirect
 			def initialize(app, pattern, prefix, status: 301, flatten: false)
 				@app = app

data/lib/utopia/session.rb

@@ -25,8 +25,10 @@ require 'digest/sha2'
 require_relative 'session/lazy_hash'
 
 module Utopia
-	# Stores all session data client side using a private symmetric encrpytion key.
+	# A middleware which provides a secure client-side session storage using a private symmetric encrpytion key.
 	class Session
+		SECRET_KEY = 'UTOPIA_SESSION_SECRET'.freeze
+		
 		RACK_SESSION = "rack.session".freeze
 		CIPHER_ALGORITHM = "aes-256-cbc"
 		
@@ -36,22 +38,26 @@ module Utopia
 		# At least, the session will be updated every 1 hour:
 		DEFAULT_UPDATE_TIMEOUT = 3600
 		
-		def initialize(app, session_name: nil, secret: nil, expires_after: nil, update_timeout: nil, **options)
+		# @param session_name [String] The name of the session cookie.
+		# @param secret [Array] The secret text used to generate a symetric encryption key for the coookie data.
+		# @param expires_after [String] The cache-control header to set for static content.
+		# @param options [Hash<Symbol,Object>] Additional defaults used for generating the cookie by `Rack::Utils.set_cookie_header!`.
+		def initialize(app, session_name: RACK_SESSION, secret: nil, expires_after: DEFAULT_EXPIRES_AFTER, update_timeout: DEFAULT_UPDATE_TIMEOUT, **options)
 			@app = app
 			
-			@session_name = session_name || RACK_SESSION
+			@session_name = session_name
 			@cookie_name = @session_name + ".encrypted"
 			
 			if secret.nil? or secret.empty?
 				secret = SecureRandom.hex(32)
-				warn "#{self.class} secret is #{secret.inspect}, generating transient secret key!"
+				warn "#{self.class} secret is #{secret.inspect}, generating transient secret key!" if $VERBOSE
 			end
 			
 			# This generates a 32-byte key suitable for aes.
 			@key = Digest::SHA2.digest(secret)
 			
-			@expires_after = expires_after || DEFAULT_EXPIRES_AFTER
-			@update_timeout = update_timeout || DEFAULT_UPDATE_TIMEOUT
+			@expires_after = expires_after
+			@update_timeout = update_timeout
 			
 			@cookie_defaults = {
 				domain: nil,
@@ -72,6 +78,8 @@ module Utopia
 		attr :cookie_defaults
 		
 		def freeze
+			return self if frozen?
+			
 			@cookie_name.freeze
 			@key.freeze
 			@expires_after.freeze

data/lib/utopia/setup.rb

@@ -19,6 +19,7 @@
 # THE SOFTWARE.
 
 module Utopia
+	# Used for setting up a Utopia web application, typically via `config/environment.rb`
 	class Bootstrap
 		def initialize(config_root, external_encoding: Encoding::UTF_8)
 			@config_root = config_root
@@ -44,7 +45,7 @@ module Utopia
 		def setup_encoding
 			# TODO: Deprecate and remove this setup - it should be the responsibility of the server to set this correctly.
 			if @external_encoding and Encoding.default_external != @external_encoding
-				warn "Updating Encoding.default_external from #{Encoding.default_external} to #{@external_encoding}"
+				warn "Updating Encoding.default_external from #{Encoding.default_external} to #{@external_encoding}" if $VERBOSE
 				Encoding.default_external = @external_encoding
 			end
 		end
@@ -69,6 +70,7 @@ module Utopia
 		end
 	end
 	
+	# The main entry point for `config/environment.rb` for setting up the site.
 	def self.setup(config_root = nil, **options)
 		# We extract the directory of the caller to get the path to $root/config
 		if config_root.nil?

data/lib/utopia/static.rb

@@ -27,7 +27,7 @@ require 'digest/sha1'
 require 'mime/types'
 
 module Utopia
-	# Serve static files from the specified root directory.
+	# A middleware which serves static files from the specified root directory.
 	class Static
 		# Default mime-types which are common for files served over HTTP:
 		MIME_TYPES = {
@@ -219,22 +219,21 @@ module Utopia
 
 		DEFAULT_CACHE_CONTROL = 'public, max-age=3600'.freeze
 
-		# Initialize the middleware with the provided options.
-		# @option options [String] :root The root directory to serve files from.
-		# @option options [Array] :types The mime-types (and file extensions) to recognize/serve.
-		# @option options [String] :cache_control The cache-control header to set.
-		def initialize(app, **options)
+		# @param root [String] The root directory to serve files from.
+		# @param types [Array] The mime-types (and file extensions) to recognize/serve.
+		# @param cache_control [String] The cache-control header to set for static content.
+		def initialize(app, root: Utopia::default_root, types: MIME_TYPES[:default], cache_control: DEFAULT_CACHE_CONTROL)
 			@app = app
-			@root = (options[:root] || Utopia::default_root).freeze
-
-			@extensions = MimeTypeLoader.extensions_for(options[:types] || MIME_TYPES[:default])
-
-			@cache_control = (options[:cache_control] || DEFAULT_CACHE_CONTROL)
+			@root = root
 			
-			self.freeze
+			@extensions = MimeTypeLoader.extensions_for(types)
+			
+			@cache_control = cache_control
 		end
 
 		def freeze
+			return self if frozen?
+			
 			@root.freeze
 			@extensions.freeze
 			@cache_control.freeze

data/lib/utopia/version.rb

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

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

@@ -59,10 +59,6 @@ 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 .} rescue nil
-	sh %W{chown -Rf #{DEPLOY_USER}:#{DEPLOY_GROUP} .} rescue nil
-	
 	sudo %W{git checkout -f}
 	sudo %W{git submodule update -i}
 	

data/setup/site/.gitignore

@@ -0,0 +1,9 @@
+# Development specific:
+.rspec_status
+.tags*
+
+# Temporary data should not be added to the repository:
+tmp/
+
+# This file should only ever exist on production, and may contain sensitive information:
+config/environment.yaml

data/setup/site/.rspec

@@ -2,3 +2,4 @@
 --format documentation
 --backtrace
 --warnings
+--require spec_helper

data/setup/site/Gemfile

@@ -8,9 +8,13 @@ gem "utopia", "~> $UTOPIA_VERSION"
 gem "rake"
 gem "bundler"
 
+gem "rack-freeze", "~> 1.2"
+
 group :development do
 	# For `rake server`:
 	gem "puma"
+	gem "guard-puma", require: false
+	gem 'guard-rspec', require: false
 	
 	# For `rake console`:
 	gem "pry"

data/setup/site/Guardfile

@@ -0,0 +1,17 @@
+
+group :development do
+	guard :puma, port: 9292 do
+		watch('Gemfile.lock')
+		watch('config.ru')
+		watch(%r{^config|lib|pages/.*})
+	end
+end
+
+group :test do
+	guard :rspec, cmd: 'rspec' do
+		watch(%r{^spec/.+_spec\.rb$})
+		watch(%r{^lib/(.+)\.rb$}) { |m| 'spec/lib/#{m[1]}_spec.rb' }
+		watch('spec/spec_helper.rb') { 'spec' }
+		watch(%r{^pages/.*}) { 'spec/website_spec.rb' }
+	end
+end

data/setup/site/Rakefile

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

data/setup/site/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
@@ -29,27 +31,18 @@ use Utopia::Redirection::Errors,
 use Utopia::Localization,
 	:default_locale => 'en',
 	:locales => ['en', 'de', 'ja', 'zh'],
-	:nonlocalized => ['/_static/', '/_cache/', '/_components/']
+	:ignore => ['/_static/', '/_cache/', '/_components/']
 
 require 'utopia/session'
 use Utopia::Session,
 	:expires_after => 3600 * 24,
 	:secret => ENV['UTOPIA_SESSION_SECRET']
 
-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/setup/site/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/setup/site/pages/_page.xnode

@@ -22,7 +22,7 @@
 		</header>
 
 		<div id="page">
-			<content />
+			<utopia:content/>
 		</div>
 	</body>
 </html>

data/setup/site/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/setup/site/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/setup/site/pages/welcome/index.xnode

@@ -1,5 +1,5 @@
-<page class="front">
-	<heading>Welcome to Utopia...</heading>
+<content:page class="front">
+	<content:heading>Welcome to Utopia...</content:heading>
 	
 	<section class="features">
 		<div>
@@ -32,4 +32,4 @@
 			<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>
-</page>
+</content:page>

data/setup/site/public/_static/site.css

@@ -88,6 +88,10 @@ p, ul, ol, dl, h3 {
 	margin: 2rem;
 }
 
+li > ul, li > ol {
+	margin: 0;
+}
+
 pre {
 	overflow: auto;
 	

data/setup/site/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+
+if ENV['COVERAGE']
+	begin
+		require 'simplecov'
+		
+		SimpleCov.start do
+			add_filter "/spec/"
+		end
+		
+		if ENV['TRAVIS']
+			require 'coveralls'
+			Coveralls.wear!
+		end
+	rescue LoadError
+		warn "Could not load simplecov: #{$!}"
+	end
+end
+
+require 'bundler/setup'
+require 'utopia'
+
+RSpec.configure do |config|
+	# Enable flags like --only-failures and --next-failure
+	config.example_status_persistence_file_path = '.rspec_status'
+
+	config.expect_with :rspec do |c|
+		c.syntax = :expect
+	end
+end

data/setup/site/tasks/deploy.rake

@@ -0,0 +1,13 @@
+
+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.
+end
+
+desc 'Restart the application server'
+task :restart do
+	# This task is run after the deployment task above.
+	if passenger_config = `which passenger-config`.chomp!
+		sh(passenger_config, 'restart-app', '--ignore-passenger-not-running', File.dirname(__dir__))
+	end
+end

data/setup/site/tasks/development.rake

@@ -0,0 +1,34 @@
+
+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
+
+desc 'Start the development server.'
+task :server => :environment do
+	exec('guard', '-g', 'development')
+end
+
+desc 'Start the development environment which includes web server and tests.'
+task :development => :environment do
+	exec('guard', '-g', 'development,test')
+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