fiber-collector 0.1.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d766d23a129b1199c9c8fad131eb750dcec6df27756506ba7b1af487c3754ba1
-  data.tar.gz: e85c74bfc3e2af76aa91c8fcfb013ae09d09c4bacc88df63ed525d2c57043ef9
+  metadata.gz: e18213ff1d06e8e74852e8e97d62f08bf02d4c5633654ee74351f74d1320e5e6
+  data.tar.gz: 212d2754251189410de0f87d544df0801eb42197ad61773cbdb93964dc65c535
 SHA512:
-  metadata.gz: 0b5e2f0b6a23a30bb5bb321e9b2f84eadb583eaa3e4533fd4a39845c1056645f8c633555bc99eeec32014dba9429d07a61303fd74daa83f552f49f47898dc7cb
-  data.tar.gz: 12cd120470d5158c374cb24f7606f4f9e3197e2f5a5c308b406a3d94fe1bc35c7e4130bfd0b2d239e7f350ee545082e996e90e6d5d2f4b17223127935c1f238a
+  metadata.gz: 84fd72f509e19cf60e942dc18853659fd348db3c7066e8b7090736afb84aa9f1c48b4300f5408d866ad683b0f25aceb4ad8c87476f2cb941c6a9d0e03121edcf
+  data.tar.gz: ddfdf89f536393f708aa1ad019eb3b82f59a64af7a7081f89dbcaf0be7a23b77e853f534762e2bde4bb39b80c1b3bb24160d360c1f82d6b6a13a849fa5dbb4fd

data/CHANGELOG.md

@@ -1,5 +1,3 @@
-## [Unreleased]
-
 ## [0.1.0] - 2022-12-09
 
 - Initial release
@@ -7,3 +5,19 @@
 ## [0.1.1] - 2022-12-09
 
 - Documentation bump for the RubyGems page
+
+## [1.0.0] - 2023-01-26
+
+- Updating dependencies, fixing CHANGELOG link, adding gem badge to README
+
+## [1.0.1] - 2026-09-20
+
+- Runs on Ruby 4. The pinned rake required ostruct, which left the standard
+  library, so `rake` could not start.
+- `all`, `any` and `race` share one polling implementation instead of each
+  carrying its own copy with the timeout and no-timeout cases written out twice.
+  No change in behaviour.
+- The default `timeout: nil` and an expiring timeout both have tests. Every
+  existing test passed a timeout that never expired, so neither path was covered.
+- The published gem no longer carries the Rakefile, Gemfile or rubocop config.
+- Publishing requires multi-factor auth.

data/README.md

@@ -1,5 +1,7 @@
 # Fiber::Collector
 
+[![Gem Version](https://badge.fury.io/rb/fiber-collector.svg)](https://badge.fury.io/rb/fiber-collector)
+
 An easy way to schedule and aggregate the results from multiple concurrent tasks inspired by JavaScript's `Promise.all()`, `Promise.any()` and `Promise.race()` methods.
 
 ## Installation

data/lib/fiber/collector/builder/all.rb

@@ -1,32 +1,24 @@
 # frozen_string_literal: true
+
 class Fiber
   module Collector
+    # Settles once every task has finished, failing as soon as any one of them
+    # does.
     class All
+      include Polling
+
       def initialize(procs)
         @tasks = procs.map { Task.new(_1) }
       end
 
       def wait(timeout)
-        raise "must run on non-blocking fiber" if Fiber.current.blocking?
-        @tasks.each do |task|
-          Fiber.schedule { task.run }
-        end
-        if timeout.nil?
-          sleep 0.001 until @tasks.all?(&:done?)
-        else
-          elapsed = 0
-          until @tasks.all?(&:done?)
-            task = @tasks.find { |t| t.error }            
-            unless task.nil?
-              raise task.error
-            end
-            t = 0.001
-            sleep t
-            elapsed += t
-            raise "timeout" if elapsed > timeout
-          end
+        schedule_tasks
+        poll_until(timeout) do
+          failed = @tasks.find(&:error)
+          raise failed.error unless failed.nil?
+
+          finished(@tasks.map(&:result)) if @tasks.all?(&:done?)
         end
-        @tasks.map { |t| t.error && raise(t.error) || t.result }
       end
     end
   end

data/lib/fiber/collector/builder/any.rb

@@ -1,34 +1,22 @@
 # frozen_string_literal: true
+
 class Fiber
   module Collector
+    # Settles on the first task to succeed, and fails only if they all fail.
     class Any
+      include Polling
+
       def initialize(procs)
         @tasks = procs.map { Task.new(_1) }
       end
 
       def wait(timeout)
-        raise "must run on non-blocking fiber" if Fiber.current.blocking?
-        @tasks.each do |task|
-          Fiber.schedule { task.run }
-        end
-        if timeout.nil?
-          loop do
-            task = @tasks.find { |t| t.done? && t.error.nil? }
-            return task.result unless task.nil?
-            raise @tasks.first.error if @tasks.all? { |t| t.done? && t.error }
-            sleep 0.001
-          end
-        else
-          elapsed = 0
-          loop do
-            task = @tasks.find { |t| t.done? && t.error.nil? }
-            return task.result unless task.nil?
-            raise @tasks.first.error if @tasks.all? { |t| t.done? && t.error }
-            t = 0.001
-            sleep t
-            elapsed += t
-            raise "timeout" if elapsed > timeout
-          end          
+        schedule_tasks
+        poll_until(timeout) do
+          task = @tasks.find { |t| t.done? && t.error.nil? }
+          next finished(task.result) unless task.nil?
+
+          raise @tasks.first.error if @tasks.all? { |t| t.done? && t.error }
         end
       end
     end

data/lib/fiber/collector/builder/polling.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+class Fiber
+  module Collector
+    # Shared machinery for the three collectors. Each schedules its tasks, then
+    # polls until the block it is given returns something other than nil, or
+    # until the timeout passes. A nil timeout waits indefinitely.
+    module Polling
+      INTERVAL = 0.001
+
+      private
+
+      def schedule_tasks
+        raise "must run on non-blocking fiber" if Fiber.current.blocking?
+
+        @tasks.each { |task| Fiber.schedule { task.run } }
+      end
+
+      def poll_until(timeout)
+        elapsed = 0
+        loop do
+          outcome = yield
+          return outcome.first unless outcome.nil?
+
+          sleep INTERVAL
+          elapsed += INTERVAL
+          raise "timeout" if timeout && elapsed > timeout
+        end
+      end
+
+      # Wraps a value so that poll_until can tell "finished with nil" from
+      # "not finished yet".
+      def finished(value) = [value]
+
+      def result_of(task)
+        raise task.error unless task.error.nil?
+
+        task.result
+      end
+    end
+  end
+end

data/lib/fiber/collector/builder/race.rb

@@ -1,38 +1,20 @@
 # frozen_string_literal: true
+
 class Fiber
   module Collector
+    # Settles as soon as any task finishes, whether it succeeded or failed.
     class Race
+      include Polling
+
       def initialize(procs)
         @tasks = procs.map { Task.new(_1) }
       end
 
       def wait(timeout)
-        raise "must run on non-blocking fiber" if Fiber.current.blocking?
-        @tasks.each do |task|
-          Fiber.schedule { task.run }
-        end
-        if timeout.nil?
-          loop do
-            task = @tasks.find { |t| t.done? }
-            unless task.nil?
-              raise task.error unless task.error.nil?
-              return task.result
-            end
-            sleep 0.001
-          end
-        else
-          elapsed = 0
-          loop do
-            task = @tasks.find { |t| t.done? }
-            unless task.nil?
-              raise task.error unless task.error.nil?
-              return task.result
-            end
-            t = 0.001
-            sleep t
-            elapsed += t
-            raise "timeout" if elapsed > timeout
-          end          
+        schedule_tasks
+        poll_until(timeout) do
+          task = @tasks.find(&:done?)
+          finished(result_of(task)) unless task.nil?
         end
       end
     end

data/lib/fiber/collector/builder/task.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
 
 class Fiber
   module Collector
+    # One scheduled block, and whatever it produced: a result, or the error it
+    # raised. Never raises out of #run, so a collector can inspect every task.
     class Task
       attr_reader :state, :error, :result
 
@@ -23,4 +26,4 @@ class Fiber
       end
     end
   end
-end
+end

data/lib/fiber/collector/builder.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
-require_relative 'builder/all'
-require_relative 'builder/any'
-require_relative 'builder/race'
-require_relative 'builder/task'
+
+require_relative "builder/polling"
+require_relative "builder/all"
+require_relative "builder/any"
+require_relative "builder/race"
+require_relative "builder/task"
 
 class Fiber
-  module Collector    
+  module Collector
+    # Gathers the scheduled blocks, then hands them to whichever collector the
+    # terminating call names: #all, #any or #race.
     class Builder
       def initialize
         @blocks = []
@@ -23,7 +27,7 @@ class Fiber
       def all(timeout: nil)
         All.new(@blocks).wait(timeout)
       end
-      
+
       def any(timeout: nil)
         Any.new(@blocks).wait(timeout)
       end

data/lib/fiber/collector/version.rb

@@ -2,6 +2,6 @@
 
 class Fiber
   module Collector
-    VERSION = "0.1.1"
+    VERSION = "1.0.1"
   end
 end

data/lib/fiber/collector.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
-require_relative 'collector/builder'
-require_relative 'collector/version'
+require_relative "collector/builder"
+require_relative "collector/version"
 
 class Fiber
+  # Collects the results of blocks run concurrently on non-blocking fibers,
+  # in the manner of JavaScript's Promise.all, Promise.any and Promise.race.
   module Collector
     def self.schedule(&block)
       Builder.new.schedule(&block)

metadata

@@ -1,35 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: fiber-collector
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Erik Madsen
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Simple constructs to collect results from multiple concurrently scheduled
-  tasks inspired by JavaScript's Promise.all(), Promise.any() and Promise.race() methods
+  tasks, inspired by JavaScript's Promise.all(), Promise.any() and Promise.race()
+  methods
 email:
 - beatmadsen@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rubocop.yml"
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
-- fiber-collector.gemspec
 - lib/fiber/collector.rb
 - lib/fiber/collector/builder.rb
 - lib/fiber/collector/builder/all.rb
 - lib/fiber/collector/builder/any.rb
+- lib/fiber/collector/builder/polling.rb
 - lib/fiber/collector/builder/race.rb
 - lib/fiber/collector/builder/task.rb
 - lib/fiber/collector/version.rb
@@ -39,8 +35,10 @@ licenses:
 metadata:
   homepage_uri: https://github.com/beatmadsen/fiber-collector
   source_code_uri: https://github.com/beatmadsen/fiber-collector
-  changelog_uri: https://github.com/beatmadsen/fiber-collector/CHANGELOG.md
-post_install_message:
+  changelog_uri: https://github.com/beatmadsen/fiber-collector/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/beatmadsen/fiber-collector/issues
+  documentation_uri: https://github.com/beatmadsen/fiber-collector#readme
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -55,8 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 4.0.9
 specification_version: 4
 summary: Collect results from multiple concurrently scheduled tasks
 test_files: []

data/.rubocop.yml

@@ -1,13 +0,0 @@
-AllCops:
-  TargetRubyVersion: 3.1
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120

data/Gemfile

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in fiber-collector.gemspec
-gemspec
-
-gem "rake", "~> 13.0"
-
-gem "minitest", "~> 5.0"
-
-gem "rubocop", "~> 1.21"
-
-
-group :development do
-  gem 'async', '> 2.0'
-end

data/Gemfile.lock

@@ -1,54 +0,0 @@
-PATH
-  remote: .
-  specs:
-    fiber-collector (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    async (2.3.0)
-      console (~> 1.10)
-      io-event (~> 1.1)
-      timers (~> 4.1)
-    console (1.16.2)
-      fiber-local
-    fiber-local (1.0.0)
-    io-event (1.1.4)
-    json (2.6.3)
-    minitest (5.16.3)
-    parallel (1.22.1)
-    parser (3.1.3.0)
-      ast (~> 2.4.1)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.6.1)
-    rexml (3.2.5)
-    rubocop (1.40.0)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.1.2.1)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.23.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.24.0)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
-    timers (4.3.5)
-    unicode-display_width (2.3.0)
-
-PLATFORMS
-  x86_64-darwin-20
-
-DEPENDENCIES
-  async (> 2.0)
-  fiber-collector!
-  minitest (~> 5.0)
-  rake (~> 13.0)
-  rubocop (~> 1.21)
-
-BUNDLED WITH
-   2.3.26

data/Rakefile

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/test_*.rb"]
-end
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[test rubocop]

data/fiber-collector.gemspec

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/fiber/collector/version"
-
-
-Gem::Specification.new do |spec|
-  spec.name = "fiber-collector"
-  spec.version = Fiber::Collector::VERSION
-  spec.authors = ["Erik Madsen"]
-  spec.email = ["beatmadsen@gmail.com"]
-
-  spec.summary = "Collect results from multiple concurrently scheduled tasks"
-  spec.description = "Simple constructs to collect results from multiple concurrently scheduled tasks inspired by JavaScript's Promise.all(), Promise.any() and Promise.race() methods"
-  spec.homepage = 'https://github.com/beatmadsen/fiber-collector'
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.1"
-
-  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = 'https://github.com/beatmadsen/fiber-collector'
-  spec.metadata["changelog_uri"] = 'https://github.com/beatmadsen/fiber-collector/CHANGELOG.md'
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end