fiber_space 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: abe3d0bb4dc3359f6888ed84d53c579e0bf4d1e8049e5ec140a29adb664b3b9a
+  data.tar.gz: f5cf577cbc73510e640991e333de0d51c81a2019997a655188b4055d4f7c1bfc
+SHA512:
+  metadata.gz: f0f463ae5c6319fdfbfd7964ed2d93573d8de4e6d6b1a625ab59faea7badb9db831c87918518e1221ca94ede9fb07f4e259bcdcb42c45924a920ca544c002133
+  data.tar.gz: 148606be51d318644a6e1c18d8121e7a9b85805cea2892b5d9ca08b1a9cdfb1ab19cbcf6048111dd6e020969d9fefc21988b30f792c9fa1de5cd1aa5d007fe2c

data/lib/fiber_space/chain.rb

@@ -0,0 +1,107 @@
+module FiberSpace
+  # A FiberChain encapsulates and organizes a SortedSet of Fiber or FiberContainer objects. It facilitates the sequential execution of Fiber and FiberContainer objects.
+  class FiberChain
+
+    # Constructs a new FiberChain
+    # @param containers [Array] collection of Fibers or FiberContainers.
+    def initialize(*containers)
+      @stack = SortedSet.new
+      containers.each { |fiber_container| register(fiber_container) }
+    end
+
+    # Performs a single iteration of execution on the FiberChain#stack.
+    def iterate
+      @worker ||= Fiber.new do
+        loop do
+          if @stack.any?(&:completed?)
+            @stack.delete_if(&:completed?)
+            prepare
+          end
+        rescue StandardError => e
+          puts 'An error occurred during FiberChain#iterate!'
+          puts e.message
+          puts e.backtrace&.join("\n")
+        ensure
+          break if complete?
+
+          Fiber.yield(@stack.first.resume)
+        end
+      end
+      @worker.resume
+    end
+
+    # Begins executing all items within the FiberChain#stack until all items are complete or the stack is empty.
+    def execute
+      iterate until complete?
+    end
+
+    # Pushes an item to the FiberChain#stack
+    # @param item [Fiber, FiberContainer] the item
+    def register(item)
+      @stack << case item
+                when Fiber then FiberContainer.new(source: item)
+                when FiberContainer then item
+                else raise TypeError, 'Expecting Fiber or FiberContainer!'
+                end
+    end
+
+    # The length of the FiberChain#stack
+    # @return [Integer] the length
+    def length
+      @stack.length
+    end
+
+    # Has all elements of the FiberChain#stack completed execution?
+    # @return [Boolean]
+    def complete?
+      @stack.empty? || @stack.all?(&:completed?)
+    end
+
+    private
+
+    # Links all elements of the FiberChain#stack to their subsequent neighbor elements via FiberContainer#target.
+    def prepare
+      current = @stack.to_a
+      current.each do |item|
+        next if item.is_a?(Fiber)
+
+        if item == current.last
+          # Complete the loop
+          item.target = current.first
+        else
+          item.chain = true
+          item.target = current[current.index(item) + 1]
+        end
+      end
+      @stack = SortedSet.new(current)
+    end
+  end
+end
+
+# Copyright (c) 2022, Patrick W.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# * Neither the name of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/fiber_space/container.rb

@@ -0,0 +1,98 @@
+module FiberSpace
+  # A FiberContainer wraps a source Fiber with attributes for maintaining a specific state. It allows storing and transferring/resuming of a target who is called once the source fiber has completed it's work.
+  class FiberContainer
+    # @!attribute [r] id
+    # @return [Integer, String, Symbol] the ID
+    attr :id
+
+    # @!attribute [r] priority
+    # @return [Symbol] the priority
+    attr :priority
+
+    # @!attribute [rw] chain
+    # @return [Boolean] the chain flag
+    attr_accessor :chain
+
+    # @!attribute [rw] target
+    # @return [Fiber, FiberContainer] the target
+    attr_accessor :target
+
+    # Constructs a new FiberContainer
+    # @param opt [Hash] options for the Container.
+    # *  cache [Array] cached arguments
+    # * id [Integer, Symbol] id of the Fiber.
+    # * count [Integer, Symbol] execution count.
+    # * target [Fiber, NilClass] target Fiber.
+    # * priority [Symbol] priority of the Fiber
+    # @return [FiberContainer]
+    def initialize(opt = {}, &work)
+      @id = opt[:id] || Druuid.gen
+      @count = opt[:count] || 1
+      @target = opt[:target] || nil
+      @priority = opt[:priority] || :LOW
+      @cache = opt[:cache] || []
+      @source = opt[:source] || Fiber.new do |cached|
+        loop do
+          if @count.zero? || @count.negative?
+            case @target
+            when FiberContainer then @target.completed? ? break : @target.resume
+            when Fiber then @target.resume if @target.alive?
+            else break
+            end
+          elsif @count == :once || completed?
+            break
+          else
+            unless completed?
+              @count -= 1
+              Fiber.yield(yield(cached))
+            end
+          end
+        end
+      end
+    end
+
+    def resume
+      @source.resume(@cache) unless completed?
+    end
+
+    # Is the fiber completed?
+    # @return [Boolean]
+    def completed?
+      @count.zero? || @count.negative? || !@source.alive?
+    end
+
+    # Mutual comparison operator
+    # @param other [FiberContainer] the other Fiber.
+    def <=>(other)
+      FiberSpace::FIBER_PRIORITIES[@priority] <=> FiberSpace::FIBER_PRIORITIES[other.priority]
+    end
+  end
+end
+
+# Copyright (c) 2022, Patrick W.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# * Neither the name of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/fiber_space/wrapper.rb

@@ -0,0 +1,77 @@
+module FiberSpace
+
+  # A Container for fiber processes.
+  class ProcessWrapper
+
+    attr :properties
+
+    attr :stack
+
+    def initialize(options = {})
+      @properties = {
+        max_fibers: options[:max_fibers] || 0xff
+      }.freeze
+
+      setup_root_trapping
+      setup_process
+    end
+
+    def shutdown
+      @worker_thread.kill
+      sleep(1) while @worker_thread.alive?
+    end
+
+    private
+
+    def setup_root_trapping
+      Signal.trap('INT') do
+        puts 'Caught INT signal!'
+        Process.kill('INT', @worker_process)
+        Process.wait(@worker_process)
+      rescue StandardError => e
+        puts 'An error occurred during shutdown!'
+        puts e.backtrace&.join("\n")
+      end
+
+      Signal.trap('TERM') do
+        puts 'Caught TERM signal.'
+        begin
+          Process.kill('TERM', @worker_process)
+          Process.wait(@worker_process)
+        rescue StandardError => e
+          puts 'An error occurred during shutdown!'
+          puts e.backtrace&.join("\n")
+        end
+      end
+    end
+
+    def setup_child_trapping
+      Signal.trap('INT') do
+        puts 'Child caught INT!!'
+      ensure
+        shutdown
+      end
+
+      Signal.trap('TERM') do
+        puts 'Child caught TERM!!'
+      ensure
+        shutdown
+      end
+    end
+
+    def setup_process
+      @worker_process = Process.spawn do
+        setup_child_trapping
+        setup_worker
+      end
+    end
+
+    def setup_worker
+      @worker_thread = Thread.new do
+        loop do
+
+        end
+      end
+    end
+  end
+end

data/lib/fiber_space.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+Dir[File.dirname(__FILE__)].each { |file| $LOAD_PATH.unshift(file) if File.directory? file }
+
+require 'druuid'
+require 'fiber'
+require 'set'
+
+# A set of tools to organize and work with Fibers.
+module FiberSpace
+
+  # @!attribute [r] FIBER_PRIORITIES
+  # @return [Hash] priorities for Fibers.
+  FIBER_PRIORITIES = { HIGH: 1, MED: 2, LOW: 3 }.freeze
+
+  autoload :FiberContainer,             'fiber_space/container'
+  autoload :FiberChain,                 'fiber_space/chain'
+  autoload :ProcessWrapper,             'fiber_space/wrapper'
+end
+
+# Copyright (c) 2022, Patrick W.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# * Neither the name of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: fiber_space
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Patrick W.
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: druuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+description:
+email: Sickday@pm.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/fiber_space.rb
+- lib/fiber_space/chain.rb
+- lib/fiber_space/container.rb
+- lib/fiber_space/wrapper.rb
+homepage: https://git.repos.pw/Sickday/fiber_space
+licenses:
+- BSD-3-Clause
+metadata:
+  source_code_uri: https://git.repos.pw/Sickday/fiber_space
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: A set of tools that expand on Fiber functionality.
+test_files: []