cmds 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29ac5b8099c66914471b6fd1585748ba6b8f74a6
-  data.tar.gz: ab9ba3a952397d2084c30cda20f6297a37680b32
+  metadata.gz: c6566ed118279014629f7435a6a271de93416f81
+  data.tar.gz: ce308a9251460a2c0d3cf4729aefc50c2e5ff1c3
 SHA512:
-  metadata.gz: 21d3ac68168ca119e4a170633f2b29c7df0060ac4d39e3aeac1bb80a773acd3f91c3b366052a137e04c791d78ceaf1be7c773f5fd9a0eb23e9162ba76b371bb0
-  data.tar.gz: 736a8e9b895c7772b6f1738801f79f6a90a9b21351ffe6205feec848ab39dcee9272c58a6504fde06720889f7f19595d8ddd9d3403bc498c706a26a5e95d036d
+  metadata.gz: aa04300533619aa99726a972ac0cfc8ca0814c40e796a5d926909fc55c7ac1119d9ec47c1b117399c1b51c57ac3b32ad9eed4856a4eb8ad8f975e4987bc910e2
+  data.tar.gz: 80c58ef1c07ab63dd515da61381200a2f5dc1bd47f223d2c6db838dba33a7bf8bae31f21aaa9f8e539915528a17c7f30258e0fa338222d26fbe41afc22067f58

data/lib/cmds/sugar.rb

@@ -51,6 +51,57 @@ class Cmds
     Cmds.new(template, assert: true).stream *subs, &input_block
   end # ::stream!
 
+
+  # @api sugar
+  #
+  # captures and returns stdout (sugar for `Cmds.capture(*args).out`).
+  #
+  # @param template [String] see {.capture}.
+  # @param subs [Array] see {.capture}.
+  # @param input_block [Proc] see {.capture}.
+  #
+  # @see .capture
+  # @see Result#out
+  #
+  def self.out template, *subs, &input_block
+    capture(template, *subs, &input_block).out
+  end
+
+
+  # @api sugar
+  #
+  # captures and returns stdout, raising an error if the command fails.
+  #
+  # @param template [String] see {.capture}.
+  # @param subs [Array] see {.capture}.
+  # @param input_block [Proc] see {.capture}.
+  #
+  # @see .capture
+  # @see Result#out
+  #
+  def self.out! template, *subs, &input_block
+    Cmds.new(
+      template,
+      options(subs, input_block).merge!(assert: true),
+    ).capture.out
+  end
+
+
+  # @api sugar
+  #
+  # captures and returns stderr (sugar for `Cmds.capture(*args).err`).
+  #
+  # @param template [String] see {.capture}.
+  # @param subs [Array] see {.capture}.
+  # @param input_block [Proc] see {.capture}.
+  #
+  # @see .capture
+  # @see Result#err
+  #
+  def self.err template, *subs, &input_block
+    capture(template, *subs, &input_block).err
+  end
+
   # instance methods
   # ================
 
@@ -74,4 +125,61 @@ class Cmds
     end
   end
 
+
+  # @api sugar
+  #
+  # captures and returns stdout
+  # (sugar for `#capture(*subs, &input_block).out`).
+  #
+  # @param subs [Array] see {.capture}.
+  # @param input_block [Proc] see {.capture}.
+  #
+  # @return [String] the command's stdout.
+  #
+  # @see #capture
+  # @see Result#out
+  #
+  def out *subs, &input_block
+    capture(*subs, &input_block).out
+  end
+
+
+  # @api sugar
+  #
+  # captures and returns stdout
+  # (sugar for `#capture(*subs, &input_block).out`).
+  #
+  # @param subs [Array] see {.capture}.
+  # @param input_block [Proc] see {.capture}.
+  #
+  # @return [String] the command's stdout.
+  #
+  # @see #capture
+  # @see Result#out
+  #
+  def out! *subs, &input_block
+    self.class.new(
+      @template,
+      merge_options(subs, input_block).merge!(assert: true),
+    ).capture.out
+  end
+
+
+  # @api sugar
+  #
+  # captures and returns stdout
+  # (sugar for `#capture(*subs, &input_block).err`).
+  #
+  # @param subs [Array] see {.capture}.
+  # @param input_block [Proc] see {.capture}.
+  #
+  # @return [String] the command's stdout.
+  #
+  # @see #capture
+  # @see Result#err
+  #
+  def err *subs, &input_block
+    capture(*subs, &input_block).err
+  end
+
 end # class Cmds

data/lib/cmds/version.rb

@@ -1,3 +1,3 @@
 class Cmds
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/spec/cmds/err_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe "Cmds.err" do
+  it "gets echo error output" do
+    expect( Cmds.err "echo %s 1>&2", ["hey there!"] ).to eq "hey there!\n"
+  end
+
+  it "reads input" do
+    expect(
+      Cmds.err("ruby -e %{script}", script: "$stderr.puts STDIN.read") {
+        "hey there!"
+      }
+    ).to eq "hey there!\n"
+  end
+end # Cmds.err
+
+describe "Cmds#err" do
+  it "gets echo error output" do
+    expect( Cmds.new("echo %s 1>&2").err ["hey there!"] ).to eq "hey there!\n"
+  end
+
+  it "reads input" do
+    expect(
+      Cmds.new("ruby -e %{script}").err(script: "$stderr.puts STDIN.read") {
+        "hey there!"
+      }
+    ).to eq "hey there!\n"
+  end
+end # Cmds#err

data/spec/cmds/out_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe "Cmds.out" do
+  it "gets echo output" do
+    expect( Cmds.out "echo %s", ["hey there!"] ).to eq "hey there!\n"
+  end
+
+  it "reads input" do
+    expect(
+      Cmds.out("ruby -e %{script}", script: "puts STDIN.read") {
+        "hey there!"
+      }
+    ).to eq "hey there!\n"
+  end
+end # Cmds.out
+
+describe "Cmds.out!" do
+  it "gets echo output" do
+    expect( Cmds.out! "echo %s", ["hey there!"] ).to eq "hey there!\n"
+  end
+
+  it "reads input" do
+    expect(
+      Cmds.out!("ruby -e %{script}", script: "puts STDIN.read") {
+        "hey there!"
+      }
+    ).to eq "hey there!\n"
+  end
+
+  it "errors when the command fails" do
+    expect { Cmds.out! "false" }.to raise_error SystemCallError
+  end
+end # Cmds.out!
+
+describe "Cmds#out" do
+  it "gets echo output" do
+    expect( Cmds.new("echo %s").out ["hey there!"] ).to eq "hey there!\n"
+  end
+
+  it "reads input" do
+    expect(
+      Cmds.new("ruby -e %{script}").out(script: "puts STDIN.read") {
+        "hey there!"
+      }
+    ).to eq "hey there!\n"
+  end
+end # Cmds#out
+
+describe "Cmds#out!" do
+  it "gets echo output" do
+    expect( Cmds.new("echo %s").out! ["hey there!"] ).to eq "hey there!\n"
+  end
+
+  it "reads input" do
+    expect(
+      Cmds.new("ruby -e %{script}").out!(script: "puts STDIN.read") {
+        "hey there!"
+      }
+    ).to eq "hey there!\n"
+  end
+
+  it "errors when the command fails" do
+    expect { Cmds.new("false").out! }.to raise_error SystemCallError
+  end
+end # Cmds#out!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cmds
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-08 00:00:00.000000000 Z
+date: 2015-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nrser
@@ -158,9 +158,11 @@ files:
 - spec/cmds/capture_spec.rb
 - spec/cmds/curry_spec.rb
 - spec/cmds/erb_context_spec.rb
+- spec/cmds/err_spec.rb
 - spec/cmds/error_spec.rb
 - spec/cmds/expand_option_hash_spec.rb
 - spec/cmds/ok_spec.rb
+- spec/cmds/out_spec.rb
 - spec/cmds/replace_shortcuts_spec.rb
 - spec/cmds/stream_spec.rb
 - spec/cmds/sub_spec.rb
@@ -202,9 +204,11 @@ test_files:
 - spec/cmds/capture_spec.rb
 - spec/cmds/curry_spec.rb
 - spec/cmds/erb_context_spec.rb
+- spec/cmds/err_spec.rb
 - spec/cmds/error_spec.rb
 - spec/cmds/expand_option_hash_spec.rb
 - spec/cmds/ok_spec.rb
+- spec/cmds/out_spec.rb
 - spec/cmds/replace_shortcuts_spec.rb
 - spec/cmds/stream_spec.rb
 - spec/cmds/sub_spec.rb