protocol-hpack 1.5.0 → 1.5.1

data/lib/protocol/hpack/huffman.rb

@@ -8,8 +8,8 @@
 # Copyright, 2022, by Daniel Morrison.
 # Copyright, 2024, by Nathan Froyd.
 
-require_relative 'huffman/machine'
-require_relative 'error'
+require_relative "huffman/machine"
+require_relative "error"
 
 module Protocol
 	module HPACK
@@ -25,8 +25,8 @@ module Protocol
 			# @return [String] binary string
 			def self.encode(str)
 				bitstring = str.each_byte.map {|chr| ENCODE_TABLE[chr]}.join
-				bitstring << '1' * ((8 - bitstring.size) % 8)
-				[bitstring].pack('B*')
+				bitstring << "1" * ((8 - bitstring.size) % 8)
+				[bitstring].pack("B*")
 			end
 
 			# Decodes provided Huffman coded string.
@@ -51,7 +51,7 @@ module Protocol
 						#  [next] next state number.
 						value, state = MACHINE[state][branch]
 						
-						raise CompressionError, 'Huffman decode error (EOS found)' if value == EOS
+						raise CompressionError, "Huffman decode error (EOS found)" if value == EOS
 						
 						emit << value.chr if value
 						shift -= BITS_AT_ONCE
@@ -59,7 +59,7 @@ module Protocol
 				end
 				# Check whether partial input is correctly filled
 				unless state <= MAX_FINAL_STATE
-					raise CompressionError, 'Huffman decode error (EOS invalid)'
+					raise CompressionError, "Huffman decode error (EOS invalid)"
 				end
 				emit.force_encoding(Encoding::BINARY)
 			end
@@ -325,7 +325,7 @@ module Protocol
 				[0x3fffffff, 30],
 			].each(&:freeze).freeze
 			
-			ENCODE_TABLE = CODES.map {|c, l| [c].pack('N').unpack1('B*')[-l..-1]}.each(&:freeze).freeze
+			ENCODE_TABLE = CODES.map {|c, l| [c].pack("N").unpack1("B*")[-l..-1]}.each(&:freeze).freeze
 		end
 	end
 end

data/lib/protocol/hpack/version.rb

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

data/lib/protocol/hpack.rb

@@ -5,5 +5,5 @@
 
 require_relative "hpack/version"
 
-require_relative 'hpack/compressor'
-require_relative 'hpack/decompressor'
+require_relative "hpack/compressor"
+require_relative "hpack/decompressor"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-hpack
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -53,7 +53,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-07-28 00:00:00.000000000 Z
+date: 2024-09-13 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -67,12 +67,11 @@ files:
 - lib/protocol/hpack/decompressor.rb
 - lib/protocol/hpack/error.rb
 - lib/protocol/hpack/huffman.rb
+- lib/protocol/hpack/huffman/generator.rb
 - lib/protocol/hpack/huffman/machine.rb
 - lib/protocol/hpack/version.rb
 - license.md
 - readme.md
-- tasks/huffman.rake
-- tasks/huffman.rb
 homepage: https://github.com/socketry/http-hpack
 licenses:
 - MIT

data/tasks/huffman.rake

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-namespace :huffman do
-	desc 'Generate the huffman state table'
-	task :generate_table do
-		require_relative 'huffman'
-		
-		Huffman::Node.generate_state_table
-	end
-end

data/tasks/huffman.rb

@@ -1,174 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2014, by Kaoru Maeda.
-# Copyright, 2015, by Tamir Duberstein.
-# Copyright, 2015, by Ilya Grigorik.
-# Copyright, 2016, by George Ulmer.
-# Copyright, 2018-2024, by Samuel Williams.
-# Copyright, 2024, by Nathan Froyd.
-
-require_relative '../lib/protocol/hpack/huffman'
-
-require 'set'
-
-module Huffman
-	BITS_AT_ONCE = Protocol::HPACK::Huffman::BITS_AT_ONCE
-	EOS = 256
-
-	class Node
-		attr_accessor :next, :emit, :final, :depth
-		attr_accessor :transitions
-		attr_accessor :id
-		@@id = 0 # rubocop:disable Style/ClassVars
-		def initialize(depth)
-			@next = [nil, nil]
-			@id = @@id
-			@@id += 1 # rubocop:disable Style/ClassVars
-			@final = false
-			@depth = depth
-		end
-
-		def add(code, len, chr)
-			self.final = true if chr == EOS && @depth <= 7
-			if len.zero?
-				@emit = chr
-			else
-				bit = (code & (1 << (len - 1))).zero? ? 0 : 1
-				node = @next[bit] ||= Node.new(@depth + 1)
-				node.add(code, len - 1, chr)
-			end
-		end
-
-		class Transition
-			attr_accessor :emit, :node
-			def initialize(emit, node)
-				@emit = emit
-				@node = node
-			end
-		end
-
-		def self.generate_tree
-			@root = new(0)
-			Protocol::HPACK::Huffman::CODES.each_with_index do |c, chr|
-				code, len = c
-				@root.add(code, len, chr)
-			end
-			puts "#{@@id} nodes"
-			@root
-		end
-
-		def self.generate_machine
-			generate_tree
-			togo = Set[@root]
-			@states = Set[@root]
-
-			until togo.empty?
-				node = togo.first
-				togo.delete(node)
-
-				next if node.transitions
-				node.transitions = Array[1 << BITS_AT_ONCE]
-
-				(1 << BITS_AT_ONCE).times do |input|
-					n = node
-					emit = +''
-					(BITS_AT_ONCE - 1).downto(0) do |i|
-						bit = (input & (1 << i)).zero? ? 0 : 1
-						n = n.next[bit]
-						next unless n.emit
-						if n.emit == EOS
-							emit = EOS # cause error on decoding
-						else
-							emit << n.emit.chr(Encoding::BINARY) unless emit == EOS
-						end
-						n = @root
-					end
-					node.transitions[input] = Transition.new(emit, n)
-					togo << n
-					@states << n
-				end
-			end
-			puts "#{@states.size} states"
-			@root
-		end
-
-		def self.generate_state_table
-			generate_machine
-			state_id = {}
-			id_state = {}
-			state_id[@root] = 0
-			id_state[0] = @root
-			max_final = 0
-			id = 1
-			(@states - [@root]).sort_by {|s| s.final ? 0 : 1}.each do |s|
-				state_id[s] = id
-				id_state[id] = s
-				max_final = id if s.final
-				id += 1
-			end
-
-			File.open(File.expand_path('../lib/protocol/hpack/huffman/machine.rb', File.dirname(__FILE__)), 'w') do |f|
-				f.print <<HEADER
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2018-2024, by Samuel Williams.
-
-# Machine generated Huffman decoder state machine.
-# DO NOT EDIT THIS FILE.
-
-module Protocol
-	module HPACK
-		class Huffman
-			# :nodoc:
-			MAX_FINAL_STATE = #{max_final}
-			MACHINE = [
-HEADER
-				id.times do |i|
-					n = id_state[i]
-					f.print "\t\t\t\t["
-					string = (1 << BITS_AT_ONCE).times.map do |t|
-						transition = n.transitions.fetch(t)
-						emit = transition.emit
-						unless emit == EOS
-							bytes = emit.bytes
-							fail ArgumentError if bytes.size > 1
-							emit = bytes.first
-						end
-						"[#{emit.inspect}, #{state_id.fetch(transition.node)}]"
-					end.join(', ')
-					f.print(string)
-					f.print "],\n"
-				end
-				f.print <<TAILER
-			].each {|arr| arr.each {|subarr| subarr.each(&:freeze)}.freeze}.freeze
-		end
-	end
-end
-TAILER
-			end
-		end
-
-		class << self
-			attr_reader :root
-		end
-
-		# Test decoder
-		def self.decode(input)
-			emit = ''
-			n = root
-			nibbles = input.unpack('C*').flat_map {|b| [((b & 0xf0) >> 4), b & 0xf]}
-			until nibbles.empty?
-				nb = nibbles.shift
-				t = n.transitions[nb]
-				emit << t.emit
-				n = t.node
-			end
-			unless n.final && nibbles.all? {|x| x == 0xf}
-				puts "len = #{emit.size} n.final = #{n.final} nibbles = #{nibbles}"
-			end
-			emit
-		end
-	end
-end