async-conditions_list 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 79c5d0704be97ff950af06e11d9f34e4178a8ad925790d3967aebb8d93a8efd9
+  data.tar.gz: 14105256b4ebf3ed9ce271ba8f35f3cd3931e5abb7451c80cdb19155c68511b6
+SHA512:
+  metadata.gz: b7d8ad945db5533c24dce48ab9b133776f140b3f490aaa8d1e89881f125bed99163f04787957506ebc77fa88df42b676aa45167580b0429013f67d97a1adc0f8
+  data.tar.gz: 4e001031e220493d5d261e9bd852e415b809b1843cc17643520097ce68c465d7d4749063b4d351a57c57819d83b3034999bf0e3aebfaa8cc7313ec40902e0083

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 140
+  Exclude:
+    - spec/**/*
+
+Metrics/BlockLength:
+  CountAsOne: ["array", "heredoc", "method_call"]
+  Exclude:
+    - spec/**/*

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-10-06
+
+- Initial release

data/README.md

@@ -0,0 +1,44 @@
+# Async::ConditionsList
+
+An extension to Async gem that allows to create a list of condition, wait for it and receive an array of results
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+```ruby
+require 'async'
+require 'async/conditions_list'
+
+conditions_list = Async::ConditionsList.new(3)
+
+Sync do |task|
+  task.async do
+    results = conditions_list.wait
+    p "All conditions have been met!"
+    p results
+  end
+
+  # Simulate asynchronous events
+  task.sleep(1)
+  conditions_list.signal(1)
+  task.sleep(1)
+  conditions_list.signal(2)
+  task.sleep(1)
+  conditions_list.signal(3)
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/holywalley/async-conditions_list.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/async/conditions_list/version.rb

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

data/lib/async/conditions_list.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative "conditions_list/version"
+require "async"
+
+module Async
+  # The ConditionsList class manages a collection of Async::Condition objects,
+  # allowing you to wait on multiple conditions and get accumulated result.
+  #
+  # == Initialization
+  #
+  # To create a new ConditionsList, specify the number of conditions you want to manage:
+  #
+  #   conditions_list = Async::ConditionsList.new(size)
+  #
+  # == Methods
+  #
+  # - `wait`: Waits on all conditions in the list.
+  #
+  # - `signal(value = nil)`: Signals the current condition being waited on.
+  #   If no condition has been waited on yet, it raises `ConditionsList::Error`.
+  #
+  # == Example Usage
+  #
+  #   require 'async'
+  #   require 'async/conditions_list'
+  #
+  #   conditions_list = Async::ConditionsList.new(3)
+  #
+  #   Sync do |task|
+  #     task.async do
+  #       conditions_list.wait
+  #       puts "All conditions have been met!"
+  #     end
+  #
+  #     # Simulate asynchronous events
+  #     task.sleep(1)
+  #     conditions_list.signal
+  #     task.sleep(1)
+  #     conditions_list.signal
+  #     task.sleep(1)
+  #     conditions_list.signal
+  #   end
+  #
+  # == Error Handling
+  #
+  # - Raises `ConditionsList::Error` if `signal` is called before any condition has been waited on.
+  #
+  # == Notes
+  #
+  # - Ensure that the `wait` method is called before `signal` to avoid errors.
+  # - This class is intended to be used within the `Async` scheduler.
+  #
+  class ConditionsList
+    class Error < StandardError; end
+
+    def initialize(size)
+      @list = Array.new(size) { Async::Condition.new }
+      @current_condition = nil
+    end
+
+    def wait
+      @list.map do |condition|
+        @current_condition = condition
+        condition.wait
+      end
+    end
+
+    def signal(value = nil)
+      raise Error, "No condition has been waited on yet." unless @current_condition
+
+      @current_condition.signal(value)
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: async-conditions_list
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- HolyWalley
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.17'
+description:
+email:
+- yakau@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- lib/async/conditions_list.rb
+- lib/async/conditions_list/version.rb
+homepage: https://github.com/HolyWalley/async-conditions_list
+licenses: []
+metadata:
+  homepage_uri: https://github.com/HolyWalley/async-conditions_list
+  source_code_uri: https://github.com/HolyWalley/async-conditions_list
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: An extension to Async gem that allows to create a list of condition, wait
+  for it and receive an array of results
+test_files: []