RubyGems - utopia - Versions diffs - 1.7.1 → 1.8.0 - Mend

utopia 1.7.1 → 1.8.0

Files changed (61) hide show

checksums.yaml +4 -4
data/.travis.yml +2 -3
data/README.md +142 -11
data/benchmarks/string_vs_symbol.rb +12 -0
data/lib/utopia/command.rb +16 -13
data/lib/utopia/content.rb +1 -5
data/lib/utopia/content/node.rb +9 -4
data/lib/utopia/{extensions/rack.rb → content/response.rb} +33 -30
data/lib/utopia/content/tag.rb +14 -17
data/lib/utopia/content/transaction.rb +19 -17
data/lib/utopia/controller.rb +29 -8
data/lib/utopia/controller/actions.rb +148 -0
data/lib/utopia/controller/base.rb +9 -49
data/lib/utopia/controller/respond.rb +1 -1
data/lib/utopia/controller/rewrite.rb +9 -1
data/lib/utopia/controller/variables.rb +1 -0
data/lib/utopia/localization.rb +4 -1
data/lib/utopia/middleware.rb +0 -2
data/lib/utopia/path.rb +9 -0
data/lib/utopia/path/matcher.rb +0 -1
data/lib/utopia/redirection.rb +3 -2
data/lib/utopia/session.rb +119 -2
data/lib/utopia/session/lazy_hash.rb +1 -3
data/lib/utopia/setup.rb +73 -0
data/lib/utopia/static.rb +9 -2
data/lib/utopia/version.rb +1 -1
data/setup/examples/wiki/controller.rb +41 -0
data/setup/examples/wiki/edit.xnode +15 -0
data/setup/examples/wiki/index.xnode +10 -0
data/setup/examples/wiki/welcome/content.md +3 -0
data/setup/server/config/environment.yaml +1 -0
data/setup/server/git/hooks/post-receive +4 -5
data/setup/site/Gemfile +5 -0
data/setup/site/config.ru +2 -1
data/setup/site/config/environment.rb +5 -17
data/setup/site/pages/_page.xnode +4 -2
data/setup/site/pages/links.yaml +1 -1
data/setup/site/pages/welcome/index.xnode +33 -15
data/setup/site/public/_static/site.css +72 -4
data/setup/site/tasks/utopia.rake +8 -0
data/spec/utopia/{rack_spec.rb → content/response_spec.rb} +12 -19
data/spec/utopia/content_spec.rb +2 -3
data/spec/utopia/controller/{action_spec.rb → actions_spec.rb} +18 -32
data/spec/utopia/controller/middleware_spec.rb +10 -10
data/spec/utopia/controller/middleware_spec/controller/controller.rb +3 -3
data/spec/utopia/controller/middleware_spec/controller/nested/controller.rb +1 -1
data/spec/utopia/controller/middleware_spec/redirect/controller.rb +1 -1
data/spec/utopia/controller/respond_spec.rb +3 -2
data/spec/utopia/controller/respond_spec/api/controller.rb +2 -2
data/spec/utopia/controller/respond_spec/errors/controller.rb +1 -1
data/spec/utopia/controller/rewrite_spec.rb +1 -1
data/spec/utopia/controller/sequence_spec.rb +12 -16
data/spec/utopia/exceptions/handler_spec/controller.rb +2 -2
data/spec/utopia/performance_spec/config.ru +1 -0
data/spec/utopia/session_spec.rb +34 -1
data/spec/utopia/session_spec.ru +3 -3
data/spec/utopia/setup_spec.rb +2 -2
data/utopia.gemspec +2 -2
metadata +18 -12
data/lib/utopia/controller/action.rb +0 -116
data/lib/utopia/session/encrypted_cookie.rb +0 -118

data/setup/examples/wiki/index.xnode ADDED

@@ -0,0 +1,10 @@
+<page>
+	<heading>#{self[:page_title]}</heading>
+	#{Kramdown::Document.new(self[:content]).to_html}
+	<footer>
+		Last Modified: #{File.mtime(self[:page_file]) rescue "N/A"} &mdash;
+		<a href="edit">Edit</a>
+	</footer>
+</page>

data/setup/examples/wiki/welcome/content.md ADDED

@@ -0,0 +1,3 @@
+Utopia is a Rack framework and build around several key pieces of middleware which provide a MVC architecture for content-centric websites.
+Utopia [provides a command-line](utopia-command-line/)

data/setup/server/config/environment.yaml ADDED

	@@ -0,0 +1 @@
1	+ RACK_ENV: production

data/setup/server/git/hooks/post-receive CHANGED

@@ -41,7 +41,7 @@ WHOAMI = `whoami`.chomp!
 # We should find out if we need to use sudo or not:
 SUDO = if WHOAMI != DEPLOY_USER
-	["sudo", "-u", DEPLOY_USER]
+	['sudo', '-u', DEPLOY_USER]
 end
 CommandFailure = Class.new(StandardError)
@@ -72,9 +72,8 @@ Dir.chdir(GIT_WORK_TREE) do
 	if File.exist? 'Rakefile'
 		sudo %W{bundle exec rake deploy}
+		puts "Restarting server..."
+		sudo %W{bundle exec rake restart}
 	end
-	puts "Restarting server..."
-	sudo %W{mkdir -p tmp} unless File.exist?('tmp')
-	sudo %W{touch tmp/restart.txt}
 end

data/setup/site/Gemfile CHANGED

@@ -16,3 +16,8 @@ group :development do
 	gem "pry"
 	gem "rack-test"
 end
+group :production do
+	# Used for passenger-config to restart server after deployment:
+	gem "passenger"
+end

data/setup/site/config.ru CHANGED

@@ -32,7 +32,8 @@ use Utopia::Localization,
 	:nonlocalized => ['/_static/', '/_cache/']
 use Utopia::Controller,
-	cache_controllers: (RACK_ENV == :production)
+	cache_controllers: (RACK_ENV == :production),
+	base: Utopia::Controller::Base
 use Utopia::Static

data/setup/site/config/environment.rb CHANGED

@@ -1,20 +1,8 @@
-# Setup default encoding:
-Encoding.default_external = Encoding::UTF_8
-Encoding.default_internal = Encoding::UTF_8
+require 'bundler/setup'
+Bundler.setup
-# Load environment variables:
-environment_path = File.expand_path('environment.yaml', __dir__)
-if File.exist? environment_path
-	require 'yaml'
-	ENV.update(YAML.load_file(environment_path))
-end
+require 'utopia/setup'
+Utopia.setup
-# Setup the server environment:
-RACK_ENV = ENV.fetch('RACK_ENV', :development).to_sym unless defined?(RACK_ENV)
-# Allow loading library code from lib directory:
-$LOAD_PATH << File.expand_path('../lib', __dir__)
-# Load utopia framework:
-require 'utopia'
+RACK_ENV = ENV.fetch('RACK_ENV', :development).to_sym unless defined? RACK_ENV

data/setup/site/pages/_page.xnode CHANGED

@@ -10,14 +10,16 @@
 			<title>Utopia</title>
 		<?r end ?>
+		<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous" />
 		<link rel="icon" type="image/png" href="/_static/icon.png" />
 		<link rel="stylesheet" href="/_static/site.css" type="text/css" media="screen" />
 	</head>
 	<body class="#{attributes[:class]}">
-		<div id="header">
+		<header>
 			<img src="/_static/utopia.svg" />
-		</div>
+		</header>
 		<div id="page">
 			<content />

data/setup/site/pages/links.yaml CHANGED

@@ -1,2 +1,2 @@
 errors:
-    display: false
+    display: false

data/setup/site/pages/welcome/index.xnode CHANGED

@@ -1,17 +1,35 @@
 <page class="front">
-	<heading>Welcome to Utopia</heading>
+	<heading>Welcome to Utopia...</heading>
-	<p><strong>Utopia is designed to simplify web development.</strong> Utopia is a fully featured stack for both content-heavy sites and dynamic web applications.</p>
-	<h2>Server Side Tag Based Markup</h2>
-	<p>Server side tags reduce the amount of duplicate view code especially for content-heavy sites.</p>
-	<h2>Recursive Controller Layer</h2>
-	<p>Nested controllers make access control a breeze.</p>
-	<h2>Standards Based Localization</h2>
-	<p>Automatically sniff the user's desired language and provide content in the correct language.</p>
-</page>
+	<section class="features">
+		<div>
+			<i class="fa fa-bolt"></i>
+			<h2>Low latency and high throughput</h2>
+			<p>Utopia has been carefully tuned for low-latency and algorithmic efficiency. During development, requests reload the entire stack, while in production everything is cached using <a href="http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/Map.html">thread-safe data-structures</a>. Serve thousands of requests per second with ease.</p>
+		</div>
+		<div>
+			<i class="fa fa-cubes"></i>
+			<h2>Modular code and structure</h2>
+			<p>Utopia provides independently useful <a href="https://github.com/rack/rack">Rack</a> middleware and has been designed with simplicify in mind. Several fully-featured webapps and a ton of commercial websites have guided the development of the Utopia stack. It is capable of handling a diverse range of requirements.</p>
+		</div>
+		<div>
+			<i class="fa fa-code"></i>
+			<h2>Well tested and maintained</h2>
+			<p>Utopia comprises a <a href="https://github.com/ioquatix/utopia">core gem</a> and several supporting libraries, the main ones being <a href="https://github.com/ioquatix/trenni">trenni</a> for templates and parsing, and <a href="https://github.com/ioquatix/http-accept">http-accept</a> for HTTP header processing. Together, these gems have over 90% test coverage.</p>
+		</div>
+		<div>
+			<i class="fa fa-server"></i>
+			<h2>Batteries included</h2>
+			<p>Utopia includes both a recommended development model and a server deployment model out of the box. This is exposed via the <code>utopia</code> command. We recommend use of <a href="https://www.nginx.com">Nginx</a> and <a href="https://www.phusionpassenger.com">Passenger</a> for server side deployment.</p>
+		</div>
+		<div>
+			<i class="fa fa-globe"></i>
+			<h2>Standards compliant localization</h2>
+			<p>Utopia supports the <code>Accept-Language</code> header and transparently selects the correct view to render. Build multi-lingual websites and webapps easily: translate content incrementally as required, or not at all.</p>
+		</div>
+	</section>
+</page>

data/setup/site/public/_static/site.css CHANGED

@@ -2,11 +2,13 @@
 html {
 	font-family: "PT Sans", Verdana, Helvetica, Arial, sans-serif;
 }
 @media (min-width: 48em) {
 	html {
 		font-size: 16px;
 	}
 }
 @media (min-width: 58em) {
 	html {
 		font-size: 20px;
@@ -20,7 +22,7 @@ body {
 	background-color: #fafafa;
 }
-#header {
+body > header {
 	margin: 1em 0 1em 0;
 	background-color: white;
@@ -30,7 +32,7 @@ body {
 	box-shadow: 0 0 20px rgba(0, 0, 0, 0.1);
 }
-#header img {
+body > header img {
 	display: block;
 	margin: auto;
 	height: 4em;
@@ -45,7 +47,6 @@ p strong {
 }
 h1, h2, h3, h4, h5, h6 {
-	color: #333;
 	margin: 2em 1em 1em 1em;
 	color: #4E8DD9;
 }
@@ -62,7 +63,7 @@ a:hover {
 	color: #55c;
 }
-p, dl, h3 {
+p, ul, ol, dl, h3 {
 	margin: 2em;
 }
@@ -85,3 +86,70 @@ body.front h1 {
 	text-align: center;
 }
+footer {
+	text-align: right;
+	margin: 2rem;
+}
+section.features {
+	display: flex;
+	flex-wrap: wrap;
+	justify-content: space-around;
+	margin: 1rem;
+}
+section.features > div {
+	box-sizing: border-box;
+	flex-basis: 20rem;
+	flex-grow: 1;
+	color: #171e42;
+	margin: 1rem;
+	padding: 1rem;
+	padding-left: 3rem;
+	position: relative;
+}
+section.features > div i {
+	position: absolute;
+	left: 0rem;
+	font-size: 1.5rem;
+	text-align: center;
+	width: 3rem;
+	color: #fafafa;
+	text-shadow: 0px 0px 1px #000;
+}
+section.features p {
+	margin: 0;
+	maring-bottom: 1rem;
+	font-size: 80%;
+}
+section.features h2 {
+	margin: 0;
+	font-size: 1.1rem;
+	padding: 0;
+}
+form fieldset {
+	border: 0;
+}
+form fieldset textarea {
+	box-sizing: border-box;
+	width: 100%;
+	height: 10rem;
+}
+form fieldset.footer {
+	text-align: right;
+}

data/setup/site/tasks/utopia.rake CHANGED

@@ -4,6 +4,14 @@ task :deploy do
 	# This task is typiclly run after the site is updated but before the server is restarted.
 end
+desc 'Restart the application server'
+task :restart do
+	# This task is run after the deployment task above.
+	if passenger_config = `which passenger-config`.chomp!
+		sh(passenger_config, 'restart-app', '--ignore-passenger-not-running', File.dirname(__dir__))
+	end
+end
 desc 'Set up the environment for running your web application'
 task :environment do
 	require_relative '../config/environment'

data/spec/utopia/{rack_spec.rb → content/response_spec.rb} RENAMED

@@ -18,42 +18,35 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
-require 'utopia/extensions/date'
-require 'utopia/extensions/rack'
+require 'utopia/content/response'
-module Utopia::RackSpec
-	describe Rack::Response do
+module Utopia::Content::ResponseSpec
+	describe Utopia::Content::Response do
 		it "should specify not to cache content" do
-			response = Rack::Response.new
+			subject.cache!(1000)
+			subject.do_not_cache!
-			response.cache!(1000)
-			response.do_not_cache!
+			expect(subject.headers['Cache-Control']).to be == "no-cache, must-revalidate"
-			expect(response['Cache-Control']).to be == "no-cache, must-revalidate"
-			expires_header = Time.parse(response['Expires'])
+			expires_header = Time.parse(subject.headers['Expires'])
 			expect(expires_header).to be <= Time.now
 		end
 		it "should specify to cache content" do
-			response = Rack::Response.new
 			duration = 120
 			expires = Time.now + 100 # At least this far into the future
-			response.cache!(duration)
+			subject.cache!(duration)
-			expect(response['Cache-Control']).to be == "public, max-age=120"
+			expect(subject.headers['Cache-Control']).to be == "public, max-age=120"
-			expires_header = Time.parse(response['Expires'])
+			expires_header = Time.parse(subject.headers['Expires'])
 			expect(expires_header).to be >= expires
 		end
 		it "should set content type" do
-			response = Rack::Response.new
-			response.content_type! "text/html"
+			subject.content_type! "text/html"
-			expect(response['Content-Type']).to be == "text/html"
+			expect(subject.headers['Content-Type']).to be == "text/html"
 		end
 	end
 end

data/spec/utopia/content_spec.rb CHANGED

@@ -80,9 +80,8 @@ module Utopia::ContentSpec
 			node = content.lookup_node(path)
 			expect(node).to be_kind_of Utopia::Content::Node
-			output = StringIO.new
-			node.process!({}, output, {})
-			expect(output.string).to be == '<h1>Hello World</h1>'
+			status, headers, body = node.process!({}, {})
+			expect(body.join).to be == '<h1>Hello World</h1>'
 		end
 		it "should fetch template and use cache" do

data/spec/utopia/controller/{action_spec.rb → actions_spec.rb} RENAMED

@@ -22,54 +22,40 @@
 require 'utopia/controller'
-module Utopia::Controller::ActionSpec
-	describe Utopia::Controller::Action do
-		it "should be a hash key" do
-			a = Utopia::Controller::Action.new
-			b = Utopia::Controller::Action.new
-			c = Utopia::Controller::Action.new {sleep}
-			expect(a).to be == b
-			expect(a.hash).to be == b.hash
-			expect(a).to be_eql b
-			expect(a).to_not be == c
-			expect(a.hash).to_not be == c.hash
-			expect(a).to_not be_eql c
+module Utopia::Controller::ActionsSpec
+	describe Utopia::Controller::Actions::Action do
+		it "can be a hash key" do
+			expect(subject).to be == subject
+			expect(subject.hash).to be == subject.hash
+			expect(subject).to be_eql subject
 		end
 		it "should resolve callbacks" do
-			actions = Utopia::Controller::Action.new
-			specific_action = actions.define(['a', 'b', 'c']) {puts 'specific_action'}
-			indirect_action = actions.define(['**']) {puts 'indirect_action'}
-			indirect_named_action = actions.define(['**', 'r']) {puts 'indirect_named_action'}
+			specific_action = subject.define(['a', 'b', 'c']) {puts 'specific_action'}
+			indirect_action = subject.define(['**']) {puts 'indirect_action'}
+			indirect_named_action = subject.define(['**', 'r']) {puts 'indirect_named_action'}
 			expect(specific_action).to_not be == indirect_action
 			expect(indirect_action).to_not be == indirect_named_action
-			expect(actions.select(['a', 'b', 'c'])).to be == [indirect_action, specific_action]
-			expect(actions.select(['q'])).to be == [indirect_action]
+			expect(subject.matching(['a', 'b', 'c'])).to be == [indirect_action, specific_action]
+			expect(subject.matching(['q'])).to be == [indirect_action]
-			expect(actions.select(['q', 'r'])).to be == [indirect_action, indirect_named_action]
-			expect(actions.select(['q', 'r', 's'])).to be == [indirect_action]
+			expect(subject.matching(['q', 'r'])).to be == [indirect_action, indirect_named_action]
+			expect(subject.matching(['q', 'r', 's'])).to be == [indirect_action]
 		end
 		it "should be greedy matching" do
-			actions = Utopia::Controller::Action.new
+			greedy_action = subject.define(['**', 'r']) {puts 'greedy_action'}
-			greedy_action = actions.define(['**', 'r']) {puts 'greedy_action'}
-			expect(actions.select(['g', 'r'])).to be_include greedy_action
-			expect(actions.select(['r'])).to be_include greedy_action
+			expect(subject.matching(['g', 'r'])).to be_include greedy_action
+			expect(subject.matching(['r'])).to be_include greedy_action
 		end
 		it "should match patterns" do
-			actions = Utopia::Controller::Action.new
-			variable_action = actions.define(['*', 'summary', '*']) {puts 'variable_action'}
+			variable_action = subject.define(['*', 'summary', '*']) {puts 'variable_action'}
-			expect(actions.select(['10', 'summary', '20'])).to be_include variable_action
+			expect(subject.matching(['10', 'summary', '20'])).to be_include variable_action
 		end
 	end
 end

data/spec/utopia/controller/middleware_spec.rb CHANGED

@@ -37,28 +37,28 @@ module Utopia::Controller::MiddlewareSpec
 		end
 		it "should successfully call the controller method" do
-			get "/controller/hello-world"
+			get "/controller/flat"
 			expect(last_response.status).to be == 200
-			expect(last_response.body).to be == 'Hello World'
+			expect(last_response.body).to be == 'flat'
 		end
-		it "should successfully call the recursive controller method" do
-			get "/controller/recursive/hello-world"
+		it "should invoke controller method from the top level" do
+			get "/controller/hello-world"
 			expect(last_response.status).to be == 200
 			expect(last_response.body).to be == 'Hello World'
 		end
-		it "should successfully call the controller method" do
-			get "/controller/flat"
+		it "should invoke the controller method with a nested path" do
+			get "/controller/nested/hello-world"
 			expect(last_response.status).to be == 200
-			expect(last_response.body).to be == 'flat'
+			expect(last_response.body).to be == 'Hello World'
 		end
-		it "should successfully call the recursive controller method" do
-			get "/controller/recursive/flat"
+		it "shouldn't call the nested controller method" do
+			get "/controller/nested/flat"
 			expect(last_response.status).to be == 404
 		end