utopia 0.12.5 → 0.12.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea079ab122d29c56750a675d963b90ef916f5eac
-  data.tar.gz: c9b2cc7c6224f2d298c519af4a07d5f78fee8633
+  metadata.gz: 296a41faf645d12aa55672af9445a4f94f939da1
+  data.tar.gz: 53019aaae569b4191d3361d3d2a1094a9e52bcfe
 SHA512:
-  metadata.gz: fb8391a52441f77e987fae432167b8b4c826e9c2856ac0e3facc96cc9e4b18ceae665df604fbeafe079542da2cffa6242125f3c6f6035b46bdceb4842d3e9598
-  data.tar.gz: 12752a420f331461d35b47292a88f58f0134a5664ebfa76dea992e47f4e4824557074e417f07c030cc2fe1c3c2502b3bdbd63c39db36042dde9b49942a2780f1
+  metadata.gz: 34aaf114f9917265dbe27b65379bb77cb66fda5310b27384d2edcae8dc21fc01d7d814d6ea79f98fca46be81cbf2c1b9dc0c1da9f40b6af20dffa7cfb5dd2557
+  data.tar.gz: 09e47aa4fd61d9d015c7aa836c734dda5f20570efd02bacdd745756b2e02c6fc4e32e413bd47dfd1d140d740adf340dd4f0682b08ad63b579352af2798b0fae7

data/lib/utopia/extensions/array.rb

@@ -19,23 +19,11 @@
 # THE SOFTWARE.
 
 class Array
-	def find_index(&block)
-		each_with_index do |item, index|
-			if yield(item)
-				return index
-			end
-		end
-		
-		return nil
-	end
-	
 	def split_at(&block)
-		index = find_index(&block)
-		
-		if index
-			return [self[0...index], self[index], self[index+1..-1]]
+		if middle = index(&block)
+			[self[0...middle], self[middle], self[middle+1..-1]]
+		else
+			[[], nil, []]
 		end
-		
-		return [[], nil, []]
 	end
 end

data/lib/utopia/extensions/date.rb

@@ -23,61 +23,26 @@
 
 require 'date'
 
-class Date
-	alias_method :old_compare, :<=>
-	
-	def <=>(other)
-		if other.class == Date
-			old_compare(other)
-		else
-			if Time === other
-				other = other.to_datetime
-			end
-			
-		 	if DateTime === other
-				result = old_compare(other.to_date)
-				if result == 0 && other.day_fraction > 0
-					-1
-				else
-					result
-				end
-			end
-		end
-	end
-end
-
 class Time
 	alias_method :old_compare, :<=>
 	
 	def <=>(other)
-		if other.class == Date
-			(other <=> self) * -1
-		elsif Time === other
-			old_compare(other)
+		if Date === other or DateTime === other
+			self.to_datetime <=> other
 		else
-			if DateTime === other
-				other = other.to_time
-			end
-			
 			old_compare(other)
 		end
 	end
 end
 
-class DateTime
+class Date
 	alias_method :old_compare, :<=>
 	
 	def <=>(other)
-		if other.class == Date
-			(other <=> self) * -1
-		elsif DateTime === other
-			old_compare(other)
+		if Time === other
+			self.to_datetime <=> other.to_datetime
 		else
-			if Time === other
-				other = other.to_datetime
-			end
-			
 			old_compare(other)
 		end
 	end
-end
+end

data/lib/utopia/extensions/hash.rb

@@ -21,8 +21,7 @@
 class Hash
 	def symbolize_keys
 		inject({}) do |options, (key, value)|
-			options[(key.to_sym rescue key) || key] = value
-			options
+			options[(key.to_sym rescue key) || key] = value; options
 		end
 	end
 end

data/lib/utopia/extensions/rack.rb

@@ -22,23 +22,18 @@ require 'rack'
 
 class Rack::Request
 	def url_with_path(path = "")
-		url = scheme + "://"
-		url << host
-
-		if scheme == "https" && port != 443 || scheme == "http" && port != 80
-			url << ":#{port}"
-		end
-
-		url << path
+		base_url << path
 	end
 end
 
 class Rack::Response
+	# Specifies that the content shouldn't be cached. Overrides `cache!` if already called.
 	def do_not_cache!
 		self["Cache-Control"] = "no-cache, must-revalidate"
 		self["Expires"] = Time.now.httpdate
 	end
 	
+	# Specify that the content should be cached.
 	def cache!(duration = 3600)
 		unless (self["Cache-Control"] || "").match(/no-cache/)
 			self["Cache-Control"] = "public, max-age=#{duration}"
@@ -46,6 +41,7 @@ class Rack::Response
 		end
 	end
 	
+	# Specify the content type of the response data.
 	def content_type!(value)
 		self["Content-Type"] = value.to_s
 	end

data/lib/utopia/extensions/string.rb

@@ -18,23 +18,22 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-class String
-	HTML_ESCAPE = {"&" => "&amp;", "<" => "&lt;", ">" => "&gt;", "\"" => "&quot;"}
-	HTML_ESCAPE_PATTERN = Regexp.new("[" + Regexp.quote(HTML_ESCAPE.keys.join) + "]")
+require 'trenni/strings'
 
+class String
 	def to_html
-		gsub(HTML_ESCAPE_PATTERN){|c| HTML_ESCAPE[c]}
+		Trenni::Strings::to_html(self)
 	end
 
 	def to_quoted_string
-		'"' + self.gsub('"', '\\"').gsub(/\r/, "\\r").gsub(/\n/, "\\n") + '"'
+		Trenni::Strings::to_quoted_string(self)
 	end
 
 	def to_title
-		self.gsub(/(^|[ \-_])(.)/){" " + $2.upcase}.strip
+		Trenni::Strings::to_title(self)
 	end
 
 	def to_snake
-		self.gsub("::", "").gsub(/([A-Z]+)/){"_" + $1.downcase}.sub(/^_+/, "")
+		Trenni::Strings::to_snake(self)
 	end
 end

data/lib/utopia/middleware/all.rb

@@ -20,6 +20,8 @@
 
 require 'pathname'
 
+warn "require 'utopia/middleware/all' is deprecated. Require 'utopia' instead."
+
 Pathname.new(__FILE__).dirname.entries.each do |path|
 	next unless /\.rb$/ === path.to_s
 

data/lib/utopia/middleware/controller/action.rb

@@ -0,0 +1,121 @@
+# Copyright, 2014, 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.
+
+module Utopia
+	module Middleware
+		class Controller
+			class Action < Hash
+				attr_accessor :callback
+				attr_accessor :options
+				
+				def callback?
+					@callback != nil
+				end
+				
+				def indirect?
+					@options[:indirect]
+				end
+				
+				def eql? other
+					super and self.callback.eql? other.callback and self.options.eql? other.options
+				end
+				
+				def hash
+					[super, callback, options].hash
+				end
+				
+				def == other
+					super and (self.callback == other.callback) and (self.options == other.options)
+				end
+				
+				protected
+				
+				def append(path, index, actions = [])
+					# ** is greedy, it always matches if possible:
+					if match_all = self[:**]
+						# Match all remaining input:
+						actions << match_all if match_all.callback?
+					end
+					
+					if index < path.size
+						name = path[index].to_sym
+					
+						if match_name = self[name]
+							# Match the exact name:
+							match_name.append(path, index+1, actions)
+						end
+						
+						if match_one = self[:*]
+							# Match one input:
+							match_one.append(path, index+1, actions)
+						end
+					else
+						# Got to end, matched completely:
+						actions << self if self.callback?
+					end
+				end
+				
+				public
+				
+				# relative_path = 2014/mr-potato
+				# actions => {:** => A}
+				def select(relative_path)
+					actions = []
+					
+					append(relative_path.reverse, 0, actions)
+					
+					# puts "select(#{relative_path}, #{self.inspect}) => #{actions.inspect}"
+					
+					return actions
+				end
+				
+				def define(path, options = {}, &callback)
+					current = self
+					
+					path.reverse.each do |name|
+						current = (current[name.to_sym] ||= Action.new)
+					end
+					
+					current.options = options
+					current.callback = callback
+					
+					return current
+				end
+				
+				def invoke!(controller, *arguments)
+					if @options[:unbound]
+						# This is the old code path for explicit methods.
+						controller.instance_exec(controller, *arguments, &@callback)
+					else
+						controller.instance_exec(*arguments, &@callback)
+					end
+				end
+				
+				def inspect
+					if callback?
+						"<action " + super + ":#{callback.source_location}(#{options})>"
+					else
+						"<action " + super + ">"
+					end
+				end
+			end
+		end
+	end
+end

data/lib/utopia/middleware/controller/base.rb

@@ -0,0 +1,184 @@
+# Copyright, 2014, 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/path'
+require 'utopia/http'
+
+module Utopia
+	module Middleware
+		class Controller
+			class Base
+				def self.base_path
+					self.const_get(:BASE_PATH)
+				end
+			
+				def self.uri_path
+					self.const_get(:URI_PATH)
+				end
+			
+				def self.controller
+					self.const_get(:CONTROLLER)
+				end
+				
+				class << self
+					def require_local(path)
+						require File.join(base_path, path)
+					end
+					
+					def direct?(path)
+						path.dirname == uri_path
+					end
+					
+					def actions
+						@actions ||= Action.new
+					end
+					
+					def on(path, options = {}, &block)
+						if Symbol === path
+							path = ['**', path]
+						end
+						
+						actions.define(Path[path].components, options, &block)
+					end
+					
+					def lookup(path)
+						possible_actions = actions.select((path - uri_path).components)
+					end
+					
+					def method_added(name)
+						if name.match(/^on_(.*)$/)
+							warn "Method #{name} using legacy definition mechanism."
+							on($1.split("_").join('/'), unbound: true, &name)
+						end
+					end
+				end
+				
+				# Given a path, look up all matched actions.
+				def lookup(path)
+					self.class.lookup(path)
+				end
+				
+				# Given a request, call associated actions if at least one exists.
+				def passthrough(request, path)
+					actions = lookup(path)
+					
+					if actions.size > 0
+						variables = request.controller
+						controller_clone = self.clone
+						
+						variables << controller_clone
+						
+						response = catch(:response) do
+							# By default give nothing - i.e. keep on processing:
+							actions.each do |action|
+								action.invoke!(controller_clone, request, path)
+							end and nil
+						end
+						
+						if response
+							return controller_clone.respond_with(*response)
+						end
+					end
+					
+					return nil
+				end
+
+				# Copy the instance variables from the previous controller to the next controller (usually only a few). This allows controllers to share effectively the same instance variables while still being separate classes/instances.
+				def copy_instance_variables(from)
+					from.instance_variables.each do |name|
+						instance_variable_set(name, from.instance_variable_get(name))
+					end
+				end
+
+				def call(env)
+					self.class.controller.app.call(env)
+				end
+
+				def respond!(*args)
+					throw :response, args
+				end
+
+				def ignore!
+					throw :response, nil
+				end
+
+				def redirect! (target, status = 302)
+					respond! :redirect => target.to_str, :status => status
+				end
+
+				def rewrite! location
+					throw :rewrite, location.to_str
+				end
+
+				def fail!(error = :bad_request)
+					respond! error
+				end
+
+				def success!(*args)
+					respond! :success, *args
+				end
+				
+				def respond_with(*args)
+					return args[0] if args[0] == nil || Array === args[0]
+
+					status = 200
+					options = nil
+
+					if Numeric === args[0] || Symbol === args[0]
+						status = args[0]
+						options = args[1] || {}
+					else
+						options = args[0]
+						status = options[:status] || status
+					end
+
+					status = Utopia::HTTP::STATUS_CODES[status] || status
+					headers = options[:headers] || {}
+
+					if options[:type]
+						headers['Content-Type'] ||= options[:type]
+					end
+
+					if options[:redirect]
+						headers["Location"] = options[:redirect]
+						status = 302 if status < 300 || status >= 400
+					end
+
+					body = []
+					if options[:body]
+						body = options[:body]
+					elsif options[:content]
+						body = [options[:content]]
+					elsif status >= 300
+						body = [Utopia::HTTP::STATUS_DESCRIPTIONS[status] || "Status #{status}"]
+					end
+
+					return [status, headers, body]
+				end
+				
+				# Return nil if this controller didn't do anything. Request will keep on processing. Return a valid rack response if the controller can do so.
+				def process!(request, path)
+					# puts "process! #{request} #{path}"
+					passthrough(request, path)
+				end
+			end
+		end
+	end
+end

data/lib/utopia/middleware/controller/variables.rb

@@ -0,0 +1,72 @@
+# Copyright, 2014, 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.
+
+module Utopia
+	module Middleware
+		class Controller
+			class Variables
+				def initialize
+					@controllers = []
+				end
+
+				def << controller
+					top = @controllers.last
+					
+					@controllers << controller
+					
+					# This ensures that most variables will be at the top and controllers can naturally interactive with instance variables.
+					controller.copy_instance_variables(top) if top
+				end
+
+				def fetch(key)
+					@controllers.reverse_each do |controller|
+						if controller.instance_variables.include?(key)
+							return controller.instance_variable_get(key)
+						end
+					end
+					
+					if block_given?
+						yield key
+					else
+						raise KeyError.new(key)
+					end
+				end
+
+				def to_hash
+					attributes = {}
+
+					@controllers.each do |controller|
+						controller.instance_variables.each do |name|
+							key = name[1..-1]
+							
+							attributes[key] = controller.instance_variable_get(name)
+						end
+					end
+
+					return attributes
+				end
+
+				def [] key
+					fetch("@#{key}".to_sym) { nil }
+				end
+			end
+		end
+	end
+end