utopia 2.21.0 → 2.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d99f06d0061224f93c7b6be1d0002d69ca7a06df9d132ba091cdf3bbbc2943e4
-  data.tar.gz: 80bb32e00719fdc27832d28eab9202d674f766253bb8f51c8bca7702353d346a
+  metadata.gz: 64d6cd31c0780c6d2071157034b6d125da0b4e6c3649affafb9338208b0467b7
+  data.tar.gz: 9092ab79ee6fb441051e1114fefbe41761aa5339d2eee574d588729e7ea5c479
 SHA512:
-  metadata.gz: 433eacbfcb8d1be7cf66aafad27b1a51cc5c2364b42c990f1251ad71e353b31040c841dc44a872270d95877088cc448784b41a9855242601aa0c41044e55b1d3
-  data.tar.gz: d655055f8d8875ed8a7f471438bfd83d0f7c19c79549b10d297e411528d5cfc503b9fb9b6b9d674af6c3f43de087950a172f2252d4317bf9ad63c1855daf718f
+  metadata.gz: cd49ec085295dded939c0da489dfc6bb64a97207032bd3cf177b39cf84f131f00b935c96173c2c6196c50032a07f4786b2312144b776cbadd4c05840b96f9f70
+  data.tar.gz: 5fc0e4c878dfa11693481cbaf560d9024f69c66c48db29cc5722a56757d216449c4026e59f534578a784f6484a94ee0bd894831e93bcddeb26830dcadf17be2b

data/bake/utopia/environment.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2018-2022, by Samuel Williams.
+
+# Update environment variables in config/environment.yaml
+def initialize(...)
+	super
+	
+	require 'securerandom'
+	require 'yaml/store'
+	require 'console'
+end
+
+# Setup default environemnts "testing" and "development".
+# @parameter root [String] The root directory of the project.
+def setup(root: context.root)
+	defaults(name: "testing", root: root)
+	defaults(name: "development", root: root)
+end
+
+# Setup the defaults for a specific environment.
+# @parameter name [String] The name of the environment to setup.
+# @parameter root [String] The root directory of the project.
+def defaults(name, root: context.root)
+	update_environment(root, name) do |store|
+		# Set some useful defaults for the environment.
+		store['UTOPIA_SESSION_SECRET'] ||= SecureRandom.hex(40)
+	end
+end
+
+# Update the specified environment.
+# @parameter name [String] The name of the environment to update.
+# @parameter variables [Hash(String, String)] A list of environment KEY=VALUE pairs to set.
+def update(name, root: context.root, **variables)
+	update_environment(root, name) 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
+		
+		yield store if block_given?
+		
+		Console.logger.debug(self) do |buffer|
+			buffer.puts "Environment #{name} (#{path}):"
+			store.roots.each do |key|
+				value = store[key]
+				
+				buffer.puts "#{key}=#{value.inspect}"
+			end
+		end
+	end
+end
+
+def read(name, root: context.root)
+	environment_path = self.environment_path(root, name)
+	
+	if File.exist?(environment_path)
+		Console.logger.debug(self) {"Loading environment #{name} from #{environment_path}..."}
+		YAML.load_file(environment_path)
+	else
+		Console.logger.debug(self) {"No environment #{name} found at #{environment_path}."}
+		{}
+	end
+end
+
+private
+
+def environment_path(root, name)
+	File.join(root, "config", "#{name}.yaml")
+end
+
+# Setup `config/environment.yaml` according to specified options.
+def update_environment(root, name)
+	environment_path = self.environment_path(root, name)
+	FileUtils.mkpath File.dirname(environment_path)
+	
+	store = YAML::Store.new(environment_path)
+	
+	store.transaction do
+		yield store, name, environment_path
+	end
+end

data/bake/utopia/server.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2017-2022, by Samuel Williams.
+
+def initialize(...)
+	super
+	
+	require 'fileutils'
+	require 'socket'
+end
+
+# Create a remote Utopia website suitable for deployment using git.
+def create(root: context.root)
+	FileUtils.mkdir_p File.join(root, "public")
+	
+	update(root: root)
+	
+	# Print out helpful git remote add message:
+	puts "Now add the git remote to your local repository:\n\tgit remote add production ssh://#{Socket.gethostname}#{root}"
+	puts "Then push to it:\n\tgit push --set-upstream production main"
+end
+
+# The path to the setup directory in the gem:
+SETUP_ROOT = File.expand_path("../../setup", __dir__)
+
+# The root directory of the template server deployment:
+SERVER_ROOT = File.join(SETUP_ROOT, 'server')
+
+# Update the git hooks in an existing server repository.
+def update(root: context.root)
+	# 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", chdir: root) or fail "could not initialize repository"
+	
+	system("git", "config", "receive.denyCurrentBranch", "ignore", chdir: root) or fail "could not set configuration"
+	system("git", "config", "core.worktree", root, chdir: root) or fail "could not set configuration"
+	
+	# Doing this invokes a lot of behaviour that isn't always ideal...
+	# system("bundle", "config", "set", "--local", "deployment", "true")
+	system("bundle", "config", "set", "--local", "without", "development", chdir: root) or fail "could not set bundle 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
+		
+	# Set some useful defaults for the environment.
+	recipe = context.lookup("utopia:environment:update")
+	recipe.instance.update("environment", root: root) do |store|
+		store['VARIANT'] ||= 'production'
+		store['UTOPIA_SESSION_SECRET'] ||= SecureRandom.hex(40)
+	end
+	
+	# Copy git hooks:
+	system("cp", "-r", File.join(SERVER_ROOT, 'git', 'hooks'), File.join(root, '.git')) or fail "could not copy git hooks"
+	# finally set everything in the .git directory to be group writable
+	# This failed for me and I had to do sudo chown http:http .git -R first.
+	system("chmod", "-Rf", "g+w", File.join(root, '.git')) or fail "could not update permissions of .git directory"
+end

data/bake/utopia/site.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2017-2023, by Samuel Williams.
+# Copyright, 2020, by Michael Adams.
+
+def initialize(...)
+	super
+	
+	require 'fileutils'
+	require 'find'
+end
+
+# The path to the setup directory in the gem:
+SETUP_ROOT = File.expand_path("../../setup", __dir__)
+
+# Configuration files which should be installed/updated:
+CONFIGURATION_FILES = ['.gitignore', 'config.ru', 'config/environment.rb', 'falcon.rb', 'gems.rb', 'Guardfile', 'bake.rb', 'test/website.rb', 'fixtures/website.rb']
+
+# Directories that should exist:
+DIRECTORIES = ["config", "lib", "pages", "public", "bake", "test"]
+
+# Directories that should be removed during upgrade process:
+OLD_PATHS = ["access_log", "cache", "tmp", "Rakefile", "tasks", ".bowerrc"]
+
+# The root directory of the template site:
+SITE_ROOT = File.join(SETUP_ROOT, 'site')
+
+# Create a new local Utopia website using the default template.
+def create(root: context.root)
+	Console.logger.debug(self) {"Setting up site in #{root} for Utopia v#{Utopia::VERSION}..."}
+	
+	DIRECTORIES.each do |directory|
+		FileUtils.mkdir_p(File.join(root, directory))
+	end
+	
+	Find.find(SITE_ROOT) do |source_path|
+		# Compute the destination path:
+		destination_path = File.join(root, source_path[SITE_ROOT.size..-1])
+		
+		if File.directory?(source_path)
+			# Create the directory:
+			FileUtils.mkdir_p(destination_path)
+		else
+			# Copy the file, unless it already exists:
+			unless File.exist? destination_path
+				FileUtils.copy_entry(source_path, destination_path)
+			end
+		end
+	end
+	
+	CONFIGURATION_FILES.each do |configuration_file|
+		destination_path = File.join(root, configuration_file)
+		
+		if File.exist?(destination_path)
+			buffer = File.read(destination_path).gsub('$UTOPIA_VERSION', Utopia::VERSION)
+			File.open(destination_path, "w") { |file| file.write(buffer) }
+		else
+			Console.logger.warn(self) {"Could not open #{destination_path}, maybe it should be removed from CONFIGURATION_FILES?"}
+		end
+	end
+	
+	system("bundle", "install", chdir: root) or warn "could not install bundled gems"
+	
+	if !File.exist?('.git')
+		Console.logger.info(self) {"Setting up git repository..."}
+		
+		system("git", "init", chdir: root) or warn "could not create git repository"
+		system("git", "add", ".", chdir: root) or warn "could not add all files"
+		system("git", "commit", "-q", "-m", "Initial Utopia v#{Utopia::VERSION} site.", chdir: root) or warn "could not commit files"
+	end
+	
+	context.lookup('utopia:environment:defaults').call(root)
+	
+	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 "bake utopia:development".center(78)
+	puts ""
+	puts "For extreme productivity, please consult the online documentation".center(78)
+	puts "https://github.com/socketry/utopia".center(78)
+	puts " ~ Samuel.  ".rjust(78)
+end
+
+# Upgrade an existing site to use the latest configuration files from the template.
+def upgrade(root: context.root)
+	branch_name = "utopia-upgrade-#{Utopia::VERSION}"
+	
+	$stderr.puts "Upgrading #{destination_root}..."
+	
+	system('git', 'checkout', '-b', branch_name, chdir: root) or fail "could not change branch"
+	
+	DIRECTORIES.each do |directory|
+		FileUtils.mkdir_p(File.join(root, directory))
+	end
+	
+	OLD_PATHS.each do |path|
+		path = File.join(root, path)
+		Console.logger.info(self) {"Removing #{path}..."}
+		FileUtils.rm_rf(path)
+	end
+	
+	CONFIGURATION_FILES.each do |configuration_file|
+		source_path = File.join(SITE_ROOT, configuration_file)
+		destination_path = File.join(root, configuration_file)
+		
+		Console.logger.info(self) {"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
+	
+	context.lookup('environment:defaults').call(root)
+	
+	begin
+		# Stage any files that have been changed or removed:
+		system("git", "add", "-u", chdir: root) or fail "could not add files"
+		
+		# Stage any new files that we have explicitly added:
+		system("git", "add", *CONFIGURATION_FILES, chdir: root) or fail "could not add files"
+		
+		move_static!(root)
+		update_gemfile!(root)
+		
+		# Commit all changes:
+		system("git", "commit", "-m", "Upgrade to utopia #{Utopia::VERSION}.", chdir: root) or fail "could not commit changes"
+		
+		# Checkout main..
+		system("git", "checkout", "main", chdir: root) or fail "could not checkout main"
+		
+		# and merge:
+		system("git", "merge", "--squash", "--no-commit", branch_name, chdir: root) or fail "could not merge changes"
+	rescue => error
+		Console.logger.error(self, error) {"Upgrade failed."}
+		
+		system("git", "checkout", "master", chdir: root)
+	ensure
+		system("git", "branch", "-D", branch_name, chdir: root)
+	end
+end
+
+private
+
+# Move legacy `pages/_static` to `public/_static`.
+def move_static!(root)
+	old_static_path = File.expand_path('pages/_static', root)
+	
+	# If public/_static doens't exist, we are done.
+	return unless File.exist?(old_static_path)
+	
+	new_static_path = File.expand_path('public/_static', root)
+	
+	if File.exist?(new_static_path)
+		if File.lstat(new_static_path).symlink?
+			FileUtils.rm_f new_static_path
+		else
+			Console.logger.warn(self) {"Can't move pages/_static to public/_static, destination already exists."}
+			return
+		end
+	end
+	
+	# One more sanity check:
+	if File.directory?(old_static_path)
+		system("git", "mv", "pages/_static", "public/")
+	end
+end
+
+# Move `Gemfile` to `gems.rb`.
+def update_gemfile!(root)
+	gemfile_path = File.expand_path('Gemfile', root)
+	
+	# If `Gemfile` doens't exist, we are done:
+	return unless File.exist?(gemfile_path)
+	
+	# If `gems.rb` already exists, we are done:
+	gems_path = File.expand_path('gems.rb', root)
+	return if File.exist?(gems_path)
+	
+	system("git", "mv", "Gemfile", "gems.rb", chdir: root)
+	system("git", "mv", "Gemfile.lock", "gems.locked", chdir: root)
+end

data/lib/utopia/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2009-2022, by Samuel Williams.
 
 module Utopia
-	VERSION = "2.21.0"
+	VERSION = "2.22.0"
 end

data/license.md

@@ -1,9 +1,9 @@
 # MIT License
 
-Copyright, 2009-2022, by Samuel Williams.  
+Copyright, 2009-2023, by Samuel Williams.  
 Copyright, 2015-2019, by Huba Nagy.  
 Copyright, 2020, by Olle Jonsson.  
-Copyright, 2020, by k1tsu.  
+Copyright, 2020, by Pierre Montelle.  
 Copyright, 2020, by Michael Adams.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

data/readme.md

@@ -2,7 +2,7 @@
 
 Utopia is a website generation framework which provides a robust set of tools 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.
 
-[![Development Status](https://github.com/socketry/utopia/workflows/Test/badge.svg)](https://github.com/socketry/utopia/actions?workflow=Test)
+[![Development Status](https://github.com/ioquatix/utopia/workflows/Test/badge.svg)](https://github.com/ioquatix/utopia/actions?workflow=Test)
 
 ## Features
 

data/setup/site/.gitignore

@@ -1,5 +1,4 @@
 # Development specific:
-/.rspec_status
 /.bundle
 
 # Temporary data should not be added to the repository:

data/setup/site/Guardfile

@@ -10,20 +10,20 @@ group :development do
 end
 
 group :test do
-	guard :rspec, cmd: 'rspec' do
-		# Notifications can get a bit tedious:
-		# notification :off
+	# guard :rspec, cmd: 'rspec' do
+	# 	# Notifications can get a bit tedious:
+	# 	# notification :off
 		
-		# Re-run specs if they are changed:
-		watch(%r{^spec/.+_spec\.rb$})
-		watch('spec/spec_helper.rb') {'spec'}
+	# 	# Re-run specs if they are changed:
+	# 	watch(%r{^spec/.+_spec\.rb$})
+	# 	watch('spec/spec_helper.rb') {'spec'}
 		
-		# Run relevent specs if files in `lib/` or `pages/` are changed:
-		watch(%r{^lib/(.+)\.rb$}) {|match| "spec/lib/#{match[1]}_spec.rb" }
-		watch(%r{^pages/(.+)\.(rb|xnode)$}) {|match| "spec/pages/#{match[1]}_spec.rb"}
-		watch(%r{^pages/(.+)controller\.rb$}) {|match| Dir.glob("spec/pages/#{match[1]}*_spec.rb")}
+	# 	# Run relevent specs if files in `lib/` or `pages/` are changed:
+	# 	watch(%r{^lib/(.+)\.rb$}) {|match| "spec/lib/#{match[1]}_spec.rb" }
+	# 	watch(%r{^pages/(.+)\.(rb|xnode)$}) {|match| "spec/pages/#{match[1]}_spec.rb"}
+	# 	watch(%r{^pages/(.+)controller\.rb$}) {|match| Dir.glob("spec/pages/#{match[1]}*_spec.rb")}
 		
-		# If any files in pages changes, ensure the website still works:
-		watch(%r{^pages/.*}) {'spec/website_spec.rb'}
-	end
+	# 	# If any files in pages changes, ensure the website still works:
+	# 	watch(%r{^pages/.*}) {'spec/website_spec.rb'}
+	# end
 end

data/setup/site/config/sus.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+require 'variant'
+Variant.force!(:testing)
+
+require 'covered/sus'
+include Covered::Sus

data/setup/site/fixtures/website.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2016-2023, by Samuel Williams.
+
+require 'rack/test'
+require 'sus/fixtures/async/http'
+require 'protocol/rack'
+
+AWebsite = Sus::Shared("a 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)}
+end
+
+AValidPage = Sus::Shared("a valid page") do |path|
+	it "can access #{path}" do
+		get path
+		
+		while last_response.redirect?
+			follow_redirect!
+		end
+		
+		expect(last_response.status).to be == 200
+	end
+end
+
+AServer = Sus::Shared("a server") do
+	include Sus::Fixtures::Async::HTTP::ServerContext
+	
+	let(:rackup_path) {File.expand_path('../config.ru', __dir__)}
+	let(:rackup_directory) {File.dirname(rackup_path)}
+	
+	let(:rack_app) {Rack::Builder.parse_file(rackup_path)}
+	let(:app) {Protocol::Rack::Adapter.new(rack_app)}
+end

data/setup/site/gems.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2012-2022, by Samuel Williams.
+# Copyright, 2012-2023, by Samuel Williams.
 
 source 'https://rubygems.org'
 
@@ -13,20 +13,18 @@ group :preload do
 	gem 'variant'
 end
 
-gem 'rake'
-gem 'bake'
-gem 'bundler'
-gem 'rack-test'
 gem 'net-smtp'
 
 group :development do
+	gem 'bake-test'
+	gem 'rack-test'
 	gem 'guard-falcon', require: false
-	gem 'guard-rspec', require: false
 	
-	gem 'rspec'
+	gem 'sus'
+	gem 'sus-fixtures-async-http'
+	
 	gem 'covered'
 	
-	gem 'async-rspec'
 	gem 'benchmark-http'
 end
 

data/setup/site/test/website.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2016-2023, by Samuel Williams.
+
+require 'website'
+require 'benchmark/http'
+
+describe "website" do
+	include_context AServer
+	
+	let(:timeout) {10}
+	let(:spider) {Benchmark::HTTP::Spider.new(depth: 128)}
+	let(:statistics) {Benchmark::HTTP::Statistics.new}
+	
+	it "should be responsive" do
+		spider.fetch(statistics, client, endpoint.url) do |method, uri, response|
+			if response.failure?
+				Console.logger.error(endpoint) {"#{method} #{uri} -> #{response.status}"}
+			end
+		end.wait
+		
+		statistics.print
+		
+		expect(statistics.samples).to be(:any?)
+		expect(statistics.failed).to be(:zero?)
+	end
+end