feat: Process.run add log_file option

with gem multi_io

Author: initdc

.github/workflows/main.yml

@@ -17,6 +17,7 @@ jobs:
     runs-on: ubuntu-latest
     name: Ruby ${{ matrix.ruby }}
     strategy:
+      fail-fast: false
       matrix:
         ruby:
           - "2.7.0"

.rubocop.yml

@@ -3,3 +3,12 @@ inherit_gem:
 
 Metrics/MethodLength:
   Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false

Gemfile

@@ -13,4 +13,6 @@ gem "rspec", "~> 3.0"
 
 gem "rubocop", "~> 1.21"
 
-gem "rubocop-config-crystal"
+gem "rubocop-config-crystal", "~> 0.0.3"
+
+gem "multi_io", "~> 0.0.1.pre2"

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rb-process (0.1.0)
+    rb-process (0.1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -11,6 +11,7 @@ GEM
     json (2.15.2)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
+    multi_io (0.0.1.pre2)
     parallel (1.27.0)
     parser (3.3.10.0)
       ast (~> 2.4.1)
@@ -47,7 +48,7 @@ GEM
     rubocop-ast (1.47.1)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
-    rubocop-config-crystal (0.0.1)
+    rubocop-config-crystal (0.0.3)
     ruby-progressbar (1.13.0)
     unicode-display_width (3.2.0)
       unicode-emoji (~> 4.1)
@@ -58,11 +59,12 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.4)
+  multi_io (~> 0.0.1.pre2)
   rake (~> 13.0)
   rb-process!
   rspec (~> 3.0)
   rubocop (~> 1.21)
-  rubocop-config-crystal
+  rubocop-config-crystal (~> 0.0.3)
 
 BUNDLED WITH
    2.4.22

lib/rb/process.rb

@@ -1,21 +1,30 @@
 # frozen_string_literal: true
 
+require "multi_io"
 require_relative "process/version"
 
 module Process
-  def self.run(*args, **options)
+  def self.run(*args, log_file: nil, **options)
+    if log_file && !log_file.is_a?(File)
+      raise ArgumentError.new("log_file must be a File with mode")
+    end
+
+    mio = log_file ? MultiIO.new($stdout, log_file) : $stdout
     result = String.new
+
     IO.popen(*args, **options) do |pipe|
       if block_given?
         yield pipe
         pipe.close_write
       end
       while !pipe.eof
         line = pipe.gets
-        print line
+        mio.write(line)
         result << line
       end
     end
+
+    log_file.close if log_file
     result
   end
 

lib/rb/process/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Process
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

spec/rb/process_spec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "tempfile"
+
 RSpec.describe Process do
   it "has a version number" do
     expect(Process::VERSION).not_to be nil
@@ -28,4 +30,12 @@
   it "answer with cmd with ruby style" do
     expect(Process.run("bash", "r+") { |pipe| pipe.puts "uname" }).to eq "Linux\n"
   end
+
+  it "print and also log to file" do
+    tempfile = Tempfile.new(["test_", ".log"])
+    Process.run("uname", log_file: File.open(tempfile.path, "w"))
+
+    expect(tempfile.readlines).to eq ["Linux\n"]
+    tempfile.delete
+  end
 end