utopia 2.13.4 → 2.14.0

data/lib/utopia/content/response.rb

@@ -39,7 +39,7 @@ module Utopia
 				self.content_type = "text/html; charset=utf-8"
 			end
 			
-			attr :status
+			attr_accessor :status
 			attr :headers
 			attr :body
 			
@@ -68,7 +68,7 @@ module Utopia
 					@headers[EXPIRES] = (Time.now + duration).httpdate
 				end
 			end
-
+			
 			# Specify the content type of the response data.
 			def content_type= value
 				@headers[CONTENT_TYPE] = value

data/lib/utopia/localization.rb

@@ -35,6 +35,10 @@ module Utopia
 				@env[LOCALIZATION_KEY]
 			end
 			
+			def localized?
+				localization != nil
+			end
+			
 			# Returns the current locale or nil if not localized.
 			def current_locale
 				@env[CURRENT_LOCALE_KEY]
@@ -49,6 +53,10 @@ module Utopia
 			def all_locales
 				localization && localization.all_locales || []
 			end
+			
+			def localized_path(path, locale)
+				"/#{locale}#{path}"
+			end
 		end
 		
 		def self.[] request
@@ -66,15 +74,19 @@ module Utopia
 		# @param default_locales [String] The locales to try in order if none is provided.
 		# @param hosts [Hash<Pattern, String>] Specify a mapping of the HTTP_HOST header to a given locale.
 		# @param ignore [Array<Pattern>] A list of patterns matched against PATH_INFO which will not be localized.
-		def initialize(app, locales:, default_locale: nil, default_locales: nil, hosts: {}, ignore: [], **options)
+		def initialize(app, locales:, default_locale: nil, default_locales: nil, hosts: {}, ignore: [])
 			@app = app
 			
 			@all_locales = HTTP::Accept::Languages::Locales.new(locales)
 			
 			# Locales here are represented as an array of strings, e.g. ['en', 'ja', 'cn', 'de'] and are used in order if no locale is specified by the user.
 			unless @default_locales = default_locales
-				# We append nil, i.e. no localization.
-				@default_locales = @all_locales.names + [nil]
+				if default_locale
+					@default_locales = [default_locale, nil]
+				else
+					# We append nil, i.e. no localization.
+					@default_locales = @all_locales.names + [nil]
+				end
 			end
 			
 			@default_locale = default_locale || @default_locales.first
@@ -87,6 +99,8 @@ module Utopia
 			@hosts = hosts
 			
 			@ignore = ignore || options[:nonlocalized]
+			
+			@methods = methods
 		end
 		
 		def freeze
@@ -166,13 +180,7 @@ module Utopia
 			return []
 		end
 		
-		SAFE_METHODS = ['GET', 'HEAD']
-		
 		def localized?(env)
-			# Only SAFE_METHODS can be localized:
-			request_method = env[Rack::REQUEST_METHOD]
-			return false unless SAFE_METHODS.include?(request_method)
-			
 			# Ignore requests which match the ignored paths:
 			path_info = env[Rack::PATH_INFO]
 			return false if @ignore.any? { |pattern| path_info[pattern] != nil }
@@ -206,7 +214,7 @@ module Utopia
 			
 			# We have a non-localized request, but there might be a localized resource. We return the best localization possible:
 			preferred_locales(env) do |localized_env|
-				# puts "Trying locale: #{env[CURRENT_LOCALE_KEY]}: #{env[Rack::PATH_INFO]}..."
+				# puts "Trying locale: #{localized_env[CURRENT_LOCALE_KEY]}: #{localized_env[Rack::PATH_INFO]}..."
 				
 				response = @app.call(localized_env)
 				

data/lib/utopia/path.rb

@@ -30,9 +30,9 @@ module Utopia
 		def initialize(components = [])
 			@components = components
 		end
-
+		
 		attr_accessor :components
-
+		
 		def freeze
 			@components.freeze
 			
@@ -65,22 +65,22 @@ module Utopia
 			
 			return self.create([".."] * up + path.components[i..-1])
 		end
-
+		
 		def shortest_path(root)
 			self.class.shortest_path(self, root)
 		end
-
+		
 		# Converts '+' into whitespace and hex encoded characters into their equivalent characters.
 		def self.unescape(string)
 			string.tr('+', ' ').gsub(/((?:%[0-9a-fA-F]{2})+)/n) {
 				[$1.delete('%')].pack('H*')
 			}
 		end
-
+		
 		def self.[] path
 			self.create(path)
 		end
-
+		
 		def self.split(path)
 			case path
 			when Path
@@ -115,15 +115,17 @@ module Utopia
 				return self.new(path)
 			when String
 				return self.new(unescape(path).split(SEPARATOR, -1))
+			when nil
+				return nil
 			else
 				return self.new([path])
 			end
 		end
-
+		
 		def replace(other_path)
 			@components = other_path.components.dup
 		end
-
+		
 		def include?(*args)
 			@components.include?(*args)
 		end
@@ -131,7 +133,7 @@ module Utopia
 		def directory?
 			return @components.last == ''
 		end
-
+		
 		def to_directory
 			if directory?
 				return self
@@ -139,15 +141,15 @@ module Utopia
 				return join([''])
 			end
 		end
-
+		
 		def relative?
 			@components.first != ''
 		end
-
+		
 		def absolute?
 			@components.first == ''
 		end
-
+		
 		def to_absolute
 			if absolute?
 				return self
@@ -155,11 +157,11 @@ module Utopia
 				return self.class.new([''] + @components)
 			end
 		end
-
+		
 		def to_relative!
 			@components.shift if relative?
 		end
-
+		
 		def to_str
 			if @components == ['']
 				SEPARATOR
@@ -167,21 +169,21 @@ module Utopia
 				@components.join(SEPARATOR)
 			end
 		end
-
+		
 		alias to_s to_str
 		
 		def to_a
 			@components
 		end
-
+		
 		def join(other)
 			self.class.new(@components + other).simplify
 		end
-
+		
 		def expand(root)
 			root + self
 		end
-
+		
 		def +(other)
 			if other.kind_of? Path
 				if other.absolute?
@@ -197,11 +199,11 @@ module Utopia
 				return join([other.to_s])
 			end
 		end
-
+		
 		def with_prefix(*args)
 			self.class.create(*args) + self
 		end
-
+		
 		# Computes the difference of the path.
 		# /a/b/c - /a/b -> c
 		# a/b/c - a/b -> c
@@ -216,10 +218,10 @@ module Utopia
 			
 			return self.class.new(@components[i,@components.size])
 		end
-
+		
 		def simplify
 			result = absolute? ? [''] : []
-
+			
 			@components.each do |bit|
 				if bit == ".."
 					result.pop
@@ -227,18 +229,20 @@ module Utopia
 					result << bit
 				end
 			end
-
+			
 			result << '' if directory?
 			
 			return self.class.new(result)
 		end
-
+		
+		# @return [String] the last path component without any file extension.
 		def basename
 			basename, _ = @components.last.split('.', 2)
 			
 			return basename || ''
 		end
 		
+		# @return [String] the last path component's file extension.
 		def extension
 			_, extension = @components.last.split('.', 2)
 			
@@ -247,14 +251,14 @@ module Utopia
 		
 		def dirname(count = 1)
 			path = self.class.new(@components[0...-count])
-
+			
 			return absolute? ? path.to_absolute : path
 		end
-
-		def to_local_path(separator = File::SEPARATOR)
+		
+		def local_path(separator = File::SEPARATOR)
 			@components.join(separator)
 		end
-
+		
 		def descend(&block)
 			return to_enum(:descend) unless block_given?
 			
@@ -278,7 +282,7 @@ module Utopia
 				components.pop
 			end
 		end
-
+		
 		def split(at)
 			if at.kind_of? String
 				at = @components.index(at)
@@ -290,15 +294,15 @@ module Utopia
 				return nil
 			end
 		end
-
+		
 		def dup
 			return Path.new(components.dup)
 		end
-
+		
 		def <=> other
 			@components <=> other.components
 		end
-
+		
 		def eql? other
 			self.class.eql?(other.class) and @components.eql?(other.components)
 		end

data/lib/utopia/version.rb

@@ -21,5 +21,5 @@
 # THE SOFTWARE.
 
 module Utopia
-	VERSION = "2.13.4"
+	VERSION = "2.14.0"
 end

data/setup/site/Gemfile

@@ -2,15 +2,17 @@
 
 source 'https://rubygems.org'
 
-gem 'utopia', '~> $UTOPIA_VERSION'
-# gem 'utopia-gallery'
-# gem 'utopia-analytics'
+group :preload do
+	gem 'utopia', '~> $UTOPIA_VERSION'
+	# gem 'utopia-gallery'
+	# gem 'utopia-analytics'
+	
+	gem 'variant'
+end
 
 gem 'rake'
 gem 'bake'
-gem 'variant'
 gem 'bundler'
-
 gem 'rack-test'
 
 group :development do

data/spec/utopia/command_spec.rb

@@ -34,7 +34,7 @@ RSpec.describe "utopia command" do
 	
 	before(:all) do
 		# We need to build a package to test deployment:
-		system("rake", "build") or abort("Could not build package for setup spec!")
+		system("bundle", "exec", "bake", "bundler:build") or abort("Could not build package for setup spec!")
 	end
 	
 	around(:each) do |example|

data/spec/utopia/content/links/bar/parent/links.yaml

@@ -0,0 +1,2 @@
+index:
+  title: "Parent?"

data/spec/utopia/content/links/links.yaml

@@ -2,8 +2,17 @@ welcome:
   order: 1
   title: "Welcome"
   uri: "/welcome"
+
 index:
   order: 0
+  title: "Home"
+
 # This metadata also gets merged with foo/links.yml#index
 foo:
-  order: 2
+  order: 2
+
+bar:
+  order: 3
+
+redirect:
+  order: 4

data/spec/utopia/content/links/redirect/links.yaml

@@ -0,0 +1,2 @@
+index:
+  uri: https://www.codeotaku.com

data/spec/utopia/content/links_spec.rb

@@ -27,75 +27,192 @@ RSpec.describe Utopia::Content::Links do
 	let(:root) {File.expand_path("links", __dir__)}
 	subject {described_class.new(root)}
 	
-	describe 'INDEX_XNODE_FILTER' do
-		subject{Utopia::Content::Links::INDEX_XNODE_FILTER}
-		
+	describe '#index_filter' do
 		it "should match index" do
-			expect("index.xnode").to match(subject)
+			expect("index.xnode").to match(subject.index_filter)
 		end
 		
 		it "should not match invalid index" do
-			expect("old-index.xnode").to_not match(subject)
+			expect("old-index.xnode").to_not match(subject.index_filter)
 		end
 	end
 	
-	it "should not match partial strings" do
-		links = subject.index(Utopia::Path.create("/"), name: "come")
+	context 'matching name' do
+		it "can match named link" do
+			links = subject.index("/", name: "welcome")
+			
+			expect(links.size).to be == 1
+			expect(links[0].name).to be == "welcome"
+		end
 		
-		expect(links).to be_empty
+		it "doesn't match partial names" do
+			links = subject.index("/", name: "come")
+			
+			expect(links).to be_empty
+		end
 	end
 	
-	it "should give a list of links" do
-		links = subject.index(Utopia::Path.create("/"))
-		
-		expect(links.size).to be == 3
-		
-		expect(links[0].kind).to be == :virtual
-		expect(links[0].href).to be == nil
-		
-		expect(links[1].title).to be == "Welcome"
-		expect(links[1].to_href).to be == '<a class="link" href="/welcome">Welcome</a>'
-		expect(links[1].kind).to be == :file
-		expect(links[1].href).to be == "/welcome"
-		expect(links[1].name).to be == 'welcome'
-		
-		expect(links[2].title).to be == 'Foo Bar'
-		expect(links[2].kind).to be == :directory
-		expect(links[2].href).to be == "/foo/index"
-		expect(links[2].name).to be == 'foo'
-		
-		expect(links[1]).to be_eql links[1]
-		expect(links[0]).to_not be_eql links[1]
+	context 'with name filter' do
+		it "should filter links by name" do
+			links = subject.index("/", name: /foo/)
+			
+			expect(links.size).to be == 1
+		end
 	end
 	
-	it "should filter links by name" do
-		links = subject.index(Utopia::Path.create("/"), name: /foo/)
-		
-		expect(links.size).to be == 1
+	context 'without locale' do
+		it "should index all links" do
+			links = subject.index("/foo")
+			expect(links.size).to be == 2
+			
+			expect(links[0].name).to be == "test"
+			expect(links[0].locale).to be == "de"
+			
+			expect(links[1].name).to be == "test"
+			expect(links[1].locale).to be == "en"
+		end
 	end
 	
-	it "should select localized links" do
-		# Select both test links
-		links = subject.index(Utopia::Path.create("/foo"))
-		expect(links.size).to be == 2
-		
-		links = subject.index(Utopia::Path.create("/foo"), locale: 'en')
-		expect(links.size).to be == 1
+	context 'with locale' do
+		it "should select localized links" do
+			links = subject.index("/foo", locale: 'en')
+			expect(links.size).to be == 1
+			
+			expect(links[0].name).to be == "test"
+			expect(links[0].locale).to be == "en"
+		end
 	end
 	
-	context 'localized links'  do
+	context 'with localized links'  do
 		let(:root) {File.expand_path("localized", __dir__)}
 		
 		it "should read correct link order for en" do
-			links = subject.index(Utopia::Path.create("/"), locale: 'en')
+			links = subject.index("/", locale: 'en')
 			
 			expect(links.collect(&:title)).to be == ['One', 'Two', 'Three', 'Four', 'Five']
 		end
 		
 		it "should read correct link order for zh" do
-			links = subject.index(Utopia::Path.create("/"), locale: 'zh')
+			links = subject.index("/", locale: 'zh')
 			
 			expect(links.collect(&:title)).to be == ['One', 'Two', 'Three', '四']
 		end
 	end
+	
+	describe '#index' do
+		it "should give a list of links" do
+			links = subject.index("/")
+			
+			expect(links.size).to be == 4
+			
+			expect(links[0].title).to be == "Welcome"
+			expect(links[0].kind).to be == :file
+			expect(links[0].name).to be == 'welcome'
+			expect(links[0].locale).to be_nil
+			expect(links[0].path).to be == ['', 'welcome']
+			expect(links[0].href).to be == "/welcome"
+			expect(links[0].to_href).to be == '<a class="link" href="/welcome">Welcome</a>'
+			
+			expect(links[1].title).to be == 'Foo Bar'
+			expect(links[1].kind).to be == :directory
+			expect(links[1].name).to be == 'foo'
+			expect(links[1].locale).to be_nil
+			expect(links[1].path).to be == ['', 'foo', 'index']
+			expect(links[1].href).to be == "/foo/index"
+			
+			expect(links[2].title).to be == 'Bar'
+			expect(links[2].kind).to be == :directory
+			expect(links[2].name).to be == 'bar'
+			expect(links[2].locale).to be_nil
+			expect(links[2].path).to be == ['', 'bar', 'index']
+			expect(links[2].href).to be == "/bar/index"
+			
+			expect(links[3].title).to be == 'Redirect'
+			expect(links[3].kind).to be == :directory
+			expect(links[3].name).to be == 'redirect'
+			expect(links[3].locale).to be_nil
+			expect(links[3].path).to be == ['', 'redirect']
+			expect(links[3].href).to be == "https://www.codeotaku.com"
+			
+			expect(links[1]).to be_eql links[1]
+			expect(links[0]).to_not be_eql links[1]
+		end
+		
+		it "can list directories" do
+			links = subject.index("/bar")
+			
+			expect(links.size).to be == 1
+			
+			expect(links[0].title).to be == "Parent?"
+			expect(links[0].kind).to be == :directory
+			expect(links[0].name).to be == "parent"
+			expect(links[0].locale).to be_nil
+			expect(links[0].path).to be == ['', 'bar', 'parent']
+		end
+		
+		it "can list directories with multiple localized indexes" do
+			links = subject.index("/bar/parent").sort_by(&:locale)
+			
+			expect(links.size).to be == 2
+			
+			expect(links[0].title).to be == "Child"
+			expect(links[0].kind).to be == :directory
+			expect(links[0].name).to be == "child"
+			expect(links[0].locale).to be == 'en'
+			expect(links[0].path).to be == ['', 'bar', 'parent', 'child', 'index']
+			
+			expect(links[1].title).to be == "Child"
+			expect(links[1].kind).to be == :directory
+			expect(links[1].name).to be == "child"
+			expect(links[1].locale).to be == 'ja'
+			expect(links[1].path).to be == ['', 'bar', 'parent', 'child', 'index']
+		end
+		
+		it "can get title of /index" do
+			links = subject.index("/", indices: true, name: "index")
+			
+			expect(links.size).to be 1
+			
+			link = links.first
+			
+			expect(link.title).to be == "Home"
+		end
+		
+		it "can get title of /foo/index" do
+			links = subject.index("/foo", indices: true, name: "index")
+			
+			expect(links.size).to be 1
+			
+			link = links.first
+			
+			expect(link.title).to be == "Foo Bar"
+		end
+		
+		it "can get title of /bar/index" do
+			links = subject.index("/bar", indices: true, name: "index")
+			
+			expect(links.size).to be 1
+			
+			link = links.first
+			
+			expect(link.title).to be == "Bar"
+		end
+	end
+	
+	describe '#for' do
+		it "can get title of /index" do
+			link = subject.for(Utopia::Path["/index"])
+			expect(link.title).to be == "Home"
+		end
+		
+		it "can get title of /foo/index" do
+			link = subject.for(Utopia::Path["/foo/index"])
+			expect(link.title).to be == "Foo Bar"
+		end
+		
+		it "can get title of /bar/index" do
+			link = subject.for(Utopia::Path["/bar/index"])
+			expect(link.title).to be == "Bar"
+		end
+	end
 end