utopia 1.9.11 → 2.0.0

data/documentation/pages/wiki/controller.rb

@@ -8,9 +8,9 @@ on '**' do |request, path|
 	@page_file = File.join(BASE_PATH, @page_path, "content.md")
 	
 	if last_path_component = @page_path.last
-		@page_title = Trenni::Strings::to_title(last_path_component)
+		@title = Trenni::Strings::to_title(last_path_component)
 	else
-		@page_title = "Wiki"
+		@title = "Wiki"
 	end
 end
 
@@ -18,7 +18,7 @@ def read_contents
 	if File.exist? @page_file
 		File.read(@page_file)
 	else
-		"\# #{@page_title}\n\n" +
+		"\# #{@title}\n\n" +
 		"This page is empty."
 	end
 end

data/documentation/pages/wiki/edit.xnode

@@ -1,22 +1,10 @@
-<page>
-	<?r response.do_not_cache! ?>
-	
-	<style type="text/css">
-		
-		form textarea {
-			
-		}
-	</style>
-	
-	<heading>Editing #{self[:page_title].inspect}</heading>
+<content:editor>
 	<form action="#" method="post">
-		<fieldset>
-			<legend>Page Content</legend>
-			<textarea name="content">#{self[:content]}</textarea>
-		</fieldset>
-		
-		<fieldset class="footer">
+		<div class="header">
+			<div>Editing #{attributes[:title].inspect}</div>
 			<input type="submit" />
-		</fieldset>
+		</div>
+		
+		<textarea name="content">#{self[:content]}</textarea>
 	</form>
-</page>
+</content:editor>

data/documentation/pages/wiki/middleware/content/content.md

@@ -3,25 +3,19 @@ A tag based content generation system which integrates nicely with HTML5. Suppor
 
 ```ruby
 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)
-	}
+	cache_templates: (RACK_ENV == :production)
 ```
 
 A basic template `create.xnode` looks something like:
 
 ```trenni
-<page>
-	<heading>Create User</heading>
+<content:page>
+	<content:heading>Create User</content:heading>
 	<form action="#">
 		<input name="name" />
 		<input type="submit" />
 	</form>
-</page>
+</content:page>
 ```
 
 This template would typically be designed with supporting `_page.xnode` and `_heading.xnode` in the same directory or, more typically, somewhere further up the directory hierarchy.

data/documentation/pages/wiki/{controller → middleware/controller}/rewrite/content.md

@@ -35,11 +35,11 @@ end
 In your `post.xnode`, as an example:
 
 ```trenni
-<page>
-	<heading>Post #{attributes[:permalink][:id]} about #{attributes[:permalink][:title]}</heading>
+<content:page>
+	<content:heading>Post #{attributes[:permalink][:id]} about #{attributes[:permalink][:title]}</content:heading>
 	
 	<p>#{attributes[:post].content}</p>
-</page>
+</content:page>
 ```
 
 Keep in mind, that URLs like `/123-pictures-of-my-cat/edit` will work as expected, and hit the `edit` action of the controller.

data/documentation/pages/wiki/show.xnode

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

data/documentation/pages/wiki/updating-utopia/content.md

@@ -0,0 +1,55 @@
+# Updating Utopia
+
+Utopia provides a model for both local development (`utopia site create`) and deployment (`utopia server create`). In addition, Utopia provides a basic upgrade path for existing sites when things within the framework change. These are not always automatic, so below are some recipes for how to update your site.
+
+## Site Update
+
+Utopia as a framework introduces changes and versions change according to semantic versioning. 
+
+### Controller Update 1.9.x to 2.0.0
+
+The controller layer no longer automatically prepends the `Actions` layer. The following program does a best effort attempt to update existing controllers:
+
+```ruby
+#!/usr/bin/env ruby
+
+paths = Dir.glob("**/controller.rb")
+
+paths.each do |path|
+	lines = File.readlines(path)
+	
+	prepend_line_index = lines.first(5).find_index{|line| line =~ /prepend/}
+	
+	unless prepend_line_index
+		puts "Updating #{path}.."
+		File.open(path, "w") do |file|
+			file.puts "\nprepend Actions"
+			file.write lines.join
+		end
+	else
+		prepend_line = lines[prepend_line_index]
+		
+		unless prepend_line =~ /Actions/
+			if lines.any?{|line| line =~ /on/}
+				lines[prepend_line_index] = "#{prepend_line.chomp}, Actions\n"
+				
+				puts "Updating #{path}.."
+				File.open(path, "w") do |file|
+					file.write lines.join
+				end
+			end
+		end
+	end
+end
+```
+
+## Server Update
+
+The utopia server git hooks are updated occasionally to improve the deployment process or to handle changes in the underlying process.
+
+You can run the update process on the server to bring the git hooks up to the latest version.
+
+```bash
+$ cd /srv/http/website
+$ utopia server update
+```

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

@@ -9,18 +9,20 @@ $ utopia site create
 $ rake server
 ```
 
-You will now have a basic template site running on http://localhost:9292.
+You will now have a basic template site running on <a href="http://localhost:9292">http://localhost:9292</a>.
 
 ## Welcome Page
 
 Utopia includes a redirection middleware to redirect all root-level requests to a given URI. The default being `/welcome/index`:
 
 ```ruby
+# in config.ru
+
 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.
+This page includes a basic overview of Utopia. Most of it's standard HTML, except for the outer `<content: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 `<utopia:content/>` which is replaced with the inner body of the `<content:page>` tag. This recursive lookup is the heart of Utopia.
 
 ## Links
 
@@ -33,4 +35,4 @@ You'll notice that there is a file `/links.yaml`. This file contains important m
 ```yaml
 errors:
     display: false 
-```
+```

data/documentation/public/materials

@@ -0,0 +1 @@
+documentation/public/../../materials

data/lib/utopia.rb

@@ -28,7 +28,6 @@ require_relative 'utopia/redirection'
 require_relative 'utopia/static'
 require_relative 'utopia/content_length'
 
-require_relative 'utopia/tags/deferred'
-require_relative 'utopia/tags/environment'
-require_relative 'utopia/tags/node'
-require_relative 'utopia/tags/override'
+# Utopia is a web application framework built on top of Rack.
+module Utopia
+end

data/lib/utopia/command.rb

@@ -20,293 +20,12 @@
 
 require_relative 'version'
 
-require 'fileutils'
-require 'find'
-
-require 'yaml/store'
-
-require 'samovar'
-require 'securerandom'
+require_relative 'command/site'
+require_relative 'command/server'
 
 module Utopia
 	module Command
-		module Setup
-			# This path must point to utopia/setup in the gem source.
-			BASE = File.expand_path("../../setup", __dir__)
-			
-			module Site
-				CONFIGURATION_FILES = ['.bowerrc', 'config.ru', 'config/environment.rb', 'Gemfile', 'Rakefile', 'tasks/utopia.rake', 'tasks/bower.rake', 'tasks/test.rake']
-				
-				DIRECTORIES = ["config", "lib", "pages", "public", "tasks"]
-				
-				# Removed during upgrade process
-				OLD_DIRECTORIES = ["access_log", "cache", "tmp"]
-				
-				ROOT = File.join(BASE, 'site')
-			end
-			
-			module Server
-				ROOT = File.join(BASE, 'server')
-				
-				def self.environment(root)
-					# Setup config/environment.yaml according to specified options:
-					environment_path = File.join(root, 'config/environment.yaml')
-					FileUtils.mkpath File.dirname(environment_path)
-					
-					store = YAML::Store.new(environment_path)
-					
-					store.transaction do
-						yield store
-					end
-				end
-				
-				# Set some useful defaults for the environment:
-				def self.update_default_environment(root)
-					# Set up some useful defaults for server environment:
-					environment(root) do |store|
-						store['RACK_ENV'] ||= 'production'
-						store['UTOPIA_SESSION_SECRET'] ||= SecureRandom.hex(40)
-					end
-				end
-			end
-		end
-		
-		class Server < Samovar::Command
-			class Create < Samovar::Command
-				self.description = "Create a remote Utopia website suitable for deployment using git."
-				
-				def invoke(parent)
-					destination_root = parent.root
-					
-					FileUtils.mkdir_p File.join(destination_root, "public")
-					
-					Dir.chdir(destination_root) do
-						# Shared allows multiple users to access the site with the same group:
-						system("git", "init", "--shared")
-						system("git", "config", "receive.denyCurrentBranch", "ignore")
-						system("git", "config", "core.worktree", destination_root)
-					end
-					
-					# Copy git hooks:
-					system("cp", "-r", File.join(Setup::Server::ROOT, 'git', 'hooks'), File.join(destination_root, '.git'))
-					
-					Setup::Server.update_default_environment(destination_root)
-					
-					# Print out helpful git remote add message:
-					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
-			
-			class Update < Samovar::Command
-				self.description = "Update the git hooks in an existing server repository."
-				
-				def invoke(parent)
-					destination_root = parent.root
-					
-					Dir.chdir(destination_root) do
-						system("git", "config", "receive.denyCurrentBranch", "ignore")
-						system("git", "config", "core.worktree", destination_root)
-					end
-					
-					# Copy git hooks:
-					system("cp", "-r", File.join(Setup::Server::ROOT, 'git', 'hooks'), File.join(destination_root, '.git'))
-					Setup::Server.update_default_environment(destination_root)
-				end
-			end
-			
-			class Environment < Samovar::Command
-				self.description = "Update environment variables in config/environment.yaml"
-				
-				many :variables, "A list of environment KEY=VALUE pairs to set."
-				
-				def invoke(parent)
-					return if variables.empty?
-					
-					destination_root = parent.root
-					
-					Setup::Server.environment(destination_root) do |store|
-						variables.each do |variable|
-							key, value = variable.split('=', 2)
-							
-							if value
-								puts "ENV[#{key.inspect}] will default to #{value.inspect} unless otherwise specified."
-								store[key] = value
-							else
-								puts "ENV[#{key.inspect}] will be unset unless otherwise specified."
-								store.delete(key)
-							end
-						end
-					end
-				end
-			end
-			
-			self.description = "Manage server deployments."
-			
-			nested '<command>',
-				'create' => Create,
-				'update' => Update,
-				'environment' => Environment
-			
-			def invoke(parent)
-				@command.invoke(parent)
-			end
-		end
-
-		class Site < Samovar::Command
-			class Create < Samovar::Command
-				self.description = "Create a new local Utopia website using the default template."
-				# self.example = "utopia --in www.example.com site create"
-				
-				def invoke(parent)
-					destination_root = parent.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))
-					end
-					
-					Find.find(Setup::Site::ROOT) do |source_path|
-						# What is this doing?
-						destination_path = File.join(destination_root, source_path[Setup::Site::ROOT.size..-1])
-						
-						if File.directory?(source_path)
-							FileUtils.mkdir_p(destination_path)
-						else
-							unless File.exist? destination_path
-								FileUtils.copy_entry(source_path, destination_path)
-							end
-						end
-					end
-					
-					Setup::Site::CONFIGURATION_FILES.each do |configuration_file|
-						destination_path = File.join(destination_root, configuration_file)
-						
-						buffer = File.read(destination_path).gsub('$UTOPIA_VERSION', Utopia::VERSION)
-						
-						File.open(destination_path, "w") { |file| file.write(buffer) }
-					end
-					
-					Dir.chdir(destination_root) do
-						puts "Setting up site in #{destination_root}..."
-						
-						if `which bundle`.strip != ''
-							puts "Generating initial package list with bundle..."
-							system("bundle", "install", "--binstubs")
-						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..."
-							system("git", "init")
-							system("git", "add", ".")
-							system("git", "commit", "-q", "-m", "Initial Utopia v#{Utopia::VERSION} site.")
-						end
-					end
-					
-					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 "To start the development server, run:".center(78)
-					puts "rake server".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
-			end
-			
-			class Update < Samovar::Command
-				self.description = "Upgrade an existing site to use the latest configuration files from the template."
-				
-				def move_static!
-					if File.lstat("public/_static").symlink?
-						FileUtils.rm_f "public/_static"
-					end
-					
-					if File.directory?("pages/_static") and !File.exist?("public/_static")
-						system("git", "mv", "pages/_static", "public/_static")
-					end
-				end
-				
-				def invoke(parent)
-					destination_root = parent.root
-					branch_name = "utopia-upgrade-#{Utopia::VERSION}"
-					
-					$stderr.puts "Upgrading #{destination_root}..."
-					
-					Dir.chdir(destination_root) do
-						system('git', 'checkout', '-b', branch_name)
-					end
-					
-					Setup::Site::DIRECTORIES.each do |directory|
-						FileUtils.mkdir_p(File.join(destination_root, directory))
-					end
-					
-					Setup::Site::OLD_DIRECTORIES.each do |directory|
-						path = File.join(destination_root, directory)
-						$stderr.puts "\tRemoving #{path}..."
-						FileUtils.rm_rf(path)
-					end
-					
-					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}..."
-						
-						FileUtils.copy_entry(source_path, destination_path)
-						buffer = File.read(destination_path).gsub('$UTOPIA_VERSION', Utopia::VERSION)
-						File.open(destination_path, "w") { |file| file.write(buffer) }
-					end
-					
-					begin
-						Dir.chdir(destination_root) do
-							# Stage any files that have been changed or removed:
-							system("git", "add", "-u")
-							
-							# Stage any new files that we have explicitly added:
-							system("git", "add", *Setup::Site::CONFIGURATION_FILES)
-							
-							move_static!
-							
-							# Commit all changes:
-							system("git", "commit", "-m", "Upgrade to utopia #{Utopia::VERSION}.")
-							
-							# Checkout master..
-							system("git", "checkout", "master")
-							
-							# and merge:
-							system("git", "merge", "--no-commit", "--no-ff", branch_name)
-						end
-					rescue RuntimeError
-						$stderr.puts "** Detected error with upgrade, reverting changes. Some new files may still exist in tree. **"
-						
-						system("git", "checkout", "master")
-						system("git", "branch", "-d", branch_name)
-					end
-				end
-			end
-			
-			nested '<command>',
-				'create' => Create,
-				'update' => Update
-			
-			self.description = "Manage local utopia sites."
-			
-			def invoke(parent)
-				@command.invoke(parent)
-			end
-		end
-		
+		# The top level utopia command.
 		class Top < Samovar::Command
 			self.description = "A website development and deployment framework."
 			
@@ -320,6 +39,7 @@ module Utopia
 				'site' => Site,
 				'server' => Server
 			
+			# The root directory for the site.
 			def root
 				File.expand_path(@options.fetch(:root, ''), Dir.getwd)
 			end