utopia 2.20.1 → 2.22.0

data/lib/utopia/session.rb

@@ -1,24 +1,8 @@
 # frozen_string_literal: true
 
-# Copyright, 2012, 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.
+# Released under the MIT License.
+# Copyright, 2014-2022, by Samuel Williams.
+# Copyright, 2019, by Huba Nagy.
 
 require 'openssl'
 require 'digest/sha2'

data/lib/utopia/setup.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# 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.
+# Released under the MIT License.
+# Copyright, 2010-2022, by Samuel Williams.
 
 require 'yaml'
 require 'securerandom'

data/lib/utopia/shell.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2020, 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.
+# Released under the MIT License.
+# Copyright, 2020-2022, by Samuel Williams.
 
 require 'rack/builder'
 require 'rack/test'

data/lib/utopia/static/local_file.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2012, 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.
+# Released under the MIT License.
+# Copyright, 2017-2022, by Samuel Williams.
 
 require 'time'
 require 'digest/sha1'

data/lib/utopia/static/mime_types.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2012, 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.
+# Released under the MIT License.
+# Copyright, 2017-2022, by Samuel Williams.
 
 require 'mime/types'
 

data/lib/utopia/static.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2012, 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.
+# Released under the MIT License.
+# Copyright, 2009-2022, by Samuel Williams.
 
 require_relative 'middleware'
 require_relative 'localization'

data/lib/utopia/version.rb

@@ -1,25 +1,8 @@
 # frozen_string_literal: true
 
-# Copyright, 2012, 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.
+# Released under the MIT License.
+# Copyright, 2009-2022, by Samuel Williams.
 
 module Utopia
-	VERSION = "2.20.1"
+	VERSION = "2.22.0"
 end

data/lib/utopia.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2012, 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.
+# Released under the MIT License.
+# Copyright, 2009-2022, by Samuel Williams.
 
 require_relative 'utopia/version'
 
@@ -31,4 +14,4 @@ require_relative 'utopia/content_length'
 
 # Utopia is a web application framework built on top of Rack.
 module Utopia
-end
+end

data/license.md

@@ -0,0 +1,25 @@
+# MIT License
+
+Copyright, 2009-2023, by Samuel Williams.  
+Copyright, 2015-2019, by Huba Nagy.  
+Copyright, 2020, by Olle Jonsson.  
+Copyright, 2020, by Pierre Montelle.  
+Copyright, 2020, by Michael Adams.  
+
+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.

data/readme.md

@@ -0,0 +1,44 @@
+# ![Utopia](materials/utopia.svg)
+
+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)
+
+## Features
+
+  - Designed for both content-based websites and applications. Does not depend on a database.
+  - Supports flexible content localization based on industry recommendations.
+  - Rack middleware compatible with all major Ruby application servers. Small memory footprint by default.
+  - Low latency and high throughput. Capable of 10,000+ requests/second out of the box.
+
+## Usage
+
+Please see the [project documentation](https://socketry.github.io/utopia).
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+## See Also
+
+  - [Trenni](https://github.com/ioquatix/trenni) — Template and markup parsers, markup generation.
+  - [Trenni::Formatters](https://github.com/ioquatix/trenni-formatters) — Helpers for HTML generation including views and forms.
+  - [Utopia::Gallery](https://github.com/ioquatix/utopia-gallery) — A fast photo gallery based on [libvips](https://github.com/jcupitt/libvips).
+  - [Utopia::Project](https://github.com/socketry/utopia-project) — A Ruby project documentation tool.
+  - [Utopia::Analytics](https://github.com/ioquatix/utopia-analytics) — Simple integration with Google Analytics.
+  - [HTTP::Accept](https://github.com/ioquatix/http-accept) — RFC compliant header parser.
+  - [Samovar](https://github.com/ioquatix/samovar) — Command line parser used by Utopia.
+  - [Mapping](https://github.com/ioquatix/mapping) — Provide structured conversions for web interfaces.
+  - [Rack::Test::Body](https://github.com/ioquatix/rack-test-body) — Provide convenient helpers for testing web interfaces.
+
+### Examples
+
+  - [Financier](https://github.com/ioquatix/financier) — A small business management platform.
+  - [mail.oriontransfer.net](https://github.com/oriontransfer/mail.oriontransfer.net) - Mail server account management.
+  - [www.codeotaku.com](http://www.codeotaku.com) ([source](https://github.com/ioquatix/www.codeotaku.com)) — Personal website, blog.

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/bake.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
-# Prepare the application for start/restart.
+# Released under the MIT License.
+# Copyright, 2020-2022, by Samuel Williams.
+
 def deploy
 	# This task is typiclly run after the site is updated but before the server is restarted.
 end

data/setup/site/config/environment.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2016-2022, by Samuel Williams.
+
 require 'bundler/setup'
 Bundler.setup
 

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/falcon.rb

@@ -1,6 +1,9 @@
 #!/usr/bin/env -S falcon host
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2019-2022, by Samuel Williams.
+
 load :rack, :lets_encrypt_tls, :supervisor
 
 hostname = File.basename(__dir__)

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,5 +1,8 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2012-2023, by Samuel Williams.
+
 source 'https://rubygems.org'
 
 group :preload do
@@ -10,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