coque 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 344cd271557b02f3d3b01fc25a524fe44a2ecf4a
+  data.tar.gz: 74a4a0f32297f6c2e7368fab1c89a3317e52168d
+SHA512:
+  metadata.gz: 4561c894a43b60ef8baaa903e1ac732473927deff5dc9fc9d3c8ce7c3bdba1aa361d783830f20762546574e82baeb252c0d5d8139ed569ffe84b8fa839e32068
+  data.tar.gz: e3a6a90e1a67e085a4aab4c5261340599ac9941bdd86da01c645830cb051d2c85fac54fc038308eaba8598cb5b061e9f79de84b9c808561ae39a08774dd4bea9

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at horace.d.williams@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    coque (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.3)
+    coderay (1.1.2)
+    docile (1.3.1)
+    json (2.1.0)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    minitest-reporters (1.2.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    pry (0.11.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (12.3.1)
+    ruby-progressbar (1.9.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  coque!
+  minitest (~> 5.11)
+  minitest-reporters
+  pry
+  rake (~> 12.3)
+  simplecov
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Horace Williams
+
+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,135 @@
+# Coque
+
+Create, manage, and interop with shell pipelines from Ruby. Like [Plumbum](https://plumbum.readthedocs.io/en/latest/), for Ruby, with native (Ruby) code streaming integration.
+
+## Installation
+
+Add to your gemfile:
+
+```ruby
+gem 'coque'
+```
+
+## Usage
+
+Create Coque commands:
+
+```rb
+cmd = Coque["echo", "hi"]
+# => <Coque::Sh ["echo", "hi"]>
+```
+
+And run them:
+
+```rb
+res = cmd.run
+# => #<Coque::Result:0x007feb5930e408 @out=#<IO:fd 13>, @pid=58688>
+res.to_a
+# => ["hi"]
+```
+
+Or pipe them:
+
+```rb
+pipeline = cmd | Coque["wc", "-c"]
+# => #<Coque::Pipeline:0x007feb598730b0 @commands=[<Coque::Sh ["echo", "hi"]>, <Coque::Sh ["wc", "-c"]>]>
+pipeline.run.to_a
+# => ["3"]
+```
+
+Coque can also create "Rb" commands, which integrate Ruby code with streaming, line-wise processing of other commands:
+
+```
+c1 = Coque["printf", '"a\nb\nc\n"']
+c2 = Coque.rb { |line| puts line.upcase }
+(c1 | c2).run.to_a
+# => ["A", "B", "C"]
+```
+
+Rb commands can also take "pre" and "post" blocks
+
+```
+dict = Coque["cat", "/usr/share/dict/words"]
+rb_wc = Coque.rb { @lines += 1 }.pre { @lines = 0 }.post { puts @lines }
+
+(dict | rb_wc).run.to_a
+# => ["235886"]
+```
+
+Commands can have Stdin, Stdout, and Stderr redirected
+
+```rb
+(Coque["echo", "hi"] > "/tmp/hi.txt").run.wait
+File.read("/tmp/hi.txt")
+# => "hi\n"
+
+(Coque["head", "-n", "4"] < "/usr/share/dict/words").run.to_a
+# => ["A", "a", "aa", "aal"]
+
+(Coque["cat", "/doesntexist.txt"] >= "/tmp/error.txt").run.wait
+File.read("/tmp/error.txt")
+# => "cat: /doesntexist.txt: No such file or directory\n"
+```
+
+Coque commands can also be derived from a `Coque::Context`:
+
+```rb
+c = Coque.context
+c["pwd"].run.to_a
+# => ["/Users/worace/code/coque"]
+
+Coque.context.chdir("/tmp")["pwd"].run.to_a
+# => ["/private/tmp"]
+
+Coque.context.setenv("my_key": "pizza")["echo", "$my_key"].run.to_a
+# => ["pizza"]
+```
+
+### Streaming Performance
+
+Should be little overhead compared with the equivalent pipeline from a standard shell.
+
+From zsh:
+
+```
+head -c 100000000 /dev/urandom | pv | wc -c
+95.4MiB 0:00:06 [14.1MiB/s] [      <=>      ]
+ 100000000
+```
+
+With coque:
+
+```rb
+p = Coque["head", "-c", "100000000", "/dev/urandom"] | Coque["pv"] | Coque["wc", "-c"]
+p.run.wait
+95.4MiB 0:00:06 [14.6MiB/s] [           <=> ]
+```
+
+## Development
+
+* Setup local environment with standard `bundle`
+* Run tests with `rake`
+* See code coverage output in `coverage/`
+* Start a pry console with `bin/console`
+* Install current dev version with `rake install`
+* Use `rake release` to release after bumping `lib/coque/version.rb`
+* New issues welcome
+
+## Further Reading / Prior Art
+
+The concept and API for this library was heavily inspired by Python's excellent [Plumbum](https://plumbum.readthedocs.io/en/latest/) library.
+
+I relied on many resources to understand Ruby's great facilities for Process creation and manipulation. Some highlights include:
+
+* Avdi Grimm's _A dozen (or so) ways to start sub-processes in Ruby_ ([Part 1](https://devver.wordpress.com/2009/06/30/a-dozen-or-so-ways-to-start-sub-processes-in-ruby-part-1/), [Part 2](https://devver.wordpress.com/2009/07/13/a-dozen-or-so-ways-to-start-sub-processes-in-ruby-part-2/), [Part 3](https://devver.wordpress.com/2009/10/12/ruby-subprocesses-part_3/))
+* Ryan Tomayko's [I like Unicorn because it's Unix](https://tomayko.com/blog/2009/unicorn-is-unix)
+* Jesse Storimer's [Working With Unix Processes](https://www.jstorimer.com/products/working-with-unix-processes)
+* Brandon Wamboldt's blog series: [How bash redirection works](https://brandonwamboldt.ca/how-bash-redirection-works-under-the-hood-1512/), [How Linux pipes work](https://brandonwamboldt.ca/how-linux-pipes-work-under-the-hood-1518/), and [Understanding how Linux creates processes](https://brandonwamboldt.ca/how-linux-creates-processes-1528/)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Coque project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[worace]/coque/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "coque"
+
+# 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

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/coque.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "coque/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "coque"
+  spec.version       = Coque::VERSION
+  spec.authors       = ["Horace Williams"]
+  spec.email         = ["horace@worace.works"]
+
+  spec.summary       = %q{Shell command utilities with easy integration with Ruby code.}
+  spec.description   = %q{Like plumbum...for Ruby...with native Ruby streaming interop.}
+  spec.homepage      = "http://github.com/worace/coque"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "minitest", "~> 5.11"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "simplecov"
+end

data/drake.rb

@@ -0,0 +1,113 @@
+require "open3"
+require "pry"
+
+class Pipeline
+  attr_reader :commands
+  def initialize(commands = [])
+    @commands = commands
+  end
+
+  def to_s
+    "Pipeline of #{commands.join("|")}"
+  end
+
+  def |(other)
+    case other
+    when Pipeline
+      Pipeline.new(commands + other.commands)
+    when Cmd
+      Pipeline.new(commands + [other])
+    when Crb
+      Pipeline.new(commands + [other])
+    end
+  end
+
+  def run
+    commands = self.commands
+    pids = []
+
+    in_read, in_write = IO.pipe
+    out_read = nil
+    out_write = nil
+
+    while commands.any? do
+      in_write.close
+      out_read, out_write = IO.pipe
+
+      cmd = commands.shift
+      puts "Spawn command: #{cmd}"
+      pids << cmd.run(in_read, out_write)
+
+      in_read = out_read
+      in_write = out_write
+    end
+    out_write.close
+    [pids, out_read]
+  end
+end
+
+class Cmd
+  attr_reader :args
+  def initialize(args)
+    @args = args
+  end
+
+  def to_s
+    "Cmd to run: `#{args.inspect}`"
+  end
+
+  def self.[](*args)
+    puts args.inspect
+    Cmd.new(args)
+  end
+
+  def command
+    args.join(" ")
+  end
+
+  def run(stdin, stdout)
+    spawn(args.join(" "), in: stdin, stdin => stdin, out: stdout, stdout => stdout)
+  end
+
+  def |(other)
+    case other
+    when Cmd
+      Pipeline.new([self, other])
+    when Crb
+      Pipeline.new([self, other])
+    when Pipeline
+      Pipeline.new([self] + other.commands)
+    end
+  end
+end
+
+class Crb
+  def initialize(&block)
+    @block = block
+  end
+
+  def run(stdin, stdout)
+    fork do
+      STDOUT.reopen(stdout)
+      stdin.each_line(&@block)
+    end
+  end
+
+  def |(other)
+    case other
+    when Cmd
+      Pipeline.new([self, other])
+    when Crb
+      Pipeline.new([self, other])
+    when Pipeline
+      Pipeline.new([self] + other.commands)
+    end
+  end
+end
+
+
+c = Cmd['cat', '/usr/share/dict/words'] | Cmd['head'] | Crb.new { |line| puts "crb - #{line}" }
+puts "pipeline: #{c}"
+pids, out = c.run
+puts "Spawned pids: #{pids}"
+out.each_line { |l| puts l }