terrapin 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5910ee1392568c14eca0ca631739457e77798c9c80413f6807c8a09a740dfc1a
-  data.tar.gz: c242a1f2550051a07e4c9f23720168686692e9aacfeae7c6f0d0fb0d95f04d5f
+  metadata.gz: 066c74dc23f8fa6c2327eb3fec6f31b8169bc240164716937b96acd3796e7df6
+  data.tar.gz: 25bf6daf469817cb75d15c17b83880faaeb0289f054a876f53a411532c4026f2
 SHA512:
-  metadata.gz: 012bc02c2f3f976957fa8615256fe2e4a0fdd27a9e7bcf9c6e6ab3eccc80a10df703a5cbef6918cfbc0dfe2206c5d7aa45ff33e6f640b0b5af72ef4225479eb9
-  data.tar.gz: 25814f1d6e0d82cb7498ce34a7809190e31318437ab22ee8d482878392011f4c78ad805f0c88d4561e9e444034a8b98937d8d61a743aa578ecac00e48e5890de
+  metadata.gz: 7c5324dc84dbff0c5487cc74bc94053f4551038586a7a36b8b4cfcb87f1947a318b271ec83e23f3396d2f038ea30243b35fcd5211c79172c2d90c708855e8439
+  data.tar.gz: 9236fe888b471278554bbbba8e89bfd26ae943e87698b8e647247bd153a6ab6195a38ff52b6407d1859e7c02fd050166b42deb9dd308ff50ef65fb4df70bd5d1

data/.github/workflows/ci.yml

@@ -11,16 +11,18 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - jruby-9.4.1.0
+          - jruby-9.4.12.0
           - "2.7"
           - "3.0"
           - "3.1"
           - "3.2"
+          - "3.3"
+          - "3.4"
 
     runs-on: 'ubuntu-latest'
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}

data/.github/workflows/dynamic-readme.yml

@@ -0,0 +1,17 @@
+name: update-templates
+
+on: 
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  update-templates:
+    permissions:
+      contents: write
+      pull-requests: write
+      pages: write
+    uses: thoughtbot/templates/.github/workflows/dynamic-readme.yaml@main
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/dynamic-security.yml

@@ -0,0 +1,19 @@
+name: update-security
+
+on:
+  push:
+    paths:
+      - SECURITY.md
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  update-security:
+    permissions:
+      contents: write
+      pull-requests: write
+      pages: write
+    uses: thoughtbot/templates/.github/workflows/dynamic-security.yaml@main
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}

data/CODEOWNERS

@@ -0,0 +1,15 @@
+# Lines starting with '#' are comments.
+# Each line is a file pattern followed by one or more owners.
+
+# More details are here: https://help.github.com/articles/about-codeowners/
+
+# The '*' pattern is global owners.
+
+# Order is important. The last matching pattern has the most precedence.
+# The folders are ordered as follows:
+
+# In each subsection folders are ordered first by depth, then alphabetically.
+# This should make it easy to add new rules without breaking existing ones.
+
+# Global rule:
+*           @cpytel

data/NEWS.md

@@ -1,3 +1,15 @@
+New for 1.1.0:
+
+* Remove Travis CI configuration
+* Fix the stderr test
+* Add Ruby 3.3, 3.4 to the build matrix
+* Upgrade actions/checkout from v2 to v4
+* Upgrade JRuby to 9.4.12.0
+* Insert an inspect on the exit status
+* Don't hang on stderr
+* Add 'logger' as development dependency (fixes ruby 3.4 warning)
+* Use String.new to create a mutable string
+
 New for 1.0.1:
 
 * Relax version requirement for `climate_control` dependency

data/README.md

@@ -1,4 +1,4 @@
-# Terrapin [![Build Status](https://secure.travis-ci.org/thoughtbot/terrapin.png?branch=master)](http://travis-ci.org/thoughtbot/terrapin)
+# Terrapin
 
 Run shell commands safely, even with user-supplied values
 
@@ -207,16 +207,27 @@ Question? Idea? Problem? Bug? Comment? Concern? Like using question marks?
 Thank you to all [the
 contributors](https://github.com/thoughtbot/terrapin/graphs/contributors)!
 
-![thoughtbot](http://thoughtbot.com/logo.png)
-
-Terrapin is maintained and funded by [thoughtbot,
-inc](http://thoughtbot.com/community)
-
-The names and logos for thoughtbot are trademarks of thoughtbot, inc.
-
 ## License
 
-Copyright 2011-2018 Jon Yurek and thoughtbot, inc. This is free software, and
+Copyright © 2011 Jon Yurek and thoughtbot, inc. This is free software, and
 may be redistributed under the terms specified in the
 [LICENSE](https://github.com/thoughtbot/terrapin/blob/master/LICENSE)
 file.
+
+<!-- START /templates/footer.md -->
+## About thoughtbot
+
+![thoughtbot](https://thoughtbot.com/thoughtbot-logo-for-readmes.svg)
+
+This repo is maintained and funded by thoughtbot, inc.
+The names and logos for thoughtbot are trademarks of thoughtbot, inc.
+
+We love open source software!
+See [our other projects][community].
+We are [available for hire][hire].
+
+[community]: https://thoughtbot.com/community?utm_source=github
+[hire]: https://thoughtbot.com/hire-us?utm_source=github
+
+
+<!-- END /templates/footer.md -->

data/SECURITY.md

@@ -0,0 +1,20 @@
+<!-- START /templates/security.md -->
+# Security Policy
+
+## Supported Versions
+
+Only the the latest version of this project is supported at a given time. If
+you find a security issue with an older version, please try updating to the
+latest version first.
+
+If for some reason you can't update to the latest version, please let us know
+your reasons so that we can have a better understanding of your situation.
+
+## Reporting a Vulnerability
+
+For security inquiries or vulnerability reports, visit
+<https://thoughtbot.com/security>.
+
+If you have any suggestions to improve this policy, visit <https://thoughtbot.com/security>.
+
+<!-- END /templates/security.md -->

data/lib/terrapin/command_line/multi_pipe.rb

@@ -29,19 +29,51 @@ module Terrapin
       end
 
       def read
-        @stdout_output = read_stream(@stdout_in)
-        @stderr_output = read_stream(@stderr_in)
+        read_streams(@stdout_in, @stderr_in)
       end
 
       def close_read
-        @stdout_in.close
+        begin
+          @stdout_in.close
+        rescue IOError
+          # do nothing
+        end
+
+        begin
         @stderr_in.close
+        rescue IOError
+          # do nothing
+        end
+      end
+
+      def read_streams(output, error)
+        @stdout_output = ""
+        @stderr_output = ""
+        read_fds = [output, error]
+        while !read_fds.empty?
+          to_read, = IO.select(read_fds)
+          if to_read.include?(output)
+            @stdout_output << read_stream(output)
+            read_fds.delete(output) if output.closed?
+          end
+
+          if to_read.include?(error)
+            @stderr_output << read_stream(error)
+            read_fds.delete(error) if error.closed?
+          end
+        end
       end
 
       def read_stream(io)
-        result = ""
-        while partial_result = io.read(8192)
-          result << partial_result
+        result = String.new
+        begin
+          while partial_result = io.read_nonblock(8192)
+            result << partial_result
+          end
+        rescue EOFError, Errno::EPIPE
+          io.close
+        rescue Errno::EINTR, Errno::EWOULDBLOCK, Errno::EAGAIN
+          # do nothing
         end
         result
       end

data/lib/terrapin/command_line.rb

@@ -89,7 +89,7 @@ module Terrapin
 
       unless @expected_outcodes.include?(@exit_status)
         message = [
-          "Command '#{full_command}' returned #{@exit_status}. Expected #{@expected_outcodes.join(", ")}",
+          "Command '#{full_command}' returned #{@exit_status.inspect}. Expected #{@expected_outcodes.join(", ")}",
           "Here is the command output: STDOUT:\n", command_output,
           "\nSTDERR:\n", command_error_output
         ].join("\n")

data/lib/terrapin/version.rb

@@ -1,4 +1,4 @@
 # coding: UTF-8
 module Terrapin
-  VERSION = "1.0.1".freeze
+  VERSION = "1.1.0".freeze
 end

data/spec/support/nonblocking_examples.rb

@@ -1,4 +1,15 @@
-shared_examples_for "a command that does not block" do
+shared_examples_for "a command that does not block" do |opts = {}|
+  if opts[:supports_stderr]
+    it "does not block if the command output a lot on stderr" do
+      Timeout.timeout(5) do
+        output = subject.call("ruby -e '$stdout.puts %{hello}; $stderr.puts %{goodbye}*10_000'")
+
+      expect(output.output).to eq "hello\n"
+      expect(output.error_output).to eq "#{"goodbye" * 10_000}\n"
+      end
+    end
+  end
+
   it 'does not block if the command outputs a lot of data' do
     garbage_file = Tempfile.new("garbage")
     10.times{ garbage_file.write("A" * 1024 * 1024) }

data/spec/terrapin/command_line/runners/backticks_runner_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Terrapin::CommandLine::BackticksRunner do
   if Terrapin::CommandLine::BackticksRunner.supported?
-    it_behaves_like 'a command that does not block'
+    it_behaves_like 'a command that does not block', { :supports_stderr => false }
 
     it 'runs the command given and captures the output in an Output' do
       output = subject.call("echo hello")

data/spec/terrapin/command_line/runners/popen_runner_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Terrapin::CommandLine::PopenRunner do
   if Terrapin::CommandLine::PopenRunner.supported?
-    it_behaves_like 'a command that does not block'
+    it_behaves_like 'a command that does not block', { :supports_stderr => false }
 
     it 'runs the command given and captures the output in an Output' do
       output = subject.call("echo hello")

data/spec/terrapin/command_line/runners/process_runner_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Terrapin::CommandLine::ProcessRunner do
   if Terrapin::CommandLine::ProcessRunner.supported?
-    it_behaves_like "a command that does not block"
+    it_behaves_like "a command that does not block", { :supports_stderr => true }
 
     it 'runs the command given and captures the output' do
       output = subject.call("echo hello")

data/terrapin.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency("rake")
   s.add_development_dependency("activesupport", ">= 3.0.0", "< 5.0")
   s.add_development_dependency("pry")
+  s.add_development_dependency("logger")
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: terrapin
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Jon Yurek
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-15 00:00:00.000000000 Z
+date: 2025-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -86,6 +85,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Run shell commands safely, even with user-supplied values
 email: jyurek@thoughtbot.com
 executables: []
@@ -93,14 +106,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
+- ".github/workflows/dynamic-readme.yml"
+- ".github/workflows/dynamic-security.yml"
 - ".gitignore"
-- ".travis.yml"
+- CODEOWNERS
 - GOALS
 - Gemfile
 - LICENSE
 - NEWS.md
 - README.md
 - Rakefile
+- SECURITY.md
 - lib/terrapin.rb
 - lib/terrapin/command_line.rb
 - lib/terrapin/command_line/multi_pipe.rb
@@ -133,7 +149,6 @@ homepage: https://github.com/thoughtbot/terrapin
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -148,8 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Run shell commands safely, even with user-supplied values
 test_files: []

data/.travis.yml

@@ -1,9 +0,0 @@
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.5
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
-  - jruby-19mode