verbose-shell 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a663b642055003a2385b8b226e7ea1998a8b58f2
+  data.tar.gz: fc6deb09aa6c056b35c4df563692fb19fa9118fb
+SHA512:
+  metadata.gz: 901addbdf0ff7287b55d9d8dac156f13620c7ee1b11a313f9650ddc40cecddfba5e52a1158ceaed5f7711956d89e4c4e7630e7c5700ab542af6f26b03f78dd07
+  data.tar.gz: a0874e66dcf32757d5beeb8d094b63bedf3365e770dd96b0b87cc2caf50cde2967b1d30c805fbb6ffbcdd3b2e434463e3f439771e21cadf12a273b2139e25a4b

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in verbose-shell.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 David Caldwell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# VerboseShell
+
+VerboseShell adds `-x`-like logging to FileUtils functions. Example:
+
+    require 'verbose-shell'
+    Vsh = VerboseShell
+    Vsh.system(*%W'ls -l')
+    Vsh.verbose = true
+    Vsh.system(*%W'echo Hello')
+    Vsh.cp('/etc/passwd', '/tmp/passwd')
+
+This outputs:
+
+    + echo Hello
+    Hello
+    + cp /etc/passwd /tmp/passwd
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'verbose-shell'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install verbose-shell
+
+## Usage
+
+Set `VerboseShell.verbose` to `true` or `false`. The default is `false`, so
+no logging will occur until it is changed.
+
+All FileUtils functions are supported. They may not log correctly--if you
+find one that doesn't log in a sane way, file a bug or (hopefully) a pull
+request.
+
+In addition, the following functions are available (all will log when
+`verbose` is set):
+
+- `VerboseShell.system(*args)`: Similar to Kernel.system except it only
+  accepts the multiple argument form (for safety). It is therefore never run
+  through the shell, and shell meta characters are unsupported (so no `|`,
+  `&&`, `||`, etc.). When `verbose` is not set, output will be captured and
+  stored in an exception if there is an error, or discarded if there is no
+  error. If `verbose` is set, output will display immediately and not be
+  captured (even on errors).
+
+- `VerboseShell.system_or_true(*args)`: Similar to the above, but will never throw
+  exceptions.
+
+- `VerboseShell.capture(*args)`: A wrapper around IO.popen(). Returns the
+  stdout of the command given. Like `VerboseShell.system()`, only the
+  multiple argument form is accepted (so no shell is involved).
+
+- `which?(exe_name)`: Searches through `ENV['PATH']` and returns the full
+  path of exe_name if found, and `nil` if not found.
+
+- `install_D(source, dest)`: Like `install -D` (see INSTALL(1)).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You
+can also run `bin/console` for an interactive prompt that will allow you to
+experiment.
+
+To install this gem onto your local machine, run `bundle exec rake
+install`. To release a new version, update the version number in
+`version.rb`, and then run `bundle exec rake release`, which will create a
+git tag for the version, push git commits and tags, and push the `.gem` file
+to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/caldwell/verbose-shell.
+
+## License
+
+The gem is available as open source under the terms of
+the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "verbose-shell"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/verbose-shell/version.rb

@@ -0,0 +1,5 @@
+module Verbose
+  module Shell
+    VERSION = "0.1.0"
+  end
+end

data/lib/verbose-shell.rb

@@ -0,0 +1,86 @@
+# coding: utf-8
+require 'fileutils'
+require 'pastel'
+
+class VerboseShell
+  @verbose = 0
+  class << self
+    attr_accessor :verbose
+    def verbose=(val); @verbose = val == true ? 1 : (val || 0); end
+
+    def system_trace(*args)
+      return unless @verbose > 0
+      puts "+ "+args.map{|a| a =~ /\s/ ? '"'+a+'"' : a}.join(' ') # TODO: Fix quoting so it's more shell-like
+    end
+
+    class ShellError < RuntimeError
+      attr_accessor :output, :cmd, :exit_code
+      def initialize(output, cmd, exit_code)
+        @output = output
+        @cmd = cmd
+        @exit_code = exit_code
+      end
+
+      def message
+        "\n\n"+(['']*20+@output.split("\n"))[-20..-1].join("\n").lstrip + "\n"+Pastel.new.bright_white.on_red("💩  Command \"#{@cmd[0]}\" returned #{@exit_code}")
+      end
+      def to_s; message; end
+    end
+
+    def system(*args)
+      system_trace *args
+      if @verbose > 0
+        Kernel.system *args or raise ShellError.new('', args, $?.exitstatus).message.lstrip
+      else
+        output = IO.popen(args + [{:err => [:child, :out]}]) {|io| io.read}
+        raise ShellError.new(output, args, $?.exitstatus) if $? != 0
+      end
+    end
+
+    def system_or_true(*args)
+      system *args
+    rescue
+    end
+
+    def capture(*args) # ``
+      system_trace *args
+      IO.popen(args + (@verbose == 0 ? [{:err => "/dev/null"}] : []), "r") {|io| io.read}.strip
+    end
+
+    def which?(exe)
+      system_trace 'which', exe
+      [exe, *ENV['PATH'].split(File::PATH_SEPARATOR).map {|p| File.join(p, exe)}].find {|f| File.executable?(f)}
+    end
+
+    def install_D(source, dest)
+      system_trace 'install', '-D', source, dest
+      FileUtils.mkdir_p(File.dirname(dest))
+      FileUtils.install(source, dest)
+    end
+
+    def method_to_a(method)
+      a = method.to_s.split('_')
+      a[1] = "-#{a[1]}" if a[1]
+      a
+    end
+
+    def chmod_formatter(method, mode, file)
+      method_to_a(method) + [mode.class == String ? mode : sprintf("%04o", mode)] + (file.class == Array ? file : [file])
+    end
+    def chmod_R_formatter(method, mode, file)
+      chmod_formatter(method, mode, file)
+    end
+    def chown_formatter(method, user, group, file)
+      method_to_a(method) + [[user,group && ":#{group}"].select{|x|x}.join('')] + (file.class == Array ? file : [file])
+    end
+    def chown_R_formatter(method, user, group, file)
+      chown_formatter(method, user, group, file)
+    end
+
+    def method_missing(method, *args, &block)
+      system_trace self.respond_to?("#{method}_formatter") ? self.send("#{method}_formatter", method, *args)
+                   : method_to_a(method) + args
+      FileUtils.send(method, *args, &block)
+    end
+  end
+end

data/verbose-shell.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "verbose-shell/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "verbose-shell"
+  spec.version       = Verbose::Shell::VERSION
+  spec.authors       = ["David Caldwell"]
+  spec.email         = ["david@porkrind.org"]
+
+  spec.summary       = %q{sh -x like logging of FileUtils functions.}
+  spec.description   = %q{sh -x like logging of FileUtils functions.}
+  spec.homepage      = 'https://github.com/caldwell/verbose-shell'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'pastel', '~> 0.7.2'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: verbose-shell
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Caldwell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: sh -x like logging of FileUtils functions.
+email:
+- david@porkrind.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/verbose-shell.rb
+- lib/verbose-shell/version.rb
+- verbose-shell.gemspec
+homepage: https://github.com/caldwell/verbose-shell
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.2.2
+signing_key: 
+specification_version: 4
+summary: sh -x like logging of FileUtils functions.
+test_files: []