fiber-collector 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c3d63f39145b3799ab77677823d49591382983238b38df60f458092898811232
+  data.tar.gz: ab280299d591112ba093e985e81bf260d9d91332522b62ef1c930fe9f78da873
+SHA512:
+  metadata.gz: a19b8a42f2a478f5fc856a66826c8cc20e98a34074b266b5fcee9ee9942940cf2d55590e5e12b166b56f2ea6c9c57343d3527eefacc01f8d1c61ae27dafaa5ab
+  data.tar.gz: 2748af88974099d58e9fa86c5f51680ebfe7981c080d76e3e222d6b8d274edb50de3f34b6edefe69fb305f08371db693d2b6a7e3d49190b209dcc674cf4ab5b6

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-12-09
+
+- Initial release

data/Gemfile

@@ -0,0 +1,17 @@
+# 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

@@ -0,0 +1,54 @@
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Erik Madsen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+# 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
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add fiber-collector
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install fiber-collector
+
+## Usage
+
+Here are some examples where `sleep` is the non-blocking operation, but it could just as well be replaced with calls to `Net::HTTP.get()` or other I/O.
+
+```ruby
+# needs a fiber scheduler
+require 'async'
+
+# Sets the fiber scheduler and executes inside a non-blocking fiber
+Async do
+  # Collect all results
+  Fiber::Collector.schedule { sleep 0.001; 'a' }
+      .and { sleep 0.002; 'b' }
+      .and { sleep 0.003; 'c' }
+      .all(timeout: 0.02)
+end.wait
+# => ['a', 'b', 'c']
+
+Async do
+  Fiber::Collector.schedule { sleep 0.001; 'a' }
+      .and { sleep 0.002; raise 'boom' }
+      .and { sleep 0.003; 'c' }
+      .all
+end.wait
+# RuntimeError raised
+
+Async do
+  Fiber::Collector.schedule { sleep 0.010; 'a' }
+      .and { sleep 0.001; raise 'e' }
+      .and { sleep 0.005; 'b' } 
+      .and { sleep 0.007; 'c' }
+      .any(timeout: 0.02)    
+end.wait
+# => 'b'
+
+Async do
+  Fiber::Collector.schedule { sleep 0.010; 'a' }
+      .and { sleep 0.001; raise XError }
+      .and { sleep 0.005; 'b' } 
+      .and { sleep 0.007; raise YError }
+      .race(timeout: 0.02)    
+end.wait
+# XError raised
+
+Async do
+  Fiber::Collector.schedule { sleep 0.010; raise XError }
+      .and { sleep 0.001; 'a' }
+      .and { sleep 0.005; 'b' } 
+      .and { sleep 0.007; raise YError }
+      .race(timeout: 0.02)    
+end.wait
+# => "a"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/beatmadsen/fiber-collector. 
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# 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

@@ -0,0 +1,40 @@
+# 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 = "Write a short summary, because RubyGems requires one."
+  spec.description = "Write a longer description or delete this line."
+  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

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+class Fiber
+  module Collector
+    class All
+      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
+        end
+        @tasks.map { |t| t.error && raise(t.error) || t.result }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+class Fiber
+  module Collector
+    class Any
+      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          
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+class Fiber
+  module Collector
+    class Race
+      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          
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+
+class Fiber
+  module Collector
+    class Task
+      attr_reader :state, :error, :result
+
+      def initialize(proc)
+        @state = :waiting
+        @proc = proc
+      end
+
+      def done?
+        @state == :done
+      end
+
+      def run
+        @state = :running
+        @result = @proc.call
+      rescue StandardError => e
+        @error = e
+      ensure
+        @state = :done
+      end
+    end
+  end
+end

data/lib/fiber/collector/builder.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+require_relative 'builder/all'
+require_relative 'builder/any'
+require_relative 'builder/race'
+require_relative 'builder/task'
+
+class Fiber
+  module Collector    
+    class Builder
+      def initialize
+        @blocks = []
+      end
+
+      def schedule(&block)
+        @blocks << block
+        self
+      end
+
+      def and(...)
+        schedule(...)
+      end
+
+      def all(timeout: nil)
+        All.new(@blocks).wait(timeout)
+      end
+      
+      def any(timeout: nil)
+        Any.new(@blocks).wait(timeout)
+      end
+
+      def race(timeout: nil)
+        Race.new(@blocks).wait(timeout)
+      end
+    end
+  end
+end

data/lib/fiber/collector/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Fiber
+  module Collector
+    VERSION = "0.1.0"
+  end
+end

data/lib/fiber/collector.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'collector/builder'
+require_relative 'collector/version'
+
+class Fiber
+  module Collector
+    def self.schedule(&block)
+      Builder.new.schedule(&block)
+    end
+
+    class Error < StandardError; end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: fiber-collector
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Erik Madsen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-09 00:00:00.000000000 Z
+dependencies: []
+description: Write a longer description or delete this line.
+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/race.rb
+- lib/fiber/collector/builder/task.rb
+- lib/fiber/collector/version.rb
+homepage: https://github.com/beatmadsen/fiber-collector
+licenses:
+- MIT
+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:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []