vow 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4456531301553115ebfeb1339b015dad92abf6ce673020844272edba0165d7af
+  data.tar.gz: a640b5a1e8d6eb0ed463deda0119b48e9bd395400c6233352a75ba81169d4d40
+SHA512:
+  metadata.gz: b06d4f2206ded53da0e3283e22eb31477ee9e3d06c1cf314af62212beab72a0ed05bfb826af76ffd26e1838ee5bd54229834e561b100f72e8f54e12db325da1f
+  data.tar.gz: 5410b0895240928b8b059d118e5417aa483af82c38f2943c708541b375b9ba70f7aec2987de0263b29fc9179a9ab350866de0050b731a3f474e35d2ed2c5beff

data/lib/vow/helper.rb

@@ -0,0 +1,32 @@
+module Vow::Helper
+  def self.refine_command(command)
+    refined = command.flatten.select {|a| !a.nil?}
+
+    if refined.length == 0
+      raise "Nothing to run"
+    end
+
+    cmdname = refined[0]
+    if cmdname.include?(' ')
+       raise "Command name does not follow safe pattern: '#{cmdname}'"
+    end
+
+    refined
+  end
+
+  def self.printable_command(command)
+    simple_command = true
+    command.each do |word|
+      unless %r|^[[[:alnum:]].+_/-]+$|.match?(word)
+	simple_command = false
+	break
+      end
+    end
+
+    if simple_command
+      return command.join(' ')
+    else
+      return command.to_s
+    end
+  end
+end

data/lib/vow.rb

@@ -0,0 +1,56 @@
+###
+# = Overview
+#
+# Vow is a Kernel.system() wrapper.
+# Vow makes it more convenient to construct external commands to run and deal with their exit codes.
+#
+# = Usage
+#
+# In the simplest form, Vow.system() can be used as a drop-in replacement for Kernel.system():
+#
+#   # Execute command
+#   Vow.system('echo', 'Hello, World!')
+
+module Vow
+
+  def self.system(*command, **args)
+    may_raise = args.delete(:may_raise)
+
+    expected_exit_codes = (args.delete(:returns) or 0)
+    expected_exit_codes = [expected_exit_codes].flatten
+
+    command = Helper.refine_command(command)
+
+    if Kernel.system(*command, **args).nil?
+      if may_raise
+	raise "Failed to execute command: #{Helper.printable_command(command)}"
+      else
+	return nil
+      end
+    end
+
+    exit_code = $?.exitstatus
+    if expected_exit_codes.include?(exit_code)
+      return true
+    else
+      if may_raise
+	raise "Unexpected error code (#{exit_code}) from command: #{Helper.printable_command(command)}"
+      else
+	return false
+      end
+    end
+  end
+
+  def self.silent(*command, **args)
+    args[:out] = '/dev/null'
+    args[:err] = '/dev/null'
+    self.system(*command, **args)
+  end
+
+  def self.strict(*command, **args)
+    args[:may_raise] = true
+    self.system(*command, **args)
+  end
+end
+
+require_relative 'vow/helper'

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: vow
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ruslan Nugmanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-09-18 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: ruslan@nugmanov.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/vow.rb
+- lib/vow/helper.rb
+homepage: https://gitlab.com/nugmanov/vow
+licenses:
+- ISC
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: system() call wrapper that makes it convenient to execute external commands
+  in safe manner
+test_files: []