utopia 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7f781caa44277d1a87ccfafe40a2374c16c4079
-  data.tar.gz: 67fbbad250fa5d8759ace04538c63c66b6d4951b
+  metadata.gz: dc5e0658eefc0372da3d7efd4ee1b0ff65747db4
+  data.tar.gz: 46b821103c885f1724c5a4d05704721a7f87adfa
 SHA512:
-  metadata.gz: 0bb4ad97ae3292dfea9879ee3367f9d8ba4559af44d4d62680a8fc4fe81df234ac3aa59ca2e98f27bf143a04a54c577bc6dd95f482eb92d2f5d1c1e415ff428a
-  data.tar.gz: e91fbb62789943bd5a3f3813c2a30a320fad5420f795f282b59cb8ef7e5c45af070d2fda0bde71a70436a0f773947d659e266297795e979d3b27a34f5383bf93
+  metadata.gz: 11b0669ed76fa442c7b62505315e19c3d6617e221f6ffe48f1f4018a10f310cb3faa8a92f5231ed19f5d29b50e56fcbad512c4e85153623eb36400dcac9b01c5
+  data.tar.gz: 86679c8aba508781eeb1a76d76fa19dd11497482aa2c7f4b3c3544b253831ea1c40b4a2dec246f81f574fd2bd1dc431245942a176f64234968548ca4fa4562c8

data/README.md

@@ -5,25 +5,86 @@ 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.
 
+[![Build Status](https://secure.travis-ci.org/ioquatix/utopia.png)](http://travis-ci.org/ioquatix/utopia)
+[![Code Climate](https://codeclimate.com/github/ioquatix/utopia.png)](https://codeclimate.com/github/ioquatix/utopia)
+[![Coverage Status](https://coveralls.io/repos/ioquatix/utopia/badge.svg)](https://coveralls.io/r/ioquatix/utopia)
+
+## Installation
+
+### Local Setup
+
+Install utopia:
+
+	$ gem install utopia
+
+Create a new site:
+
+	$ utopia create www.example.com
+	$ cd www.example.com
+	$ rake server
+
+#### Bower Integration
+
+If you create a site using the utopia generator, it includes a `.bowerrc` configuration which installs components into `public/_static/components`. To install jquery, for example:
+
+	$ bower install jquery
+
+Then add the appropriate `<script>` tags to `pages/_page.xnode`:
+
+	<script src="/_static/components/jquery/dist/jquery.min.js" type="text/javascript"></script>
+
+### Server Setup
+
+Utopia can be used to set up remote sites quickly and easily.
+
+Firstly log into your remote site using `ssh` and install utopia:
+
+	$ ssh remote
+	$ sudo gem install utopia
+
+Then use the utopia command to generate a new remote site:
+
+	$ sudo -u http utopia server:create /srv/http/www.example.com
+
+On the local site, you can set up a git remote:
+
+	$ git remote add production ssh://remote/srv/http/www.example.com
+	$ git push --set-upstream production master
+
+### Passenger+Nginx Setup
+
+Utopia works well with Passenger+Nginx. Installing Passenger+Nginx is easy:
+
+	$ ssh remote
+	$ sudo gem install passenger
+	$ passenger-install-nginx-module
+
+Then, Nginx is configured like so:
+
+	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;
+	}
+
+## Usage
+
 Utopia builds on top of Rack with the following middleware:
 
-- `Utopia::Static`: Serve static files with recursive lookup.
+- `Utopia::Static`: Serve static files efficiently.
 - `Utopia::Redirector`: Redirect URL patterns and status codes.
 - `Utopia::Localization`: Non-intrusive localization of resources.
 - `Utopia::Controller`: Dynamic behaviour with recursive execution.
 - `Utopia::Content`: XML-style template engine with powerful tag behaviours.
 - `Utopia::Session::EncryptedCookie`: Session storage using an encrypted cookie.
 
-For more details please see the main [project page][1].
-
-[1]: http://www.oriontransfer.co.nz/gems/utopia
-
-[![Build Status](https://secure.travis-ci.org/ioquatix/utopia.png)](http://travis-ci.org/ioquatix/utopia)
-[![Code Climate](https://codeclimate.com/github/ioquatix/utopia.png)](https://codeclimate.com/github/ioquatix/utopia)
-[![Coverage Status](https://coveralls.io/repos/ioquatix/utopia/badge.svg)](https://coveralls.io/r/ioquatix/utopia)
-
-## Middleware
-
 ### Static
 
 This middleware serves static files using the `mime-types` library. By default, it works with `Rack::Sendfile` and `Rack::Cache` and supports `ETag` based caching.
@@ -48,32 +109,6 @@ A tag based content generation system which integrates nicely with HTML5. Suppor
 
 The encrypted cookie session management uses symmetric private key encryption to store data on the client and avoid tampering.
 
-## Installation
-
-Install utopia:
-
-	$ gem install utopia
-
-Create a new site:
-
-	$ utopia create www.example.com
-	$ cd www.example.com
-	$ rake server
-
-### Bower Integration
-
-If you create a site using the utopia generator, it includes a `.bowerrc` configuration which installs components into `public/_static/components`. To install jquery, for example:
-
-	bower install jquery
-
-Then add the appropriate `<script>` tags to `pages/_page.xnode`:
-
-	<script src="/_static/components/jquery/dist/jquery.min.js" type="text/javascript"></script>
-
-## Usage
-
-The default site includes documentation and examples.
-
 ## Contributing
 
 1. Fork it
@@ -104,4 +139,4 @@ 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.
+THE SOFTWARE.

data/bin/utopia

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2015, 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
@@ -30,82 +30,101 @@ require 'find'
 require 'rake'
 
 $app = Rake.application = Rake::Application.new
-$app.init('Utopia')
+$app.init(File.basename($0))
+
+Rake::TaskManager.record_task_metadata = true
+
+verbose(false)
 
 module Setup
-	DIRECTORIES = ["cache", "cache/meta", "cache/body", "lib", "pages", "public", "tmp"]
-	SYMLINKS = {"public/_static" => "../pages/_static"}
+	BASE = File.expand_path("../../setup", __FILE__)
 	
-	CONFIGURATION_FILES = ['config.ru', 'Gemfile', 'Rakefile']
+	module Site
+		CONFIGURATION_FILES = ['config.ru', 'Gemfile', 'Rakefile']
+		
+		DIRECTORIES = ["cache", "cache/meta", "cache/body", "lib", "pages", "public", "tmp"]
+		SYMLINKS = {"public/_static" => "../pages/_static"}
+		
+		# Removed during upgrade process
+		OLD_DIRECTORIES = ["access_log"]
+		
+		ROOT = File.join(BASE, 'site')
+	end
 	
-	# Removed during upgrade process
-	OLD_DIRECTORIES = ["access_log"]
+	module Server
+		ROOT = File.join(BASE, 'server')
+	end
 end
 
+desc "Create a local utopia instance which includes a basic website template.\n" +
+     "Uses current working directory or path argument if provided."
 task :create do
-	$stderr.puts("Usage: #{File.basename $0} create $path") & exit if ARGV.size != 2 
-	
-	destination_root = File.expand_path(ARGV.last, Dir.getwd)
-	setup_root = File.expand_path("../../setup", __FILE__)
+	destination_root = File.expand_path(ARGV.last || '.', Dir.getwd)
 	
-	$stderr.puts "Copying files from #{setup_root} to #{destination_root}..."
+	$stderr.puts "Setting up initial site in #{destination_root}..."
 	
-	Setup::DIRECTORIES.each do |directory|
+	Setup::Site::DIRECTORIES.each do |directory|
 		FileUtils.mkdir_p(File.join(destination_root, directory))
 	end
 	
-	Find.find(setup_root) do |source_path|
+	Find.find(Setup::Site::ROOT) do |source_path|
 		# What is this doing?
-		destination_path = File.join(destination_root, source_path[setup_root.size..-1])
+		destination_path = File.join(destination_root, source_path[Setup::Site::ROOT.size..-1])
 		
 		if File.directory?(source_path)
 			FileUtils.mkdir_p(destination_path)
 		else
-			if File.exist? destination_path
-				$stderr.puts "\tFile already exists: #{destination_path}!"
-			else
-				$stderr.puts "\tCopying #{source_path} to #{destination_path}..."
+			unless File.exist? destination_path
 				FileUtils.copy_entry(source_path, destination_path)
 			end
 		end
 	end
 	
-	Setup::SYMLINKS.each do |path, target|
-		FileUtils.ln_s(target, File.join(destination_root, path))
+	Setup::Site::SYMLINKS.each do |path, target|
+		FileUtils.ln_s(target, File.join(destination_root, path), force: true)
 	end
 	
-	Setup::CONFIGURATION_FILES.each do |configuration_file|
+	Setup::Site::CONFIGURATION_FILES.each do |configuration_file|
 		destination_path = File.join(destination_root, configuration_file)
 		
-		$stderr.puts "Updating #{destination_path}..."
-		
 		buffer = File.read(destination_path).gsub('$UTOPIA_VERSION', Utopia::VERSION)
+		
 		File.open(destination_path, "w") { |file| file.write(buffer) }
 	end
-
-	if `which git`.strip == ""
-		$stderr.puts "Now is a good time to learn about git : http://git-scm.com/"
-	end
 	
 	Dir.chdir(destination_root) do
-		unless File.exist? '.git'
+		if `which bundle`.strip != ''
+			puts "Generating initial package list with bundle..."
+			sh("bundle", "install", "--quiet")
+		end
+		
+		if `which git`.strip == ""
+			$stderr.puts "Now is a good time to learn about git : http://git-scm.com/"
+		elsif !File.exist?('.git')
+			puts "Setting up git repository..."
 			sh("git", "init")
 			sh("git", "add", ".")
-			sh("git", "commit", "-m", "Initial utopia site.")
+			sh("git", "commit", "-q", "-m", "Initial Utopia v#{Utopia::VERSION} site.")
 		end
 	end
 	
-	$stderr.puts "*** Thanks for using Utopia! ***"
-	$stderr.puts "To start the server:\n\tcd #{ARGV.last}\n\trake server"
+	name = `git config user.name || whoami`.chomp
+	
+	puts
+	puts "  #{name},".ljust(78)
+	puts "Thank you for using Utopia!".center(78)
+	puts "We sincerely hope that Utopia helps to".center(78)
+	puts "make your life easier and more enjoyable.".center(78)
+	puts ""
+	puts "For extreme productivity, please consult the online documentation".center(78)
+	puts "https://github.com/ioquatix/utopia".center(78)
+	puts " ~ Samuel.  ".rjust(78)
 end
 
+desc "Upgrade an existing site to use the latest configuration files from the template.\n" +
+     "Uses current working directory or path argument if provided."
 task :upgrade do
-	$stderr.puts("Usage: #{File.basename $0} upgrade $path") & exit if ARGV.size != 2 
-	
 	destination_root = File.expand_path(ARGV.last || '.', Dir.getwd)
-	setup_root = File.expand_path("../../setup", __FILE__)
-	directories = ["cache", "cache/meta", "cache/body", "lib", "pages", "public"]
-	symlinks = {"public/_static" => "../pages/_static"}
 	branch_name = "utopia-upgrade-#{Utopia::VERSION}"
 	
 	$stderr.puts "Upgrading #{destination_root}..."
@@ -114,22 +133,22 @@ task :upgrade do
 		sh('git', 'checkout', '-b', branch_name)
 	end
 	
-	Setup::DIRECTORIES.each do |directory|
+	Setup::Site::DIRECTORIES.each do |directory|
 		FileUtils.mkdir_p(File.join(destination_root, directory))
 	end
 	
-	Setup::OLD_DIRECTORIES.each do |directory|
+	Setup::Site::OLD_DIRECTORIES.each do |directory|
 		path = File.join(destination_root, directory)
 		$stderr.puts "\tRemoving #{path}..."
 		FileUtils.rm_rf(path)
 	end
 	
-	Setup::SYMLINKS.each do |path, target|
+	Setup::Site::SYMLINKS.each do |path, target|
 		FileUtils.ln_s(target, File.join(destination_root, path), force: true)
 	end
 	
-	Setup::CONFIGURATION_FILES.each do |configuration_file|
-		source_path = File.join(setup_root, configuration_file)
+	Setup::Site::CONFIGURATION_FILES.each do |configuration_file|
+		source_path = File.join(Setup::Site::ROOT, configuration_file)
 		destination_path = File.join(destination_root, configuration_file)
 		
 		$stderr.puts "Updating #{destination_path}..."
@@ -162,16 +181,36 @@ task :upgrade do
 		sh("git", "checkout", "master")
 		sh("git", "branch", "-d", branch_name)
 	end
-	
-	$stderr.puts "*** Thanks for using Utopia! ***"
+end
+
+namespace :server do
+	desc "Create a remote utopia instance suitable for deployment using git.\n" +
+	     "Uses current working directory or path argument if provided."
+	task :create do
+		destination_root = File.expand_path(ARGV.last || '.', Dir.getwd)
+		
+		FileUtils.mkdir_p File.join(destination_root, "public")
+		FileUtils.mkdir_p File.join(destination_root, "tmp")
+		
+		Dir.chdir(destination_root) do
+			# Shared allows multiple users to access the site with the same group:
+			sh("git", "init", "--shared")
+			sh("git", "config", "receive.denyCurrentBranch", "ignore")
+			sh("git", "config", "core.worktree", destination_root)
+			
+			sh("cp", "-r", File.join(Setup::Server::ROOT, 'git', 'hooks'), File.join(destination_root, '.git'))
+		end
+		
+		hostname = `hostname`.chomp
+		puts "Now add the git remote to your local repository:\n\tgit remote add production ssh://#{hostname}#{destination_root}"
+		puts "Then push to it:\n\tgit push --set-upstream production master"
+	end
 end
 
 task :help do
-	$stderr.puts "To create a new site, use the create task:"
-	$stderr.puts "\t#{File.basename($0)} create path/to/www.example.com"
-	
-	$stderr.puts "To upgrade an existing site, use the upgrade task:"
-	$stderr.puts "\t#{File.basename($0)} upgrade path/to/www.example.com"
+	$app.options.show_tasks = :describe
+	$app.options.show_task_pattern = Regexp.new('')
+	$app.display_tasks_and_comments
 end
 
 task :default => :help

data/lib/utopia/version.rb

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

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

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+
+# Copyright, 2015, 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 'etc'
+
+# Add the following into sudoers for this to work correctly:
+# 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
+
+working_tree = `git config core.worktree`.chomp
+
+puts "Updating Site #{working_tree}..."
+
+# 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
+
+puts "Updating permissions..."
+
+Dir.chdir(working_tree) do
+	sh("chmod -Rf ug+rwX .")
+	sh("chown -Rf #{deploy_user}:#{deploy_group} .")
+
+	puts "Updating site #{Dir.pwd} as #{deploy_user}:#{deploy_group}..."
+	
+	sh("sudo -u #{deploy_user} git checkout -f")
+	sh("sudo -u #{deploy_user} git submodule update -i")
+	
+	if File.exist? 'Gemfile'
+		sh("sudo -u #{deploy_user} bundle install --deployment") or abort("Could not setup bundle!")
+	end
+	
+	ENV['DEPLOY_USER'] = deploy_user
+	ENV['DEPLOY_GROUP'] = deploy_group
+	
+	if File.exist? 'Rakefile'
+		sh("rake deploy") or abort("Deploy task failed!")
+	end
+	
+	puts "Restarting server..."
+	sh("sudo -u #{deploy_user} mkdir -p tmp && touch tmp/restart.txt")
+end

data/setup/site/Rakefile

@@ -0,0 +1,9 @@
+
+task :server do
+	system('puma')
+end
+
+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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: utopia
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-31 00:00:00.000000000 Z
+date: 2015-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trenni
@@ -185,22 +185,23 @@ files:
 - lib/utopia/tags/override.rb
 - lib/utopia/version.rb
 - setup/.bowerrc
-- setup/Gemfile
-- setup/Rakefile
-- setup/cache/head/readme.txt
-- setup/cache/meta/readme.txt
-- setup/config.ru
-- setup/lib/readme.txt
-- setup/pages/_heading.xnode
-- setup/pages/_page.xnode
-- setup/pages/_static/icon.png
-- setup/pages/_static/site.css
-- setup/pages/errors/exception.xnode
-- setup/pages/errors/file-not-found.xnode
-- setup/pages/links.yaml
-- setup/pages/welcome/index.xnode
-- setup/public/readme.txt
-- setup/tmp/readme.txt
+- setup/server/git/hooks/post-receive
+- setup/site/Gemfile
+- setup/site/Rakefile
+- setup/site/cache/head/readme.txt
+- setup/site/cache/meta/readme.txt
+- setup/site/config.ru
+- setup/site/lib/readme.txt
+- setup/site/pages/_heading.xnode
+- setup/site/pages/_page.xnode
+- setup/site/pages/_static/icon.png
+- setup/site/pages/_static/site.css
+- setup/site/pages/errors/exception.xnode
+- setup/site/pages/errors/file-not-found.xnode
+- setup/site/pages/links.yaml
+- setup/site/pages/welcome/index.xnode
+- setup/site/public/readme.txt
+- setup/site/tmp/readme.txt
 - spec/utopia/content/link_spec.rb
 - spec/utopia/content/links/foo/index.xnode
 - spec/utopia/content/links/foo/links.yaml

data/setup/Rakefile

@@ -1,18 +0,0 @@
-
-task :server do
-	system('puma')
-end
-
-task :deploy do
-	$stderr.puts "Updating permissions..."
-	sh("chmod -Rf ug+rwX .")
-	sh("chown -Rf http:http .")
-	
-	$stderr.puts "Updating site #{Dir.pwd} as #{`whoami`.chomp}..."
-	sh("sudo -u http git checkout -f")
-	sh("sudo -u http git submodule update -i")
-	sh("sudo -u http bundle install --deployment")
-	
-	$stderr.puts "Restarting server..."
-	sh("sudo -u http touch tmp/restart.txt")
-end