protocol-url 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2aa761d6ff888e7d33270085ff84b2743230dec6a755450987a1f005b9ff124
-  data.tar.gz: 1de5b782218b6c8d289704d7cfc953593cf5133e86fe7c55edbda8044a9e9b41
+  metadata.gz: '049540a7791381da861b94d6ed8e6b3e0ad751d3b176106f1c50a029aba36e32'
+  data.tar.gz: d6431de11836accc4318f01066b3c2431b9f26e349b46e77fcf9108da80cfb5e
 SHA512:
-  metadata.gz: 58533d06cadb21b1f038b156a7bb7d0d0e39c503e8993bab5fd7c7811d2f03e13b8431aa97b5221e925cbabdbb75b1d0a95d58d57c5c29d701aa552c327c0568
-  data.tar.gz: 5fce5dc33f50136790eff38c7a122e7041c0b06fa07ce2b1bfc41ade0568f352a731b26b233c9aa36b2d7ce460a0b1de32dfd9b68beed86213c123d5bd5676d8
+  metadata.gz: 27cee8571add43c57a7b0c2255d7f6a40566d1b44fe49b8ed73a7b06c50ef2d9d259eb951c0ffae7bce3c77f026fb193924f7eb003c85bfc61250661c2ed6135
+  data.tar.gz: ec74d61c74a06b318b9ff1b9ebcedb261bb90e0f80293b8def6e8d22efeef30db04ebc873e5546f746556312cd45cbeaa6c487893021c0b773a27990a3efd3d5

data/lib/protocol/url/absolute.rb

@@ -114,7 +114,8 @@ module Protocol
 			end
 			
 			# Append the absolute URL to the given buffer.
-			def append(buffer = String.new)
+			# @parameter explicit [Boolean] Ignored because absolute URLs are already lexically identifiable.
+			def append(buffer = String.new, explicit: false)
 				buffer << @scheme << ":" if @scheme
 				buffer << "//" << @authority if @authority
 				super(buffer)
@@ -147,9 +148,8 @@ 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, explicit: false)
+			def relative_to(base)
 				return self
 			end
 			
@@ -170,9 +170,10 @@ module Protocol
 			
 			# Convert the URL to its string representation.
 			#
+			# @parameter explicit [Boolean] Ignored because absolute URLs are already lexically identifiable.
 			# @returns [String] The formatted absolute URL string.
-			def to_s
-				append
+			def to_s(explicit: false)
+				append(explicit: explicit)
 			end
 		end
 	end

data/lib/protocol/url/path.rb

@@ -67,7 +67,6 @@ 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.
@@ -77,8 +76,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, explicit: false)
-				return Path[target].relative(from, explicit: explicit).to_s
+			def self.relative(target, from)
+				return Path[target].relative(from).to_s
 			end
 			
 			# Initialize a path from either its complete encoded representation or encoded segments.
@@ -358,9 +357,8 @@ 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, explicit: false)
+			def relative(from)
 				target_segments = self.segments
 				from_segments = Path[from].segments
 				
@@ -388,9 +386,6 @@ module Protocol
 				# 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(".")

data/lib/protocol/url/reference.rb

@@ -162,8 +162,9 @@ module Protocol
 			# Append the reference to the given buffer.
 			# Encodes the fragment; the path already retains its encoded structure.
 			# Query strings are passed through as-is (they contain = and & which are valid syntax).
-			def append(buffer = String.new)
-				buffer << @path.encoded
+			# @parameter explicit [Boolean] Whether the result should be lexically identifiable as a URL in a mixed grammar.
+			def append(buffer = String.new, explicit: false)
+				append_path(buffer, explicit: explicit)
 				
 				if @query and !@query.empty?
 					buffer << "?" << @query

data/lib/protocol/url/relative.rb

@@ -138,16 +138,15 @@ 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, explicit: false)
+			def relative_to(base)
 				return self unless @path.absolute?
 				
 				if base.is_a?(Relative)
 					base = base.path
 				end
 				
-				return self.class.new(@path.relative(base, explicit: explicit), @query, @fragment)
+				return self.class.new(@path.relative(base), @query, @fragment)
 			end
 			
 			# Normalize the encoded path and simplify its structure.
@@ -176,8 +175,9 @@ module Protocol
 			
 			# Append the relative URL to the given buffer.
 			# The path, query, and fragment are expected to already be properly encoded.
-			def append(buffer = String.new)
-				buffer << @path.encoded
+			# @parameter explicit [Boolean] Whether the result should be lexically identifiable as a URL in a mixed grammar.
+			def append(buffer = String.new, explicit: false)
+				append_path(buffer, explicit: explicit)
 				
 				if @query and !@query.empty?
 					buffer << "?" << @query
@@ -237,10 +237,13 @@ module Protocol
 			end
 			
 			# Convert the URL to its string representation.
+			# When explicit, same-directory references start with `./` so they can be
+			# distinguished from non-URL values in a mixed grammar.
 			#
+			# @parameter explicit [Boolean] Whether the result should be lexically identifiable as a URL in a mixed grammar.
 			# @returns [String] The formatted URL string.
-			def to_s
-				append
+			def to_s(explicit: false)
+				append(explicit: explicit)
 			end
 			
 			# Convert the URL to a JSON-compatible representation.
@@ -264,6 +267,16 @@ module Protocol
 				"#<#{self.class} #{to_s}>"
 			end
 			
+			# Append the path, optionally identifying a relative URL explicitly.
+			private def append_path(buffer, explicit: false)
+				if explicit && @path.relative?
+					path = @path.encoded
+					buffer << "./" unless path.start_with?("./", "../")
+				end
+				
+				buffer << @path.encoded
+			end
+			
 		end
 	end
 end

data/lib/protocol/url/version.rb

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

data/readme.md

@@ -34,6 +34,46 @@ bundle exec sus
 
 Please see the [project releases](https://socketry.github.io/protocol-url/releases/index) for all releases.
 
+### v0.18.0
+
+  - Support explicit URL serialization for mixed grammars, and remove explicit prefixes from relative path calculation.
+
+### 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.17.0
 
   - Add optional explicit `./` prefixes when generating same-directory relative URLs.

data/releases.md

@@ -1,5 +1,9 @@
 # Releases
 
+## v0.18.0
+
+  - Support explicit URL serialization for mixed grammars, and remove explicit prefixes from relative path calculation.
+
 ## v0.17.0
 
   - Add optional explicit `./` prefixes when generating same-directory relative URLs.

metadata

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