cmds 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6566ed118279014629f7435a6a271de93416f81
-  data.tar.gz: ce308a9251460a2c0d3cf4729aefc50c2e5ff1c3
+  metadata.gz: 1dd522e09d442b565bd299965feb5568ac5d830e
+  data.tar.gz: 901dde67d7c5f77571539ab2ae8ea7a3b67c9d5d
 SHA512:
-  metadata.gz: aa04300533619aa99726a972ac0cfc8ca0814c40e796a5d926909fc55c7ac1119d9ec47c1b117399c1b51c57ac3b32ad9eed4856a4eb8ad8f975e4987bc910e2
-  data.tar.gz: 80c58ef1c07ab63dd515da61381200a2f5dc1bd47f223d2c6db838dba33a7bf8bae31f21aaa9f8e539915528a17c7f30258e0fa338222d26fbe41afc22067f58
+  metadata.gz: 7c5eea2077d11d90db033f8fd98ce2fb8782ac554427676087f1917fdf2f402ff6836089ab03a1e274783108b1acee9a49185e68fc7c46996b0db973c46a9b49
+  data.tar.gz: 85f29ade7132c8c083c94b4e7939aed8be3fe7a1d2153fadff115f581f9d32a43e5a5d5cfcdfe277efc6f641fd2290294e89dce2f5c27c18da6f7b27fc810b50

data/lib/cmds/sugar.rb

@@ -54,14 +54,17 @@ class Cmds
 
   # @api sugar
   #
-  # captures and returns stdout (sugar for `Cmds.capture(*args).out`).
+  # captures and returns stdout
+  # (sugar for `Cmds.capture(*template, *subs, &input_block).out`).
+  #
+  # @see .capture
+  # @see Result#out
   #
   # @param template [String] see {.capture}.
   # @param subs [Array] see {.capture}.
   # @param input_block [Proc] see {.capture}.
   #
-  # @see .capture
-  # @see Result#out
+  # @return [String] the command's stdout.
   #
   def self.out template, *subs, &input_block
     capture(template, *subs, &input_block).out
@@ -72,12 +75,16 @@ class Cmds
   #
   # captures and returns stdout, raising an error if the command fails.
   #
+  # @see .capture
+  # @see Result#out
+  #
   # @param template [String] see {.capture}.
   # @param subs [Array] see {.capture}.
   # @param input_block [Proc] see {.capture}.
   #
-  # @see .capture
-  # @see Result#out
+  # @return [String] the command's stdout.
+  #
+  # @raise [SystemCallError] if the command fails (non-zero exit status).
   #
   def self.out! template, *subs, &input_block
     Cmds.new(
@@ -89,15 +96,56 @@ class Cmds
 
   # @api sugar
   #
-  # captures and returns stderr (sugar for `Cmds.capture(*args).err`).
+  # captures and chomps stdout
+  # (sugar for `Cmds.out(*template, *subs, &input_block).chomp`).
+  #
+  # @see .out
+  #
+  # @param template [String] see {.capture}.
+  # @param subs [Array] see {.capture}.
+  # @param input_block [Proc] see {.capture}.
+  #
+  # @return [String] the command's chomped stdout.
+  #
+  def self.chomp template, *subs, &input_block
+    out(template, *subs, &input_block).chomp
+  end
+
+
+  # @api sugar
+  #
+  # captures and chomps stdout, raising an error if the command fails.
+  # (sugar for `Cmds.out!(*template, *subs, &input_block).chomp`).
+  #
+  # @see .out!
   #
   # @param template [String] see {.capture}.
   # @param subs [Array] see {.capture}.
   # @param input_block [Proc] see {.capture}.
   #
+  # @return [String] the command's chomped stdout.
+  #
+  # @raise [SystemCallError] if the command fails (non-zero exit status).
+  #
+  def self.chomp! template, *subs, &input_block
+    out!(template, *subs, &input_block).chomp
+  end
+
+
+  # @api sugar
+  #
+  # captures and returns stderr
+  # (sugar for `Cmds.capture(template, *subs, &input_block).err`).
+  #
   # @see .capture
   # @see Result#err
   #
+  # @param template [String] see {.capture}.
+  # @param subs [Array] see {.capture}.
+  # @param input_block [Proc] see {.capture}.
+  #
+  # @return [String] the command's stderr.
+  #
   def self.err template, *subs, &input_block
     capture(template, *subs, &input_block).err
   end
@@ -131,14 +179,14 @@ class Cmds
   # captures and returns stdout
   # (sugar for `#capture(*subs, &input_block).out`).
   #
+  # @see #capture
+  # @see Result#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
@@ -149,13 +197,15 @@ class Cmds
   # captures and returns stdout
   # (sugar for `#capture(*subs, &input_block).out`).
   #
+  # @see #capture
+  # @see Result#out
+  #
   # @param subs [Array] see {.capture}.
   # @param input_block [Proc] see {.capture}.
   #
   # @return [String] the command's stdout.
   #
-  # @see #capture
-  # @see Result#out
+  # @raise [SystemCallError] if the command fails (non-zero exit status).
   #
   def out! *subs, &input_block
     self.class.new(
@@ -165,6 +215,43 @@ class Cmds
   end
 
 
+  # @api sugar
+  #
+  # captures and chomps stdout
+  # (sugar for `#out(*subs, &input_block).chomp`).
+  #
+  # @see #out
+  #
+  # @param subs [Array] see {.capture}.
+  # @param input_block [Proc] see {.capture}.
+  #
+  # @return [String] the command's chomped stdout.
+  #
+  def chomp *subs, &input_block
+    out(*subs, &input_block).chomp
+  end
+
+
+  # @api sugar
+  #
+  # captures and chomps stdout, raising an error if the command failed.
+  # (sugar for `#out!(*subs, &input_block).chomp`).
+  #
+  # @see #capture
+  # @see Result#out
+  #
+  # @param subs [Array] see {.capture}.
+  # @param input_block [Proc] see {.capture}.
+  #
+  # @return [String] the command's chomped stdout.
+  #
+  # @raise [SystemCallError] if the command fails (non-zero exit status).
+  #
+  def chomp! *subs, &input_block
+    out!(*subs, &input_block).chomp
+  end
+
+
   # @api sugar
   #
   # captures and returns stdout
@@ -173,11 +260,11 @@ class Cmds
   # @param subs [Array] see {.capture}.
   # @param input_block [Proc] see {.capture}.
   #
-  # @return [String] the command's stdout.
-  #
   # @see #capture
   # @see Result#err
   #
+  # @return [String] the command's stderr.
+  #
   def err *subs, &input_block
     capture(*subs, &input_block).err
   end

data/lib/cmds/version.rb

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

data/spec/cmds/chomp_spec.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cmds
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - nrser
@@ -156,6 +156,7 @@ files:
 - scratch/proxy.rb
 - spec/cmds/assert_spec.rb
 - spec/cmds/capture_spec.rb
+- spec/cmds/chomp_spec.rb
 - spec/cmds/curry_spec.rb
 - spec/cmds/erb_context_spec.rb
 - spec/cmds/err_spec.rb
@@ -202,6 +203,7 @@ summary: helps read, write and remember commands.
 test_files:
 - spec/cmds/assert_spec.rb
 - spec/cmds/capture_spec.rb
+- spec/cmds/chomp_spec.rb
 - spec/cmds/curry_spec.rb
 - spec/cmds/erb_context_spec.rb
 - spec/cmds/err_spec.rb