utopia 1.9.11 → 2.0.0

data/lib/utopia/command/server.rb

@@ -0,0 +1,115 @@
+# Copyright, 2016, 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_relative 'setup'
+
+module Utopia
+	module Command
+		# Server setup commands.
+		class Server < Samovar::Command
+			# Create a server.
+			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")
+					
+					Update.new.invoke(parent)
+					
+					# 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
+			
+			# Update a server.
+			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
+						# It's okay to call this on an existing repo, it will only update config as required to enable --shared.
+						# --shared allows multiple users to access the site with the same group.
+						system("git", "init", "--shared") or fail "could not initialize repository"
+						
+						system("git", "config", "receive.denyCurrentBranch", "ignore") or fail "could not set configuration"
+						system("git", "config", "core.worktree", destination_root) or fail "could not set configuration"
+						
+						# In theory, to convert from non-shared to shared:
+						# chgrp -R <group-name> .                   # Change files and directories' group
+						# chmod -R g+w .                            # Change permissions
+						# chmod g-w .git/objects/pack/*             # Git pack files should be immutable
+						# chmod g+s `find . -type d`                # New files get group id of directory
+					end
+					
+					Setup::Server.update_default_environment(destination_root)
+					
+					# Copy git hooks:
+					system("cp", "-r", File.join(Setup::Server::ROOT, 'git', 'hooks'), File.join(destination_root, '.git')) or fail "could not copy git hooks"
+					# finally set everything in the .git directory to be group writable
+					system("chmod", "-Rf", "g+w", File.join(destination_root, '.git')) or fail "could not update permissions of .git directory"
+				end
+			end
+			
+			# Set environment variables within the server deployment.
+			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
+	end
+end

data/lib/utopia/command/setup.rb

@@ -0,0 +1,78 @@
+# Copyright, 2016, 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 'fileutils'
+require 'find'
+
+require 'yaml/store'
+
+require 'samovar'
+require 'securerandom'
+
+module Utopia
+	module Command
+		# The command for client/server setup.
+		module Setup
+			# This path must point to utopia/setup in the gem source.
+			BASE = File.expand_path("../../../setup", __dir__)
+			
+			# Helpers for setting up a local site.
+			module Site
+				# Configuration files which should be installed/updated:
+				CONFIGURATION_FILES = ['.bowerrc', '.gitignore', 'config.ru', 'config/environment.rb', 'Gemfile', 'Guardfile', 'Rakefile', 'tasks/bower.rake', 'tasks/deploy.rake', 'tasks/development.rake', 'tasks/environment.rake', 'tasks/log.rake']
+				
+				# Directories that should exist:
+				DIRECTORIES = ["config", "lib", "pages", "public", "tasks"]
+				
+				# Directories that should be removed during upgrade process:
+				OLD_PATHS = ["access_log", "cache", "tmp", 'tasks/test.rake', 'tasks/utopia.rake']
+				
+				# The root directory of the template site:
+				ROOT = File.join(BASE, 'site')
+			end
+			
+			# Helpers for setting up the server deployment.
+			module Server
+				# The root directory of the template server deployment:
+				ROOT = File.join(BASE, 'server')
+				
+				# Setup `config/environment.yaml` according to specified options.
+				def self.environment(root)
+					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)
+					environment(root) do |store|
+						store['RACK_ENV'] ||= 'production'
+						store['UTOPIA_SESSION_SECRET'] ||= SecureRandom.hex(40)
+					end
+				end
+			end
+		end
+	end
+end

data/lib/utopia/command/site.rb

@@ -0,0 +1,183 @@
+# Copyright, 2016, 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_relative 'setup'
+
+module Utopia
+	module Command
+		# Local site setup commands.
+		class Site < Samovar::Command
+			# Create a local site.
+			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") or fail "could not install bundled gems"
+						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") or fail "could not create git repository"
+							system("git", "add", ".") or fail "could not add all files"
+							system("git", "commit", "-q", "-m", "Initial Utopia v#{Utopia::VERSION} site.") or fail "could not commit files"
+						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
+			
+			# Update a local site.
+			class Update < Samovar::Command
+				self.description = "Upgrade an existing site to use the latest configuration files from the template."
+				
+				# Move legacy `pages/_static` to `public/_static`.
+				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/")
+					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) or fail "could not change branch"
+					end
+					
+					Setup::Site::DIRECTORIES.each do |directory|
+						FileUtils.mkdir_p(File.join(destination_root, directory))
+					end
+					
+					Setup::Site::OLD_PATHS.each do |path|
+						path = File.join(destination_root, path)
+						$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") or fail "could not add files"
+							
+							# Stage any new files that we have explicitly added:
+							system("git", "add", *Setup::Site::CONFIGURATION_FILES) or fail "could not add files"
+							
+							move_static!
+							
+							# Commit all changes:
+							system("git", "commit", "-m", "Upgrade to utopia #{Utopia::VERSION}.") or fail "could not commit changes"
+							
+							# Checkout master..
+							system("git", "checkout", "master") or fail "could not checkout master"
+							
+							# and merge:
+							system("git", "merge", "--squash", "--no-commit", branch_name) or fail "could not merge changes"
+						end
+					rescue RuntimeError
+						$stderr.puts "** Detected error with upgrade, reverting changes. Some new files may still exist in tree. **"
+						
+						system("git", "checkout", "master")
+					ensure
+						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
+	end
+end

data/lib/utopia/content.rb

@@ -23,94 +23,65 @@ require_relative 'localization'
 
 require_relative 'content/node'
 require_relative 'content/markup'
+require_relative 'content/tags'
 
 require 'trenni/template'
 
 require 'concurrent/map'
 
 module Utopia
+	# A middleware which serves dynamically generated content based on markup files.
 	class Content
 		INDEX = 'index'.freeze
 		
-		def initialize(app, **options)
+		CONTENT_NAMESPACE = 'content'.freeze
+		UTOPIA_NAMESPACE = 'utopia'.freeze
+		DEFERRED_TAG_NAME = 'utopia:deferred'.freeze
+		CONTENT_TAG_NAME = 'utopia:content'.freeze
+		
+		# @param root [String] The content root where pages will be generated from.
+		# @param namespaces [Hash<String,Library>] Tag namespaces for dynamic tag lookup.
+		def initialize(app, root: Utopia::default_root, namespaces: {})
 			@app = app
+			@root = root
 			
-			@root = File.expand_path(options[:root] || Utopia::default_root)
+			@template_cache = Concurrent::Map.new
+			@node_cache = Concurrent::Map.new
 			
-			if options[:cache_templates]
-				@template_cache = Concurrent::Map.new
-			else
-				@template_cache = nil
-			end
+			@namespaces = namespaces
 			
-			@tags = options.fetch(:tags, {})
+			# Default content namespace for dynamic path based lookup:
+			@namespaces[CONTENT_NAMESPACE] ||= self.method(:content_tag)
 			
-			self.freeze
+			# The core namespace for utopia specific functionality:
+			@namespaces[UTOPIA_NAMESPACE] ||= Tags
 		end
 
 		def freeze
+			return self if frozen?
+			
 			@root.freeze
-			@tags.freeze
+			@namespaces.values.each(&:freeze)
+			@namespaces.freeze
 			
 			super
 		end
-
+		
 		attr :root
-
+		
 		def fetch_template(path)
-			if @template_cache
-				@template_cache.fetch_or_store(path.to_s) do
-					Trenni::MarkupTemplate.load_file(path)
-				end
-			else
+			@template_cache.fetch_or_store(path.to_s) do
 				Trenni::MarkupTemplate.load_file(path)
 			end
 		end
 		
-		# This function looks up a named tag in a given path. It's a hotspot and needs improvement.
-		private def fetch_tag(name, parent_path)
-			if String === name && name.index('/')
-				name = Path.create(name)
-			end
-			
-			if Path === name
-				name = parent_path + name
-				name_path = name.components.dup
-				name_path[-1] += XNODE_EXTENSION
-			else
-				name_path = name + XNODE_EXTENSION
-			end
+		# Look up a named tag such as `<entry />` or `<content:page>...`
+		def lookup_tag(qualified_name, node)
+			namespace, name = Trenni::Tag.split(qualified_name)
 			
-			components = parent_path.components.dup
-			
-			while components.any?
-				tag_path = File.join(root, components, name_path)
-
-				if File.exist? tag_path
-					return Node.new(self, Path[components] + name, parent_path + name, tag_path)
-				end
-
-				if String === name_path
-					tag_path = File.join(root, components, '_' + name_path)
-
-					if File.exist? tag_path
-						return Node.new(self, Path[components] + name, parent_path + name, tag_path)
-					end
-				end
-				
-				components.pop
-			end
-			
-			return nil
-		end
-		
-		# Look up a named tag such as <entry />
-		def lookup_tag(name, parent_path)
-			if @tags.key? name
-				return @tags[name]
+			if library = @namespaces[namespace]
+				library.call(name, node)
 			end
-			
-			return fetch_tag(name, parent_path)
 		end
 		
 		# The request_path is an absolute uri path, e.g. /foo/bar. If an xnode file exists on disk for this exact path, it is instantiated, otherwise nil.
@@ -155,5 +126,58 @@ module Utopia
 			
 			return @app.call(env)
 		end
+		
+		private
+		
+		def lookup_content(name, parent_path)
+			if String === name && name.index('/')
+				name = Path.create(name)
+			end
+			
+			if Path === name
+				name = parent_path + name
+				name_path = name.components.dup
+				name_path[-1] += XNODE_EXTENSION
+			else
+				name_path = name + XNODE_EXTENSION
+			end
+			
+			components = parent_path.components.dup
+			
+			while components.any?
+				tag_path = File.join(@root, components, name_path)
+
+				if File.exist? tag_path
+					return Node.new(self, Path[components] + name, parent_path + name, tag_path)
+				end
+
+				if String === name_path
+					tag_path = File.join(@root, components, '_' + name_path)
+
+					if File.exist? tag_path
+						return Node.new(self, Path[components] + name, parent_path + name, tag_path)
+					end
+				end
+				
+				components.pop
+			end
+			
+			return nil
+		end
+		
+		def content_tag(name, node)
+			parent_path = node.parent_path
+			
+			# If the current node is called 'foo', we can't lookup 'foo' in the current directory or we will have infinite recursion.
+			if name == node.name
+				parent_path = parent_path.dirname
+			end
+			
+			cache_key = parent_path + name
+			
+			@node_cache.fetch_or_store(cache_key) do
+				lookup_content(name, parent_path)
+			end
+		end
 	end
 end