command_line 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaa71300b625158d9cf0460e8be73d20fdc1e045ff0f7dcab2e7483019f96408
-  data.tar.gz: 6d5eb5b7ff2083b75ae156c14038cc01ecbda66572a1cf8c5b9fa017f35b05f1
+  metadata.gz: 2be62115c457c82067cee8e0a5239f98e38a66de71e3e8041abdcc3438fa9370
+  data.tar.gz: a406fab9a99fe399f84ff5bfa8eda39a579fe939404adef3c37666bc99fa6969
 SHA512:
-  metadata.gz: b4335254d86f1369417000bdecc9fd486040918368d3757976e884da50f4a213dc197b5f20de55ed0176497dcd21b3f6998774443928b9967c356019546db639
-  data.tar.gz: 8116f37462c0cda552988f526bbd75f768db92a9520646959a0cb50328930328ec4b4282ae2da44ec45ef22a66436ab6ac412d80a3f9069c45693560af84eb22
+  metadata.gz: 18073bff45489bc86735085782f4f76ab19397e91f421f6bdd68db1c700c74d74919474479366bf5bd660a526288a8167fce1d7e9080a735f12e795e53db950f
+  data.tar.gz: 8f0f6075cc00e1f9adabf826441be43e597ab97debd0b3db458e4d8e2bd6e64c0438e98b7c43758e04ae67138934664924ca8528aa112e386dc2e91da7dfde90

data/.github/workflows/linux.yml

@@ -0,0 +1,22 @@
+name: Linux
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.7, 2.6, 2.5]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby }}
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Build
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+    - name: Test
+      run: bundle exec rake

data/.github/workflows/macos.yml

@@ -0,0 +1,22 @@
+name: MacOS
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: macos-latest
+    strategy:
+      matrix:
+        ruby: [2.7, 2.6, 2.5]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby }}
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Build
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+    - name: Test
+      run: bundle exec rake

data/.github/workflows/windows.yml

@@ -0,0 +1,22 @@
+name: Windows
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        ruby: [2.7, 2.6, 2.5]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby }}
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Build
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+    - name: Test
+      run: bundle exec rake

data/.gitignore

@@ -3,4 +3,5 @@
 /pkg/
 /spec/reports/
 /spec/examples.txt
+/doc
 Gemfile.lock

data/.rubocop.yml

@@ -1,14 +1,14 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
   Exclude:
   - '*.gemspec'
   - Gemfile
   - Rakefile
   - spec/fixtures/**/*
   - bin/**/*
-Layout/AlignArguments:
+Layout/ArgumentAlignment:
   EnforcedStyle: with_fixed_indentation
-Layout/IndentFirstHashElement:
+Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 Metrics/BlockLength:
   Exclude:

data/.yardopts

@@ -0,0 +1,6 @@
+--markup markdown
+--markup-provider redcarpet
+--readme README.md
+-
+CHANGELOG.md
+LICENSE.txt

data/CHANGELOG.md

@@ -1,4 +1,19 @@
-# [1.1.0] (TBD)
+# [2.0.0] (2020-04-13)
+
+## Changed
+
+- Arguments are now always sent as a single command to `Open3.popen3`. Sending as multiple arguments can cause it to not use the shell. Passing as a single argument ensures the shell is always used.
+- Drop support for Ruby 2.4.
+
+## Added
+
+- The `:env` flag now accepts non-string keys and will convert them to strings.
+
+## Fixed
+
+- Deprecation warning about keyword arguments.
+
+# [1.1.0] (2019-10-23)
 
 ## Added
 
@@ -16,5 +31,6 @@
 
 Initial release.
 
+[2.0.0]: https://github.com/DragonRuby/command_line/compare/v1.1.0...v2.0.0
 [1.1.0]: https://github.com/DragonRuby/command_line/compare/v1.0.1...v1.1.0
 [1.0.1]: https://github.com/DragonRuby/command_line/compare/v1.0.0...v1.0.1

data/CONTRIBUTING.md

@@ -0,0 +1,24 @@
+# Steps
+
+1. [Fork][] the repo.
+2. Add a breaking test for your change.
+3. Make the tests pass.
+4. Push your fork.
+5. Submit a pull request.
+
+## Code Style
+
+This project uses [EditorConfig] to tell editors what formatting to use.
+It's built into many editors and there are plugins for nearly every other editor that will automatically enforce the formatting.
+If you want to handle it manually you can look at the [.editorconfig] file to see the rules to follow.
+
+# Testing
+
+Running the tests using `rake` (with no args) will also check for style issues in the code.
+Ideally all submissions would pass these checks.
+If the code style is causing issues we can work with you to correct it.
+Don't let it stop you from contributing.
+
+[fork]: https://github.com/DragonRuby/command_line
+[EditorConfig]: https://editorconfig.org/
+[.editorconfig]: .editorconfig

data/README.md

@@ -1,8 +1,9 @@
 # CommandLine
 
 [![Version](https://img.shields.io/gem/v/command_line.svg?style=flat-square)](https://rubygems.org/gems/command_line)
-[![Linux and OS X Build](https://img.shields.io/travis/com/DragonRuby/command_line?label=Linux%20and%20OS%20X&style=flat-square)](https://travis-ci.com/DragonRuby/command_line)
-[![Windows Build](https://img.shields.io/appveyor/ci/AaronLasseigne/command-line?label=Windows&style=flat-square)](https://ci.appveyor.com/project/AaronLasseigne/command-line)
+[![Linux Build](https://img.shields.io/github/workflow/status/DragonRuby/command_line/Linux?label=Linux&style=flat-square)](https://github.com/DragonRuby/command_line/actions?query=workflow%3ALinux)
+[![MacOS Build](https://img.shields.io/github/workflow/status/DragonRuby/command_line/MacOS?label=MacOS&style=flat-square)](https://github.com/DragonRuby/command_line/actions?query=workflow%3AMacOS)
+[![Windows Build](https://img.shields.io/github/workflow/status/DragonRuby/command_line/Windows?label=Windows&style=flat-square)](https://github.com/DragonRuby/command_line/actions?query=workflow%3AWindows)
 
 CommandLine provides an easier way to run command-line applications.
 It captures all outputs, can handle applications that require stdin, and can pass environment variables.
@@ -17,13 +18,13 @@ This project uses [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'command_line', '~> 1.1'
+gem 'command_line', '~> 2.0'
 ```
 
 If you want `command_line` available globally you can add this line to your application's Gemfile:
 
 ```ruby
-gem 'command_line', '~> 1.1', require: 'command_line/global'
+gem 'command_line', '~> 2.0', require: 'command_line/global'
 ```
 
 Or manually install it yourself with:
@@ -74,7 +75,7 @@ end
 Environment variables can be passed after the command and arguments are passed.
 
 ```ruby
-command_line('some_webserver', env: { 'PORT' => '80' })
+command_line('some_webserver', env: { PORT: '80' })
 ```
 
 If you're concerned about the command running too long you can set a `:timeout`.
@@ -106,11 +107,3 @@ end
 ```
 
 This will make `command_line` available in your test suite.
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/DragonRuby/command_line.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/command_line.gemspec

@@ -1,6 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'command_line/version'
+require_relative 'lib/command_line/version'
 
 Gem::Specification.new do |spec|
   spec.name    = 'command_line'
@@ -29,8 +27,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.9'
-  spec.add_development_dependency 'rubocop', '~> 0.75.0'
+  spec.add_development_dependency 'rubocop', '~> 0.81.0'
   spec.add_development_dependency 'yard', '~> 0.9.20'
+  spec.add_development_dependency 'redcarpet', '~> 3.5.0'
 end

data/lib/command_line.rb

@@ -27,9 +27,9 @@ module CommandLine
   # @param command [String] The command to run.
   # @param args [Array] Any arguments passed to the command. All arguments will
   #   be converted to strings using `to_s`.
-  # @param [Hash] env: Pass environment variables to use. The key should
-  #   be a String representing the environment variable name. The value
-  #   is the value you want that variable to have.
+  # @param [Hash] env: Pass environment variables to use. The key is the name
+  #   of the environment variable. The value is the value you want that variable
+  #   to have.
   # @param [Integer, Float, nil] Number of seconds to wait for the block to
   #   terminate. Floats can be used to specify fractional seconds. A value of 0
   #   or nil will execute the block without any timeout.
@@ -47,7 +47,7 @@ module CommandLine
   #   end
   #
   # @example
-  #   command_line('some_webserver', env: { 'PORT' => '80' })
+  #   command_line('some_webserver', env: { PORT: '80' })
   #
   # @return [Result]
   def command_line(command, *args, env: {}, timeout: nil)
@@ -55,29 +55,29 @@ module CommandLine
     stderr = ''
     status = nil
 
-    Open3.popen3(env, command.to_str, *args.map(&:to_s)) do |i, o, e, wait_thr|
-      begin
-        threads = []
+    full_command = [command, *args].map(&:to_s).join(' ')
+    environment = env.transform_keys(&:to_s)
+    Open3.popen3(environment, full_command) do |i, o, e, wait_thr|
+      threads = []
 
-        Timeout.timeout(timeout, TimeoutError) do
-          yield i if block_given?
+      Timeout.timeout(timeout, TimeoutError) do
+        yield i if block_given?
 
-          threads << Thread.new { stdout = o.read }
-          threads << Thread.new { stderr = e.read }
-          threads.each(&:join)
-          status = wait_thr.value
-        end
-      rescue TimeoutError => e
-        threads.map(&:kill)
-
-        raise e
+        threads << Thread.new { stdout = o.read }
+        threads << Thread.new { stderr = e.read }
+        threads.each(&:join)
+        status = wait_thr.value
       end
+    rescue TimeoutError => e
+      threads.map(&:kill)
+
+      raise e
     end
 
     Result.new(stdout, stderr, status)
   end
 
-  # Same as CommandLine.command_line except that a failure on exit raises an
+  # Same as {CommandLine.command_line} except that a failure on exit raises an
   # error.
   #
   # @see CommandLine.command_line

data/lib/command_line/global.rb

@@ -9,9 +9,9 @@ require 'command_line'
 # @param command [String] The command to run.
 # @param args [Array] Any arguments passed to the command. All arguments will
 #   be converted to strings using `to_s`.
-# @param [Hash] env: Pass environment variables to use. The key should
-#   be a String representing the environment variable name. The value
-#   is the value you want that variable to have.
+# @param [Hash] env: Pass environment variables to use. The key is the name
+#   of the environment variable. The value is the value you want that variable
+#   to have.
 # @param [Integer, Float, nil] Number of seconds to wait for the block to
 #   terminate. Floats can be used to specify fractional seconds. A value of 0
 #   or nil will execute the block without any timeout.
@@ -29,11 +29,11 @@ require 'command_line'
 #   end
 #
 # @example
-#   command_line('some_webserver', env: { 'PORT' => '80' })
+#   command_line('some_webserver', env: { PORT: '80' })
 #
 # @return [Result]
-def command_line(*args, &block)
-  CommandLine.command_line(*args, &block)
+def command_line(*args, **kwargs, &block)
+  CommandLine.command_line(*args, **kwargs, &block)
 end
 
 # Same as CommandLine.command_line except that a failure on exit raises an
@@ -51,6 +51,6 @@ end
 # @return [Result]
 # @raise [CommandLine::ExitFailureError] If the application exits with an
 #   error status. The message will be the contents of Result#stderr.
-def command_line!(*args, &block)
-  CommandLine.command_line!(*args, &block)
+def command_line!(*args, **kwargs, &block)
+  CommandLine.command_line!(*args, **kwargs, &block)
 end

data/lib/command_line/result.rb

@@ -27,7 +27,7 @@ module CommandLine
     # @return [String]
     attr_reader :stderr
 
-    # Returns true if the application exited normally.
+    # Returns `true` if the application exited normally.
     #
     # @example
     #   command_line('grep').exited?
@@ -50,7 +50,7 @@ module CommandLine
       @status.exitstatus
     end
 
-    # Returns true if the command exited normally with a success status.
+    # Returns `true` if the command exited normally with a success status.
     #
     # @example
     #   command_line('echo', 'hi').success?
@@ -61,7 +61,7 @@ module CommandLine
       !@status.nil? && @status.success?
     end
 
-    # Returns true if the command failed to exit normally or exited with a
+    # Returns `true` if the command failed to exit normally or exited with a
     # failing status.
     #
     # @example

data/lib/command_line/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CommandLine
-  VERSION = '1.1.0'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_line
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Aaron Lasseigne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-23 00:00:00.000000000 Z
+date: 2020-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 0.81.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 0.81.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.20
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
 description: An easier way execute command line applications and get all of the output.
 email:
 - aaron.lasseigne@dragonruby.org
@@ -88,16 +102,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/linux.yml"
+- ".github/workflows/macos.yml"
+- ".github/workflows/windows.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- appveyor.yml
 - bin/console
 - bin/setup
 - command_line.gemspec
@@ -127,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: An easier way execute command line applications and get all of the output.

data/.travis.yml

@@ -1,23 +0,0 @@
-language: ruby
-before_install: # for bundler 2.0+
-  - gem install bundler
-script: bundle exec rake $RAKE_TASK
-matrix:
-  include:
-    # Linux - Tests and Linting
-    - os: linux
-      rvm: 2.6
-    - os: linux
-      rvm: 2.5
-    - os: linux
-      rvm: 2.4
-    # OS X - Tests
-    - os: osx
-      rvm: 2.6
-      env: RAKE_TASK=spec
-    - os: osx
-      rvm: 2.5
-      env: RAKE_TASK=spec
-    - os: osx
-      rvm: 2.4
-      env: RAKE_TASK=spec

data/appveyor.yml

@@ -1,19 +0,0 @@
-environment:
-  matrix:
-    - RUBY_VERSION: 26
-    - RUBY_VERSION: 25
-    - RUBY_VERSION: 24
-
-install:
-  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
-  - bundle install
-
-build: off
-
-before_test:
-  - ruby -v
-  - gem -v
-  - bundle -v
-
-test_script:
-  - bundle exec rake spec