utopia 2.22.1 → 2.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5346625f0101f4b3dee975979109f2ee037f0f988ad4e2f229dd4bdbb5c11ccb
-  data.tar.gz: ca3605f007fb7d6652ca0b25602932b42aa77e2a1b2a16370fcfcd2f634b6f23
+  metadata.gz: fe8b55483bdf9ce333c4edc86df63f44089079c03ba671d8c0dfe889751733c0
+  data.tar.gz: cd2642132d31ac3a4e46e688daf3ff9d1e1f706f7eff89ea5f8ed25af9e0f337
 SHA512:
-  metadata.gz: b9e41aeefc40579975116bb42d231de217f5409970647a0c0ac25568fd339ecf934280245996e4b46c49b2426c396c5b43d6d0bf1d83113f9dae71f8fc289c9b
-  data.tar.gz: 6d1daec542aec32e68fa1954bb8bd7f4d29130d88cab7247e62d1a955b91d4117628611239f7d72b94864aae65c8788b0902b844d6a793e05d87a1880f5e97f3
+  metadata.gz: ef6f7c5e487e5df0edcaa341b6b699b2ad0f41879c8b36a8dd00b7006f65d62a99f908bf158ef7dd3a67406ba08f31d94dc7fdb952177633b9d3206abacae029
+  data.tar.gz: 637c10fca8f1e1e6ff8b1f6e252ed71ad41ed80f196b6198416a2b452664e518c34544f756d2e3aaf911c3fbe454b5545eaa724f7b4ab6ed65a9492422b2d7f1

data/bake/utopia/environment.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2022, by Samuel Williams.
+# Copyright, 2018-2023, by Samuel Williams.
 
 # Update environment variables in config/environment.yaml
 def initialize(...)
@@ -15,8 +15,8 @@ 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)
+	defaults("testing", root: root)
+	defaults("development", root: root)
 end
 
 # Setup the defaults for a specific environment.
@@ -24,6 +24,7 @@ end
 # @parameter root [String] The root directory of the project.
 def defaults(name, root: context.root)
 	update_environment(root, name) do |store|
+		Console.logger.info(self) {"Setting up defaults for environment #{name}..."}
 		# Set some useful defaults for the environment.
 		store['UTOPIA_SESSION_SECRET'] ||= SecureRandom.hex(40)
 	end
@@ -33,22 +34,23 @@ end
 # @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)
+	update_environment(root, name) do |store, _, path|
+		variables&.each do |key, value|
+			# Ensure the key is a string...
+			key = key.to_s
 			
-			if value
-				puts "ENV[#{key.inspect}] will default to #{value.inspect} unless otherwise specified."
+			if value && !value.empty?
+				Console.logger.info(self) {"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."
+				Console.logger.info(self) {"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|
+		Console.logger.info(self) do |buffer|
 			buffer.puts "Environment #{name} (#{path}):"
 			store.roots.each do |key|
 				value = store[key]

data/bake/utopia/server.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2017-2022, by Samuel Williams.
+# Copyright, 2023, by Samuel Williams.
 
 def initialize(...)
 	super

data/bake/utopia/site.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2017-2023, by Samuel Williams.
-# Copyright, 2020, by Michael Adams.
+# Copyright, 2023, by Samuel Williams.
 
 def initialize(...)
 	super
@@ -20,7 +19,7 @@ SETUP_ROOT = File.expand_path("../../setup", __dir__)
 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 = ["config", "lib", "pages", "public", "bake", "fixtures", "test"]
 
 # Directories that should be removed during upgrade process:
 OLD_PATHS = ["access_log", "cache", "tmp", "Rakefile", "tasks", ".bowerrc"]
@@ -64,6 +63,8 @@ def create(root: context.root)
 	
 	system("bundle", "install", chdir: root) or warn "could not install bundled gems"
 	
+	context.lookup('utopia:environment:setup').call(root: root)
+	
 	if !File.exist?('.git')
 		Console.logger.info(self) {"Setting up git repository..."}
 		
@@ -72,8 +73,6 @@ def create(root: context.root)
 		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
@@ -92,36 +91,37 @@ 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
+	message = "Upgrade to utopia v#{Utopia::VERSION}."
 	
-	OLD_PATHS.each do |path|
-		path = File.join(root, path)
-		Console.logger.info(self) {"Removing #{path}..."}
-		FileUtils.rm_rf(path)
-	end
+	Console.logger.info(self) {"Upgrading #{root}..."}
 	
-	CONFIGURATION_FILES.each do |configuration_file|
-		source_path = File.join(SITE_ROOT, configuration_file)
-		destination_path = File.join(root, configuration_file)
+	commit_changes(root, message) do
+		DIRECTORIES.each do |directory|
+			FileUtils.mkdir_p(File.join(root, directory))
+		end
 		
-		Console.logger.info(self) {"Updating #{destination_path}..."}
+		OLD_PATHS.each do |path|
+			path = File.join(root, path)
+			
+			if File.exist?(path)
+				Console.logger.info(self) {"Removing #{path}..."}
+				FileUtils.rm_rf(path)
+			end
+		end
 		
-		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)
+		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('utopia:environment:setup').call(root: root)
 	
-	begin
 		# Stage any files that have been changed or removed:
 		system("git", "add", "-u", chdir: root) or fail "could not add files"
 		
@@ -130,26 +130,27 @@ def upgrade(root: context.root)
 		
 		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
 
+def commit_changes(root, message)
+	# Ensure the current branch is clean:
+	system("git", "diff-index", "--quiet", "HEAD", chdir: root) or fail "current branch is not clean"
+	
+	begin
+		yield
+	rescue
+		# Clear out the changes:
+		system("git", "reset", "--hard", "HEAD", chdir: root) or fail "could not reset changes"
+		raise
+	end
+	
+	# Commit all changes:
+	system("git", "commit", "-m", message, chdir: root) or fail "could not commit changes"
+end
+
 # Move legacy `pages/_static` to `public/_static`.
 def move_static!(root)
 	old_static_path = File.expand_path('pages/_static', root)

data/lib/utopia/content.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2009-2022, by Samuel Williams.
+# Copyright, 2009-2023, by Samuel Williams.
 
 require_relative 'middleware'
 require_relative 'localization'
@@ -190,7 +190,7 @@ module Utopia
 				'link.href' => link.href
 			}
 			
-			trace("utopia.content.respond", attributes: attributes) {super}
+			Traces.trace("utopia.content.respond", attributes: attributes) {super}
 		end
 	end
 end

data/lib/utopia/static.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2009-2022, by Samuel Williams.
+# Copyright, 2009-2023, by Samuel Williams.
 
 require_relative 'middleware'
 require_relative 'localization'
@@ -102,7 +102,7 @@ module Utopia
 				path_info: path_info,
 			}
 			
-			trace("utopia.static.respond", attributes: attributes) {super}
+			Traces.trace("utopia.static.respond", attributes: attributes) {super}
 		end
 	end
 end

data/lib/utopia/version.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2009-2022, by Samuel Williams.
+# Copyright, 2009-2023, by Samuel Williams.
 
 module Utopia
-	VERSION = "2.22.1"
+	VERSION = "2.23.0"
 end

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/ioquatix/utopia/workflows/Test/badge.svg)](https://github.com/ioquatix/utopia/actions?workflow=Test)
+[![Development Status](https://github.com/socketry/utopia/workflows/Test/badge.svg)](https://github.com/socketry/utopia/actions?workflow=Test)
 
 ## Features
 
@@ -25,6 +25,14 @@ We welcome contributions to this project.
 4.  Push to the branch (`git push origin my-new-feature`).
 5.  Create new Pull Request.
 
+### Developer Certificate of Origin
+
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+
+### Contributor Covenant
+
+This project is governed by [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
+
 ## See Also
 
   - [Trenni](https://github.com/ioquatix/trenni) — Template and markup parsers, markup generation.

data/setup/site/Guardfile

@@ -8,22 +8,3 @@ group :development do
 		notification :off
 	end
 end
-
-group :test do
-	# 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'}
-		
-	# 	# 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
-end

data/setup/site/config.ru

@@ -14,7 +14,7 @@ else
 	use Rack::ShowExceptions unless UTOPIA.testing?
 end
 
-# serve static files from public/
+# Serve static files from "public" directory:
 use Utopia::Static, root: 'public'
 
 use Utopia::Redirection::Rewrite, {
@@ -40,10 +40,10 @@ use Utopia::Session,
 
 use Utopia::Controller
 
-# serve static files from pages/
+# Serve static files from "pages" directory:
 use Utopia::Static
 
-# Serve dynamic content
+# Serve dynamic content:
 use Utopia::Content
 
 run lambda { |env| [404, {}, []] }

data/setup/site/fixtures/website.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2016-2023, by Samuel Williams.
+# Copyright, 2023, by Samuel Williams.
 
 require 'rack/test'
 require 'sus/fixtures/async/http'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: utopia
 version: !ruby/object:Gem::Version
-  version: 2.22.1
+  version: 2.23.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -41,7 +41,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-02-21 00:00:00.000000000 Z
+date: 2023-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -173,16 +173,16 @@ dependencies:
   name: traces
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: trenni
   requirement: !ruby/object:Gem::Requirement
@@ -404,14 +404,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: Utopia is a framework for building dynamic content-driven websites.