event_stream_parser 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 498814773bcffd664024e918c1f94e32393e6b8af266fe88084cadb4cd8c86d7
-  data.tar.gz: da45b31afcb41e23bb2fb4dbde9d0c5ed173d8fb8ac0759464129528b19e49bd
+  metadata.gz: 830b3472c8f361af6b3e3fe2b3d405be779a188dfad03689d742e1c7432c9d9a
+  data.tar.gz: 136a34302cc7b8ac6de60307960258fac2618035ad66394867417481f8c76437
 SHA512:
-  metadata.gz: 2123d8df807cb4cb1a3f1981f3bd3d59eec2393579d4c41bc7a4f597be6f827e285ef8cffb37abfd12d9266e69febe5be09ad79f7dff53ef288c950ffc077603
-  data.tar.gz: dbadc0f0bc184c0d08f8e6466f4384ce51baf25da1d97bbc90ba75a0d92f3a48468dc82882015f82d17d5f047d64625ddffe8897a51dd7b8e972a19b3d585fbb
+  metadata.gz: 1834aa3df2243b44538415a4e05b4cc4cf2a86132a48ad32b70c12994205866fa3f80a530e75573b204d1d3cfc2719928f92fa13ddd9db868d6fbdee5f9d241e
+  data.tar.gz: 3b6b3bc90c9353988bc906b6fdec21e54d6bd3762f5f386d7cbfff4688fb7df0a626e5f3d8f054d8957f1c170d2bdb98295815887d278b84d0b82907b47ed96f

data/README.md

@@ -1,5 +1,8 @@
 # event_stream_parser
 
+[![Gem Version](https://badge.fury.io/rb/event_stream_parser.svg)](https://badge.fury.io/rb/event_stream_parser)
+[![CI](https://github.com/Shopify/event_stream_parser/actions/workflows/ci.yml/badge.svg)](https://github.com/Shopify/event_stream_parser/actions/workflows/ci.yml)
+
 A lightweight, fully spec-compliant parser for the
 [event stream](https://www.w3.org/TR/eventsource/) format.
 
@@ -11,6 +14,8 @@ from an HTTP client, for example) and emits events as it parses them. But it
 remembers the last event id and reconnection time and keeps emitting them as
 long as they are not overwritten by new ones.
 
+BOM stripping is left as a responsibility of the chunk provider.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -74,11 +79,7 @@ After checking out the repo:
 2. Run `rake test` to run the tests.
 3. Run `rubocop` to run Rubocop.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To
-release a new version, update the version number in `version.rb`, and then run
-`bundle exec rake release`, which will create a git tag for the version, push
-git commits and tags, and push the `.gem` file to
-[rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 

data/lib/event_stream_parser/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EventStreamParser
-  VERSION = "0.1.0"
+  VERSION = '0.3.0'
 end

data/lib/event_stream_parser.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "event_stream_parser/version"
+require 'event_stream_parser/version'
 
 module EventStreamParser
   ##
@@ -12,34 +12,22 @@ module EventStreamParser
   # Code comments are copied from the spec.
   #
   class Parser
-    UTF_8_BOM = [0xEF, 0xBB, 0xBF].pack("C*").force_encoding("UTF-8").freeze
-
     def initialize
       ##
       # When a stream is parsed, a data buffer, an event type buffer, and a last
       # event ID buffer must be associated with it. They must be initialized to
       # the empty string.
       #
-      @data_buffer = +""
-      @event_type_buffer = +""
-      @last_event_id_buffer = +""
+      @data_buffer = +''
+      @event_type_buffer = +''
+      @last_event_id_buffer = +''
 
       @reconnection_time = nil
-      @buffer = +""
-      @first_chunk = true
+      @buffer = +''
       @last_delimiter = nil
     end
 
     def feed(chunk, &proc)
-      ##
-      # The UTF-8 decode algorithm strips one leading UTF-8 Byte Order Mark (BOM),
-      # if any.
-      #
-      if @first_chunk
-        chunk = chunk.delete_prefix(UTF_8_BOM)
-        @first_chunk = false
-      end
-
       @buffer << chunk
 
       ##
@@ -50,9 +38,7 @@ module EventStreamParser
       # followed by a U+000A LINE FEED (LF) character being the ways in which a
       # line can end.
       #
-      if @last_delimiter == "\r"
-        @buffer.delete_prefix!("\n")
-      end
+      @buffer.delete_prefix!("\n") if @last_delimiter == "\r"
 
       while (line = @buffer.slice!(/.*?(?<delim>\r\n|\r|\n)/))
         line.chomp!
@@ -80,7 +66,7 @@ module EventStreamParser
       ##
       # If the line is empty (a blank line)
       #
-      when ""
+      when ''
         ##
         # Dispatch the event, as defined below.
         #
@@ -118,7 +104,7 @@ module EventStreamParser
         # Process the field using the steps described below, using the whole line
         # as the field name, and the empty string as the field value.
         #
-        process_field(line, "")
+        process_field(line, '')
       end
     end
 
@@ -132,7 +118,7 @@ module EventStreamParser
       ##
       # If the field name is "event"
       #
-      when "event"
+      when 'event'
         ##
         # Set the event type buffer to field value.
         #
@@ -140,7 +126,7 @@ module EventStreamParser
       ##
       # If the field name is "data"
       #
-      when "data"
+      when 'data'
         ##
         # Append the field value to the data buffer, then append a single U+000A
         # LINE FEED (LF) character to the data buffer.
@@ -149,7 +135,7 @@ module EventStreamParser
       ##
       # If the field name is "id"
       #
-      when "id"
+      when 'id'
         ##
         # If the field value does not contain U+0000 NULL, then set the last event
         # ID buffer to the field value. Otherwise, ignore the field.
@@ -158,7 +144,7 @@ module EventStreamParser
       ##
       # If the field name is "retry"
       #
-      when "retry"
+      when 'retry'
         ##
         # If the field value consists of only ASCII digits, then interpret the
         # field value as an integer in base ten, and set the event stream's
@@ -200,8 +186,8 @@ module EventStreamParser
       #    event type buffer to the empty string and return.
       #
       if @data_buffer.empty?
-        @data_buffer = +""
-        @event_type_buffer = +""
+        @data_buffer = +''
+        @event_type_buffer = +''
         return
       end
       ##
@@ -225,8 +211,8 @@ module EventStreamParser
       ##
       # 7. Set the data buffer and the event type buffer to the empty string.
       #
-      @data_buffer = +""
-      @event_type_buffer = +""
+      @data_buffer = +''
+      @event_type_buffer = +''
 
       yield type, data, id, @reconnection_time
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: event_stream_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ates Goral
@@ -9,35 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2023-10-16 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
+dependencies: []
 description: 
 email:
 - ates.goral@shopify.com
@@ -54,7 +26,11 @@ homepage: https://github.com/Shopify/event_stream_parser
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/Shopify/event_stream_parser/issues
+  changelog_uri: https://github.com/Shopify/event_stream_parser/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/Shopify/event_stream_parser
   allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -63,7 +39,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="