command-runner 0.3.0 → 0.4.0

data/README.md

@@ -59,6 +59,18 @@ line.pass.no_command? # => true
 
 it'll tell you.
 
+It calls the given block...
+
+```Ruby
+line = Command::Runner.new("echo", "{something}")
+
+line.pass(something: "hello") do |message|
+  message.stdout
+end # => "hello\n"
+```
+
+and return the value.
+
 ## Compatibility
 It works on
 

data/lib/command/runner.rb

@@ -89,14 +89,16 @@ module Command
     # @note This method may not raise a {NoCommandError} and instead
     #   return a {Message} with the error code +127+, even if the
     #   command doesn't exist.
+    # @yield [Message] when the command finishes.
     # @raise [NoCommandError] on no command.
     # @param interops [Hash<Symbol, Object>] the interpolations to
     #   make.
     # @param options [Hash<Symbol, Object>] the options for the
     #   backend.
-    # @return [Message]
-    def pass!(interops = {}, options = {})
-        backend.call(*[contents(interops), options.delete(:env) || {}, options].flatten)
+    # @return [Message, Object] message if no block was given, the
+    #   return value of the block otherwise.
+    def pass!(interops = {}, options = {}, &block)
+      backend.call(*[contents(interops), options.delete(:env) || {}, options].flatten, &block)
 
     rescue Errno::ENOENT
       raise NoCommandError, @command
@@ -106,13 +108,20 @@ module Command
     # defaults to no interpolations.  Calls {#pass!}, but does not
     # raise an error.
     #
+    # @yield (see #pass!)
     # @param (see #pass!)
     # @return (see #pass!)
-    def pass(interops = {}, options = {})
-      pass! interops, options
+    def pass(interops = {}, options = {}, &block)
+      pass! interops, options, &block
 
     rescue NoCommandError
-      Message.error(:line => contents(interops))
+      message = Message.error(contents(interops).join(' '))
+
+      if block_given?
+        block.call(message)
+      else
+        message
+      end
     end
 
     # The command line being run by the runner. Interpolates the

data/lib/command/runner/backends/backticks.rb

@@ -25,7 +25,8 @@ module Command
         # @param env [Hash] the enviornment to run the command
         #   under.
         # @param options [Hash] the options to run the command under.
-        # @return [Message] information about the process that ran.
+        # @return [Message, Object] message if no block is given, the
+        #   result of the block call otherwise.
         def call(command, arguments, env = {}, options = {})
           super
           output = ""
@@ -38,7 +39,7 @@ module Command
             end_time = Time.now
           end
 
-          Message.new :process_id => $?.pid,
+          message = Message.new :process_id => $?.pid,
                       :exit_code => $?.exitstatus,
                       :finished => true,
                       :time => (end_time - start_time).abs,
@@ -48,6 +49,12 @@ module Command
                       :line => [command, arguments].join(' '),
                       :executed => true,
                       :status => $?
+
+          if block_given?
+            block.call(message)
+          else
+            message
+          end
         end
 
         private

data/lib/command/runner/backends/fake.rb

@@ -28,17 +28,20 @@ module Command
         # @abstract
         # @note Does nothing.
         # @raise [Errno::ENOENT] if the command doesn't exist.
+        # @yield [message] when the command finishes.
         # @param command [String] the command to run.
         # @param arguments [String] the arguments to pass to the
         #   command.
         # @param env [Hash] the enviornment to run the command
         #   under.
         # @param options [Hash] the options to run the command under.
-        # @return [Message] information about the process that ran.
-        def call(command, arguments, env = {}, options = {})
+        # @return [Message, Object] message if no block is given, the
+        #   result of the block call otherwise.
+        def call(command, arguments, env = {}, options = {}, &block)
           @ran << [command, arguments]
 
-          Message.new :env => env, :options => options
+          message = Message.new :env => env, :options => options, :line =>
+            [command, arguments].join(' ')
         end
 
         # Determines whether or not the given command and arguments were

data/lib/command/runner/backends/spawn.rb

@@ -6,7 +6,9 @@ module Command
       class Spawn < Fake
 
         # Returns whether or not this backend is available on this
-        # platform.
+        # platform.  Process.spawn doesn't work the way we want it to
+        # on JRuby 1.9 mode, so we prevent this from being used on
+        # that platform.
         #
         # @return [Boolean]
         def self.available?
@@ -20,10 +22,14 @@ module Command
 
         # Run the given command and arguments, in the given environment.
         #
+        # @note The block is called in another thread, so in ruby
+        #   versions other than MRI, make sure your code is
+        #   thread-safe.
         # @raise [Errno::ENOENT] if the command doesn't exist.
+        # @yield (see Fake#call)
         # @param (see Fake#call)
         # @return (see Fake#call)
-        def call(command, arguments, env = {}, options = {})
+        def call(command, arguments, env = {}, options = {}, &block)
           super
           stderr_r, stderr_w = IO.pipe
           stdout_r, stdout_w = IO.pipe
@@ -49,7 +55,7 @@ module Command
 
             [stdout_w, stderr_w].each(&:close)
 
-            Message.new :process_id => process_id,
+            message = Message.new :process_id => process_id,
                         :exit_code  => status.exitstatus,
                         :finished   => true,
                         :time       => (start_time - end_time).abs,
@@ -60,6 +66,12 @@ module Command
                         :line       => line,
                         :executed   => true,
                         :status     => status
+
+            if block_given?
+              block.call(message)
+            else
+              message
+            end
           end
         end
 

data/lib/command/runner/message.rb

@@ -11,7 +11,7 @@ module Command
       #   +Errno::ENOENT+ error.
       # @ return [Message]
       def self.error(line)
-        Message.new(:line => line, :exit_code => 127)
+        new(:line => line, :exit_code => 127)
       end
 
       # Initialize the message with the given data about the process.

data/lib/command/runner/version.rb

@@ -3,7 +3,7 @@ module Command
   class Runner
 
     # The current version of Runner.
-    VERSION = "0.3.0".freeze
+    VERSION = "0.4.0".freeze
 
   end
 end

data/spec/messenger_spec.rb

@@ -47,7 +47,7 @@ describe Command::Runner do
     end
   end
 
-  context "selects backends" do
+  context "selecting backends" do
     it "selects the best backend" do
       Command::Runner::Backends::PosixSpawn.stub(:available?).and_return(false)
       Command::Runner::Backends::Spawn.stub(:available?).and_return(true)
@@ -58,14 +58,23 @@ describe Command::Runner do
     end
   end
 
-  context "running bad commands" do
+  context "bad commands" do
     let(:command) { "some-non-existant-command" }
     let(:arguments) { "" }
 
-    it "raises exceptions on non-existant commands" do
+    before :each do
       subject.backend = Command::Runner::Backends::Backticks.new
+    end
+
+    its(:pass) { should be_no_command }
+
+    it "calls the block given" do
+      subject.backend = Command::Runner::Backends::Backticks.new
+      subject.pass do |message|
+        message.should be_no_command
 
-      subject.pass.should be_no_command
+        message.line.should == "some-non-existant-command "
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: command-runner
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors: