process_executer 0.6.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e0e00cd80ace5ff3db9a5c73bdb9ee768538de1fc1c59e0341b3dc70f59c876
-  data.tar.gz: 29a8e6d5513f7e0e3ebee923a11a4851adf28293ca5e91a8b4d240cd5c8ab94c
+  metadata.gz: ec0548ff8356b9466db5fe9c9992e134010c9842561e1b0c0b95a5418fb2c2d2
+  data.tar.gz: 7b9ead3538f7117b453a5353ad0a1ed352b7c60fa86fbacaa12081ff32b411cb
 SHA512:
-  metadata.gz: 49dda3a26c6a7e95dc94ecdb76d005e0fd05247ad42e57c3113793403a60e8f97d9914ddc7d6221901dc7aa9c7ee4fcd2014548645f4ffb5cea125429f6239c5
-  data.tar.gz: e2ad549d573658d1052e99489d8fb9e18b3523c0829fe667b7cfd8bd2a4ce59fd8beee0956086a948ffcc9b1b7e9b1581caf2f4b50f1ed3ec1a5f16085f19807
+  metadata.gz: a35f9cd143bf7236efbb107a8de130784c195bedb83e95262cc26ae7e2b7e586b7230bdf1ad680c508a5dd8b2c3398c89290ad01a1e5914e165179c298bf5b11
+  data.tar.gz: 5dabb78fd2151f587078b3a139974eb390e23e86be961ce93a7d4f65dd161007e8a175b36b208d13939d38cd5dab41f0a446e7d5213aee34c7f07273c4804f49

data/.markdownlint.yml

@@ -1,7 +1,7 @@
 default: true
 
 # Unordered list indentation
-MD007: { indent: 4 }
+MD007: { indent: 2 }
 
 # Line length
 MD013: { line_length: 90, tables: false, code_blocks: false }

data/.rubocop.yml

@@ -7,7 +7,7 @@ AllCops:
   SuggestExtensions: false
   # RuboCop enforces rules depending on the oldest version of Ruby which
   # your project supports:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
 
 # The default max line length is 80 characters
 Layout/LineLength:
@@ -18,3 +18,6 @@ Metrics/BlockLength:
   Exclude:
     - "spec/**/*_spec.rb"
     - "*.gemspec"
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.0.5

data/CHANGELOG.md

@@ -5,6 +5,28 @@ All notable changes to the process_executer gem will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## v1.0.0 (2023-12-31)
+
+[Full Changelog](https://github.com/main-branch/process_executer/compare/v0.7.0..v1.0.0)
+
+Changes since v0.7.0:
+
+* e11f03e Separate semver PR label check into its own workflow (#36)
+* eabcc3e Update min req Ruby version from 2.7 to 3.0 (#32)
+* 5483bb8 Update spec_helper.rb to new standard (#31)
+* 4a27341 Update all development dependencies to latest versions (#30)
+* ea7513d Enforce that a semver label is present on PRs (#28)
+* 0aa26cd Instruct Rubocop that dev deps go in gemspec (#29)
+* 53cb526 Add a truffle-ruby build on ubuntu (#18)
+
+## v0.7.0 (2023-02-17)
+
+[Full Changelog](https://github.com/main-branch/process_executer/compare/v0.6.1..v0.7.0)
+
+Changes since v0.6.1:
+
+* c5c07fd Reduce the time spent waiting for output (#25)
+
 ## v0.6.1 (2023-02-12)
 
 [Full Changelog](https://github.com/main-branch/process_executer/compare/v0.6.0..v0.6.1)

data/README.md

@@ -7,10 +7,21 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/0b5c67e5c2a773009cd0/maintainability)](https://codeclimate.com/github/main-branch/process_executer/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/0b5c67e5c2a773009cd0/test_coverage)](https://codeclimate.com/github/main-branch/process_executer/test_coverage)
 
-## Features
+* [Usage](#usage)
+  * [ProcessExecuter::MonitoredPipe](#processexecutermonitoredpipe)
+  * [ProcessExecuter.spawn](#processexecuterspawn)
+* [Installation](#installation)
+* [Contributing](#contributing)
+  * [Reporting Issues](#reporting-issues)
+  * [Developing](#developing)
+  * [Submitting Pull Requests](#submitting-pull-requests)
+  * [Releasing](#releasing)
+* [License](#license)
+
+## Usage
 
 [Full YARD documentation](https://rubydoc.info/gems/process_executer/) for this
-gem is hosted on RubyGems.org.
+gem is hosted on RubyGems.org. Read below of an overview and several examples.
 
 This gem contains the following important classes:
 
@@ -18,7 +29,7 @@ This gem contains the following important classes:
 
 `ProcessExecuter::MonitoredPipe` streams data sent through a pipe to one or more writers.
 
-When a new `MonitoredPipe` is created, an pipe is created (via IO.pipe) and
+When a new `MonitoredPipe` is created, a pipe is created (via IO.pipe) and
 a thread is created which reads data as it is written written to the pipe.
 
 Data that is read from the pipe is written one or more writers passed to
@@ -82,27 +93,84 @@ If bundler is not being used to manage dependencies, install the gem by executin
 gem install process_executer
 ```
 
-## Usage
+## Contributing
 
-See the examples in the project's YARD documentation.
+### Reporting Issues
 
-## Development
+Bug reports and other support requests are welcome on [this project's
+GitHub issue tracker](https://github.com/main-branch/process_executer)
 
-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.
+### Developing
 
-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).
+Clone the repo, run `bin/setup` to install dependencies, and then run `rake spec` to
+run the tests. You can also run `bin/console` for an interactive prompt that will
+allow you to experiment.
 
-## Contributing
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Submitting Pull Requests
+
+In order for a pull request to be merged, it must be approved by a code owner and
+include a semver label.
+
+The approval must be done using the Github PR Review process by a code owner defined
+in the project's CODEOWNERS file.
+
+The semver label indicates the type of change so that the gem version can be
+increments according to semver rules prior to release. One and only one of the
+following labels must added to the PR:
+
+* **`major-change`**
+
+  Use when the PR includes incompatible API or functional changes.
+
+  This typically occurs when the changes introduced could break existing code that
+  depends on this gem. For example, removing a public method, changing a method's
+  signature, or altering the expected behavior of a method in a way that would
+  require changes in the dependent code.
+
+* **`minor-change`**
+
+  Use when the PR adds functionality in a backward-compatible manner.
+
+  This includes adding new features, enhancements, or deprecating existing features
+  as long as the deprecation itself doesn't break compatibility.
+
+  It's also common to include substantial improvements or optimizations in this
+  category, as long as they don't alter the expected behavior of the existing API.
+
+* **`patch-change`**
+
+  Use when the PR includes small user-facing changes that are backward-compatible and
+  do not introduce new functionality.
+
+  This includes bug fixes or other internal changes that do not affect the API such
+  as refactoring code, improving performance, or updating user documentation.
+
+* **`internal-change`**
+
+  Use when the PR includes changes that are NOT user facing and will NOT require a
+  release.
+
+  This includes updates to developer documentation, comments, GitHub Actions, minor
+  refactorings, and fixing Rubocop offenses.
+
+### Releasing
+
+To release a new version, first determine the proper semver increment based on the
+PRs included in the release.
+
+Then in the root directory of this project with the `main` branch checked out, run
+the following command:
+
+```shell
+create-github-release {major|minor|patch}
+```
 
-Bug reports and pull requests are welcome on our
-[GitHub issue tracker](https://github.com/main-branch/process_executer)
+Follow the directions given by the `create-github-release` to publish the new version
+of the gem.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -31,10 +31,6 @@ end
 CLEAN << 'pkg'
 CLOBBER << 'Gemfile.lock'
 
-# Bump
-
-require 'bump/tasks'
-
 # RSpec
 
 require 'rspec/core/rake_task'

data/lib/process_executer/monitored_pipe.rb

@@ -86,7 +86,7 @@ module ProcessExecuter
       return unless state == :open
 
       @state = :closing
-      sleep 0.01 until state == :closed
+      sleep 0.001 until state == :closed
     end
 
     # Return the write end of the pipe so that data can be written to it
@@ -149,6 +149,8 @@ module ProcessExecuter
     # @api private
     #
     def write(data)
+      raise IOError, 'closed stream' unless state == :open
+
       pipe_writer.write(data)
     end
 
@@ -289,7 +291,7 @@ module ProcessExecuter
         @state = :closing
       end
     rescue IO::WaitReadable
-      pipe_reader.wait_readable(0.01)
+      pipe_reader.wait_readable(0.001)
     end
 
     # Read any remaining data from the pipe and close it

data/lib/process_executer/version.rb

@@ -2,5 +2,5 @@
 
 module ProcessExecuter
   # The current Gem version
-  VERSION = '0.6.1'
+  VERSION = '1.0.0'
 end

data/process_executer.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description = 'An API for executing commands in a subprocess'
   spec.homepage = 'https://github.com/main-branch/process_executer'
   spec.license = 'MIT'
-  spec.required_ruby_version = '>= 2.7.0'
+  spec.required_ruby_version = '>= 3.0.0'
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
@@ -31,20 +31,17 @@ Gem::Specification.new do |spec|
   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"
-  spec.add_development_dependency 'bump', '~> 0.10'
   spec.add_development_dependency 'bundler-audit', '~> 0.9'
-  spec.add_development_dependency 'create_github_release', '~> 1.0'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.10'
-  spec.add_development_dependency 'rubocop', '~> 1.36'
-  spec.add_development_dependency 'simplecov', '~> 0.21'
+  spec.add_development_dependency 'create_github_release', '~> 1.1'
+  spec.add_development_dependency 'rake', '~> 13.1'
+  spec.add_development_dependency 'rspec', '~> 3.12'
+  spec.add_development_dependency 'rubocop', '~> 1.59'
+  spec.add_development_dependency 'semverify', '~> 0.3'
+  spec.add_development_dependency 'simplecov', '~> 0.22'
   spec.add_development_dependency 'simplecov-lcov', '~> 0.8'
-  spec.add_development_dependency 'solargraph', '~> 0.47'
 
   unless RUBY_PLATFORM == 'java'
-    spec.add_development_dependency 'redcarpet', '~> 3.5'
+    spec.add_development_dependency 'redcarpet', '~> 3.6'
     spec.add_development_dependency 'yard', '~> 0.9', '>= 0.9.28'
     spec.add_development_dependency 'yardstick', '~> 0.9'
   end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: process_executer
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 1.0.0
 platform: ruby
 authors:
 - James Couball
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-12 00:00:00.000000000 Z
+date: 2023-12-31 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bump
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -44,112 +30,112 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.36'
+        version: '1.59'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.36'
+        version: '1.59'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: semverify
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: simplecov-lcov
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.22'
 - !ruby/object:Gem::Dependency
-  name: solargraph
+  name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -194,6 +180,7 @@ files:
 - ".markdownlint.yml"
 - ".rspec"
 - ".rubocop.yml"
+- ".tool-versions"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
@@ -222,14 +209,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: An API for executing commands in a subprocess