bwrap 1.0.0.pre.alpha2 → 1.0.0.pre.beta1

data/lib/bwrap/output/log.rb

@@ -1,9 +1,7 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 
 # force_encoding modifies string, so can’t freeze strings.
 
-require_relative "output"
-
 # Logging methods.
 class Bwrap::Output::Log
   @@log_file = nil
@@ -15,12 +13,12 @@ class Bwrap::Output::Log
 
   # Writes given string to log.
   def self.write_to_log str
-    @@log_file&.write str.force_encoding("UTF-8")
+    @@log_file&.write str.dup.force_encoding("UTF-8")
   end
 
   # Writes given string to log.
   def self.puts_to_log str
-    @@log_file&.puts str.force_encoding("UTF-8")
+    @@log_file&.puts str.dup.force_encoding("UTF-8")
   end
 
   # Closes an open log file.
@@ -40,7 +38,7 @@ class Bwrap::Output::Log
     @@log_file = log_file
 
     at_exit do
-      ::Bwrap::Output::Log.close_log_file
+      Bwrap::Output::Log.close_log_file
     end
   end
 end

data/lib/bwrap/output/output_impl.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+# Have variables like $CHILD_STATUS which is alias of $?.
+require "English"
+
+require "bwrap/execution/labels"
+
+require_relative "levels"
+require_relative "log"
+
+# Methods useful for output handling.
+#
+# There is four different log levels:
+#
+# @!description_list
+#   @term error
+#   @description
+#     Causes execution to halt either to exit with requested code or,
+#     if requested, raises an exception.
+#   @term warning
+#   @description Outputs given text to STDERR.
+#   @term verbose
+#   @description Outputs given text if verbose, debug or trace flag is set.
+#   @term debug
+#   @description Outputs given text if debug or trace flag is set.
+#   @term trace
+#   @description Outputs given text if trace flag is set.
+#
+# Output levels can be enabled with {.handle_output_options}.
+#
+# When using {Bwrap::Bwrap}, {Bwrap::Bwrap#parse_command_line_arguments}
+# causes output levels to be set if relevant CLI arguments have been
+# given. TODO: Add documentation about CLI args somewhere. Maybe README?
+module Bwrap::Output
+  # @see #verbose?
+  def self.verbose?
+    Bwrap::Output::Levels.verbose?
+  end
+
+  # @see #debug?
+  def self.debug?
+    Bwrap::Output::Levels.debug?
+  end
+
+  # @see #trace?
+  def self.trace?
+    Bwrap::Output::Levels.trace?
+  end
+
+  # Takes hash of options received from Optimist and checks output related flags.
+  def self.handle_output_options options
+    Bwrap::Output::Levels.handle_output_options options
+  end
+
+  # Handler used by #trace to output given string.
+  def self.trace_output str, raw: false, log_callback: 1
+    return unless trace?
+
+    if raw
+      print str
+    else
+      out = Bwrap::Output::Levels.trace_print_formatted str, log_callback: (log_callback + 1)
+    end
+    Bwrap::Output::Log.puts_to_log out || str
+  end
+
+  # Handler used by #debug to output given string.
+  def self.debug_output str, raw: false, log_callback: 1
+    return unless debug?
+
+    if raw
+      print str
+    else
+      out = Bwrap::Output::Levels.debug_print_formatted str, log_callback: (log_callback + 1)
+    end
+    Bwrap::Output::Log.puts_to_log out || str
+  end
+
+  # Handler used by #verb to output given string.
+  def self.verb_output str, raw: false, log_callback: 1
+    return unless verbose?
+
+    if raw
+      print str
+    else
+      out = Bwrap::Output::Levels.verbose_print_formatted str, log_callback: (log_callback + 1)
+    end
+    Bwrap::Output::Log.puts_to_log out || str
+  end
+
+  # Handler used by #warn to output given string.
+  def self.warn_output str, raw: false, log_callback: 1
+    if raw
+      print str
+    else
+      out = Bwrap::Output::Levels.warning_print_formatted str, log_callback: (log_callback + 1)
+    end
+    Bwrap::Output::Log.puts_to_log out || str
+  end
+
+  # Aborts current process.
+  #
+  # Use this instead of Ruby’s #exit in order to filter out dummy #exit calls from the code.
+  def self.error_output str = nil, label: :unspecified, log_callback: 1, raise_exception: false
+    unless str.nil?
+      out = Bwrap::Output::Levels.error_print_formatted str, log_callback: (log_callback + 1)
+      Bwrap::Output::Log.puts_to_log out
+    end
+
+    exit_code = Bwrap::Execution::Labels.resolve_exit_code(label)
+    raise str if raise_exception
+
+    exit exit_code
+  end
+
+  # @return true if --verbose, --debug or --trace has been passed, false if not.
+  private def verbose?
+    Bwrap::Output::Levels.verbose?
+  end
+
+  # @return true if --debug or --trace has been passed, false if not.
+  private def debug?
+    Bwrap::Output::Levels.debug?
+  end
+
+  # @return true if --trace has been passed, false if not.
+  private def trace?
+    Bwrap::Output::Levels.trace?
+  end
+
+  # @!group Outputters
+
+  # Outputs given string if trace flag has been set.
+  #
+  # Output flags can be set with {.handle_output_options}.
+  #
+  # @param str String to be outputted
+  # @param raw [Boolean] If true, disables output formatting
+  private def trace str, raw: false
+    Bwrap::Output.trace_output(str, raw: raw, log_callback: 2)
+  end
+
+  # Outputs given string if debug flag has been set.
+  #
+  # Output flags can be set with {.handle_output_options}.
+  #
+  # @param str String to be outputted
+  # @param raw [Boolean] If true, disables output formatting
+  private def debug str, raw: false
+    Bwrap::Output.debug_output(str, raw: raw, log_callback: 2)
+  end
+
+  # Outputs given string if verbose flag has been set.
+  #
+  # Output flags can be set with {.handle_output_options}.
+  #
+  # @param str String to be outputted
+  # @param raw [Boolean] If true, disables output formatting
+  private def verb str, raw: false
+    Bwrap::Output.verb_output(str, raw: raw, log_callback: 2)
+  end
+
+  # Outputs given string to `$stderr`.
+  #
+  # @param str String to be outputted
+  # @param raw [Boolean] If true, disables output formatting
+  private def warn str, raw: false
+    Bwrap::Output.warn_output(str, raw: raw, log_callback: 2)
+  end
+
+  # Outputs given string to `$stderr` and halts execution.
+  #
+  # @param str String to be outputted
+  # @param label [Symbol] Exit label accepted by {Bwrap::Execution.resolve_exit_code}
+  # @param raise_exception [Boolean] if true, an exception is raised instead of just existing with exit code.
+  private def error str = nil, label: :unspecified, raise_exception: false
+    Bwrap::Output.error_output(str, label: label, log_callback: 2, raise_exception: raise_exception)
+  end
+
+  # @!endgroup
+end

data/lib/bwrap/output.rb

@@ -1,153 +1,11 @@
 # frozen_string_literal: true
 
-# Have variables like $CHILD_STATUS which is alias of $?.
-require "English"
-
-require "bwrap/execution/labels"
-require_relative "output/colors"
-require_relative "output/levels"
-require_relative "output/log"
-
-# Extends the module with outputting methods.
+# Declare Output module here so Bwrap::Output module is
+# already declared for Output module classes, to avoid
+# a circular dependency.
+#
+# See output/output.rb for documentation.
 module Bwrap::Output
-  include Bwrap::Output::Colors
-
-  # @see #verbose?
-  def self.verbose?
-    Bwrap::Output::Levels.verbose?
-  end
-
-  # @see #debug?
-  def self.debug?
-    Bwrap::Output::Levels.debug?
-  end
-
-  # @see #trace?
-  def self.trace?
-    Bwrap::Output::Levels.trace?
-  end
-
-  # Takes hash of options received from Optimist and checks output related flags.
-  def self.handle_output_options options
-    Bwrap::Output::Levels.handle_output_options options
-  end
-
-  # Handler used by #trace to output given string.
-  def self.trace_output str, raw: false, log_callback: 1
-    return unless trace?
-
-    if raw
-      print str
-    else
-      out = Bwrap::Output::Levels.trace_print_formatted str, log_callback: (log_callback + 1)
-    end
-    Bwrap::Output::Log.puts_to_log out || str
-  end
-
-  # Handler used by #debug to output given string.
-  def self.debug_output str, raw: false, log_callback: 1
-    return unless debug?
-
-    if raw
-      print str
-    else
-      out = Bwrap::Output::Levels.debug_print_formatted str, log_callback: (log_callback + 1)
-    end
-    Bwrap::Output::Log.puts_to_log out || str
-  end
-
-  # Handler used by #verb to output given string.
-  def self.verb_output str, raw: false, log_callback: 1
-    return unless verbose?
-
-    if raw
-      print str
-    else
-      out = Bwrap::Output::Levels.verbose_print_formatted str, log_callback: (log_callback + 1)
-    end
-    Bwrap::Output::Log.puts_to_log out || str
-  end
-
-  # Handler used by #warn to output given string.
-  def self.warn_output str, raw: false, log_callback: 1
-    if raw
-      print str
-    else
-      out = Bwrap::Output::Levels.warning_print_formatted str, log_callback: (log_callback + 1)
-    end
-    Bwrap::Output::Log.puts_to_log out || str
-  end
-
-  # Aborts current process.
-  #
-  # Use this instead of Ruby’s #exit in order to filter out dummy #exit calls from the code.
-  def self.error_output str = nil, label: :unspecified, log_callback: 1
-    unless str.nil?
-      out = Bwrap::Output::Levels.error_print_formatted str, log_callback: (log_callback + 1)
-      Bwrap::Output::Log.puts_to_log out
-    end
-
-    exit Bwrap::Execution::Labels.resolve_exit_code(label)
-  end
-
-  # @return true if --verbose, --debug or --trace has been passed, false if not.
-  private def verbose?
-    Bwrap::Output::Levels.verbose?
-  end
-
-  # @return true if --debug or --trace has been passed, false if not.
-  private def debug?
-    Bwrap::Output::Levels.debug?
-  end
-
-  # @return true if --trace has been passed, false if not.
-  private def trace?
-    Bwrap::Output::Levels.trace?
-  end
-
-  # Outputs given string if trace flag has been set.
-  #
-  # Output flags can be set with {.handle_output_options}.
-  #
-  # @param str String to be outputted
-  # @param raw [Boolean] If true, disables output formatting
-  private def trace str, raw: false
-    Bwrap::Output.trace_output(str, raw: raw, log_callback: 2)
-  end
-
-  # Outputs given string if debug flag has been set.
-  #
-  # Output flags can be set with {.handle_output_options}.
-  #
-  # @param str String to be outputted
-  # @param raw [Boolean] If true, disables output formatting
-  private def debug str, raw: false
-    Bwrap::Output.debug_output(str, raw: raw, log_callback: 2)
-  end
-
-  # Outputs given string if verbose flag has been set.
-  #
-  # Output flags can be set with {.handle_output_options}.
-  #
-  # @param str String to be outputted
-  # @param raw [Boolean] If true, disables output formatting
-  private def verb str, raw: false
-    Bwrap::Output.verb_output(str, raw: raw, log_callback: 2)
-  end
-
-  # Outputs given string to `$stderr`.
-  #
-  # @param str String to be outputted
-  # @param raw [Boolean] If true, disables output formatting
-  private def warn str, raw: false
-    Bwrap::Output.warn_output(str, raw: raw, log_callback: 2)
-  end
-
-  # Outputs given string to `$stderr` and halts execution.
-  #
-  # @param str String to be outputted
-  # @param label [Symbol] Exit label accepted by {Bwrap::Execution.resolve_exit_code}
-  private def error str = nil, label: :unspecified
-    Bwrap::Output.error_output(str, label: label, log_callback: 2)
-  end
 end
+
+require_relative "output/output_impl"

data/lib/bwrap/version.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-# bwrap command runner tools.
 module Bwrap
   # Current version of bwrap.
-  VERSION = "1.0.0-alpha2"
+  VERSION = "1.0.0-beta1"
 end
 
 require "deep-cover" if ENV["DEEP_COVER"]

data/lib/bwrap.rb

@@ -1,74 +1,28 @@
 # frozen_string_literal: true
 
-require "optimist"
-
-#require "deep-cover" if ENV["DEEP_COVER"]
-
-require "bwrap/version"
-require "bwrap/args/construct"
-require "bwrap/config"
-require "bwrap/execution"
-
-# Executes bwrap command using given configuration.
-class Bwrap::Bwrap
-  include Bwrap::Execution
-
-  def initialize config
-    @config = config
-
-    parse_command_line_arguments
-  end
-
-  # Runs given command inside bwrap.
-  #
-  # @param command [String, Array] Command, with necessary arguments, to be executed inside bwrap
-  def run command
-    construct = Bwrap::Args::Construct.new
-    construct.config = @config
-    bwrap_args = construct.construct_bwrap_args
-
-    exec_command = [ "bwrap" ]
-    exec_command += bwrap_args
-    exec_command += %W{ #{command} --new-instance }
-    exec_command += ARGV unless ARGV.empty?
-
-    execute exec_command
-
-    construct.cleanup
-  end
-
-  # Parses command line arguments given to caller script.
-  private def parse_command_line_arguments
-    options = optimist_cli_args
-
-    Bwrap::Output.handle_output_options options
-  end
-
-  # Parses global bwrap flags using Optimist.
-  private def optimist_cli_args
-    Optimist.options do
-      version ::Bwrap::VERSION
-
-      banner "Usage:"
-      banner "  #{$PROGRAM_NAME} [global options]\n \n"
-      banner "Global options:"
-      opt :verbose,
-          "Show verbose output",
-          short: "v"
-      opt :debug,
-          "Show debug output (useful when debugging a problem)",
-          short: "d"
-      opt :trace,
-          "Show trace output (noisiest, probably not useful for most of time)",
-          short: :none
-      opt :version,
-          "Print version and exit",
-          short: "V"
-      opt :help,
-          "Show help message",
-          short: "h"
-
-      educate_on_error
-    end
-  end
+require "bwrap/bwrap"
+
+# ruby-bwrap provides easy-to-use interface to run complex programs in sandboxes created with
+# {https://github.com/containers/bubblewrap bubblewrap}.
+#
+# To run a program inside bubblewrap, a wrapper executable can be created. For example:
+#
+#     require "bwrap"
+#
+#     config = Bwrap::Config.new
+#     config.user = "dummy_user"
+#     config.full_system_mounts = true
+#     config.binaries_from = %w{
+#       /bin
+#       /usr/bin
+#     }
+#
+#     bwrap = Bwrap::Bwrap.new config
+#     bwrap.parse_command_line_arguments
+#     bwrap.run "/bin/true"
+#
+# There also are few generic utilities, {Bwrap::Output} for handling output of scripts and
+# {Bwrap::Execution} to run executables.
+module Bwrap
+  # Empty module.
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bwrap
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha2
+  version: 1.0.0.pre.beta1
 platform: ruby
 authors:
 - Samu Voutilainen
@@ -34,36 +34,22 @@ cert_chain:
   X4ioQwEn1/9tHs19VO1CLF58451HgEo1BXd7eWLmV1V5cqw0YWok1ly4L/Su/Phf
   MRxVMHiVAqY=
   -----END CERTIFICATE-----
-date: 2021-11-14 00:00:00.000000000 Z
+date: 2021-12-12 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: optimist
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -120,7 +106,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.7'
-description: For now this just reserves this name. Please be back later.
+description: For now this is tailored to my needs, so this may or may not be of any
+  use.
 email:
 - smar@smar.fi
 executables: []
@@ -133,20 +120,28 @@ files:
 - lib/bwrap.rb
 - lib/bwrap/args/args.rb
 - lib/bwrap/args/bind.rb
+- lib/bwrap/args/bind/library.rb
+- lib/bwrap/args/bind/mime.rb
 - lib/bwrap/args/construct.rb
 - lib/bwrap/args/environment.rb
+- lib/bwrap/args/features.rb
+- lib/bwrap/args/library.rb
 - lib/bwrap/args/machine_id.rb
 - lib/bwrap/args/mount.rb
+- lib/bwrap/bwrap.rb
 - lib/bwrap/config.rb
+- lib/bwrap/config/features.rb
 - lib/bwrap/execution.rb
+- lib/bwrap/execution/exceptions.rb
 - lib/bwrap/execution/execute.rb
 - lib/bwrap/execution/execution.rb
 - lib/bwrap/execution/labels.rb
+- lib/bwrap/execution/path.rb
 - lib/bwrap/output.rb
 - lib/bwrap/output/colors.rb
 - lib/bwrap/output/levels.rb
 - lib/bwrap/output/log.rb
-- lib/bwrap/output/output.rb
+- lib/bwrap/output/output_impl.rb
 - lib/bwrap/version.rb
 homepage: https://git.sr.ht/~smar/ruby-bwrap
 licenses:
@@ -155,6 +150,7 @@ metadata:
   homepage_uri: https://git.sr.ht/~smar/ruby-bwrap
   source_code_uri: https://git.sr.ht/~smar/ruby-bwrap
   changelog_uri: https://git.sr.ht/~smar/ruby-bwrap/tree/master/item/CHANGELOG.md
+  rubygems_mfa_required: 'false'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -174,5 +170,5 @@ rubyforge_project:
 rubygems_version: 2.7.6.3
 signing_key: 
 specification_version: 4
-summary: 'THIS WILL BE IN FUTURE: Framework to create commands for bwrap'
+summary: Framework to create commands for bwrap
 test_files: []

data/lib/bwrap/output/output.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require "bwrap/version"
-
-# Outputting utilities.
-module Bwrap::Output
-  # Nya.
-end