sack_race 1.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1498684f3df3d6be627b01f8c20c8e5d7b8697cc312a57ff6806d9f6a0b0c910
+  data.tar.gz: 16ddd6862af4847f77044c147609ebee5787f2b06cce9392811dc661f240efdc
+SHA512:
+  metadata.gz: 686eaf249eec247483c6c1f914c1b0d0eda80dc84535b304e6dac7196eb06575d03f1d8f1b904b06cd0602619b47e41f641b9b0849fc76716cfa79f9637eec79
+  data.tar.gz: 8a01fa9788dbca097e9a68716b429ccf67be442cc3db46b6a51ad34a569d5768e0ce89e9f8286be0b476ac20aa874b0e218dca514c1a3e06c00623514262ba0c

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+3.4.1

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# CHANGELOG
+
+## 1.0.0.rc1 (2025-04-08)
+
+* Add initial implementation ([#2][])
+
+[#2]: https://github.com/nickcharlton/sack_race/pull/2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Nick Charlton
+
+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,31 @@
+# SackRace
+
+A process manager that allows you to trigger and wait for events in output.
+
+## Installation
+
+You can install `sack_race` via RubyGems: `gem install sack_race`
+
+## Usage
+
+```ruby
+# define the process we want to run
+process = SackRace::Process.new("bundle exec rails server")
+
+# add an event to wait for and start
+process.add_handler(:ready, "Use Ctrl-C to stop\n")
+process.start
+
+# block until the handler is called
+process.wait_for_handler(:ready)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub][].
+
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the [code of conduct][].
+
+[GitHub]: https://github.com/nickcharlton/sack_race
+[code of conduct]: https://github.com/nickcharlton/sack_race/blob/main/CODE_OF_CONDUCT.md

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/sack_race/process.rb

@@ -0,0 +1,96 @@
+require "open3"
+
+module SackRace
+  class Process
+    attr_reader :command, :opts, :verbose
+
+    def initialize(command, opts = {})
+      @command = command
+      @verbose = opts.delete(:verbose)
+      @opts = opts
+      @handlers = {}
+    end
+
+    def add_handler(name, matching_string, &block)
+      @handlers[name] = Handler.new(name, matching_string, block)
+    end
+
+    def start
+      @running_thread = Thread.new do
+        run_subprocess(command, opts) do |stdout, stderr, thread|
+          puts stdout if verbose
+          warn stderr if verbose
+
+          @handlers.each do |name, handler|
+            if handler.match?(stdout)
+              handler.set_continue
+            end
+          end
+        end
+      end
+    end
+
+    def stop
+      ::Process.kill("INT", subprocess_thread.pid)
+      running_thread.join
+    end
+
+    def wait_for_handler(name)
+      handler = @handlers[name]
+      handler.wait
+    end
+
+    private
+
+    attr_reader :handlers, :running_thread, :subprocess_thread
+
+    def run_subprocess(cmd, opts, &block)
+      Open3.popen3(cmd, opts) do |stdin, stdout, stderr, thread|
+        @subprocess_thread = thread
+        readers = {out: stdout, err: stderr}.map do |key, stream|
+          Thread.new do
+            until (line = stream.gets).nil?
+              if block_given?
+                if key == :out
+                  yield line, nil, thread
+                else
+                  yield nil, line, thread
+                end
+              end
+            end
+          end
+        end
+
+        thread.join # don't exit until the external process is done
+        readers.map(&:join) # ensure we clear out open buffers
+      end
+    end
+  end
+
+  class Handler
+    def initialize(name, matching_string, block)
+      @name = name
+      @matching_string = matching_string
+      @block = block
+      @continue = false
+      @thread = Thread.new do
+        until @continue
+          sleep 1
+        end
+      end
+    end
+
+    def set_continue
+      @continue = true
+    end
+
+    def match?(stdout)
+      @matching_string == stdout
+    end
+
+    def wait
+      @thread.join
+      @block&.call
+    end
+  end
+end

data/lib/sack_race/version.rb

@@ -0,0 +1,3 @@
+module SackRace
+  VERSION = "1.0.0.rc1"
+end

data/lib/sack_race.rb

@@ -0,0 +1,8 @@
+require "open3"
+
+require_relative "sack_race/version"
+require_relative "sack_race/process"
+
+module SackRace
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: sack_race
+version: !ruby/object:Gem::Version
+  version: 1.0.0.rc1
+platform: ruby
+authors:
+- Nick Charlton
+bindir: exe
+cert_chain: []
+date: 2025-04-08 00:00:00.000000000 Z
+dependencies: []
+email:
+- nick@nickcharlton.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sack_race.rb
+- lib/sack_race/process.rb
+- lib/sack_race/version.rb
+homepage: https://github.com/nickcharlton/sack_race
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nickcharlton/sack_race
+  source_code_uri: https://github.com/nickcharlton/sack_race
+  changelog_uri: https://github.com/nickcharlton/sack_race/blob/main/CHANGELOG.md
+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.6.2
+specification_version: 4
+summary: Manage processes with in progress callbacks
+test_files: []