terrapin 0.6.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fe1ba61cb02d982ac5535ff8423186dcb045c9de
-  data.tar.gz: d1eae833ed7b0041442275d6a005188c4300a5fa
+SHA256:
+  metadata.gz: de8290a9a7c02f78729afc093bc4f91ded448cde41dfa85d3d7c57ce0acb1aa8
+  data.tar.gz: ebdcaed25d509d37f0652f3a3a8ed4f195d574a2ccf2e7ac57e541da4585b243
 SHA512:
-  metadata.gz: d8d2a8e41b0f12e41062cfcbbacaa7abcc9e2d02519ffe27214a4ffaa93c5c0243b681066fa76e59c66e13dd2f8abf87258644b5cf421c7e66e47118434c764d
-  data.tar.gz: 3e3e8d27c8a9e569fe99b30a09baacbe05a7dae3a260b36470453bcaaa7303f685a6868d84304d6e1afd55661ead32b31d89f3d4debf01bd7b31c67379ac47b0
+  metadata.gz: 8abf06d0433f3955d508291e81e44d5a9300a4bbddbb804ee40e959152a2bea72eaf0454a673fc427aba84aa5a747e90afacb0efa7ccf64aa159adec8e87647e
+  data.tar.gz: d4b1e42addf7855b8b38656aa7ad36f149041e2a1b8595fcad71fc5624178e6fde1b9472dd618a95a4766ebe781f0e44ba00f572ad72423216379dd2e83304a1

data/.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+on:
+  - push
+  - pull_request
+
+jobs:
+  build:
+    name: Ruby ${{ matrix.ruby }}
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 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@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Setup project
+        run: bundle install
+      - name: Run test
+        run: bundle exec rake

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/Gemfile

@@ -1,7 +1,3 @@
 source 'https://rubygems.org'
 
 gemspec
-
-platforms :ruby do
-  gem "posix-spawn"
-end

data/NEWS.md

@@ -1,3 +1,29 @@
+New for 1.1.1:
+
+* Fix specs flaking due to leaky path and runner
+* Use String.new to create a mutable string
+
+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
+
+New for 1.0.0:
+
+* Terrapin::CommandLine::PosixRunner was removed. You can replace any usage of this with Terrapin::CommandLine::ProcessRunner, which uses Ruby’s builtin Process.spawn.
+* Moved CI from Travis to GH Actions.
+
 New for 0.6.0:
 
 * Rename the project to Terrapin

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
 
@@ -105,11 +105,11 @@ line.command # => "lolwut", but it looks in /opt/bin for it.
 You can even give it a bunch of places to look:
 
 ```ruby
-    FileUtils.rm("/opt/bin/lolwut")
-    File.open('/usr/local/bin/lolwut') {|f| f.write('echo Hello') }
-    Terrapin::CommandLine.path = ["/opt/bin", "/usr/local/bin"]
-    line = Terrapin::CommandLine.new("lolwut")
-    line.run # => prints 'Hello', because it searches the path
+FileUtils.rm("/opt/bin/lolwut")
+File.open('/usr/local/bin/lolwut') { |f| f.write('echo Hello') }
+Terrapin::CommandLine.path = ["/opt/bin", "/usr/local/bin"]
+line = Terrapin::CommandLine.new("lolwut")
+line.run # => prints 'Hello', because it searches the path
 ```
 
 Or just put it in the command:
@@ -145,23 +145,18 @@ second argument of `new`. Terrapin assumes that you will not be manually
 passing user-generated data to that argument and will be using it as a template
 for your command line's structure.
 
-## POSIX Spawn
+## Runners
 
-You can potentially increase performance by installing [the posix-spawn
-gem](https://rubygems.org/gems/posix-spawn). This gem can keep your
-application's heap from being copied when forking command line
-processes. For applications with large heaps the gain can be
-significant. To include `posix-spawn`, simply add it to your `Gemfile` or,
-if you don't use bundler, install the gem.
+Terrapin will choose from among a couple different ways of running commands.
+The simplest is `Process.spawn`, which is also the default. Terrapin can also just use [backticks], so if for some reason you'd prefer that, you can ask Terrapin to use that:
 
-## Runners
+```ruby
+Terrapin::CommandLine.runner = Terrapin::CommandLine::BackticksRunner.new
+```
+
+And if you really want to, you can define your own Runner, though I can't imagine why you would.
 
-Terrapin will attempt to choose from among 3 different ways of running commands.
-The simplest is using backticks, and is the default in 1.8. In Ruby 1.9, it
-will attempt to use `Process.spawn`. And, as mentioned above, if the
-`posix-spawn` gem is installed, it will attempt to use that. If for some reason
-one of the `.spawn` runners don't work for you, you can override them manually
-by setting a new runner, like so:
+[backticks]: https://ruby-doc.org/3.2.1/Kernel.html#method-i-60
 
 ```ruby
 Terrapin::CommandLine.runner = Terrapin::CommandLine::BackticksRunner.new
@@ -212,16 +207,26 @@ 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 = String.new
+        @stderr_output = String.new
+        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/runners.rb

@@ -2,6 +2,5 @@
 
 require 'terrapin/command_line/runners/backticks_runner'
 require 'terrapin/command_line/runners/process_runner'
-require 'terrapin/command_line/runners/posix_runner'
 require 'terrapin/command_line/runners/popen_runner'
 require 'terrapin/command_line/runners/fake_runner'

data/lib/terrapin/command_line.rb

@@ -38,7 +38,7 @@ module Terrapin
       private
 
       def best_runner
-        [PosixRunner, ProcessRunner, BackticksRunner].detect do |runner|
+        [ProcessRunner, BackticksRunner].detect do |runner|
           runner.supported?
         end.new
       end
@@ -49,15 +49,20 @@ module Terrapin
     attr_reader :exit_status, :runner
 
     def initialize(binary, params = "", options = {})
-      @binary            = binary.dup
-      @params            = params.dup
-      @options           = options.dup
-      @runner            = @options.delete(:runner) || self.class.runner
-      @logger            = @options.delete(:logger) || self.class.logger
-      @swallow_stderr    = @options.delete(:swallow_stderr)
+      if options.nil?
+        raise ArgumentError, "3rd argument to CommandLine.new should be a" \
+          "hash of values that will be interpolated into the command line"
+      end
+
+      @options = options.dup
+      @binary = binary.dup
+      @params = params.to_s.dup
+      @runner = @options.delete(:runner) || self.class.runner
+      @logger = @options.delete(:logger) || self.class.logger
+      @swallow_stderr = @options.delete(:swallow_stderr)
       @expected_outcodes = @options.delete(:expected_outcodes) || [0]
-      @environment       = @options.delete(:environment) || {}
-      @runner_options    = @options.delete(:runner_options) || {}
+      @environment = @options.delete(:environment) || {}
+      @runner_options = @options.delete(:runner_options) || {}
     end
 
     def command(interpolations = {})
@@ -84,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 = "0.6.0".freeze
+  VERSION = "1.1.1".freeze
 end

data/spec/spec_helper.rb

@@ -1,6 +1,4 @@
 require 'rspec'
-require 'mocha/api'
-require 'bourne'
 require 'terrapin'
 require 'timeout'
 require 'tempfile'
@@ -14,10 +12,13 @@ begin; require 'active_support/buffered_logger'; rescue LoadError; end
 Dir[File.dirname(__FILE__) + "/support/**.rb"].each{|support_file| require support_file }
 
 RSpec.configure do |config|
-  config.mock_with :mocha
   config.include WithExitstatus
   config.include StubOS
-  config.include UnsettingExitstatus
+
+  config.before(:example) do
+    Terrapin::CommandLine.path = nil
+    Terrapin::CommandLine.runner = nil
+  end
 end
 
 def best_logger

data/spec/support/nonblocking_examples.rb

@@ -1,12 +1,23 @@
-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) }
 
     Timeout.timeout(5) do
       output = subject.call("cat '#{garbage_file.path}'")
-      $?.exitstatus.should == 0
-      output.output.length.should == 10 * 1024 * 1024
+      expect($?.exitstatus).to eq(0)
+      expect(output.output.length).to eq(10 * 1024 * 1024)
     end
 
     garbage_file.close

data/spec/support/stub_os.rb

@@ -1,25 +1,25 @@
 module StubOS
   def on_windows!
     stub_os('mswin')
-    Terrapin::OS.stubs(:path_separator).returns(";")
+    allow(Terrapin::OS).to receive(:path_separator).and_return(";")
   end
 
   def on_unix!
     stub_os('darwin11.0.0')
-    Terrapin::OS.stubs(:path_separator).returns(":")
+    allow(Terrapin::OS).to receive(:path_separator).and_return(":")
   end
 
   def on_mingw!
     stub_os('mingw')
-    Terrapin::OS.stubs(:path_separator).returns(";")
+    allow(Terrapin::OS).to receive(:path_separator).and_return(";")
   end
 
   def on_java!
-    Terrapin::OS.stubs(:arch).returns("universal-java1.7")
+    allow(Terrapin::OS).to receive(:arch).and_return("universal-java1.7")
   end
 
   def stub_os(host_string)
     # http://blog.emptyway.com/2009/11/03/proper-way-to-detect-windows-platform-in-ruby/
-    RbConfig::CONFIG.stubs(:[]).with('host_os').returns(host_string)
+    allow(RbConfig::CONFIG).to receive(:[]).with('host_os').and_return(host_string)
   end
 end

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")
@@ -16,9 +16,9 @@ describe Terrapin::CommandLine::BackticksRunner do
 
     it 'sets the exitstatus when a command completes' do
       subject.call("ruby -e 'exit 0'")
-      $?.exitstatus.should == 0
+      expect($?.exitstatus).to eq(0)
       subject.call("ruby -e 'exit 5'")
-      $?.exitstatus.should == 5
+      expect($?.exitstatus).to eq(5)
     end
   end
 end

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

@@ -4,19 +4,19 @@ describe Terrapin::CommandLine::FakeRunner do
   it 'records commands' do
     subject.call("some command", :environment)
     subject.call("other command", :other_environment)
-    subject.commands.should eq [["some command", :environment], ["other command", :other_environment]]
+    expect(subject.commands).to eq [["some command", :environment], ["other command", :other_environment]]
   end
 
   it 'can tell if a command was run' do
     subject.call("some command", :environment)
     subject.call("other command", :other_environment)
-    subject.ran?("some command").should eq true
-    subject.ran?("no command").should eq false
+    expect(subject.ran?("some command")).to eq true
+    expect(subject.ran?("no command")).to eq false
   end
 
   it 'can tell if a command was run even if shell options were set' do
     subject.call("something 2>/dev/null", :environment)
-    subject.ran?("something").should eq true
+    expect(subject.ran?("something")).to eq true
   end
 
 end

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")
@@ -16,9 +16,9 @@ describe Terrapin::CommandLine::PopenRunner do
 
     it 'sets the exitstatus when a command completes' do
       subject.call("ruby -e 'exit 0'")
-      $?.exitstatus.should == 0
+      expect($?.exitstatus).to eq(0)
       subject.call("ruby -e 'exit 5'")
-      $?.exitstatus.should == 5
+      expect($?.exitstatus).to eq(5)
     end
   end
 end

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")
@@ -21,9 +21,9 @@ describe Terrapin::CommandLine::ProcessRunner do
 
     it 'sets the exitstatus when a command completes' do
       subject.call("ruby -e 'exit 0'")
-      $?.exitstatus.should == 0
+      expect($?.exitstatus).to eq(0)
       subject.call("ruby -e 'exit 5'")
-      $?.exitstatus.should == 5
+      expect($?.exitstatus).to eq(5)
     end
 
     it "runs the command it's given and allows access to stderr afterwards" do