process_output_wrapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f43843c763315a7998253b5aadec7034e4e1524ccb0d8b8e2dad269a6db80615
+  data.tar.gz: 3d80d67897194c25c22e3af8f0b6b6b9ea0242479f67d799b5c4ea954d4ffcbc
+SHA512:
+  metadata.gz: dc178be5684de0da88babd04e73b3cecb711752c657a0c4e040a2dbdbf9f24525a1cc9da7b7f787017b13d931a8fc3fb942280d5bd773752b198ffa07aef366c
+  data.tar.gz: da828465539672efaa3db3145c166d7fccb78699721c3110bb654a5a5a801903dc3c74d5b917612d2d510fc1f7d969676906ce23d1b20f742f7f075be01c8d00

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in process_output_wrapper.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    process_output_wrapper (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  process_output_wrapper!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Daniel Inkpen
+
+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,45 @@
+# ProcessOutputWrapper
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'process_output_wrapper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install process_output_wrapper
+
+## Usage
+
+Here's an example:
+
+```
+include ProcessOutputWrapper::DSL
+
+run_this "echo hello; echo hi; echo hey" do
+  whenever { line.start_with?("he") }
+    .do { puts(line + " world") }
+end
+```
+
+Which outputs the following:
+
+``` ruby
+hello world
+hey world
+```
+
+Within the `do` block, you can toggle state on whether output should be filtered using `print_normally!` and `print_wrapped!`.
+
+If the Ruby process is run with the environment variable `VERBOSE=true`, the output of the process would print as normal.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "process_output_wrapper"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/process_output_wrapper.rb

@@ -0,0 +1,7 @@
+require 'pty'
+require 'io/console'
+
+require "process_output_wrapper/version"
+require "process_output_wrapper/whenever"
+require "process_output_wrapper/command"
+require "process_output_wrapper/dsl"

data/lib/process_output_wrapper/command.rb

@@ -0,0 +1,95 @@
+module ProcessOutputWrapper
+  class Command
+    def initialize(command)
+      @command = command
+      @line = ""
+      @print_normally = false
+    end
+
+    def execute
+      if ENV['VERBOSE'] == 'true'
+        execute_normally
+      else
+        execute_wrapped
+      end
+    end
+
+    def whenever(&blk)
+      Whenever.new(&blk).tap do |w|
+        conditionals << w
+      end
+    end
+
+    private
+
+    attr_reader :command,
+                :line
+
+    def print_normally!
+      @print_normally = true
+    end
+
+    def print_wrapped!
+      @print_normally = false
+    end
+
+    def conditionals
+      @conditionals ||= []
+    end
+
+    def check_conditionals
+      return if @line.length == 0
+      @line = without_color(@line)
+
+      conditionals.each do |conditional|
+        if instance_eval(&conditional.condition)
+          instance_eval(&conditional.result)
+        end
+      end
+    end
+
+    def without_color(str)
+      str.gsub(/\x1B\[([0-9]{1,3}((;[0-9]{1,3})*)?)?[m|K]/, "")
+    end
+
+    def execute_normally
+      system(command)
+    end
+
+    def execute_wrapped
+      @output = ""
+      @line = ""
+      input_thread = nil
+
+      IO.console.raw!
+
+      PTY.spawn(command) do |read, write, pid|
+        write.winsize = STDOUT.winsize
+        Signal.trap(:WINCH) { write.winsize = STDOUT.winsize }
+        input_thread = Thread.new { IO.copy_stream(STDIN, write) }
+
+        read.each_char do |char|
+          @output.concat(char)
+          print(char) if @print_normally
+
+          case char
+          when "\n", "\r"
+            IO.console.cooked!
+            check_conditionals
+            IO.console.raw!
+            @line = ""
+          else
+            @line.concat(char)
+          end
+        end
+
+        Process.wait(pid)
+      end
+      input_thread.kill if input_thread
+
+      IO.console.cooked!
+
+      $?.exitstatus
+    end
+  end
+end

data/lib/process_output_wrapper/dsl.rb

@@ -0,0 +1,9 @@
+module ProcessOutputWrapper
+  module DSL
+    def run_this(command, &blk)
+      command = Command.new(command)
+      command.instance_eval(&blk)
+      command.execute
+    end
+  end
+end

data/lib/process_output_wrapper/version.rb

@@ -0,0 +1,3 @@
+module ProcessOutputWrapper
+  VERSION = "0.1.0"
+end

data/lib/process_output_wrapper/whenever.rb

@@ -0,0 +1,15 @@
+module ProcessOutputWrapper
+  class Whenever
+    attr_reader :condition,
+                :result
+
+    def initialize(&condition)
+      @condition = condition
+      @result = -> {}
+    end
+
+    def do(&result)
+      @result = result
+    end
+  end
+end

data/process_output_wrapper.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "process_output_wrapper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "process_output_wrapper"
+  spec.version       = ProcessOutputWrapper::VERSION
+  spec.authors       = ["Daniel Inkpen"]
+  spec.email         = ["dan2552@gmail.com"]
+
+  spec.summary       = %q{Process wrapper which customizes output of the given command}
+  spec.description   = spec.summary
+  spec.homepage      = "http://github.com/Dan2552/process_output_wrapper"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: process_output_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Inkpen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: Process wrapper which customizes output of the given command
+email:
+- dan2552@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/process_output_wrapper.rb
+- lib/process_output_wrapper/command.rb
+- lib/process_output_wrapper/dsl.rb
+- lib/process_output_wrapper/version.rb
+- lib/process_output_wrapper/whenever.rb
+- process_output_wrapper.gemspec
+homepage: http://github.com/Dan2552/process_output_wrapper
+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.3
+signing_key: 
+specification_version: 4
+summary: Process wrapper which customizes output of the given command
+test_files: []