utopia 0.12.5 → 0.12.6

data/spec/utopia/extensions_spec.rb

@@ -0,0 +1,84 @@
+# 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.
+
+require 'utopia/extensions/array'
+require 'utopia/extensions/date'
+require 'utopia/extensions/hash'
+require 'utopia/extensions/regexp'
+
+module Utopia::ExtensionsSpec
+	describe Array do
+		it "should split in the middle" do
+			a = [1, 2, 3, 4, 5]
+			
+			a, b, c = a.split_at{|x| x == 3}
+			
+			expect(a).to be == [1, 2]
+			expect(b).to be == 3
+			expect(c).to be == [4, 5]
+		end
+	end
+	
+	describe Date do
+		it "should be equivalent" do
+			time = Time.gm(2000) # 2000-01-01 00:00:00 UTC
+			date = time.to_date
+			datetime = time.to_datetime
+			
+			expect(time <=> date).to be == 0
+			expect(time <=> datetime).to be == 0
+			
+			expect(date <=> datetime).to be == 0
+			expect(date <=> time).to be == 0
+			
+			expect(datetime <=> time).to be == 0
+			expect(datetime <=> date).to be == 0
+		end
+		
+		it "should compare correctly" do
+			today = Date.today
+			yesterday = today - 1
+			
+			expect(today <=> yesterday).to be == 1
+			expect(yesterday <=> today).to be == -1
+			
+			expect(today <=> yesterday.to_datetime).to be == 1
+			expect(today <=> yesterday.to_time).to be == 1
+			
+			expect(today.to_time <=> yesterday.to_datetime).to be == 1
+			expect(today.to_time <=> yesterday.to_time).to be == 1
+		end
+	end
+	
+	describe Hash do
+		it "should symbolize keys" do
+			hash = {'a' => 1, 'b' => 2}
+			
+			expect(hash.symbolize_keys).to be == {a: 1, b: 2}
+		end
+	end
+	
+	describe Regexp do
+		it "should start with" do
+			expect(Regexp.starts_with("foobar")).to be =~ "foobarbaz"
+			expect(Regexp.starts_with("bar")).to_not be =~ "blubarbaz"
+		end
+	end
+end

data/spec/utopia/middleware/controller_spec.rb

@@ -22,24 +22,86 @@ require 'rack/mock'
 require 'utopia/middleware/controller'
 
 module Utopia::Middleware::ControllerSpec
+	describe Utopia::Middleware::Controller::Action do
+		it "should resolve callbacks" do
+			actions = Utopia::Middleware::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'}
+			
+			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(actions.select(['q', 'r'])).to be == [indirect_action, indirect_named_action]
+			expect(actions.select(['q', 'r', 's'])).to be == [indirect_action]
+		end
+		
+		it "should be greedy matching" do
+			actions = Utopia::Middleware::Controller::Action.new
+			
+			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
+		end
+	end
+	
 	APP = lambda {|env| [404, [], []]}
 	
 	class TestController < Utopia::Middleware::Controller::Base
-		def direct?(path)
-			true
-		end
-		
-		def on_success(path, request)
+		on 'success' do
 			success!
 		end
 		
-		def on_failure(path, request)
-			fail!
+		on :failure do
+			fail! 400
 		end
 		
-		def on_variable(path, request)
+		on :variable do |request, path|
 			@variable = :value
 		end
+		
+		def self.uri_path
+			Utopia::Path["/"]
+		end
+	end
+	
+	class TestIndirectController < Utopia::Middleware::Controller::Base
+		def initialize
+			@sequence = ""
+		end
+		
+		on('user/update') do
+			@sequence << 'A'
+		end
+		
+		on('**/comment/post') do
+			@sequence << 'B'
+		end
+		
+		on('comment/delete') do
+			@sequence << 'C'
+		end
+		
+		on('**/comment/delete') do
+			@sequence << 'D'
+		end
+		
+		on('**') do
+			@sequence << 'E'
+		end
+		
+		on('*') do
+			@sequence << 'F'
+		end
+		
+		def self.uri_path
+			Utopia::Path["/"]
+		end
 	end
 	
 	class MockControllerMiddleware
@@ -51,20 +113,52 @@ module Utopia::Middleware::ControllerSpec
 	end
 	
 	describe Utopia::Middleware::Controller do
+		let(:variables) {Utopia::Middleware::Controller::Variables.new}
+		
 		it "should call controller methods" do
-			variables = Utopia::Middleware::Controller::Variables.new
 			request = Rack::Request.new("utopia.controller" => variables)
-			middleware = MockControllerMiddleware.new
-			controller = TestController.new(middleware)
+			controller = TestController.new
 		
-			result = controller.process!(Utopia::Path["/success"], request)
+			result = controller.process!(request, Utopia::Path["/success"])
 			expect(result).to be == [200, {}, []]
 		
-			result = controller.process!(Utopia::Path["/failure"], request)
+			result = controller.process!(request, Utopia::Path["/foo/bar/failure"])
 			expect(result).to be == [400, {}, ["Bad Request"]]
 		
-			result = controller.process!(Utopia::Path["/variable"], request)
+			result = controller.process!(request, Utopia::Path["/variable"])
 			expect(variables.to_hash).to be == {"variable"=>:value}
 		end
+		
+		it "should call direct controller methods" do
+			request = Rack::Request.new("utopia.controller" => variables)
+			controller = TestIndirectController.new
+			
+			controller.process!(request, Utopia::Path["/user/update"])
+			expect(variables['sequence']).to be == 'EA'
+		end
+		
+		it "should call indirect controller methods" do
+			request = Rack::Request.new("utopia.controller" => variables)
+			controller = TestIndirectController.new
+			
+			result = controller.process!(request, Utopia::Path["/foo/comment/post"])
+			expect(variables['sequence']).to be == 'EB'
+		end
+		
+		it "should call multiple indirect controller methods in order" do
+			request = Rack::Request.new("utopia.controller" => variables)
+			controller = TestIndirectController.new
+			
+			result = controller.process!(request, Utopia::Path["/comment/delete"])
+			expect(variables['sequence']).to be == 'EDC'
+		end
+		
+		it "should match single patterns" do
+			request = Rack::Request.new("utopia.controller" => variables)
+			controller = TestIndirectController.new
+			
+			result = controller.process!(request, Utopia::Path["/foo"])
+			expect(variables['sequence']).to be == 'EF'
+		end
 	end
 end

data/spec/utopia/path_spec.rb

@@ -28,5 +28,19 @@ module Utopia::PathSpec
 			expect(root).to be_absolute
 			expect(root + Utopia::Path["foo/bar"]).to be == Utopia::Path["/foo/bar"]
 		end
+		
+		it "should compute all descendant paths" do
+			root = Utopia::Path["/foo/bar"]
+			
+			descendants = root.descend.to_a
+			
+			expect(descendants[0].components).to be == [""]
+			expect(descendants[1].components).to be == ["", "foo"]
+			expect(descendants[2].components).to be == ["", "foo", "bar"]
+			
+			ascendants = root.ascend.to_a
+			
+			expect(descendants.reverse).to be == ascendants
+		end
 	end
 end

data/spec/utopia/rack_spec.rb

@@ -0,0 +1,71 @@
+# 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.
+
+require 'utopia/extensions/date'
+require 'utopia/extensions/rack'
+
+module Utopia::RackSpec
+	describe Rack::Request do
+		it "should construct the url" do
+			request = Rack::Request.new(
+				'rack.url_scheme' => 'http', 
+				'HTTP_HOST' => 'localhost',
+				'SERVER_PORT' => 80
+			)
+			
+			expect(request.url_with_path("/foo/bar")).to be == "http://localhost/foo/bar"
+		end
+	end
+	
+	describe Rack::Response do
+		it "should specify not to cache content" do
+			response = Rack::Response.new
+			
+			response.cache!(1000)
+			response.do_not_cache!
+			
+			expect(response['Cache-Control']).to be == "no-cache, must-revalidate"
+			
+			expires_header = Time.parse(response['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)
+			
+			expect(response['Cache-Control']).to be == "public, max-age=120"
+			
+			expires_header = Time.parse(response['Expires'])
+			expect(expires_header).to be >= expires
+		end
+		
+		it "should set content type" do
+			response = Rack::Response.new
+			
+			response.content_type! "text/html"
+			
+			expect(response['Content-Type']).to be == "text/html"
+		end
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: utopia
 version: !ruby/object:Gem::Version
-  version: 0.12.5
+  version: 0.12.6
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-15 00:00:00.000000000 Z
+date: 2014-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trenni
@@ -157,7 +157,6 @@ files:
 - lib/utopia/extensions/array.rb
 - lib/utopia/extensions/date.rb
 - lib/utopia/extensions/hash.rb
-- lib/utopia/extensions/maybe.rb
 - lib/utopia/extensions/rack.rb
 - lib/utopia/extensions/regexp.rb
 - lib/utopia/extensions/string.rb
@@ -169,10 +168,13 @@ files:
 - lib/utopia/middleware/content/node.rb
 - lib/utopia/middleware/content/processor.rb
 - lib/utopia/middleware/controller.rb
+- lib/utopia/middleware/controller/action.rb
+- lib/utopia/middleware/controller/base.rb
+- lib/utopia/middleware/controller/variables.rb
 - lib/utopia/middleware/directory_index.rb
+- lib/utopia/middleware/exception_handler.rb
 - lib/utopia/middleware/localization.rb
 - lib/utopia/middleware/localization/name.rb
-- lib/utopia/middleware/logger.rb
 - lib/utopia/middleware/mail_exceptions.rb
 - lib/utopia/middleware/redirector.rb
 - lib/utopia/middleware/requester.rb
@@ -181,7 +183,6 @@ files:
 - lib/utopia/session/encrypted_cookie.rb
 - lib/utopia/setup.rb
 - lib/utopia/setup/Gemfile
-- lib/utopia/setup/access_log/readme.txt
 - lib/utopia/setup/cache/head/readme.txt
 - lib/utopia/setup/cache/meta/readme.txt
 - lib/utopia/setup/config.ru
@@ -203,13 +204,14 @@ files:
 - lib/utopia/tags/environment.rb
 - lib/utopia/tags/node.rb
 - lib/utopia/tags/override.rb
-- lib/utopia/time_store.rb
 - lib/utopia/version.rb
+- spec/utopia/extensions_spec.rb
 - spec/utopia/middleware/content_root/_heading.xnode
 - spec/utopia/middleware/content_root/index.xnode
 - spec/utopia/middleware/content_spec.rb
 - spec/utopia/middleware/controller_spec.rb
 - spec/utopia/path_spec.rb
+- spec/utopia/rack_spec.rb
 - utopia.gemspec
 homepage: https://github.com/ioquatix/utopia
 licenses: []
@@ -235,8 +237,10 @@ signing_key:
 specification_version: 4
 summary: Utopia is a framework for building dynamic content-driven websites.
 test_files:
+- spec/utopia/extensions_spec.rb
 - spec/utopia/middleware/content_root/_heading.xnode
 - spec/utopia/middleware/content_root/index.xnode
 - spec/utopia/middleware/content_spec.rb
 - spec/utopia/middleware/controller_spec.rb
 - spec/utopia/path_spec.rb
+- spec/utopia/rack_spec.rb

data/lib/utopia/extensions/maybe.rb

@@ -1,31 +0,0 @@
-# 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.
-
-class NilClass
-	def maybe?
-	end
-end
-
-class Object
-	# A helper that allows you to avoid excessive number of i
-	def maybe?
-		yield self
-	end
-end

data/lib/utopia/middleware/logger.rb

@@ -1,78 +0,0 @@
-# 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.
-
-require 'utopia/middleware'
-require 'utopia/time_store'
-
-module Utopia
-	module Middleware
-
-		class Logger
-			ACCESS_LOG = "access_log"
-			HEADER = [:ip, :agent, :method, :url, :status, :location, :referer, :length]
-
-			def write_log(env, response)
-				request = Rack::Request.new(env)
-
-				record = {
-					:ip => request.ip,
-					:host => request.host,
-					:url => request.url,
-					:referer => request.referer,
-					:agent => env['HTTP_USER_AGENT'],
-					:status => response[0],
-					:method => request.request_method,
-					:user => env['REMOTE_USER'],
-					:version => env['HTTP_VERSION']
-				}
-
-				if response[1].key? "Location"
-					record[:location] = response[1]["Location"]
-				end
-				
-				if response[1].key? "Content-Length"
-					record[:length] = response[1]["Content-Length"]
-				end
-
-				@log << record
-				
-				if UTOPIA_ENV != :production
-					$stderr.puts ">> #{record[:method]} #{record[:url]} -> #{response[0]}"
-				end
-			end
-
-			def initialize(app, options = {})
-				@app = app
-				
-				@log = options[:log] || TimeStore.new(options[:path] || ACCESS_LOG, options[:header] || HEADER)
-			end
-
-			def call(env)
-				response = @app.call(env)
-
-				Thread.new do
-					write_log(env, response)
-				end
-
-				return response
-			end
-		end
-	end
-end

data/lib/utopia/setup/access_log/readme.txt

@@ -1 +0,0 @@
-The access log keeps track of all requests and is rotated automatically on a weekly basis.

data/lib/utopia/time_store.rb

@@ -1,107 +0,0 @@
-# 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.
-
-require 'set'
-require 'csv'
-
-module Utopia
-	
-	# TimeStore is a very simple time oriented database. New entries 
-	# are added in chronological order and it is not possible to change 
-	# this behaviour, or remove old entries. It stores data in a CSV
-	# format into a directory where each file represents a week in the 
-	# year.
-	#
-	# The design of this class is to enable efficient logging of data
-	# in a backup friendly file format (i.e. files older than one week
-	# are not touched).
-	#
-	# Due to the nature of CSV data, a header must be specified. This
-	# header can have columns added, but not removed. Columns not
-	# specified in the header will not be recorded.
-	#
-	class TimeStore
-		def initialize(path, header)
-			@path = path
-
-			header = header.collect{|name| name.to_s}
-
-			@header_path = File.join(@path, "header.csv")
-
-			if File.exist? @header_path
-				@header = File.read(@header_path).split(",")
-			else
-				@header = []
-			end
-
-			diff = (Set.new(header) + ["time"]) - @header
-
-			if diff.size
-				@header += diff.to_a.sort
-
-				File.open(@header_path, "w") do |file|
-					file.write(@header.join(","))
-				end
-			end
-			
-			@last_path = nil
-			@last_file = nil
-		end
-
-		attr :header
-
-		def path_for_time(time)
-			return File.join(@path, time.strftime("%Y-%W") + ".csv")
-		end
-
-		def open(time, &block)
-			path = path_for_time(time)
-
-			if @last_path != path
-				if @last_file
-					@last_file.close
-					@last_file = nil
-				end
-
-				@last_file = File.open(path, "a")
-				@last_file.sync = true
-				@last_path = path
-			end
-
-			yield @last_file
-
-			#File.open(path_for_time(time), "a", &block)
-		end
-
-		def dump(values)
-			row = @header.collect{|key| values[key.to_sym]}
-			return CSV.generate_line(row)
-		end
-
-		def <<(values)
-			time = values[:time] = Time.now
-
-			open(time) do |file|
-				file.puts(dump(values))
-			end
-		end
-	end
-	
-end