cliver 0.2.2 → 0.3.1

data/lib/cliver.rb

@@ -4,6 +4,7 @@ require File.expand_path('../core_ext/file', __FILE__)
 
 require 'cliver/version'
 require 'cliver/dependency'
+require 'cliver/shell_capture'
 require 'cliver/detector'
 require 'cliver/filter'
 
@@ -49,16 +50,19 @@ module Cliver
   end
 
   # Verify an absolute-path to an executable.
-  # @param (see Cliver::Dependency#initialize)
-  #   EXCEPT: executable must be a single, absolute path.
-  # @option options [Boolean] :strict (true) @see Cliver::Dependency::initialize
-  # @raise (see Cliver::Dependency#detect!)
-  # @return (see Cliver::Dependency#detect!)
+  # @overload verify!(executable, *requirements, options = {})
+  #   @param executable [String] absolute path to an executable
+  #   @param requirements (see Cliver::Dependency#initialize)
+  #   @option options (see Cliver::Dependency::initialize)
+  #   @raise (see Cliver::Dependency#detect!)
+  #   @return (see Cliver::Dependency#detect!)
   def self.verify!(executable, *args, &block)
     unless File.absolute_path?(executable)
       raise ArgumentError, "executable path must be absolute, " +
                            "got '#{executable.inspect}'."
     end
+    options = args.last.kind_of?(Hash) ? args.pop : {}
+    args << options.merge(:path => '.') # ensure path non-empty.
     Dependency::new(executable, *args, &block).detect!
   end
 

data/lib/cliver/dependency.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 require 'rubygems/requirement'
+require 'set'
 
 module Cliver
   # This is how a dependency is specified.
@@ -197,18 +198,18 @@ module Cliver
     def find_executables
       return enum_for(:find_executables) unless block_given?
 
-      exts = ENV.has_key?('PATHEXT') ? ENV.fetch('PATHEXT').split(';') : ['']
+      exts = (ENV.has_key?('PATHEXT') ? ENV.fetch('PATHEXT').split(';') : []) << ''
       paths = @path.sub('*', ENV['PATH']).split(File::PATH_SEPARATOR)
+      raise ArgumentError.new('No PATH to search!') if paths.empty?
       cmds = strict? ? @executables.first(1) : @executables
 
-      detected_exes = []
+      lookup_cache = Set.new
       cmds.product(paths, exts).map do |cmd, path, ext|
         exe = File.absolute_path?(cmd) ? cmd : File.expand_path("#{cmd}#{ext}", path)
 
+        next unless lookup_cache.add?(exe) # don't yield the same exe path 2x
         next unless File.executable?(exe)
-        next if detected_exes.include?(exe) # don't yield the same exe path 2x
 
-        detected_exes << exe
         yield exe
       end
     end

data/lib/cliver/detector.rb

@@ -40,15 +40,15 @@ module Cliver
     # @return [String] - should be contain {Gem::Version}-parsable
     #                    version number.
     def detect_version(executable_path)
-      output = shell_out_and_capture version_command(executable_path).shelljoin
-      if $?.exitstatus == 127
+      capture = ShellCapture.new(version_command(executable_path))
+      unless capture.command_found
         raise Cliver::Dependency::NotFound.new(
             "Could not find an executable at given path '#{executable_path}'." +
             "If this path was not specified explicitly, it is probably a " +
             "bug in [Cliver](https://github.com/yaauie/cliver/issues)."
           )
       end
-      output[version_pattern]
+      capture.stdout[version_pattern] || capture.stderr[version_pattern]
     end
 
     # This is the interface that any detector must have.
@@ -80,13 +80,5 @@ module Cliver
     def version_command(executable_path)
       [executable_path, *Array(command_arg)]
     end
-
-    private
-
-    # @api private
-    # A boundary that is useful for testing.
-    def shell_out_and_capture(command)
-      `#{command} 2>&1`
-    end
   end
 end

data/lib/cliver/shell_capture.rb

@@ -0,0 +1,35 @@
+require 'open3'
+
+module Cliver
+  class ShellCapture
+    attr_reader :stdout, :stderr, :command_found
+
+    # @overlaod initialize(command)
+    #   @param command [String] the command to run
+    # @overload initialize(command)
+    #   @param command [Array<String>] the command to run; elements in
+    #     the supplied array will be shelljoined.
+    # @return [void]
+    def initialize(command)
+      command = command.shelljoin if command.kind_of?(Array)
+      @stdout = @stderr = ''
+      begin
+        Open3.popen3(command) do |i, o, e|
+          @stdout = o.read.chomp
+          @stderr = e.read.chomp
+        end
+        # Fix for ruby 1.8.7 (and probably earlier):
+        # Open3.popen3 does not raise anything there, but the error goes to STDERR.
+        if @stderr =~ /open3.rb:\d+:in `exec': No such file or directory -.*\(Errno::ENOENT\)/ or
+           @stderr =~ /An exception occurred in a forked block\W+No such file or directory.*\(Errno::ENOENT\)/
+          @stderr = ''
+          @command_found = false
+        else
+          @command_found = true
+        end
+      rescue Errno::ENOENT, IOError
+        @command_found = false
+      end
+    end
+  end
+end

data/lib/cliver/version.rb

@@ -2,5 +2,5 @@
 
 module Cliver
   # Cliver follows {http://semver.org SemVer}
-  VERSION = '0.2.2'
+  VERSION = '0.3.1'
 end

data/lib/core_ext/file.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 
+# Core-Extensions on File
 class File
   # determine whether a String path is absolute.
   # @example
@@ -9,10 +10,17 @@ class File
   #   File.absolute_path?('/foo/bar') #=> true
   #   File.absolute_path?('C:foo/bar') #=> false
   #   File.absolute_path?('C:/foo/bar') #=> true
-  # @param [String] - a pathname
+  # @param path [String] - a pathname
   # @return [Boolean]
-  def self.absolute_path?(path)
-    false | path[ABSOLUTE_PATH_PATTERN]
+  def self.absolute_path?(path, platform = :default)
+    pattern = case platform
+              when :default then ABSOLUTE_PATH_PATTERN
+              when :windows then WINDOWS_ABSOLUTE_PATH_PATTERN
+              when :posix   then POSIX_ABSOLUTE_PATH_PATTERN
+              else raise ArgumentError, "Unsupported platform '#{platform.inspect}'"
+              end
+
+    false | path[pattern]
   end
 
   unless defined?(POSIX_ABSOLUTE_PATH_PATTERN)

data/spec/cliver/detector_spec.rb

@@ -41,4 +41,38 @@ describe Cliver::Detector do
     its(:command_arg) { should eq [version_arg] }
     its(:version_pattern) { should eq regexp_arg }
   end
+
+  context 'detecting a command' do
+    before(:each) do
+      Cliver::ShellCapture.stub(:new => capture)
+    end
+
+    context 'that reports version on stdout' do
+      let(:capture) { double('capture', :stdout => '1.1',
+                                        :stderr => 'Warning: There is a monkey 1.2 metres left of you.',
+                                        :command_found => true) }
+
+      it 'should prefer the stdout output' do
+        expect(detector.detect_version('foo')).to eq('1.1')
+      end
+    end
+
+    context 'that reports version on stderr' do
+      let(:capture) { double('capture', :stdout => '',
+                                        :stderr => 'Version: 1.666',
+                                        :command_found => true) }
+
+      it 'should prefer the stderr output' do
+        expect(detector.detect_version('foo')).to eq('1.666')
+      end
+    end
+
+    context 'that does not exist' do
+      let(:capture) { Cliver::ShellCapture.new('acommandnosystemshouldhave123') }
+
+      it 'should raise an exception' do
+        expect { detector.detect_version('foo') }.to raise_error(Cliver::Dependency::NotFound)
+      end
+    end
+  end
 end

data/spec/cliver/shell_capture_spec.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+require 'cliver'
+
+describe Cliver::ShellCapture do
+  let(:test_command) { 'test command' }
+  subject { Cliver::ShellCapture.new(test_command) }
+
+  context 'a command that exists' do
+    let(:intended_stdout) { StringIO.new('1.1.1').tap(&:rewind) }
+    let(:intended_stderr) { StringIO.new('foo baar 1').tap(&:rewind) }
+    let(:intended_stdin)  { StringIO.new('').tap(&:rewind) }
+
+    ['test command', %w(test command)].each do |input|
+      context "with #{input.class.name} input" do
+        let(:test_command) { input }
+
+        before(:each) do
+          Open3.should_receive(:popen3) do |*args|
+            args.size.should eq 1
+            args.first.should == 'test command'
+          end.and_yield(intended_stdin, intended_stdout, intended_stderr)
+        end
+
+        its(:stdout) { should eq '1.1.1' }
+        its(:stderr) { should eq 'foo baar 1' }
+        its(:command_found) { should be_true }
+      end
+    end
+  end
+
+  context 'looking for a command that does not exist' do
+    before(:each) do
+      Open3.should_receive(:popen3) do |command|
+        command.should eq test_command
+        raise Errno::ENOENT.new("No such file or directory - #{test_command}")
+      end
+    end
+    its(:stdout) { should eq '' }
+    its(:stderr) { should eq '' }
+    its(:command_found) { should be_false }
+  end
+end

data/spec/cliver_spec.rb

@@ -1,6 +1,14 @@
 # encoding: utf-8
 require 'cliver'
 require 'spec_helper'
+require File.expand_path('../support/executable_mock', __FILE__)
+
+RSpec::Matchers.define :be_filesystem_equivalent_of do |expected|
+  match do |actual|
+    ExecutableMock.new(expected) == actual
+  end
+end
+
 
 describe Cliver do
   # The setup. Your test will likeley interact with subject.
@@ -10,29 +18,32 @@ describe Cliver do
   # These can get overridden in context blocks
   let(:method) { raise ArgumentError, 'spec didn\'t specify :method' }
   let(:args) { raise ArgumentError, 'spec didn\'t specify :args' }
-  let(:block) { version_map.method(:fetch) }
+  let(:block) { version_directory.method(:version) }
+
+  # BecauseWindows. This enables us to mock out File::executable?
+  # and the responses from our detectors given any representation
+  # of a file path.
+  let(:version_directory) do
+    ExecutableMock::Registry.new(version_map)
+  end
 
   before(:each) do
-    File.stub(:executable?) { |path| executables.include? path }
-    # Cliver::Dependency.any_instance.stub(:detect_version) do |arg|
-    #   version_map[arg]
-    # end
+    File.stub(:executable?, &version_directory.method(:executable?))
   end
 
   let(:options) do
     {
-      :path =>       path,
+      :path =>       path.join(File::PATH_SEPARATOR),
       :executable => executable,
     }
   end
-  let(:executables) { version_map.keys }
   let(:args) do
     args = [Array(executable)]
     args.concat Array(requirement)
     args << options
   end
 
-  let(:path) { '/foo/bar:/baz/bingo' }
+  let(:path) { ['/foo/bar','/baz/bingo'] }
   let(:executable) { 'doodle' }
   let(:requirement) { '~>1.1'}
 
@@ -55,14 +66,14 @@ describe Cliver do
     end
     context '::detect' do
       let(:method) { :detect }
-      it { should eq '/baz/bingo/doodle' }
+      it { should be_filesystem_equivalent_of '/baz/bingo/doodle' }
     end
     context '::detect!' do
       let(:method) { :detect! }
       it 'should not raise' do
         expect { action }.to_not raise_exception
       end
-      it { should eq '/baz/bingo/doodle' }
+      it { should be_filesystem_equivalent_of '/baz/bingo/doodle' }
     end
   end
 
@@ -137,7 +148,7 @@ describe Cliver do
     let(:version_map) do
       {'/baz/bingo/doodle' => '1.2.1'}
     end
-    let(:path) { '/fiddle/foo:/deedle/dee'}
+    let(:path) { ['/fiddle/foo','/deedle/dee'] }
 
     context 'that is absolute' do
       let(:executable) { '/baz/bingo/doodle' }
@@ -212,14 +223,14 @@ describe Cliver do
       end
       context '::detect' do
         let(:method) { :detect }
-        it { should eq '/baz/bingo/doodle'}
+        it { should be_filesystem_equivalent_of '/baz/bingo/doodle' }
       end
       context '::detect!' do
         let(:method) { :detect! }
         it 'should not raise' do
           expect { action }.to_not raise_exception
         end
-        it { should eq '/baz/bingo/doodle' }
+        it { should be_filesystem_equivalent_of '/baz/bingo/doodle' }
       end
     end
   end
@@ -262,7 +273,7 @@ describe Cliver do
         end
         context '::detect' do
           let(:method) { :detect }
-          it { should eq '/baz/bingo/primary' }
+          it { should be_filesystem_equivalent_of '/baz/bingo/primary' }
         end
       end
       context 'and primary insufficient' do
@@ -275,7 +286,7 @@ describe Cliver do
         context 'the secondary' do
           context '::detect' do
             let(:method) { :detect }
-            it { should eq '/foo/bar/fallback' }
+            it { should be_filesystem_equivalent_of '/foo/bar/fallback' }
           end
         end
       end
@@ -289,7 +300,7 @@ describe Cliver do
         end
         context '::detect' do
           let(:method) { :detect }
-          it { should eq '/foo/bar/fallback' }
+          it { should be_filesystem_equivalent_of '/foo/bar/fallback' }
         end
       end
     end

data/spec/support/executable_mock.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+class ExecutableMock
+  def initialize(path)
+    @path = _to_platform_abs_path(path)
+  end
+  attr_reader :path
+  attr_reader :version
+
+  def == (other_path)
+    other_path = _to_platform_abs_path(other_path)
+    if other_path[/[A-Z]:/i] # windows
+      pattern = /\A#{self.path}(#{(ENV['PATHEXT']||'').split(';').map(&Regexp::method(:escape)).join('|')})?\Z/i
+      pattern =~ other_path
+    else # posix
+      self.path == other_path
+    end
+  end
+
+  private
+
+  def _to_platform_abs_path(source)
+    (File::absolute_path?(source, :windows) && !File::absolute_path?(source, :posix)) ?
+      source.tr('\\','/') :
+      File.expand_path(source)
+  end
+
+  class Registry
+    def initialize(version_map)
+      @registry = {}
+      version_map.each do |path,version|
+        @registry[ExecutableMock.new(path)] = version
+      end
+    end
+
+    def executable?(path)
+      false | version(path)
+    end
+
+    def version(path)
+      key = @registry.keys.find {|exe| exe == path }
+      key && @registry[key]
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cliver
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-18 00:00:00.000000000 Z
+date: 2013-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -127,12 +127,15 @@ files:
 - lib/cliver/dependency.rb
 - lib/cliver/detector.rb
 - lib/cliver/filter.rb
+- lib/cliver/shell_capture.rb
 - lib/cliver/version.rb
 - lib/core_ext/file.rb
 - spec/cliver/detector_spec.rb
+- spec/cliver/shell_capture_spec.rb
 - spec/cliver_spec.rb
 - spec/core_ext/file_spec.rb
 - spec/spec_helper.rb
+- spec/support/executable_mock.rb
 homepage: https://www.github.com/yaauie/cliver
 licenses:
 - MIT
@@ -160,7 +163,9 @@ specification_version: 3
 summary: Cross-platform version constraints for cli tools
 test_files:
 - spec/cliver/detector_spec.rb
+- spec/cliver/shell_capture_spec.rb
 - spec/cliver_spec.rb
 - spec/core_ext/file_spec.rb
 - spec/spec_helper.rb
+- spec/support/executable_mock.rb
 has_rdoc: yard