event_stream_parser 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49756d751627c15a8f085902ed658146505e48886f1dd00478303377cf306ef9
-  data.tar.gz: 02a1527fac3865d65041ae9f42c915da6f29af6db490dc18e021486571652fbf
+  metadata.gz: f6c523a863200d11f4277cd2def00738e53d40adcae96a8bf5e0dc8e4e734457
+  data.tar.gz: 684c33aaf90439ce864e2b9c063f7ad487866b7749e62e5edb3f0bcbb20b777b
 SHA512:
-  metadata.gz: 644f4a6394f418ba3bb7ea34f0ec80cd52a1814c480fbdae7b9e15004c421c731ae273a7d68ca1976f2de471dfe898170658ccd625c5da3961712fda68c0b783
-  data.tar.gz: ba6cb519e0c839c65d0d4179d1ddee7ba66cd8cd7c92cac1b7c449cda497bdf71eef97912d950050ea0ec8629293556c43b173cc708e02257ce9ca50fbf1f601
+  metadata.gz: a4527ea1befd90840ca9640b19f37f1c0232aae9ce9eab2a68612e6ff2db1d3842fdf0041bb6f6e2778950ffb86c3bd0c428d5867456e6aeb32ba01def56a154
+  data.tar.gz: 4b9a408e6f8eb325a52d35756af38087dcac36cf82b43ea06bd1af6f4287c45a9125d0e1d894382c2513e57e3c4239071aa7f915a7fbe1a6c9bd74dc735e0939

data/README.md

@@ -1,5 +1,8 @@
 # event_stream_parser
 
+[![Gem (including prereleases)](https://img.shields.io/gem/v/event_stream_parser)](https://rubygems.org/gems/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.
 
@@ -35,23 +38,23 @@ gem install event_stream_parser
 
 ## Usage
 
-Create a new Parser and give it a block to receive events:
+Create a new Parser:
 
 ```rb
 parser = EventStreamParser::Parser.new
-
-parser.feed do |type, data, id, reconnection_time|
-  puts "Event type: #{type}"
-  puts "Event data: #{data}"
-  puts "Event id: #{id}"
-  puts "Reconnection time: #{reconnection_time}"
-end
 ```
 
 Then, feed it chunks as they come in:
 
 ```rb
-do_something_that_yields_chunks do { |chunk| parser.feed(chunk) }
+do_something_that_yields_chunks do |chunk|
+  parser.feed(chunk) do |type, data, id, reconnection_time|
+    puts "Event type: #{type}"
+    puts "Event data: #{data}"
+    puts "Event id: #{id}"
+    puts "Reconnection time: #{reconnection_time}"
+  end
+end
 ```
 
 Or use the `stream` method to generate a proc that you can pass to a chunk

data/lib/event_stream_parser/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EventStreamParser
-  VERSION = "0.2.0"
+  VERSION = '1.0.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
   ##
@@ -18,12 +18,12 @@ module EventStreamParser
       # 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 = +""
+      @buffer = +''
       @last_delimiter = nil
     end
 
@@ -38,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!
@@ -68,7 +66,7 @@ module EventStreamParser
       ##
       # If the line is empty (a blank line)
       #
-      when ""
+      when ''
         ##
         # Dispatch the event, as defined below.
         #
@@ -106,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
 
@@ -120,7 +118,7 @@ module EventStreamParser
       ##
       # If the field name is "event"
       #
-      when "event"
+      when 'event'
         ##
         # Set the event type buffer to field value.
         #
@@ -128,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.
@@ -137,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.
@@ -146,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
@@ -188,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
       ##
@@ -213,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,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: event_stream_parser
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Ates Goral
 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'
+date: 2023-11-13 00:00:00.000000000 Z
+dependencies: []
 description: 
 email:
 - ates.goral@shopify.com
@@ -58,6 +30,7 @@ metadata:
   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:
@@ -66,14 +39,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.7
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.4.21
 signing_key: 
 specification_version: 4
 summary: A spec-compliant event stream parser