utopia 2.21.0 → 2.22.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: utopia
 version: !ruby/object:Gem::Version
-  version: 2.21.0
+  version: 2.22.0
 platform: ruby
 authors:
 - Samuel Williams
 - Huba Nagy
 - Michael Adams
 - Olle Jonsson
-- k1tsu
+- Pierre Montelle
 autorequire:
 bindir: bin
 cert_chain:
@@ -41,7 +41,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2022-12-28 00:00:00.000000000 Z
+date: 2023-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -49,14 +49,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: console
   requirement: !ruby/object:Gem::Requirement
@@ -212,7 +212,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: async-rspec
+  name: async-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -226,7 +226,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: async-websocket
+  name: bake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -240,7 +240,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -254,7 +254,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: covered
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -268,7 +268,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: covered
+  name: falcon
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -282,7 +282,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: falcon
+  name: sus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -296,37 +296,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: sus-fixtures-async-http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0'
 description:
 email:
-executables:
-- utopia
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - bake/utopia.rb
+- bake/utopia/environment.rb
 - bake/utopia/node.rb
+- bake/utopia/server.rb
 - bake/utopia/shell.rb
+- bake/utopia/site.rb
 - bake/utopia/static.rb
-- bake/utopia/test.rb
-- bin/utopia
 - lib/utopia.rb
-- lib/utopia/command.rb
-- lib/utopia/command/environment.rb
-- lib/utopia/command/server.rb
-- lib/utopia/command/site.rb
 - lib/utopia/content.rb
 - lib/utopia/content/document.rb
 - lib/utopia/content/link.rb
@@ -372,14 +368,14 @@ files:
 - readme.md
 - setup/server/git/hooks/post-receive
 - setup/site/.gitignore
-- setup/site/.rspec
 - setup/site/Guardfile
-- setup/site/README.md
 - setup/site/bake.rb
 - setup/site/config.ru
-- setup/site/config/README.md
 - setup/site/config/environment.rb
+- setup/site/config/readme.md
+- setup/site/config/sus.rb
 - setup/site/falcon.rb
+- setup/site/fixtures/website.rb
 - setup/site/gems.rb
 - setup/site/lib/readme.txt
 - setup/site/pages/_heading.xnode
@@ -393,9 +389,8 @@ files:
 - setup/site/public/_static/utopia-background.svg
 - setup/site/public/_static/utopia.svg
 - setup/site/public/readme.txt
-- setup/site/spec/spec_helper.rb
-- setup/site/spec/website_context.rb
-- setup/site/spec/website_spec.rb
+- setup/site/readme.md
+- setup/site/test/website.rb
 homepage: https://github.com/ioquatix/utopia
 licenses:
 - MIT
@@ -409,14 +404,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.0.dev
 signing_key:
 specification_version: 4
 summary: Utopia is a framework for building dynamic content-driven websites.

data/bake/utopia/test.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2020-2022, by Samuel Williams.
-
-def coverage
-	ENV['COVERAGE'] = 'PartialSummary'
-end
-
-def test
-	system("rspec") or abort
-end

data/bin/utopia

@@ -1,25 +0,0 @@
-#!/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_relative '../lib/utopia/command'
-
-Utopia::Command.call

data/lib/utopia/command/environment.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2018-2022, by Samuel Williams.
-
-require 'securerandom'
-require 'yaml/store'
-require 'console'
-
-module Utopia
-	module Command
-		# Set environment variables within the server deployment.
-		class Environment < Samovar::Command
-			self.description = "Update environment variables in config/environment.yaml"
-			
-			options do
-				option '-e/--environment-name <name>', "The environment file to modify.", default: 'environment'
-				option '-d/--defaults', "Initialize any recommended defaults."
-			end
-			
-			many :variables, "A list of environment KEY=VALUE pairs to set."
-			
-			def self.defaults(destination_root)
-				# Set some useful defaults for the environment.
-				self["--environment-name", "testing", "--defaults"].call(destination_root)
-				self["--environment-name", "development", "--defaults"].call(destination_root)
-			end
-			
-			def environment_name
-				@options[:environment_name]
-			end
-			
-			# Setup `config/environment.yaml` according to specified options.
-			def update_environment(root, name = self.environment_name)
-				environment_path = File.join(root, "config", "#{name}.yaml")
-				FileUtils.mkpath File.dirname(environment_path)
-				
-				store = YAML::Store.new(environment_path)
-				
-				store.transaction do
-					yield store, name, environment_path
-				end
-			end
-			
-			def call(root = parent.root)
-				update_environment(root) do |store, name, path|
-					if @options[:defaults]
-						# Set some useful defaults for the environment.
-						store['UTOPIA_SESSION_SECRET'] ||= SecureRandom.hex(40)
-					end
-					
-					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
-					
-					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
-		end
-	end
-end

data/lib/utopia/command/server.rb

@@ -1,100 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2017-2022, by Samuel Williams.
-
-require_relative 'site'
-
-require 'fileutils'
-require 'socket'
-
-require 'samovar'
-
-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 hostname
-					Socket.gethostname
-				end
-				
-				def call
-					destination_root = parent.root
-					
-					FileUtils.mkdir_p File.join(destination_root, "public")
-					
-					Update[parent: parent].call
-					
-					# Print out helpful git remote add message:
-					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 template_root
-					# The root directory of the template server deployment:
-					File.join(SETUP_ROOT, 'server')
-				end
-				
-				def call
-					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"
-						
-						# 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")
-						
-						# 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
-					
-					# Set some useful defaults for the environment.
-					environment = Environment[]
-					environment.update_environment(destination_root) do |store|
-						store['VARIANT'] ||= 'production'
-						store['UTOPIA_SESSION_SECRET'] ||= SecureRandom.hex(40)
-					end
-					
-					# Copy git hooks:
-					system("cp", "-r", File.join(template_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
-					# This failed for me and I had to do sudo chown http:http .git -R first.
-					system("chmod", "-Rf", "g+w", File.join(destination_root, '.git')) or fail "could not update permissions of .git directory"
-				end
-			end
-			
-			self.description = "Manage server deployments."
-			
-			nested :command, {
-				'create' => Create,
-				'update' => Update
-			}
-			
-			def root
-				@parent.root
-			end
-			
-			def call
-				@command.call
-			end
-		end
-	end
-end

data/lib/utopia/command/site.rb

@@ -1,217 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2017-2022, by Samuel Williams.
-# Copyright, 2020, by Michael Adams.
-
-require 'fileutils'
-require 'find'
-
-require 'samovar'
-
-module Utopia
-	module Command
-		# This path must point to utopia/setup in the gem source.
-		SETUP_ROOT = File.expand_path("../../../setup", __dir__)
-		
-		# Local site setup commands.
-		class Site < Samovar::Command
-			# Configuration files which should be installed/updated:
-			CONFIGURATION_FILES = ['.gitignore', 'config.ru', 'config/environment.rb', 'falcon.rb', 'gems.rb', 'Guardfile', 'bake.rb', 'spec/spec_helper.rb', 'spec/website_context.rb', 'spec/website_spec.rb']
-			
-			# Directories that should exist:
-			DIRECTORIES = ["config", "lib", "pages", "public", "tasks", "spec"]
-			
-			# Directories that should be removed during upgrade process:
-			OLD_PATHS = ["access_log", "cache", "tmp", "Rakefile", "tasks", ".bowerrc"]
-			
-			# The root directory of the template site:
-			ROOT = File.join(SETUP_ROOT, 'site')
-			
-			# Create a local site.
-			class Create < Samovar::Command
-				self.description = "Create a new local Utopia website using the default template."
-				
-				def call
-					destination_root = parent.root
-					
-					$stderr.puts "Setting up initial site in #{destination_root} for Utopia v#{Utopia::VERSION}..."
-					
-					DIRECTORIES.each do |directory|
-						FileUtils.mkdir_p(File.join(destination_root, directory))
-					end
-					
-					Find.find(ROOT) do |source_path|
-						# What is this doing?
-						destination_path = File.join(destination_root, source_path[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
-					
-					CONFIGURATION_FILES.each do |configuration_file|
-						destination_path = File.join(destination_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
-							warn "Could not open #{destination_path}, maybe it should be removed from CONFIGURATION_FILES?"
-						end
-					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") 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
-					
-					Environment.defaults(destination_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
-			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 public/_static doens't exist, we are done.
-					return unless File.exist? 'pages/_static'
-					
-					if File.exist? 'public/_static'
-						if File.lstat("public/_static").symlink?
-							FileUtils.rm_f "public/_static"
-						else
-							warn "Can't move pages/_static to public/_static, destination already exists."
-							return
-						end
-					end
-					
-					# One more sanity check:
-					if File.directory? 'pages/_static'
-						system("git", "mv", "pages/_static", "public/")
-					end
-				end
-				
-				# Move `Gemfile` to `gems.rb`.
-				def update_gemfile!
-					# If `Gemfile` doens't exist, we are done:
-					return unless File.exist?('Gemfile')
-					
-					system("git", "mv", "Gemfile", "gems.rb")
-					system("git", "mv", "Gemfile.lock", "gems.locked")
-				end
-				
-				def call
-					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
-					
-					DIRECTORIES.each do |directory|
-						FileUtils.mkdir_p(File.join(destination_root, directory))
-					end
-					
-					OLD_PATHS.each do |path|
-						path = File.join(destination_root, path)
-						$stderr.puts "\tRemoving #{path}..."
-						FileUtils.rm_rf(path)
-					end
-					
-					CONFIGURATION_FILES.each do |configuration_file|
-						source_path = File.join(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
-					
-					Environment.defaults(destination_root)
-					
-					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", *Site::CONFIGURATION_FILES) or fail "could not add files"
-							
-							move_static!
-							update_gemfile!
-							
-							# 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 root
-				@parent.root
-			end
-			
-			def call
-				@command.call
-			end
-		end
-	end
-end

data/lib/utopia/command.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2016-2022, by Samuel Williams.
-# Copyright, 2017, by Huba Nagy.
-
-require_relative 'version'
-
-require_relative 'command/site'
-require_relative 'command/server'
-require_relative 'command/environment'
-
-module Utopia
-	module Command
-		def self.call(*arguments)
-			Top.call(*arguments)
-		end
-		
-		# The top level utopia command.
-		class Top < Samovar::Command
-			self.description = "A website development and deployment framework."
-			
-			options do
-				option '-i/--in/--root <path>', "Work in the given root directory."
-				option '-h/--help', "Print out help information."
-				option '-v/--version', "Print out the application version."
-			end
-			
-			nested :command, {
-				'site' => Site,
-				'server' => Server,
-				'environment' => Environment
-			}
-			
-			# The root directory for the site.
-			def root
-				File.expand_path(@options.fetch(:root, ''), Dir.getwd)
-			end
-			
-			def call
-				if @options[:version]
-					puts "#{self.name} v#{VERSION}"
-				elsif @options[:help]
-					print_usage(output: $stdout)
-				else
-					@command.call
-				end
-			end
-		end
-	end
-end

data/setup/site/.rspec

@@ -1,4 +0,0 @@
---format documentation
---backtrace
---warnings
---require spec_helper