protocol-url 0.15.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d1384cd7ea74826bb5dc6e145fb09c9573c807fdac7d2297164317b6caf5645
-  data.tar.gz: 4d4b5100c8aca8008c3be18ad9f4b79139c00251f711283a90432179e292c941
+  metadata.gz: b2aa761d6ff888e7d33270085ff84b2743230dec6a755450987a1f005b9ff124
+  data.tar.gz: 1de5b782218b6c8d289704d7cfc953593cf5133e86fe7c55edbda8044a9e9b41
 SHA512:
-  metadata.gz: f284536c31a02466b10821c12bb1a4529a023d789cafbdfae10dd71d8f3049d78f0a0dbc03f8255f3ebdb0b7278eeccd38ca81baf480e116b6fe2a4b72a0bf22
-  data.tar.gz: 4ae5bb2749190910c76193b6c451b47b4bbcacaded41002cc54713dc219638e4966f4522f9df2e20a7f04e1e89ab2c09c6df1497bf849afe9a202fb7ad5ceacf
+  metadata.gz: 58533d06cadb21b1f038b156a7bb7d0d0e39c503e8993bab5fd7c7811d2f03e13b8431aa97b5221e925cbabdbb75b1d0a95d58d57c5c29d701aa552c327c0568
+  data.tar.gz: 5fce5dc33f50136790eff38c7a122e7041c0b06fa07ce2b1bfc41ade0568f352a731b26b233c9aa36b2d7ce460a0b1de32dfd9b68beed86213c123d5bd5676d8

data/lib/protocol/url/absolute.rb

@@ -147,8 +147,9 @@ module Protocol
 			
 			# Absolute URLs cannot be made relative without comparing their origins.
 			# @parameter base [Object] The ignored base URL or path.
+			# @parameter explicit [Boolean] Ignored for absolute URLs.
 			# @returns [self] This absolute URL.
-			def relative_to(base)
+			def relative_to(base, explicit: false)
 				return self
 			end
 			

data/lib/protocol/url/path.rb

@@ -67,6 +67,7 @@ module Protocol
 			#
 			# @parameter target [String] The destination path (where you want to go).
 			# @parameter from [String] The source path (where you are starting from).
+			# @parameter explicit [Boolean] Whether same-directory paths should start with `./`.
 			# @returns [String] The relative path from `from` to `target`.
 			#
 			# @example Calculate relative path between pages.
@@ -76,8 +77,8 @@ module Protocol
 			# @example Calculate relative path in same directory.
 			# 	Path.relative("/docs/guide.html", "/docs/index.html")
 			# 	# => "guide.html"
-			def self.relative(target, from)
-				return Path[target].relative(from).to_s
+			def self.relative(target, from, explicit: false)
+				return Path[target].relative(from, explicit: explicit).to_s
 			end
 			
 			# Initialize a path from either its complete encoded representation or encoded segments.
@@ -357,8 +358,9 @@ module Protocol
 			# Calculate this path relative to another path.
 			#
 			# @parameter from [String | Array(String) | Path] The source path.
+			# @parameter explicit [Boolean] Whether same-directory paths should start with `./`.
 			# @returns [Path] The relative path from `from` to this path.
-			def relative(from)
+			def relative(from, explicit: false)
 				target_segments = self.segments
 				from_segments = Path[from].segments
 				
@@ -372,12 +374,28 @@ module Protocol
 					common_length = i + 1
 				end
 				
+				# Preserve the final segment when the target names the containing directory as a file:
+				if common_length > 0 && common_length == target_segments.size && target_segments.last != ""
+					common_length -= 1
+				end
+				
 				# Calculate how many levels to go up
 				up_levels = from_segments.size - common_length
 				
 				# Build the relative path segments
 				relative_segments = [".."] * up_levels + target_segments[common_length..-1]
 				
+				# An empty reference identifies the current document, so identify the current directory explicitly:
+				if relative_segments == [""]
+					relative_segments = [".", ""]
+				elsif explicit && relative_segments.first != ".."
+					# Identify same-directory references explicitly:
+					relative_segments.unshift(".")
+				elsif relative_segments.first&.include?(":")
+					# A colon in the first segment would be interpreted as a URI scheme:
+					relative_segments.unshift(".")
+				end
+				
 				return Path.new(nil, relative_segments)
 			end
 			

data/lib/protocol/url/relative.rb

@@ -138,15 +138,16 @@ module Protocol
 			# are preserved when converting a root-relative path.
 			#
 			# @parameter base [Relative | Path | String] The base URL or path.
+			# @parameter explicit [Boolean] Whether same-directory paths should start with `./`.
 			# @returns [Relative] The relative URL.
-			def relative_to(base)
+			def relative_to(base, explicit: false)
 				return self unless @path.absolute?
 				
 				if base.is_a?(Relative)
 					base = base.path
 				end
 				
-				return self.class.new(@path.relative(base), @query, @fragment)
+				return self.class.new(@path.relative(base, explicit: explicit), @query, @fragment)
 			end
 			
 			# Normalize the encoded path and simplify its structure.

data/lib/protocol/url/version.rb

@@ -7,6 +7,6 @@
 module Protocol
 	# @namespace
 	module URL
-		VERSION = "0.15.0"
+		VERSION = "0.17.0"
 	end
 end

data/readme.md

@@ -34,6 +34,87 @@ bundle exec sus
 
 Please see the [project releases](https://socketry.github.io/protocol-url/releases/index) for all releases.
 
+### v0.17.0
+
+  - Add optional explicit `./` prefixes when generating same-directory relative URLs.
+
+### v0.16.0
+
+  - Preserve directory and file semantics when generating relative URL paths.
+
+### v0.15.0
+
+  - Add `Protocol::URL::Relative#relative_to` for expressing root-relative URLs relative to a base path.
+
+### v0.14.0
+
+  - Allow paths to compare with their encoded string representation.
+
+### v0.13.0
+
+  - Add conservative normalization of encoded URL paths.
+
+### v0.12.0
+
+  - Allow unfrozen relative and absolute URLs to replace their components.
+
+### v0.10.0
+
+  - Rename `Protocol::URL::FormData::Parser::CONTENT_TYPE` to `MEDIA_TYPE`.
+
+### v0.9.0
+
+  - Add `Protocol::URL::LimitError` for configured processing limits.
+
+### v0.8.0
+
+  - Use consistent limit naming for form data parser constraints.
+
+### v0.7.0
+
+  - Allow `Protocol::URL::FormData::Parser#parse` to populate a supplied result object.
+
+### v0.16.0
+
+  - Preserve directory and file semantics when generating relative URL paths.
+
+### v0.15.0
+
+  - Add `Protocol::URL::Relative#relative_to` for expressing root-relative URLs relative to a base path.
+
+### v0.14.0
+
+  - Allow paths to compare with their encoded string representation.
+
+### v0.13.0
+
+  - Add conservative normalization of encoded URL paths.
+
+### v0.12.0
+
+  - Allow unfrozen relative and absolute URLs to replace their components.
+
+### v0.10.0
+
+  - Rename `Protocol::URL::FormData::Parser::CONTENT_TYPE` to `MEDIA_TYPE`.
+
+### v0.9.0
+
+  - Add `Protocol::URL::LimitError` for configured processing limits.
+
+### v0.8.0
+
+  - Use consistent limit naming for form data parser constraints.
+
+### v0.7.0
+
+  - Allow `Protocol::URL::FormData::Parser#parse` to populate a supplied result object.
+
+### v0.6.0
+
+  - Add `Protocol::URL::FormData::Parser` for incremental, limited parsing of `application/x-www-form-urlencoded` form data.
+  - Add `Protocol::URL::FormData::Nested` for consistently building nested form data while preserving absent and empty values.
+
 ### v0.15.0
 
   - Add `Protocol::URL::Relative#relative_to` for expressing root-relative URLs relative to a base path.

data/releases.md

@@ -1,5 +1,13 @@
 # Releases
 
+## v0.17.0
+
+  - Add optional explicit `./` prefixes when generating same-directory relative URLs.
+
+## v0.16.0
+
+  - Preserve directory and file semantics when generating relative URL paths.
+
 ## v0.15.0
 
   - Add `Protocol::URL::Relative#relative_to` for expressing root-relative URLs relative to a base path.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-url
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Samuel Williams