stagnum 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d935b2dcef0e06bf324569727b0e0416444d733d20da884426bd28d5d76ea18
+  data.tar.gz: f00a9639d70ba8c6fbd3da0e0877e4c8bbff5ae8968a1691d5312644f230e4b4
+SHA512:
+  metadata.gz: '08c53834df95715abd1b77ab151ff49d29b9913db15cb81903c18174e67e0a2d4b33fecd45697efdfb4574bb732b0cb840b2d438ac9def2bae70e448b41eeea9'
+  data.tar.gz: ce0f53b3c4650e5aa3d2e1880a4fe31a49162949881f1fa755c70e7b9aed8979669e3044027aff6297515c19f33139a6c7b2cc7ebaa055898226b80e983c12ce

data/LICENSE.txt

@@ -0,0 +1,24 @@
+
+Copyright (c) 2025-2025, John Mettraux, jmettraux+flor@gmail.com
+
+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.
+
+
+Made in Japan
+

data/README.md

@@ -0,0 +1,51 @@
+
+# stagnum
+
+A stupid Ruby worker pool based on `Thread` and `Thread::Queue`.
+
+```ruby
+pool = Stagnum::Pool.new('pool-zero', 4)
+  #
+  # 4 worker threads to service the enqueued jobs
+
+q = Stagnum::DoneQueue.new
+  #
+  # a queue shared by a group of jobs to enqueue
+
+30.times do |i|
+
+  pool.enqueue(q, { i: i }) do |d|
+
+    sleep rand * 1
+
+    d[:tname] = Thread.current.name
+  end
+end
+
+successes, failures = q.pop_all
+  #
+  # Stagnum::DoneQueue extends Thread::Queue
+  # but has a #pop_all convenience method
+
+pp successes
+  #
+  # ==>
+  #
+  # [[:success, {i: 0, tname: "pool-zero__0"}],
+  #  [:success, {i: 3, tname: "pool-zero__3"}],
+  #  [:success, {i: 1, tname: "pool-zero__1"}],
+  #  [:success, {i: 2, tname: "pool-zero__2"}],
+  #  [:success, {i: 7, tname: "pool-zero__2"}],
+  #  [:success, {i: 5, tname: "pool-zero__3"}],
+  #  [:success, {i: 9, tname: "pool-zero__3"}],
+  #  [:success, {i: 6, tname: "pool-zero__1"}],
+  #  [:success, {i: 4, tname: "pool-zero__0"}],
+  #  [:success, {i: 8, tname: "pool-zero__2"}]]
+```
+
+One can use `Thread::Queue` instead of `Stagnum::DoneQueue`
+
+## LICENSE
+
+MIT, see [LICENSE.txt](LICENSE.txt)
+

data/lib/stagnum.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require 'thread'
+
+
+module Stagnum
+
+  VERSION = '0.9.0'
+
+
+  class Pool
+
+    attr_reader :name
+
+    def initialize(name, worker_count)
+
+      @name = name
+      @work_queue = ::Thread::Queue.new
+      @worker_count = worker_count
+
+      @maintenance_mutex = ::Thread::Mutex.new
+      @next_worker_thread_id = -1
+      @worker_threads = []
+    end
+
+    def enqueue(done_queue=Stagnum::DoneQueue.new, data, &block)
+
+      maintain
+
+      done_queue.increment if done_queue.respond_to?(:increment)
+
+      @work_queue << [ done_queue, data, block ]
+
+      done_queue
+    end
+
+    def next_worker_thread_id
+
+      @next_worker_thread_id += 1
+    end
+
+    protected
+
+    def maintain
+
+      @maintenance_mutex.synchronize do
+
+        @worker_threads = @worker_threads.select { |t| t.alive? }
+
+        while @worker_threads.size < @worker_count
+
+          @worker_threads << Stagnum::WorkerThread.new(self, @work_queue)
+        end
+      end
+    end
+  end
+
+  class DoneQueue < ::Thread::Queue
+
+    attr_reader :count
+
+    def initialize(items=[])
+
+      super
+
+      @count = 0
+    end
+
+    def increment
+
+      @count += 1
+    end
+
+    # Returns [ successes, failures ]
+    #
+    def pop_all
+
+      @count.times
+        .inject([ [], [] ]) { |a, i|
+          r = self.pop
+          a[r[0] == :success ? 0 : 1] << r
+          a }
+    end
+  end
+
+  class WorkerThread < ::Thread
+
+    def initialize(stagnum, work_queue)
+
+      @stagnum = stagnum
+      @work_queue = work_queue
+
+      self.name = "#{stagnum.name}__#{stagnum.next_worker_thread_id}"
+
+      super do
+
+        loop do
+
+          done_queue, data, block = @work_queue.pop
+
+          block.call(data)
+
+          done_queue << [ :success, data ]
+
+        rescue => err
+
+          done_queue << [ :failure, data, err ]
+        end
+      end
+    end
+  end
+end
+

data/stagnum.gemspec

@@ -0,0 +1,46 @@
+
+Gem::Specification.new do |s|
+
+  s.name = 'stagnum'
+
+  s.version = File.read(
+    File.expand_path('../lib/stagnum.rb', __FILE__)
+  ).match(/ VERSION *= *['"]([^'"]+)/)[1]
+
+  s.platform = Gem::Platform::RUBY
+  s.authors = [ 'John Mettraux' ]
+  s.email = [ 'jmettraux+flor@gmail.com' ]
+  s.homepage = 'https://github.com/floraison/stagnum'
+  s.license = 'MIT'
+  s.summary = 'a worker pool'
+
+  s.description = %{
+A stupid worker pool
+  }.strip
+
+  s.metadata = {
+    'changelog_uri' => s.homepage + '/blob/master/CHANGELOG.md',
+    'bug_tracker_uri' => s.homepage + '/issues',
+    'homepage_uri' =>  s.homepage,
+    'documentation_uri' => s.homepage,
+    'source_code_uri' => s.homepage,
+    #'mailing_list_uri' => 'https://groups.google.com/forum/#!forum/floraison',
+    #'wiki_uri' => s.homepage + '/wiki',
+    'rubygems_mfa_required' => 'true',
+  }
+
+  #s.files = `git ls-files`.split("\n")
+  s.files = Dir[
+    '{README,CHANGELOG,CREDITS,LICENSE}.{md,txt}',
+    #'Makefile',
+    'lib/**/*.rb', #'spec/**/*.rb', 'test/**/*.rb',
+    "#{s.name}.gemspec",
+  ]
+
+  #s.add_runtime_dependency 'raabro', '~> 1.4'
+
+  s.add_development_dependency 'probatio', '~> 1.0'
+
+  s.require_path = 'lib'
+end
+

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: stagnum
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- John Mettraux
+bindir: bin
+cert_chain: []
+date: 2025-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: probatio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A stupid worker pool
+email:
+- jmettraux+flor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/stagnum.rb
+- stagnum.gemspec
+homepage: https://github.com/floraison/stagnum
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/floraison/stagnum/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/floraison/stagnum/issues
+  homepage_uri: https://github.com/floraison/stagnum
+  documentation_uri: https://github.com/floraison/stagnum
+  source_code_uri: https://github.com/floraison/stagnum
+  rubygems_mfa_required: 'true'
+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.6.2
+specification_version: 4
+summary: a worker pool
+test_files: []