protocol-url 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10d18a95d6f20f5ca2457a52a2defa8d961ecf26eb372d45bea1f2d339f3a5c6
-  data.tar.gz: f15a84b24bd971e6262306b84e271196b5c20cde76983eba4625af28b0895ddd
+  metadata.gz: 0e251b8fa72bc3017a56cfa385bf2bc7b9e1e4ef8add2bcd12fb8321cc349c75
+  data.tar.gz: 700835c1db54aead624eb89003c7daa42d9ad992f7139c336e2a5293291db619
 SHA512:
-  metadata.gz: e1493486247a9e36b696bf62225a33888905d7e4a5a83b31357dc67d227b3a6f481844e2423befc5cc21f4c0a14aebc4ea507faa68a06a50490619e455396950
-  data.tar.gz: ee45f80e209b66b2a30d6b155188138a513e9a2c632bf1a4edc0322823e9bef209d2515babc955030c43c26c9da9ea687303a2aa91fa9704a2ac0594405d8cda
+  metadata.gz: 6285b5b91ba997d2f822fcc4ffd49b96dffcc1336483bd043f42a736dfb3bbe4e145e492044a201de1c8f0f3e363ae816d64af79e0412b2ce4715ec69e3b4d9c
+  data.tar.gz: 6e4c0817905afb9b17e8e0eceae42e7ea24d6c0af6a57773d7395355b2e7b597d043c9d7795ddf62194790f0a3f53f6346d7950598721c4b079e7a419e95f793

checksums.yaml.gz.sig

@@ -1 +1 @@
-q;+�ߎ� ���:c�ٜj�g��¾tC�[7�ѣ����UpR�����NK��
���j��� e&�.ň��:p͠y�={�{��e͕VY��+a��c��Z6�T�&�*l	NX���^Ӏq~���/���
<<X�H�`\����7� h=]�����s����eSf�aKߣ�κ�U�.+�m��st�o���[Dg�.�����Ft�v�� &I(�K�vm��{�9�h��հ~1�5��7��e�̓���f}\:칙�аK�]�q�X��o̍S�	q�3wUz�:?*#w�lK�jC
+K"�7z<\�m.zQѕ8�cEw��F)?f}��؋>	x��h;I��a�����V�5�n>�\Cfq��'A�)������ܕ��J��$h�W�?�X���&X�T�Nc��9���O�C�,�@���y�Q�n�'�QR�H�iC���I�ͬ��U����F�fI�Fk��5��V\�ofO��0���F�)&
_�uKr�d���	щ�?wt�7�������<,���c�Ҭ�ܷ��|�\��?ҍ���c��b@Qk�o��,�$�����)\�r�O�_�s���ĭ84���co�QyA�r31�iR&8�����sg�a�kp��_�'� +��R���꬚�.X�\пD�@�p�c&�0#��C�lm?��+��ܜ�va��CD�

data/lib/protocol/url/form_data/nested.rb

@@ -10,13 +10,13 @@ module Protocol
 		module FormData
 			# Builds nested form data from names and values.
 			class Nested
-				# The default maximum depth of a bracketed form name.
-				MAXIMUM_DEPTH = 8
+				# The bracketed form name depth limit.
+				DEPTH_LIMIT = 8
 				
 				# Initialize the nested form data.
-				# @parameter maximum_depth [Integer | Nil] The maximum depth of a bracketed form name.
-				def initialize(maximum_depth: MAXIMUM_DEPTH)
-					@maximum_depth = maximum_depth
+				# @parameter depth_limit [Integer | Nil] The bracketed form name depth limit.
+				def initialize(depth_limit: DEPTH_LIMIT)
+					@depth_limit = depth_limit
 					@root = {}
 				end
 				
@@ -31,8 +31,8 @@ module Protocol
 						raise ArgumentError, "Invalid form data name: #{name.inspect}!"
 					end
 					
-					if @maximum_depth and keys.size > @maximum_depth
-						raise RangeError, "Form data depth exceeded limit of #{@maximum_depth}!"
+					if @depth_limit and keys.size > @depth_limit
+						raise RangeError, "Form data depth exceeded limit of #{@depth_limit}!"
 					end
 					
 					Encoding.assign(keys, value, @root)

data/lib/protocol/url/form_data/parser.rb

@@ -13,20 +13,20 @@ module Protocol
 			class Parser
 				CONTENT_TYPE = "application/x-www-form-urlencoded"
 				
-				# The default maximum encoded body size.
-				MAXIMUM_TOTAL_SIZE = 2 * 1024 * 1024
+				# The encoded body size limit.
+				SIZE_LIMIT = 2 * 1024 * 1024
 				
-				# The default maximum number of form pairs.
-				MAXIMUM_PAIR_COUNT = 1024
+				# The form pair count limit.
+				PAIR_COUNT_LIMIT = 1024
 				
 				# Initialize the form data parser.
-				# @parameter maximum_total_size [Integer | Nil] The maximum encoded body size.
-				# @parameter maximum_pair_count [Integer | Nil] The maximum number of form pairs.
-				# @parameter maximum_depth [Integer | Nil] The maximum depth of a bracketed form name.
-				def initialize(maximum_total_size: MAXIMUM_TOTAL_SIZE, maximum_pair_count: MAXIMUM_PAIR_COUNT, maximum_depth: Nested::MAXIMUM_DEPTH)
-					@maximum_total_size = maximum_total_size
-					@maximum_pair_count = maximum_pair_count
-					@maximum_depth = maximum_depth
+				# @parameter size_limit [Integer | Nil] The encoded body size limit.
+				# @parameter pair_count_limit [Integer | Nil] The form pair count limit.
+				# @parameter depth_limit [Integer | Nil] The bracketed form name depth limit.
+				def initialize(size_limit: SIZE_LIMIT, pair_count_limit: PAIR_COUNT_LIMIT, depth_limit: Nested::DEPTH_LIMIT)
+					@size_limit = size_limit
+					@pair_count_limit = pair_count_limit
+					@depth_limit = depth_limit
 				end
 				
 				# Parse URL-encoded form data into a nested hash.
@@ -34,17 +34,16 @@ module Protocol
 				# When a block is given, each decoded value is passed through the block before assignment. The value returned by the block is assigned to the result.
 				#
 				# @parameter body [Object] A readable body which yields chunks from `#read`.
+				# @parameter result [Object] The result to populate. It must support `#add` and `#to_h`.
 				# @yields {|name, value| ...} Each decoded form pair before assignment.
 				# @returns [Hash] The nested form data.
-				def parse(body)
-					nested = Nested.new(maximum_depth: @maximum_depth)
-					
+				def parse(body, result = make_result)
 					each(body) do |name, value|
 						value = yield(name, value) if block_given?
-						nested.add(name, value)
+						result.add(name, value)
 					end
 					
-					return nested.to_h
+					return result.to_h
 				end
 				
 				# Incrementally enumerate URL-encoded form data as ordered name/value pairs.
@@ -55,14 +54,14 @@ module Protocol
 					return to_enum(__method__, body) unless block_given?
 					
 					buffer = String.new.b
-					total_size = 0
+					size = 0
 					pair_count = 0
 					
 					while chunk = body.read
 						break if chunk.empty?
 						
-						total_size += chunk.bytesize
-						check_limit(:total_size, total_size, @maximum_total_size)
+						size += chunk.bytesize
+						check_limit(:size, size, @size_limit)
 						buffer << chunk
 						
 						while separator = buffer.index("&")
@@ -71,7 +70,7 @@ module Protocol
 							
 							unless assignment.empty?
 								pair_count += 1
-								check_limit(:pair_count, pair_count, @maximum_pair_count)
+								check_limit(:pair_count, pair_count, @pair_count_limit)
 								yield_pair(assignment) {|name, value| yield name, value}
 							end
 						end
@@ -79,7 +78,7 @@ module Protocol
 					
 					unless buffer.empty?
 						pair_count += 1
-						check_limit(:pair_count, pair_count, @maximum_pair_count)
+						check_limit(:pair_count, pair_count, @pair_count_limit)
 						yield_pair(buffer) {|name, value| yield name, value}
 					end
 					
@@ -88,6 +87,10 @@ module Protocol
 				
 				private
 				
+				def make_result
+					return Nested.new(depth_limit: @depth_limit)
+				end
+				
 				def yield_pair(assignment)
 					name, value = assignment.split("=", 2)
 					
@@ -102,9 +105,9 @@ module Protocol
 					return Encoding.unescape(component.tr("+", " "))
 				end
 				
-				def check_limit(name, value, maximum)
-					if maximum and value > maximum
-						raise RangeError, "Form data #{name} exceeded limit of #{maximum}!"
+				def check_limit(name, value, limit)
+					if limit and value > limit
+						raise RangeError, "Form data #{name} exceeded limit of #{limit}!"
 					end
 				end
 			end

data/lib/protocol/url/version.rb

@@ -7,6 +7,6 @@
 module Protocol
 	# @namespace
 	module URL
-		VERSION = "0.6.0"
+		VERSION = "0.8.0"
 	end
 end

data/readme.md

@@ -34,6 +34,14 @@ This project is best served by a collaborative and respectful environment. Treat
 
 Please see the [project releases](https://socketry.github.io/protocol-url/releases/index) for all releases.
 
+### 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.

data/releases.md

@@ -1,5 +1,13 @@
 # Releases
 
+## 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.

metadata

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