command-runner 0.2.1 → 0.3.0

data/README.md

@@ -49,6 +49,16 @@ line.pass
 
 but defaults to the best one.
 
+If you run a command that doesn't exist on the machine...
+
+```Ruby
+line = Command::Runner.new("some-non-existant-command", "")
+
+line.pass.no_command? # => true
+```
+
+it'll tell you.
+
 ## Compatibility
 It works on
 

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

@@ -18,6 +18,7 @@ module Command
 
         # Run the given command and arguments, in the given environment.
         #
+        # @raise [Errno::ENOENT] if the command doesn't exist.
         # @param command [String] the command to run.
         # @param arguments [String] the arguments to pass to the
         #   command.
@@ -31,24 +32,22 @@ module Command
           start_time = nil
           end_time = nil
 
-          future do
-            with_modified_env(env) do
-              start_time = Time.now
-              output << `#{command} #{arguments}`
-              end_time = Time.now
-            end
-
-            Message.new :process_id => $?.pid,
-                        :exit_code => $?.exitstatus,
-                        :finished => true,
-                        :time => (end_time - start_time).abs,
-                        :env => env,
-                        :options => {},
-                        :stdout => output,
-                        :line => [command, arguments].join(' '),
-                        :executed => true,
-                        :status => $?
+          with_modified_env(env) do
+            start_time = Time.now
+            output << `#{command} #{arguments}`
+            end_time = Time.now
           end
+
+          Message.new :process_id => $?.pid,
+                      :exit_code => $?.exitstatus,
+                      :finished => true,
+                      :time => (end_time - start_time).abs,
+                      :env => env,
+                      :options => {},
+                      :stdout => output,
+                      :line => [command, arguments].join(' '),
+                      :executed => true,
+                      :status => $?
         end
 
         private

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

@@ -27,6 +27,7 @@ module Command
         #
         # @abstract
         # @note Does nothing.
+        # @raise [Errno::ENOENT] if the command doesn't exist.
         # @param command [String] the command to run.
         # @param arguments [String] the arguments to pass to the
         #   command.

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

@@ -5,7 +5,10 @@ module Command
       # Spawns a process using ruby's Process.spawn.
       class Spawn < Fake
 
-        # (see Fake.available?)
+        # Returns whether or not this backend is available on this
+        # platform.
+        #
+        # @return [Boolean]
         def self.available?
           Process.respond_to?(:spawn) && !(RUBY_PLATFORM == "java" && RUBY_VERSION =~ /\A1\.9/)
         end
@@ -17,6 +20,7 @@ module Command
 
         # Run the given command and arguments, in the given environment.
         #
+        # @raise [Errno::ENOENT] if the command doesn't exist.
         # @param (see Fake#call)
         # @return (see Fake#call)
         def call(command, arguments, env = {}, options = {})
@@ -24,13 +28,14 @@ module Command
           stderr_r, stderr_w = IO.pipe
           stdout_r, stdout_w = IO.pipe
           stdin_r,  stdin_w  = IO.pipe
+          clean_exceptions   = options.delete(:clean_exceptions) || false
 
+          if options[:input]
+            stdin_w.write(options.delete(:input))
+          end
           new_options = options.merge(:in => stdin_r,
             :out => stdout_w, :err => stderr_w)
 
-          if new_options[:input]
-            stdin_w.write(new_options.delete(:input))
-          end
           stdin_w.close
 
           line = [command, arguments].join(' ')
@@ -56,17 +61,6 @@ module Command
                         :executed   => true,
                         :status     => status
           end
-
-        rescue Errno::ENOENT => e
-          Message.new :exit_code => 127,
-                      :finished  => true,
-                      :time      => -1,
-                      :env       => {},
-                      :options   => {},
-                      :stdout    => "",
-                      :stderr    => e.message,
-                      :line      => line,
-                      :executed  => false
         end
 
         # Spawn the given process, in the environment with the

data/lib/command/runner/exceptions.rb

@@ -6,5 +6,9 @@ module Command
     # support it.
     class NotAvailableBackendError < StandardError; end
 
+    # Raised when a command that was passed is not available on this
+    # platform.
+    class NoCommandError < StandardError; end
+
   end
 end

data/lib/command/runner/message.rb

@@ -5,6 +5,15 @@ module Command
     # its exit code, process id, and even time it took to run.
     class Message
 
+      # For when a message is created for a NoCommandError.
+      #
+      # @param line [String] the line that was executed, but gave a
+      #   +Errno::ENOENT+ error.
+      # @ return [Message]
+      def self.error(line)
+        Message.new(:line => line, :exit_code => 127)
+      end
+
       # Initialize the message with the given data about the process.
       #
       # @param data [Hash] the data about the process.
@@ -58,6 +67,14 @@ module Command
         exit_code != 0
       end
 
+      # Whether or not the command existed; or, if the exit code
+      # is 127.
+      #
+      # @return [Boolean]
+      def no_command?
+        exit_code == 127
+      end
+
       # @!attribute [r] exit_code
       #   The code the process exited with.
       #

data/lib/command/runner/version.rb

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

data/lib/command/runner.rb

@@ -52,6 +52,8 @@ module Command
     # The options the messenger was initialized with.
     #
     # @return [Hash]
+    # @!parse
+    #   attr_reader :options
     def options
       @options.dup.freeze
     end
@@ -59,7 +61,7 @@ module Command
     # Gets the backend to be used by the messenger.  If it is not defined
     # on the instance, it'll get the class default.
     #
-    # @see Messenger.backend
+    # @see Runner.backend
     # @return [#call] a backend to use.
     def backend
       @backend || self.class.backend
@@ -83,8 +85,34 @@ module Command
 
     # Runs the command and arguments with the given interpolations;
     # defaults to no interpolations.
+    #
+    # @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.
+    # @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)
+
+    rescue Errno::ENOENT
+      raise NoCommandError, @command
+    end
+
+    # Runs the command and arguments with the given interpolations;
+    # defaults to no interpolations.  Calls {#pass!}, but does not
+    # raise an error.
+    #
+    # @param (see #pass!)
+    # @return (see #pass!)
     def pass(interops = {}, options = {})
-      backend.call(*[contents(interops), options.delete(:env) || {}, options].flatten)
+      pass! interops, options
+
+    rescue NoCommandError
+      Message.error(:line => contents(interops))
     end
 
     # The command line being run by the runner. Interpolates the

data/spec/backticks_spec.rb

@@ -10,12 +10,7 @@ describe Command::Runner::Backends::Backticks do
     value.should be_executed
   end
 
-  it "doesn't block" do
-    start_time = Time.now
-    value = subject.call("sleep", "0.5")
-    end_time = Time.now
-
-    (end_time - start_time).should be_within((1.0/100)).of(0)
-    value.time.should be_within(0.1).of(0.5)
+  it "gives the correct time" do
+    subject.call("sleep", "0.5").time.should be_within(0.1).of(0.5)
   end
 end

data/spec/messenger_spec.rb

@@ -57,4 +57,15 @@ describe Command::Runner do
       Command::Runner.best_backend.should be_instance_of Command::Runner::Backends::PosixSpawn
     end
   end
+
+  context "running bad commands" do
+    let(:command) { "some-non-existant-command" }
+    let(:arguments) { "" }
+
+    it "raises exceptions on non-existant commands" do
+      subject.backend = Command::Runner::Backends::Backticks.new
+
+      subject.pass.should be_no_command
+    end
+  end
 end

metadata

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