process_executer 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d476a9c88bc9491b887b5a5507dd2288f1aadf1b4735c8c15b790dbbfa423f9
-  data.tar.gz: 763c100ce03c3f625e323fefcdafe3788300c51429296110a5aa9222eb05d039
+  metadata.gz: 7c875872382e447e7af6dfec78af45242baa13c7b832d5c25f3e146bbc2b9f1d
+  data.tar.gz: a68da52f9b1dfae542386a0d61abc85cdc0d86ee0471c4893692061db661f4e5
 SHA512:
-  metadata.gz: f27eebdee1a46bac93ecfa8c78d29feba3ebb2c833d53dda7cd3213ee43c441994f50e0317592898a31d0eff42ca3a83cc3e3ad201d746fd641c7de9d3d9d762
-  data.tar.gz: 1e303f09b81b1605cfef527b41fbfc52f8e247a10c5ad3af1bed944bab2d6cf839eac9850b1b1c6038d73549abd1e7d0cef18de3dc081930f8d764512a3adc43
+  metadata.gz: a0f6b19a6570dab6843b0d76af1839496ae7ff0651a3f485d6465414b3eb6f0d4a78236bc9ae80ad1b4d7e2e43d8c093ef2733e047eaadb27f3c2e7f174e5f82
+  data.tar.gz: 65da6657d7b821f2b0641bcad6278ded70fd78c06497dfa93fa67ab52c6bb0b57443fa6aa92b5cc160b68ff3b4b68165208b2ff77eea0f4b50542e1243a62c8e

data/.commitlintrc.yml

@@ -0,0 +1,16 @@
+---
+extends: '@commitlint/config-conventional'
+
+rules:
+  # See: https://commitlint.js.org/reference/rules.html
+  #
+  # Rules are made up by a name and a configuration array. The configuration array contains:
+  #
+  # * Severity [0..2]: 0 disable rule, 1 warning if violated, or 2 error if violated
+  # * Applicability [always|never]: never inverts the rule
+  # * Value: value to use for this rule
+  #
+  # Run `npx commitlint --print-config` to see the current setting for all rules.
+  #
+  body-leading-blank:    [2, 'always']
+  footer-leading-blank:  [2, 'always']

data/.husky/commit-msg

@@ -0,0 +1 @@
+npx --no-install commitlint --edit "$1"

data/.rubocop.yml

@@ -1,23 +1,7 @@
-AllCops:
-  NewCops: enable
-  # Output extra information for each offense to make it easier to diagnose:
-  DisplayCopNames: true
-  DisplayStyleGuide: true
-  ExtraDetails: true
-  SuggestExtensions: false
-  # RuboCop enforces rules depending on the oldest version of Ruby which
-  # your project supports:
-  TargetRubyVersion: 3.0
-
-# The default max line length is 80 characters
-Layout/LineLength:
-  Max: 120
+inherit_gem:
+  main_branch_shared_rubocop_config: config/rubocop.yml
 
-# The DSL for RSpec and the gemspec file make it very hard to limit block length:
-Metrics/BlockLength:
-  Exclude:
-    - "spec/**/*_spec.rb"
-    - "*.gemspec"
-
-Gemspec/DevelopmentDependencies:
-  Enabled: false
+AllCops:
+  # Pin this project to Ruby 3.1 in case the shared config above is upgraded to 3.2
+  # or later.
+  TargetRubyVersion: 3.1

data/.tool-versions

@@ -1 +1 @@
-ruby 3.3.5
+ruby 3.3.5

data/.yardopts

@@ -3,4 +3,6 @@
 --markup-provider=redcarpet
 --markup markdown
 - CHANGELOG.md
-- LICENSE.md
+- CONTRIBUTING.md
+- RELEASING.md
+- LICENSE.txt

data/CHANGELOG.md

@@ -5,17 +5,69 @@ 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.1.1 (2024-09-25)
-
-[Full Changelog](https://github.com/main-branch/process_executer/compare/v1.1.0..v1.1.1)
+## v1.2.0 (2024-10-10)
+
+[Full Changelog](https://github.com/main-branch/process_executer/compare/v1.1.2..v1.2.0)
+
+Changes since v1.1.2:
+
+* 35663c9 chore: reset main branch to 1.x
+* 39913bc build: remove semver pr label check
+* 8ae8e34 build: enforce conventional commit message formatting
+* f5b8c51 Release v2.0.0.pre1
+* 8e15c39 Re-add require for 'forwardable'
+* 4bba06e Fix flakey test that checks for thread to die
+* 83bfd78 Remove unused require for 'forwardable' and 'ostruct'
+* ea3ea3c Use shared Rubocop config
+* ecd2cb5 Update copyright notice in this project
+* 7d5bfe1 Update links in gemspec
+* 797de91 Add Slack badge for this project in README
+* 591b716 Update “Build Status” link the README
+* 2fcd001 Update yardopts with new standard options
+* 4e1de47 Standardize YARD and Markdown Lint configurations
+* 929c680 Set JRuby --debug option when running tests in GitHub Actions workflows
+* 71049cb Finish Integration of simplecov-rspec into the project
+* 4fb44bb Update continuous integration and experimental ruby builds
+* 289645c Depend on v1 of semver_pr_label_check
+* 3c4d988 Update code climate test coverage reporter version
+* 04103b4 Simplify how the experimental ruby builds are triggered
+* 35840a4 Use a reusable workflow for the Semver PR label check
+* 0d887f0 Update code climate test coverage reporter version
+* bb7f73b Rename the experimental build workflow
+* 035ce8a Fix the experimental CI Build workflow
+* 3d739f4 Move CI builds using experimental Rubies to a different workflow
+* c5ef6b0 Integrate simplecov-rspec to ensure code covage in CI builds
+* f33707e Update development dependencies and examples (#45)
+
+## v2.0.0.pre1 (2024-09-26)
+
+[Full Changelog](https://github.com/main-branch/process_executer/compare/v1.1.0..v2.0.0.pre1)
 
 Changes since v1.1.0:
 
-* c3f063a Use a later version of ruby for development
-* d4eeb1e Use latest version of the actions/checkout to v4
-* eb4dad7 Fix flakey test on  JRuby
-* ac9417a Update CI build to run on v1.x branch
-* 014e70f Remove unused require for 'forwardable' and 'ostruct' (for v1.x)
+* 8e15c39 Re-add require for 'forwardable'
+* 4bba06e Fix flakey test that checks for thread to die
+* 83bfd78 Remove unused require for 'forwardable' and 'ostruct'
+* ea3ea3c Use shared Rubocop config
+* ecd2cb5 Update copyright notice in this project
+* 7d5bfe1 Update links in gemspec
+* 797de91 Add Slack badge for this project in README
+* 591b716 Update “Build Status” link the README
+* 2fcd001 Update yardopts with new standard options
+* 4e1de47 Standardize YARD and Markdown Lint configurations
+* 929c680 Set JRuby --debug option when running tests in GitHub Actions workflows
+* 71049cb Finish Integration of simplecov-rspec into the project
+* 4fb44bb Update continuous integration and experimental ruby builds
+* 289645c Depend on v1 of semver_pr_label_check
+* 3c4d988 Update code climate test coverage reporter version
+* 04103b4 Simplify how the experimental ruby builds are triggered
+* 35840a4 Use a reusable workflow for the Semver PR label check
+* 0d887f0 Update code climate test coverage reporter version
+* bb7f73b Rename the experimental build workflow
+* 035ce8a Fix the experimental CI Build workflow
+* 3d739f4 Move CI builds using experimental Rubies to a different workflow
+* c5ef6b0 Integrate simplecov-rspec to ensure code covage in CI builds
+* f33707e Update development dependencies and examples (#45)
 
 ## v1.1.0 (2024-02-02)
 

data/{LICENSE.md → LICENSE.txt}

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 James Couball
+Copyright (c) 2024 James Couball
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -3,9 +3,12 @@
 [![Gem Version](https://badge.fury.io/rb/process_executer.svg)](https://badge.fury.io/rb/process_executer)
 [![Documentation](https://img.shields.io/badge/Documentation-Latest-green)](https://rubydoc.info/gems/process_executer/)
 [![Change Log](https://img.shields.io/badge/CHANGELOG-Latest-green)](https://rubydoc.info/gems/process_executer/file/CHANGELOG.md)
-[![Build Status](https://github.com/main-branch/process_executer/workflows/CI%20Build/badge.svg?branch=main)](https://github.com/main-branch/process_executer/actions?query=workflow%3ACI%20Build)
+[![Build Status](https://github.com/main-branch/process_executer/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/main-branch/process_executer/actions/workflows/continuous-integration.yml)
 [![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)
+[![Conventional
+Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
+[![Slack](https://img.shields.io/badge/slack-main--branch/process__executer-yellow.svg?logo=slack)](https://main-branch.slack.com/archives/C07NG2BPG8Y)
 
 * [Usage](#usage)
   * [ProcessExecuter::MonitoredPipe](#processexecutermonitoredpipe)
@@ -14,7 +17,8 @@
 * [Contributing](#contributing)
   * [Reporting Issues](#reporting-issues)
   * [Developing](#developing)
-  * [Submitting Pull Requests](#submitting-pull-requests)
+  * [Commit message guidelines](#commit-message-guidelines)
+  * [Pull request guidelines](#pull-request-guidelines)
   * [Releasing](#releasing)
 * [License](#license)
 
@@ -116,59 +120,34 @@ allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
-### Submitting Pull Requests
+### Commit message guidelines
 
-In order for a pull request to be merged, it must be approved by a code owner and
-include a semver label.
+All commit messages must follow the [Conventional Commits
+standard](https://www.conventionalcommits.org/en/v1.0.0/). This helps us maintain a
+clear and structured commit history, automate versioning, and generate changelogs
+effectively.
 
-The approval must be done using the Github PR Review process by a code owner defined
-in the project's CODEOWNERS file.
+To ensure compliance, this project includes:
 
-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:
+* A git commit-msg hook that validates your commit messages before they are accepted.
 
-* **`major-change`**
+  To activate the hook, you must have node installed and run `npm install`.
 
-  Use when the PR includes incompatible API or functional changes.
+* A GitHub Actions workflow that will enforce the Conventional Commit standard as
+  part of the continuous integration pipeline.
 
-  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.
+  Any commit message that does not conform to the Conventional Commits standard will
+  cause the workflow to fail and not allow the PR to be merged.
 
-* **`minor-change`**
+### Pull request guidelines
 
-  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.
+All pull requests must be merged using rebase merges. This ensures that commit
+messages from the feature branch are preserved in the release branch, keeping the
+history clean and meaningful.
 
 ### 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
+In the root directory of this project with the `main` branch checked out, run
 the following command:
 
 ```shell

data/Rakefile

@@ -45,14 +45,9 @@ CLEAN << 'rspec-report.xml'
 
 require 'rubocop/rake_task'
 
-RuboCop::RakeTask.new do |t|
-  t.options = %w[
-    --format progress
-    --format json --out rubocop-report.json
-  ]
-end
+RuboCop::RakeTask.new
 
-CLEAN << 'rubocop-report.json'
+# YARD
 
 unless RUBY_PLATFORM == 'java'
   # YARD

data/lib/process_executer/status.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'delegate'
+require 'forwardable'
 
 module ProcessExecuter
   # A simple delegator for Process::Status that adds a `timeout?` attribute

data/lib/process_executer/version.rb

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

data/lib/process_executer.rb

@@ -23,6 +23,7 @@ module ProcessExecuter
   #   status = ProcessExecuter.spawn('echo hello')
   #   status.exited? # => true
   #   status.success? # => true
+  #   status.timeout? # => false
   #
   # @example with a timeout
   #   status = ProcessExecuter.spawn('sleep 10', timeout: 0.01)
@@ -30,6 +31,7 @@ module ProcessExecuter
   #   status.success? # => nil
   #   status.signaled? # => true
   #   status.termsig # => 9
+  #   status.timeout? # => true
   #
   # @example capturing stdout to a string
   #   stdout = StringIO.new

data/package.json

@@ -0,0 +1,11 @@
+{
+  "devDependencies": {
+    "@commitlint/cli": "^19.5.0",
+    "@commitlint/config-conventional": "^19.5.0",
+    "husky": "^9.1.0"
+  },
+  "scripts": {
+    "postinstall": "husky",
+    "prepare": "husky"
+  }
+}

data/process_executer.gemspec

@@ -10,16 +10,17 @@ Gem::Specification.new do |spec|
 
   spec.summary = 'An API for executing commands in a subprocess'
   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 = '>= 3.0.0'
+  spec.required_ruby_version = '>= 3.1.0'
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
+  # Project links
+  spec.homepage = "https://github.com/main-branch/#{spec.name}"
   spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/main-branch/process_executer'
-  spec.metadata['changelog_uri'] = "https://rubydoc.info/gems/#{spec.name}/#{spec.version}/file/CHANGELOG.md"
+  spec.metadata['source_code_uri'] = spec.homepage
   spec.metadata['documentation_uri'] = "https://rubydoc.info/gems/#{spec.name}/#{spec.version}"
+  spec.metadata['changelog_uri'] = "https://rubydoc.info/gems/#{spec.name}/#{spec.version}/file/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -31,15 +32,21 @@ Gem::Specification.new do |spec|
   spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.requirements = [
+    'Platform: Mac, Linux, or Windows',
+    'Ruby: MRI 3.1 or later, TruffleRuby 24 or later, or JRuby 9.4 or later'
+  ]
 
   spec.add_development_dependency 'bundler-audit', '~> 0.9'
-  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 'create_github_release', '~> 2.1'
+  spec.add_development_dependency 'main_branch_shared_rubocop_config', '~> 0.1'
+  spec.add_development_dependency 'rake', '~> 13.2'
+  spec.add_development_dependency 'rspec', '~> 3.13'
+  spec.add_development_dependency 'rubocop', '~> 1.66'
   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 'simplecov-rspec', '~> 0.3'
 
   unless RUBY_PLATFORM == 'java'
     spec.add_development_dependency 'redcarpet', '~> 3.6'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: process_executer
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - James Couball
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-25 00:00:00.000000000 Z
+date: 2024-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -30,56 +30,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: main_branch_shared_rubocop_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.1'
+        version: '13.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.1'
+        version: '13.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.59'
+        version: '1.66'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.59'
+        version: '1.66'
 - !ruby/object:Gem::Dependency
   name: semverify
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -177,6 +205,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".commitlintrc.yml"
+- ".husky/commit-msg"
 - ".markdownlint.yml"
 - ".rspec"
 - ".rubocop.yml"
@@ -184,7 +214,7 @@ files:
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
-- LICENSE.md
+- LICENSE.txt
 - README.md
 - Rakefile
 - lib/process_executer.rb
@@ -192,6 +222,7 @@ files:
 - lib/process_executer/options.rb
 - lib/process_executer/status.rb
 - lib/process_executer/version.rb
+- package.json
 - process_executer.gemspec
 homepage: https://github.com/main-branch/process_executer
 licenses:
@@ -200,8 +231,8 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/main-branch/process_executer
   source_code_uri: https://github.com/main-branch/process_executer
-  changelog_uri: https://rubydoc.info/gems/process_executer/1.1.1/file/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/process_executer/1.1.1
+  documentation_uri: https://rubydoc.info/gems/process_executer/1.2.0
+  changelog_uri: https://rubydoc.info/gems/process_executer/1.2.0/file/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -211,13 +242,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
+requirements:
+- 'Platform: Mac, Linux, or Windows'
+- 'Ruby: MRI 3.1 or later, TruffleRuby 24 or later, or JRuby 9.4 or later'
 rubygems_version: 3.5.16
 signing_key:
 specification_version: 4