utopia 2.13.4 → 2.16.1

data/.codeclimate.yml

@@ -1,5 +0,0 @@
-exclude_paths:
-- "docs/**/*"
-- "documentation/**/*"
-- "setup/**/*"
-- "benchmarks/*"

data/.gitignore

@@ -1,8 +0,0 @@
-tmp
-.tags*
-*.gem
-Gemfile.lock
-documentation/run/*
-documentation/public/code/*
-.rspec_status
-.yardoc

data/.rspec

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

data/.travis.yml

@@ -1,28 +0,0 @@
-language: ruby
-cache: bundler
-
-before_install:
-  - gem install bundler
-  # Install all dependencies:
-  - gem install utopia
-  # For testing purposes:
-  - git config --global user.email "samuel@oriontransfer.net"
-  - git config --global user.name "Samuel Williams"
-
-matrix:
-  include:
-    - rvm: 2.5
-    - rvm: 2.6
-      env: BENCHMARK=true
-    - rvm: 2.6
-      env: COVERAGE=BriefSummary,Coveralls
-    - rvm: 2.6
-      os: osx
-    - rvm: 2.7
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: truffleruby
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: truffleruby

data/.yardopts

@@ -1,2 +0,0 @@
---markup markdown
---asset materials:materials

data/Gemfile

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in utopia.gemspec
-gemspec
-
-group :development do
-	gem 'yard'
-	
-	gem 'kramdown'
-	gem 'kramdown-parser-gfm'
-	
-	gem 'json'
-	
-	gem 'rackula'
-end
-
-group :test do
-	gem 'benchmark-ips'
-	gem 'ruby-prof', platforms: :mri
-	
-	gem 'guard-falcon'
-	
-	gem 'rack-test'
-end
-
-gem "thread-local", "~> 1.0"

data/README.md

@@ -1,92 +0,0 @@
-# ![Utopia Logo](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.
-
-[![Build Status](https://travis-ci.com/socketry/utopia.svg?branch=master)](http://travis-ci.com/socketry/utopia)
-[![Code Climate](https://codeclimate.com/github/ioquatix/utopia.svg)](https://codeclimate.com/github/ioquatix/utopia)
-[![Coverage Status](https://coveralls.io/repos/ioquatix/utopia/badge.svg)](https://coveralls.io/r/ioquatix/utopia)
-
-## Motivation
-
-The [original Utopia project](https://github.com/ioquatix/utopia-php) was written in PHP in the early 2000s. It consisted of an XML parser, a database layer and some code to assist with business logic. It was initially designed to reduce the amount of HTML required to build both content-centric websites and business apps. At the time, CSS was very poorly supported and thus a lot of the time, you'd be using quite complex `<table>`s with embedded `<img>`s to generate simple things like boxes with drop shadows, etc. Utopia provided a core concept - a node - which was essentially a small snippet of HTML, which could be composed into other nodes simply by using a named tag (similar to ColdFusion). Attributes and content were passed in, and thus you could easily build complex pages with simple semantic markup.
-
-At the time, the available frameworks were pretty basic. Utopia was a working, albeit poor, implementation of MVC and supported several commercial websites I developed at the time. I made it, partly just because I could, but also because it served a commercial purpose.
-
-Eventually one day I started using Ruby on Rails. There are aspects of the Rails framework which I like. However, at the time I was using it (starting with version 0.8), I found that it's flat organisation of controllers and views very limiting. Nested controllers and views make it easier to manage complexity in a web application. Utopia embraces this principle, and applies it to both the controller and view layers. I also developed a [model layer with similar principles](https://github.com/ioquatix/relaxo-model).
-
-So, Utopia exists because it suits my way of thinking about web applications, and it's conceptual core has been refined for over a decade. It provides a considered amount of both flexibility, and opinionated behavior.
-
-### Is it production ready?
-
-Yes. We've used Utopia since about 2010 in production.
-
-### Is it fast?
-
-Yes. [Trenni](https://github.com/ioquatix/trenni) includes native [Ragel](http://www.colm.net/open-source/ragel/) parsers, and Utopia uses [Concurrent::Map](https://github.com/ruby-concurrency/concurrent-ruby) for multi-thread safe caches. On my laptop, Utopia can process 3000 requests/s rendering content on a single thread.
-
-## Installation
-
-Make sure you have git, ruby, and bundler installed and set up correctly.
-
-Install utopia:
-
-	$ gem install utopia
-
-Create a new site:
-
-	$ mkdir www.example.com
-	$ cd www.example.com
-	$ utopia site create
-	$ rake
-
-## Usage
-
-There is an excellent [documentation wiki](https://ioquatix.github.io/utopia/) included with the source code. Simply clone this repository and `rake documentation:server`. This documentation wiki is editable, so feel free to submit a PR with improvements.
-
-## Contributing
-
-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::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.
-
-### Applications
-
-- [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.
-
-## License
-
-Released under the MIT license.
-
-Copyright, 2017, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
-
-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/Rakefile

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:test)
-
-namespace :documentation do
-	task :yard do
-		sh('yard', '-o', "documentation/public/code")
-	end
-
-	desc "Build and run the documentation wiki."
-	task :server => :yard do
-		Bundler.with_unbundled_env do
-			Dir.chdir('documentation') do
-				sh('bundle', 'install', '--quiet')
-				sh('bundle', 'exec', 'rake')
-			end
-		end
-	end
-
-	desc "Update static documentation."
-	task :static => :yard do
-		require 'rackula/command'
-		
-		Dir.chdir("documentation") do
-			Rackula::Command::Top["generate", "--force", "--output-path", "../docs"].invoke
-		end
-	end
-end
-
-task :default => :test

data/benchmark/call_vs_check.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require 'benchmark/ips'
-
-class A
-end
-
-class B
-	def self.do
-	end
-end
-
-class C
-	def self.do
-	end
-end
-
-Benchmark.ips do |x|
-	x.report("responds_to? (nothing)") do |times|
-		while (times -= 1) >= 0
-			A.do if A.respond_to?(:do)
-		end
-	end
-	
-	x.report("B (empty method)") do |times|
-		while (times -= 1) >= 0
-			B.do
-		end
-	end
-	
-	x.report("responds_to? (empty method)") do |times|
-		while (times -= 1) >= 0
-			C.do if C.respond_to?(:do)
-		end
-	end
-	
-	x.compare!
-end

data/benchmark/const_vs_hash.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require 'benchmark/ips'
-
-module Foo
-	class Bar
-	end
-end
-
-
-THINGS = {
-	'Bar' => Foo::Bar
-}
-
-Benchmark.ips do |x|
-	x.report("const_get('Bar')") do |i|
-		while (i -= 1) > 0
-			Foo.const_get('Bar')
-		end
-	end
-
-	x.report("const_get(:Bar)") do |i|
-		while (i -= 1) > 0
-			Foo.const_get(:Bar)
-		end
-	end
-
-	x.report("Hash\#[]") do |i|
-		while (i -= 1) > 0
-			THINGS['Bar']
-		end
-	end
-	
-	x.compare!
-end

data/benchmark/hash_vs_openstruct.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-require 'benchmark/ips'
-require 'ostruct'
-
-# This benchmark compares accessing an instance variable vs accessing a struct member (via a function). The actual method dispatch is about 25% slower.
-
-puts "Ruby #{RUBY_VERSION} at #{Time.now}"
-
-NAME = "Test Name"
-EMAIL = "test@example.org"
-
-test = nil
-
-class ObjectHash
-	def []= key, value
-		instance_variable_set(key, value)
-	end
-	
-	def [] key
-		instance_variable_get(key)
-	end
-end
-
-# There IS a measuarble difference:
-Benchmark.ips do |x|
-	x.report("Hash") do |i|
-		i.times do
-			p = {name: NAME, email: EMAIL}
-			
-			test = p[:name] + p[:email]
-		end
-	end
-	
-	x.report("OpenStruct") do |i|
-		i.times do
-			p = OpenStruct.new(name: NAME, email: EMAIL)
-			
-			test = p.name + p.email
-	 end
-	end
-	
-	x.report("ObjectHash") do |i|
-		i.times do
-			o = ObjectHash.new
-			o[:@name] = NAME
-			o[:@email] = EMAIL
-			
-			test = o[:@name] + o[:@email]
-		end
-	end
-	
-	x.compare!
-end

data/benchmark/string_vs_symbol.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-require 'benchmark/ips'
-
-STRING_HASH = { "foo" => "bar" }
-SYMBOL_HASH = { :foo => "bar"  }
-
-Benchmark.ips do |x|
-	x.report("string") { STRING_HASH["foo"] }
-	x.report("symbol") { SYMBOL_HASH[:foo]  }
-	x.report("symbol-from-string") { SYMBOL_HASH["foo".to_sym]  }
-	
-	x.compare!
-end

data/benchmark/struct_vs_class.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-require 'benchmark/ips'
-
-# This benchmark compares accessing an instance variable vs accessing a struct member (via a function). The actual method dispatch is about 25% slower.
-
-puts "Ruby #{RUBY_VERSION} at #{Time.now}"
-
-ItemsStruct = Struct.new(:items) do
-	def initialize
-		super []
-	end
-	
-	def push_me_pull_you(value = :x)
-		items = self.items
-		
-		items << value
-		items.pop
-	end
-	
-	def empty?
-		self.items.empty?
-	end
-end
-
-class ItemsClass
-	def initialize
-		@items = []
-	end
-	
-	def push_me_pull_you(value = :x)
-		items = @items
-		
-		items << value
-		items.pop
-	end
-	
-	def empty?
-		@items.empty?
-	end
-end
-
-# There IS a measuarble difference:
-Benchmark.ips do |x|
-	x.report("Struct#empty?") do |times|
-		i = 0
-		instance = ItemsStruct.new
-		
-		while i < times
-			break unless instance.empty?
-			i += 1
-		end
-	end
-	
-	x.report("Class#empty?") do |times|
-		i = 0
-		instance = ItemsClass.new
-		
-		while i < times
-			break unless instance.empty?
-			i += 1
-		end
-	end
-	
-	x.compare!
-end
-
-# This shows that in the presence of additional work, the difference is neglegible.
-Benchmark.ips do |x|
-	x.report("Struct#push_me_pull_you") do |times|
-		i = 0
-		a = A.new
-		
-		while i < times
-			a.push_me_pull_you(i)
-			i += 1
-		end
-	end
-	
-	x.report("Class#push_me_pull_you") do |times|
-		i = 0
-		b = B.new
-		
-		while i < times
-			b.push_me_pull_you(i)
-			i += 1
-		end
-	end
-	
-	x.compare!
-end