fiber_stream 0.3.0 → 0.5.0

data/sig/fiber_stream.rbs

@@ -2,7 +2,7 @@ module FiberStream
   type ractor_transfer_policy = :copy | :move
   type ractor_port_pair = { port: untyped, ack_port: untyped }
   type ractor_map_error_kind = :input_transfer | :output_transfer | :worker | :worker_termination | :isolation
-  type ractor_port_source_error_kind = :invalid_message | :producer_failure | :receive | :ack_transfer | :cancel_transfer
+  type ractor_port_source_error_kind = :invalid_message | :producer_failure | :receive | :ack_transfer | :cancel_transfer | :producer_setup
   type ractor_port_cancel_reason = :closed
 
   class SchedulerRequiredError < RuntimeError
@@ -14,6 +14,19 @@ module FiberStream
   class PipelineCancelledError < RuntimeError
   end
 
+  class RateLimiter
+    class Request < Data
+      attr_reader rate: Integer
+      attr_reader per: Numeric
+      attr_reader burst: Integer
+      attr_reader permits: Integer
+      attr_reader now: Float
+    end
+
+    def initialize: (rate: Integer, ?per: Numeric, ?burst: Integer?) ?{ (Request request) -> Numeric? } -> void
+    def acquire: (?permits: Integer) -> nil
+  end
+
   class RactorPortSourceError < RuntimeError
     attr_reader kind: ractor_port_source_error_kind
     attr_reader cause_class_name: String
@@ -48,26 +61,46 @@ module FiberStream
     end
   end
 
+  class RactorProducer
+    def emit: [Elem] (Elem value, ?transfer: ractor_transfer_policy?) -> bool
+    def complete: () -> bool
+    def fail: (?untyped error, ?cause_class_name: String?, ?cause_message: String?) -> bool
+    def cancelled?: () -> bool
+  end
+
+  class RactorProducerGroup
+    def producer: (*untyped args, ?transfer: ractor_transfer_policy?) { (RactorProducer producer, *untyped args) -> void } -> self
+  end
+
   class Source[Elem]
     def self.each: [Elem] (Enumerable[Elem] enumerable) -> Source[Elem]
     def self.io: (untyped io, ?chunk_size: Integer, ?close: bool) -> Source[String]
     def self.ractor_port: [Elem] (untyped port, ack_port: untyped, ?ack_transfer: ractor_transfer_policy, ?cancel: bool) -> Source[Elem]
     def self.ractor_merge_ports: [Elem] (Enumerable[ractor_port_pair] ports, ?ack_transfer: ractor_transfer_policy, ?cancel: bool) -> Source[Elem]
+    def self.ractor_producer: [Elem] (*untyped args, ?transfer: ractor_transfer_policy, ?ack_transfer: ractor_transfer_policy) { (RactorProducer producer, *untyped args) -> void } -> Source[Elem]
+    def self.ractor_merge_producers: [Elem] (?transfer: ractor_transfer_policy, ?ack_transfer: ractor_transfer_policy) { (RactorProducerGroup group) -> void } -> Source[Elem]
     def via: [Out] (Flow[Elem, Out] flow) -> Source[Out]
     def concat: [Other] (Source[Other] source) -> Source[Elem | Other]
     def zip: [Other] (Source[Other] source) -> Source[[Elem, Other]]
     def merge: [Other] (Source[Other] source) -> Source[Elem | Other]
     def map: [Out] () { (Elem) -> Out } -> Source[Out]
     def parallel_map: [Out] (concurrency: Integer) { (Elem) -> Out } -> Source[Out]
+    def parallel_unordered_map: [Out] (concurrency: Integer) { (Elem) -> Out } -> Source[Out]
     def ractor_map: [Out] (workers: Integer, ?input_transfer: ractor_transfer_policy, ?output_transfer: ractor_transfer_policy) { (Elem) -> Out } -> Source[Out]
+    def filter_map: [Out] () { (Elem) -> (Out | false | nil) } -> Source[Out]
+    def compact: () -> Source[Elem]
+    def map_concat: [Out] () { (Elem) -> Enumerable[Out] } -> Source[Out]
     def select: () { (Elem) -> boolish } -> Source[Elem]
+    def reject: () { (Elem) -> boolish } -> Source[Elem]
     def take: (Integer count) -> Source[Elem]
     def drop: (Integer count) -> Source[Elem]
     def grouped: (Integer count) -> Source[Array[Elem]]
+    def scan: [Acc] (Acc initial) { (Acc, Elem) -> Acc } -> Source[Acc]
     def take_while: () { (Elem) -> boolish } -> Source[Elem]
     def drop_while: () { (Elem) -> boolish } -> Source[Elem]
     def async: () -> Source[Elem]
     def buffer: (Integer count) -> Source[Elem]
+    def throttle: (?rate: Integer, ?per: Numeric, ?burst: Integer?, ?limiter: untyped) -> Source[Elem]
     def lines: (?chomp: bool, ?max_length: Integer?) -> Source[String]
     def split: (String separator, ?keep_separator: bool, ?max_length: Integer?) -> Source[String]
     def to: [Mat] (Sink[Elem, Mat] sink) -> Pipeline[Mat]
@@ -76,16 +109,24 @@ module FiberStream
 
   class Flow[In, Out]
     def self.map: [In, Out] () { (In) -> Out } -> Flow[In, Out]
+    def self.tap: [Elem] () { (Elem) -> void } -> Flow[Elem, Elem]
     def self.parallel_map: [In, Out] (concurrency: Integer) { (In) -> Out } -> Flow[In, Out]
+    def self.parallel_unordered_map: [In, Out] (concurrency: Integer) { (In) -> Out } -> Flow[In, Out]
     def self.ractor_map: [In, Out] (workers: Integer, ?input_transfer: ractor_transfer_policy, ?output_transfer: ractor_transfer_policy) { (In) -> Out } -> Flow[In, Out]
+    def self.filter_map: [In, Out] () { (In) -> (Out | false | nil) } -> Flow[In, Out]
+    def self.compact: [Elem] () -> Flow[Elem, Elem]
+    def self.map_concat: [In, Out] () { (In) -> Enumerable[Out] } -> Flow[In, Out]
     def self.select: [Elem] () { (Elem) -> boolish } -> Flow[Elem, Elem]
+    def self.reject: [Elem] () { (Elem) -> boolish } -> Flow[Elem, Elem]
     def self.take: [Elem] (Integer count) -> Flow[Elem, Elem]
     def self.drop: [Elem] (Integer count) -> Flow[Elem, Elem]
     def self.grouped: [Elem] (Integer count) -> Flow[Elem, Array[Elem]]
+    def self.scan: [Elem, Acc] (Acc initial) { (Acc, Elem) -> Acc } -> Flow[Elem, Acc]
     def self.take_while: [Elem] () { (Elem) -> boolish } -> Flow[Elem, Elem]
     def self.drop_while: [Elem] () { (Elem) -> boolish } -> Flow[Elem, Elem]
     def self.async: [Elem] () -> Flow[Elem, Elem]
     def self.buffer: [Elem] (Integer count) -> Flow[Elem, Elem]
+    def self.throttle: [Elem] (?rate: Integer, ?per: Numeric, ?burst: Integer?, ?limiter: untyped) -> Flow[Elem, Elem]
     def self.lines: (?chomp: bool, ?max_length: Integer?) -> Flow[String, String]
     def self.split: (String separator, ?keep_separator: bool, ?max_length: Integer?) -> Flow[String, String]
     def via: [Next] (Flow[Out, Next] flow) -> Flow[In, Next]
@@ -95,6 +136,7 @@ module FiberStream
   class Sink[In, Mat]
     def self.to_a: [Elem] () -> Sink[Elem, Array[Elem]]
     def self.first: [Elem] () -> Sink[Elem, Elem?]
+    def self.count: [Elem] () -> Sink[Elem, Integer]
     def self.fold: [Elem, Acc] (Acc initial) { (Acc, Elem) -> Acc } -> Sink[Elem, Acc]
     def self.foreach: [Elem] () { (Elem) -> void } -> Sink[Elem, Integer]
     def self.io: (untyped io, ?close: bool, ?flush: bool) -> Sink[String, Integer]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fiber_stream
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Dai Akatsuka
@@ -119,32 +119,45 @@ files:
 - examples/ractor_map_hashing.rb
 - examples/ractor_merge_ports_and_map.rb
 - examples/ractor_port_source.rb
+- examples/ractor_producer_sources.rb
 - lib/fiber_stream.rb
 - lib/fiber_stream/errors.rb
 - lib/fiber_stream/flow.rb
+- lib/fiber_stream/internal/ractor_transfer_policy.rb
 - lib/fiber_stream/pipeline.rb
 - lib/fiber_stream/pull.rb
 - lib/fiber_stream/pull/async_boundary.rb
 - lib/fiber_stream/pull/buffer_boundary.rb
+- lib/fiber_stream/pull/compact.rb
 - lib/fiber_stream/pull/concat.rb
 - lib/fiber_stream/pull/drop.rb
 - lib/fiber_stream/pull/drop_while.rb
 - lib/fiber_stream/pull/each.rb
+- lib/fiber_stream/pull/filter_map.rb
 - lib/fiber_stream/pull/grouped.rb
 - lib/fiber_stream/pull/io_source.rb
 - lib/fiber_stream/pull/lines.rb
 - lib/fiber_stream/pull/map.rb
+- lib/fiber_stream/pull/map_concat.rb
 - lib/fiber_stream/pull/merge.rb
 - lib/fiber_stream/pull/parallel_map_boundary.rb
+- lib/fiber_stream/pull/parallel_unordered_map_boundary.rb
 - lib/fiber_stream/pull/ractor_map_boundary.rb
 - lib/fiber_stream/pull/ractor_merge_ports_source.rb
 - lib/fiber_stream/pull/ractor_port_source.rb
+- lib/fiber_stream/pull/ractor_producer_source.rb
+- lib/fiber_stream/pull/reject.rb
+- lib/fiber_stream/pull/scan.rb
 - lib/fiber_stream/pull/select.rb
 - lib/fiber_stream/pull/split.rb
 - lib/fiber_stream/pull/take.rb
 - lib/fiber_stream/pull/take_while.rb
+- lib/fiber_stream/pull/tap.rb
+- lib/fiber_stream/pull/throttle.rb
 - lib/fiber_stream/pull/zip.rb
 - lib/fiber_stream/ractor_port.rb
+- lib/fiber_stream/ractor_producer.rb
+- lib/fiber_stream/rate_limiter.rb
 - lib/fiber_stream/running_pipeline.rb
 - lib/fiber_stream/sink.rb
 - lib/fiber_stream/source.rb
@@ -156,7 +169,7 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/dakatsuka/fiber_stream
-  source_code_uri: https://github.com/dakatsuka/fiber_stream/tree/v0.3.0
+  source_code_uri: https://github.com/dakatsuka/fiber_stream/tree/v0.5.0
   changelog_uri: https://github.com/dakatsuka/fiber_stream/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
@@ -173,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Asynchronous, non-blocking stream processing with backpressure.
 test_files: []