shell_adapter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9c604c28773fc260835782f25225dbe53a33c2aed6d1669ed1fbb76c5c733372
+  data.tar.gz: 2d43317111952fa08514ab52265a43f35202a47f33c167891b0b87d97b67e5b2
+SHA512:
+  metadata.gz: ad20f71921312ba70e5c2c6ae6bf402e950947261b4ea8c7f10011600c153daeaaa9281a6c8fa45a11cb19b630c771457c31c1eda87605f39d99fdd2d8d3e322
+  data.tar.gz: 6d0afb18e383e315e9d7f617b5648c5603031aa05fcab9f0f8f77e6b9a7c2ff9ff5edcbe1c1b85146bde080dcdb4ca7b7112ec191aa033611d2bf4c5d26a5205

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby '2.6.0'
+
+group :test do
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,29 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+
+RUBY VERSION
+   ruby 2.6.0p0
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -0,0 +1,16 @@
+# Shell Adapter
+
+A very simpler wrapper around the fiddliness of interacting with shell commands
+in Ruby. Extracted from [Ministry of Justice's "FormBuilder Publisher"](https://github.com/ministryofjustice/fb-publisher).
+
+# Usage
+
+Commands executed with ShellAdapter will inherit the environment of their
+parent process (i.e. the running Ruby process), including PATH.
+
+```ruby
+# run a command with arguments, discarding the output:
+ShellAdapter.exec(cmd, arg1, arg2, ....)
+# e.g.
+ShellAdapter.exec('cp', file_path_1, file_path_2)
+```

data/lib/cmd_failed_error.rb

@@ -0,0 +1,2 @@
+class CmdFailedError < StandardError
+end

data/lib/shell_adapter.rb

@@ -0,0 +1,56 @@
+require 'logger'
+require 'open3'
+
+require_relative 'cmd_failed_error'
+
+class ShellAdapter
+  # run the given binary with the given arguments,
+  # discarding the output
+  def self.exec(binary, *args)
+    cmd_line = build_cmd( executable: binary, args: args )
+    log "executing cmd #{cmd_line}"
+    # TODO: maybe use Open3.popen2e instead, so that we
+    # can get streaming output as well as exit code?
+    result = Kernel.system(cmd_line)
+    raise CmdFailedError.new(cause: "#{$?}", message: "failing cmd: #{cmd_line}") unless result
+  end
+
+  def self.output_of(*args)
+    capture_with_stdin(cmd: args).strip
+  end
+
+  def self.capture_with_stdin(cmd: [], stdin: nil)
+    cmd_line = build_cmd( executable: cmd[0], args: cmd[1..-1] )
+
+    stdout_str, status = Open3.capture2(cmd_line, stdin_data: stdin)
+    unless status.success?
+      raise CmdFailedError.new(cause: "#{$?}", message: "failing cmd: #{cmd_line}")
+    end
+    stdout_str
+  end
+
+  def self.build_cmd(executable:, args: [], redirect_to: nil, pipe_to: nil)
+    line = [executable, args].flatten.compact.join(' ')
+    line = add_pipe(cmd: line, to: pipe_to) if pipe_to
+    line = add_redirect(cmd: line, to: redirect_to) if redirect_to
+    line
+  end
+
+  def self.add_redirect(cmd:, to:, operator: '>>')
+    [cmd, operator, to].join(' ')
+  end
+
+  def self.add_pipe(cmd:, to:, operator: '|')
+    [cmd, operator, to].join(' ')
+  end
+
+  protected
+
+  def self.log(string, level: :info)
+    self.logger.send(level, string)
+  end
+
+  def self.logger
+    @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: shell_adapter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Al Davidson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-26 00:00:00.000000000 Z
+dependencies: []
+description: |
+  A simple wrapper around the fiddliness of interacting with the shell in Ruby.
+  Extracted from Ministry of Justice's "FormBuilder Publisher"
+  (https://github.com/ministryofjustice/fb-publisher)
+email: apdavidson at gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/cmd_failed_error.rb
+- lib/shell_adapter.rb
+homepage: http://rubygems.org/gems/shelladapter
+licenses:
+- MIT
+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.0.1
+signing_key: 
+specification_version: 4
+summary: Shell Adapter
+test_files: []