bwrap 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e72a18d3f00660f02729fc5bad5c5f10e006fe3021a55d3128f7acd1ab0aace
-  data.tar.gz: b916e9b3e5fc6cf44adb515e3f52b174549fdd12f4fe275badab1d95ab78bb90
+  metadata.gz: 352b23610ac14344695cc17c4bcdaeaf7307b3742983f520581251b4bb7f85a5
+  data.tar.gz: e4cfa7fb8ca749e5dfddf11f6eb030fd82af1bd2a15dad5062d9ba4fd9be72fb
 SHA512:
-  metadata.gz: 9b2c7793ae6321bbe2ed4ce81883bfb901d5b2683adf5bc4bea66b25318e5219992851c41bbd33c10bafb67cbae826d4fa5ac153901c565e7b746e672af41a6c
-  data.tar.gz: 7e4cea7fd04e77ad8a5dd97d8279ffc39aa3ef094e7f30c35c11e2287f753d951f015644a1bfcb3205bbd592e5d27d7767b267fcb4d66aa9d80f2fdcee6686a7
+  metadata.gz: cb7feb42474faa52ab6cce4cafd66daabf20f8490519a0f950885b1347332d38a6c335de40d6db4c7371e9eb0a0a722352d6e4613db3e3df193688ae896c584e
+  data.tar.gz: 90892a26e8efddc5112c4fa22bd1b95e8380f1860df1680031549f0addf485b4229fcdd11d786a63d476bf151483db60eba7682d045d35b08dfccea88e6b5f44

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changes
 
+## 1.1.1 (07.06.2022)
+
+* Added Bwrap::Execution.popen2e
+* Fixed compatibility with ruby-2.5
+
 ## 1.1.0 (01.06.2022)
 
 * No changes.

data/lib/bwrap/execution/execute.rb

@@ -40,6 +40,13 @@ class Bwrap::Execution::Execute
 
   # @return formatted command.
   def self.format_command command, rootcmd:
+    # Flatten the command if required, so nils can be converted in more of cases.
+    # Flattenization is also done in executions, but they also take in account
+    # for example rootcmd, so they probably should be done in addition to this one.
+    if command.respond_to? :flatten!
+      command.flatten!
+    end
+
     replace_nils command
     return command if rootcmd.nil?
 

data/lib/bwrap/execution/execution.rb

@@ -5,6 +5,7 @@ require "bwrap/output"
 require_relative "exceptions"
 require_relative "execute"
 require_relative "path"
+require_relative "popen2e"
 
 # Provides methods to execute commands and handle its output.
 #
@@ -78,9 +79,27 @@ module Bwrap::Execution
   end
 
   # Works similarly to {Open3.popen2e}.
-  def self.popen2e *cmd, *opts, &block
-
+  #
+  # TODO: If there will be any difference to input syntax, document those differences here.
+  # For now, rootcmd option has been implemented.
+  #
+  # A block is accepted, as does {Open3.popen2e}. For now, at least.
+  #
+  # TODO: Implement this so that this uses same execution things as other things here.
+  # This way bwrap actually can be integrated to this...
+  #
+  # TODO: Verify default log_callback is correct
+  #
+  # @warning Only array style commands are accepted. For example, `ls /`
+  # is not ok, but `ls` or `%w{ ls / }` is ok.
+  def popen2e *cmd, rootcmd: nil, log_callback: 1, log: true, &block
+    popen = Bwrap::Execution::Popen2e.new
+    popen.dry_run = @dry_run
+    popen.popen2e(*cmd, rootcmd: rootcmd, log_callback: log_callback, log: log, &block)
+  ensure
+    @last_status = $CHILD_STATUS
   end
+  module_function :popen2e
 
   # Returns Process::Status instance of last execution.
   #

data/lib/bwrap/execution/popen2e.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+# @see {Bwrap::Execution.popen2e}
+class Bwrap::Execution::Popen2e
+  attr_writer :dry_run
+
+  # @see {Bwrap::Execution.popen2e}
+  # TODO: Add a test for this (does Ruby have anything I could use here?).
+  #
+  # @note Also options accepted by {Open3.popen2e} are accepted
+  #   here, in addition to those specified here.
+  def popen2e *cmd, rootcmd: nil, log_callback: 1, log: true, &block
+    @rootcmd = rootcmd
+    @log_callback = log_callback + 1 # Passing to another method, so need to add one more.
+    @log = log
+    self.opts_from_input = cmd
+
+    resolve_actual_command cmd
+
+    return if @dry_run || Bwrap::Execution::Execute.dry_run
+
+    open_pipes
+    popen_run(@actual_command, [ @in_read, @out_write ], [ @in_write, @out_read ], &block)
+  ensure
+    if block
+      @in_read.close
+      @in_write.close
+      @out_read.close
+      @out_write.close
+    end
+  end
+
+  # Sets @opts from `cmd` given to {#popen2e}, if any extra options have been given.
+  private def opts_from_input= cmd
+    @opts = cmd.last.is_a?(Hash) && cmd.pop.dup || {}
+  end
+
+  private def open_pipes
+    @in_read, @in_write = IO.pipe
+    @opts[:in] = @in_read
+    @in_write.sync = true
+
+    @out_read, @out_write = IO.pipe
+    @opts[[ :out, :err ]] = @out_write
+  end
+
+  # First element may be optional environment variables.
+  private def resolve_actual_command cmd
+    temp_cmd = cmd.dup
+
+    # Delete environment hash.
+    env_hash = temp_cmd.shift if temp_cmd.first.is_a? Hash
+
+    # Delete option hash.
+    option_hash = temp_cmd.pop if temp_cmd.last.is_a? Hash
+
+    temp_cmd = Bwrap::Execution::Execute.format_command temp_cmd, rootcmd: @rootcmd
+    Bwrap::Execution::Execute.handle_logging temp_cmd, log_callback: @log_callback, log: @log, dry_run: @dry_run
+
+    temp_cmd.unshift env_hash if env_hash
+    temp_cmd.push option_hash if option_hash
+
+    # If command is an array, there can’t be arrays inside the array (hashes are preserved).
+    # For convenience, the array is flattened here, so callers can construct commands more easily.
+    temp_cmd.flatten!
+
+    @actual_command = temp_cmd
+  end
+
+  private def popen_run cmd, child_io, parent_io
+    pid = spawn(*cmd, @opts)
+    wait_thr = Process.detach(pid)
+    child_io.each(&:close)
+    result = [ *parent_io, wait_thr ]
+
+    if defined? yield
+      begin
+        return yield(*result)
+      ensure
+        parent_io.each(&:close)
+        wait_thr.join
+      end
+    end
+
+    result
+  end
+end

data/lib/bwrap/version.rb

@@ -2,7 +2,7 @@
 
 module Bwrap
   # Current version of bwrap.
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end
 
 require "deep-cover" if ENV["DEEP_COVER"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bwrap
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Samu Voutilainen
@@ -34,7 +34,7 @@ cert_chain:
   X4ioQwEn1/9tHs19VO1CLF58451HgEo1BXd7eWLmV1V5cqw0YWok1ly4L/Su/Phf
   MRxVMHiVAqY=
   -----END CERTIFICATE-----
-date: 2022-06-01 00:00:00.000000000 Z
+date: 2022-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -172,6 +172,7 @@ files:
 - lib/bwrap/execution/execution.rb
 - lib/bwrap/execution/labels.rb
 - lib/bwrap/execution/path.rb
+- lib/bwrap/execution/popen2e.rb
 - lib/bwrap/output.rb
 - lib/bwrap/output/colors.rb
 - lib/bwrap/output/levels.rb