protocol-hpack 1.4.3 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3192190834a35550921cbff8e50482499716791371f521a77c3f7c4b5a0efcff
-  data.tar.gz: 40d443b19eaac26aaaaae63da3baab5ae384246804643fdc7fb01f5455595dc3
+  metadata.gz: 3d664c70ae90134d28bf5491fe5f46612ce17292d8ebdc06daba9e423459501e
+  data.tar.gz: 0ede73ffcfb63a755022f3212309ce6ce4a74dcebd819f0287f8cf610a17fbee
 SHA512:
-  metadata.gz: c19a7524c1a544016e0feb7d88099a67fbccf3fe200214f7bc21639512da55e72a9e3442c8917f69fec1568a3027487e701a2f1e99deb652942ebae54c4752a7
-  data.tar.gz: 3f105d7bba7111585325db6bc8f414c34366bfb189f2263fa497e8ec53ed1502c3694c0dcd6749151fb10456c52a5a333daa9b7f5f8b362026d8be745c568375
+  metadata.gz: a194f5bbdfdbb5552f0ca6216b9cbb314bb5590a10316d51f99578961ebd3247bfa3aea6f3f8430f0e2f34ec89e9a18574c7080988f5cfde571b58ed8d6b143e
+  data.tar.gz: e11f0747b74859d27a2834350e46c49ea573e71f772687b387d6b4e4d1fd6b3033bc2c99537961fe2c59944e0acb2e0aeb78c0d7a9dbeb681cb04391d7e0ebb2

data/lib/protocol/hpack/compressor.rb

@@ -11,6 +11,7 @@
 # Copyright, 2018, by Kenichi Nakamura.
 # Copyright, 2019, by Jingyi Chen.
 # Copyright, 2020, by Justin Mazzocchi.
+# Copyright, 2024, by Nathan Froyd.
 
 require_relative 'context'
 require_relative 'huffman'
@@ -118,7 +119,7 @@ module Protocol
 			# @return [String] binary string
 			def write_string(string, huffman = self.huffman)
 				if huffman != :never
-					encoded = Huffman.new.encode(string)
+					encoded = Huffman.encode(string)
 					
 					if huffman == :shorter and encoded.bytesize >= string.bytesize
 						encoded = nil

data/lib/protocol/hpack/context.rb

@@ -2,6 +2,8 @@
 
 # Released under the MIT License.
 # Copyright, 2018-2024, by Samuel Williams.
+# Copyright, 2024, by Maruth Goyal.
+# Copyright, 2024, by Nathan Froyd.
 
 require_relative 'huffman'
 
@@ -94,7 +96,20 @@ module Protocol
 				["via", ""],
 				["www-authenticate", ""],
 			].each(&:freeze).freeze
-			
+
+			STATIC_EXACT_LOOKUP = {}
+			STATIC_NAME_LOOKUP = {}
+
+			STATIC_TABLE.each_with_index do |(name, value), i|
+				exact_header_values = (STATIC_EXACT_LOOKUP[name] ||= [])
+				exact_header_values << [value, i]
+				STATIC_NAME_LOOKUP[name] = i if STATIC_NAME_LOOKUP[name].nil?
+			end
+
+			STATIC_EXACT_LOOKUP.each {|k, v| v.freeze}
+			STATIC_EXACT_LOOKUP.freeze
+			STATIC_NAME_LOOKUP.freeze
+
 			# Initializes compression context with appropriate client/server defaults and maximum size of the dynamic table.
 			#
 			# @param table [Array] Table of header key-value pairs.
@@ -233,29 +248,42 @@ module Protocol
 			#  :static  Use static table only.
 			#  :all     Use all of them.
 			#
-			# @param header [Array] +[name, value]+
+			# @param name [String]
+			# @param value [String]
 			# @return [Hash] command
-			def add_command(*header)
+			def add_command(name, value)
 				exact = nil
 				name_only = nil
 
-				if [:all, :static].include?(@index)
-					STATIC_TABLE.each_index do |i|
-						if STATIC_TABLE[i] == header
-							exact ||= i
-							break
-						elsif STATIC_TABLE[i].first == header.first
-							name_only ||= i
+				if @index == :all || @index == :static
+					if (values_and_indices = STATIC_EXACT_LOOKUP[name])
+						values_and_indices.each do |known_value, index|
+							if value == known_value
+								exact = index
+								break
+							end
 						end
+						
+						needs_name_lookup = exact.nil?
+					else
+						needs_name_lookup = true
+					end
+
+					if needs_name_lookup && (static_value = STATIC_NAME_LOOKUP[name])
+						name_only = static_value
 					end
 				end
-				if [:all].include?(@index) && !exact
+
+				if @index == :all && !exact
 					@table.each_index do |i|
-						if @table[i] == header
-							exact ||= i + STATIC_TABLE.size
-							break
-						elsif @table[i].first == header.first
-							name_only ||= i + STATIC_TABLE.size
+						entry = @table[i]
+						if entry.first == name
+							if entry.last == value
+								exact ||= i + STATIC_TABLE.size
+								break
+							else
+								name_only ||= i + STATIC_TABLE.size
+							end
 						end
 					end
 				end
@@ -263,9 +291,9 @@ module Protocol
 				if exact
 					{name: exact, type: :indexed}
 				elsif name_only
-					{name: name_only, value: header.last, type: :incremental}
+					{name: name_only, value: value, type: :incremental}
 				else
-					{name: header.first, value: header.last, type: :incremental}
+					{name: name, value: value, type: :incremental}
 				end
 			end
 

data/lib/protocol/hpack/decompressor.rb

@@ -2,6 +2,8 @@
 
 # Released under the MIT License.
 # Copyright, 2018-2024, by Samuel Williams.
+# Copyright, 2024, by Maruth Goyal.
+# Copyright, 2024, by Nathan Froyd.
 
 require_relative 'context'
 require_relative 'huffman'
@@ -88,7 +90,7 @@ module Protocol
 				
 				raise CompressionError, "Invalid string length, got #{string.bytesize}, expecting #{length}!" unless string.bytesize == length
 				
-				string = Huffman.new.decode(string) if huffman
+				string = Huffman.decode(string) if huffman
 				
 				return string.force_encoding(Encoding::UTF_8)
 			end

data/lib/protocol/hpack/huffman.rb

@@ -6,6 +6,7 @@
 # Copyright, 2015, by Tamir Duberstein.
 # Copyright, 2018-2024, by Samuel Williams.
 # Copyright, 2022, by Daniel Morrison.
+# Copyright, 2024, by Nathan Froyd.
 
 require_relative 'huffman/machine'
 require_relative 'error'
@@ -22,7 +23,7 @@ module Protocol
 			#
 			# @param str [String]
 			# @return [String] binary string
-			def encode(str)
+			def self.encode(str)
 				bitstring = str.each_byte.map {|chr| ENCODE_TABLE[chr]}.join
 				bitstring << '1' * ((8 - bitstring.size) % 8)
 				[bitstring].pack('B*')
@@ -33,14 +34,15 @@ module Protocol
 			# @param buf [Buffer]
 			# @return [String] binary string
 			# @raise [CompressionError] when Huffman coded string is malformed
-			def decode(buffer)
+			def self.decode(buffer)
 				emit = String.new.b
 				state = 0 # start state
 
 				mask = (1 << BITS_AT_ONCE) - 1
 				buffer.each_byte do |c|
-					(8 / BITS_AT_ONCE - 1).downto(0) do |shift|
-						branch = (c >> (shift * BITS_AT_ONCE)) & mask
+					shift = BITS_AT_ONCE
+					while shift >= 0
+						branch = (c >> shift) & mask
 						
 						# MACHINE[state] = [final, [transitions]]
 						#  [final] unfinished bits so far are prefix of the EOS code.
@@ -52,6 +54,7 @@ module Protocol
 						raise CompressionError, 'Huffman decode error (EOS found)' if value == EOS
 						
 						emit << value.chr if value
+						shift -= BITS_AT_ONCE
 					end
 				end
 				# Check whether partial input is correctly filled

data/lib/protocol/hpack/version.rb

@@ -5,6 +5,6 @@
 
 module Protocol
 	module HPACK
-		VERSION = "1.4.3"
+		VERSION = "1.5.0"
 	end
 end

data/license.md

@@ -15,6 +15,8 @@ Copyright, 2020, by Olle Jonsson.
 Copyright, 2020, by Justin Mazzocchi.  
 Copyright, 2022, by Daniel Morrison.  
 Copyright, 2022, by Felix Yan.  
+Copyright, 2024, by Maruth Goyal.  
+Copyright, 2024, by Nathan Froyd.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -10,6 +10,11 @@ Please see the [project documentation](https://socketry.github.io/protocol-hpack
 
   - [Getting Started](https://socketry.github.io/protocol-hpack/guides/getting-started/index) - This guide explains how to use the `protocol-hpack` gem to compress and decompress HTTP/2 headers using HPACK.
 
+## See Also
+
+  - [protocol-http2](https://github.com/socketry/protocol-http2) - Provides an HTTP/2 client and server implementation.
+  - [async-http](https://github.com/socketry/async-http) - Provides a complete HTTP client and server implementation on top of Async.
+
 ## Contributing
 
 We welcome contributions to this project.
@@ -22,13 +27,8 @@ We welcome contributions to this project.
 
 ### Developer Certificate of Origin
 
-This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
 
-### Contributor Covenant
-
-This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
-
-## See Also
+### Community Guidelines
 
-- [protocol-http2](https://github.com/socketry/protocol-http2) - Provides an HTTP/2 client and server implementation.
-- [async-http](https://github.com/socketry/async-http) - Provides a complete HTTP client and server implementation on top of Async.
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

data/tasks/huffman.rb

@@ -6,13 +6,14 @@
 # Copyright, 2015, by Ilya Grigorik.
 # Copyright, 2016, by George Ulmer.
 # Copyright, 2018-2024, by Samuel Williams.
+# Copyright, 2024, by Nathan Froyd.
 
-require_relative '../lib/http/hpack/huffman'
+require_relative '../lib/protocol/hpack/huffman'
 
 require 'set'
 
 module Huffman
-	BITS_AT_ONCE = HTTP::HPACK::Huffman::BITS_AT_ONCE
+	BITS_AT_ONCE = Protocol::HPACK::Huffman::BITS_AT_ONCE
 	EOS = 256
 
 	class Node
@@ -49,7 +50,7 @@ module Huffman
 
 		def self.generate_tree
 			@root = new(0)
-			HTTP::HPACK::Huffman::CODES.each_with_index do |c, chr|
+			Protocol::HPACK::Huffman::CODES.each_with_index do |c, chr|
 				code, len = c
 				@root.add(code, len, chr)
 			end
@@ -71,7 +72,7 @@ module Huffman
 
 				(1 << BITS_AT_ONCE).times do |input|
 					n = node
-					emit = ''
+					emit = +''
 					(BITS_AT_ONCE - 1).downto(0) do |i|
 						bit = (input & (1 << i)).zero? ? 0 : 1
 						n = n.next[bit]
@@ -107,7 +108,7 @@ module Huffman
 				id += 1
 			end
 
-			File.open(File.expand_path('../lib/http/hpack/huffman/machine.rb', File.dirname(__FILE__)), 'w') do |f|
+			File.open(File.expand_path('../lib/protocol/hpack/huffman/machine.rb', File.dirname(__FILE__)), 'w') do |f|
 				f.print <<HEADER
 # frozen_string_literal: true
 

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: protocol-hpack
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.5.0
 platform: ruby
 authors:
 - Samuel Williams
 - Ilya Grigorik
 - Tamir Duberstein
+- Nathan Froyd
 - Kaoru Maeda
 - Tiago Cardoso
 - Byron Formwalt
@@ -18,6 +19,7 @@ authors:
 - Justin Mazzocchi
 - Kenichi Nakamura
 - Kien Nguyen Trung
+- Maruth Goyal
 - Olle Jonsson
 autorequire:
 bindir: bin
@@ -51,7 +53,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-03-12 00:00:00.000000000 Z
+date: 2024-07-28 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -76,6 +78,7 @@ licenses:
 - MIT
 metadata:
   documentation_uri: https://socketry.github.io/protocol-hpack/
+  source_code_uri: https://github.com/socketry/http-hpack.git
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -84,14 +87,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: A compresssor and decompressor for HTTP/2's HPACK format.