cliver 0.2.0 → 0.2.1

data/lib/cliver.rb

@@ -1,4 +1,7 @@
 # encoding: utf-8
+
+require File.expand_path('../core_ext/file', __FILE__)
+
 require 'cliver/version'
 require 'cliver/dependency'
 require 'cliver/detector'
@@ -37,14 +40,28 @@ module Cliver
   # @overload (see Cliver::Dependency#initialize)
   # @param (see Cliver::Dependency#initialize)
   # @option options [Boolean] :strict (true) @see Cliver::Dependency::initialize
-  # @raise (see Cliver::Dependency#assert!)
-  # @return (see Cliver::Dependency#assert!)
+  # @raise (see Cliver::Dependency#detect!)
+  # @return (see Cliver::Dependency#detect!)
   def self.assert(*args, &block)
     options = args.last.kind_of?(Hash) ? args.pop : {}
     args << options.merge(:strict => true)
     Dependency::new(*args, &block).detect!
   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!)
+  def self.verify!(executable, *args, &block)
+    unless File.absolute_path?(executable)
+      raise ArgumentError, "executable path must be absolute, " +
+                           "got '#{executable.inspect}'."
+    end
+    Dependency::new(executable, *args, &block).detect!
+  end
+
   extend self
 
   # Wraps Cliver::assert and returns truthy/false instead of raising

data/lib/cliver/dependency.rb

@@ -55,8 +55,22 @@ module Cliver
       @strict = options.fetch(:strict, false)
 
       @executables = Array(executables).dup.freeze
-
       @requirement = args unless args.empty?
+
+      check_compatibility!
+    end
+
+    # One of these things is not like the other ones...
+    # Some feature combinations just aren't compatible. This method ensures
+    # the the features selected for this object are compatible with each-other.
+    # @return [void]
+    # @raise [ArgumentError] if incompatibility found
+    def check_compatibility!
+      case
+      when @executables.any? {|exe| exe[File::SEPARATOR] && !File.absolute_path?(exe) }
+        # if the executable contains a path component, it *must* be absolute.
+        raise ArgumentError, "Relative-path executable requirements are not supported."
+      end
     end
 
     # Get all the installed versions of the api-compatible executables.
@@ -124,20 +138,18 @@ module Cliver
     # @api private
     # @raise [Cliver::Dependency::NotFound] with appropriate error message
     def raise_not_found!
-      raise Dependency::NotFound.new <<-EOERR
-        Could not find an executable #{@executables} on your path.
-      EOERR
+      raise Dependency::NotFound.new(
+        "Could not find an executable #{@executables} on your path.")
     end
 
     # @api private
     # @raise [Cliver::Dependency::VersionMismatch] with appropriate error message
     # @param installed [Hash<String,String>] the found versions
     def raise_version_mismatch!(installed)
-      raise Dependency::VersionMismatch.new <<-EOERR
-        Could not find an executable #{executable_description} that matched the
-        requirements #{requirements_description}.
-        Found versions were #{installed.inspect}
-      EOERR
+      raise Dependency::VersionMismatch.new(
+        "Could not find an executable #{executable_description} that " +
+        "matched the requirements #{requirements_description}. " +
+        "Found versions were #{installed.inspect}.")
     end
 
     # @api private
@@ -189,9 +201,15 @@ module Cliver
       paths = @path.sub('*', ENV['PATH']).split(File::PATH_SEPARATOR)
       cmds = strict? ? @executables.first(1) : @executables
 
+      detected_exes = []
       cmds.product(paths, exts).map do |cmd, path, ext|
-        exe = File.join(path, "#{cmd}#{ext}")
-        yield exe if File.executable?(exe)
+        exe = File.expand_path("#{cmd}#{ext}", path)
+
+        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
   end

data/lib/cliver/detector.rb

@@ -41,6 +41,13 @@ module Cliver
     #                    version number.
     def detect_version(executable_path)
       output = shell_out_and_capture version_command(executable_path).shelljoin
+      if $?.exitstatus == 127
+        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]
     end
 

data/lib/cliver/version.rb

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

data/lib/core_ext/file.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+class File
+  # determine whether a String path is absolute.
+  # @example
+  #   File.absolute_path?('foo') #=> false
+  #   File.absolute_path?('/foo') #=> true
+  #   File.absolute_path?('foo/bar') #=> false
+  #   File.absolute_path?('/foo/bar') #=> true
+  #   File.absolute_path?('C:foo/bar') #=> false
+  #   File.absolute_path?('C:/foo/bar') #=> true
+  # @param [String] - a pathname
+  # @return [Boolean]
+  def self.absolute_path?(path)
+    false | File.dirname(path)[/\A([A-Z]:)?#{Regexp.escape(File::SEPARATOR)}/i]
+  end
+end

data/spec/cliver_spec.rb

@@ -32,14 +32,14 @@ describe Cliver do
     args << options
   end
 
-  let(:path) { 'foo/bar:baz/bingo' }
+  let(:path) { '/foo/bar:/baz/bingo' }
   let(:executable) { 'doodle' }
   let(:requirement) { '~>1.1'}
 
   context 'when first-found version is sufficient' do
 
     let(:version_map) do
-      {'baz/bingo/doodle' => '1.2.1'}
+      {'/baz/bingo/doodle' => '1.2.1'}
     end
 
     context '::assert' do
@@ -55,20 +55,94 @@ describe Cliver do
     end
     context '::detect' do
       let(:method) { :detect }
-      it { should eq 'baz/bingo/doodle' }
+      it { should eq '/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 eq '/baz/bingo/doodle' }
+    end
+  end
+
+  context '::verify!' do
+    let(:method) { :verify! }
+    let(:version_map) do
+      {'/baz/bingo/doodle' => '0.2.1',
+       '/baz/fiddle/doodle' => '1.1.4'}
+    end
+    let(:args) do
+      args = [executable]
+      args.concat Array(requirement)
+      args << options
+    end
+    context 'when a relative path is given' do
+      let(:executable) { 'foo/bar/doodle' }
+      it 'should raise' do
+        expect { action }.to raise_exception ArgumentError
+      end
+    end
+    context 'when an absolute path is given' do
+      context 'and that path is not found' do
+        let(:executable) { '/blip/boom' }
+        it 'should raise' do
+          expect { action }.to raise_exception Cliver::Dependency::NotFound
+        end
+      end
+      context 'and the executable at that path is sufficent' do
+        let(:executable) { '/baz/fiddle/doodle' }
+        it 'should not raise' do
+          expect { action }.to_not raise_exception Cliver::Dependency::NotFound
+        end
+      end
+      context 'and the executable at that path is not sufficent' do
+        let(:executable) { '/baz/bingo/doodle' }
+        it 'should raise' do
+          expect { action }.to raise_exception Cliver::Dependency::VersionMismatch
+        end
+      end
+    end
+  end
+
+  context 'when given executable as a path' do
+    let(:version_map) do
+      {'/baz/bingo/doodle' => '1.2.1'}
+    end
+    let(:path) { '/fiddle/foo:/deedle/dee'}
+
+    context 'that is absolute' do
+      let(:executable) { '/baz/bingo/doodle' }
+      %w(assert dependency_unmet? detect detect).each do |method_name|
+        context "::#{method_name}" do
+          let(:method) { method_name.to_sym }
+          it 'should only detect its version once' do
+            Cliver::Dependency.any_instance.
+              should_receive(:detect_version).
+              once.
+              and_call_original
+            action
+          end
+        end
+      end
+    end
+
+    context 'that is relative' do
+      let(:executable) { 'baz/bingo/doodle' }
+      %w(assert dependency_unmet? detect detect).each do |method_name|
+        context "::#{method_name}" do
+          let(:method) { method_name.to_sym }
+          it 'should raise an ArgumentError' do
+            expect { action }.to raise_exception ArgumentError
+          end
+        end
+      end
     end
   end
 
   context 'when first-found version insufficient' do
     let(:version_map) do
-      {'baz/bingo/doodle' => '1.0.1'}
+      {'/baz/bingo/doodle' => '1.0.1'}
     end
     context '::assert' do
       let(:method) { :assert }
@@ -94,8 +168,8 @@ describe Cliver do
     context 'and when sufficient version found later on path' do
       let(:version_map) do
         {
-          'foo/bar/doodle'    => '0.0.1',
-          'baz/bingo/doodle'  => '1.1.0',
+          '/foo/bar/doodle'    => '0.0.1',
+          '/baz/bingo/doodle'  => '1.1.0',
         }
       end
       context '::assert' do
@@ -110,14 +184,14 @@ describe Cliver do
       end
       context '::detect' do
         let(:method) { :detect }
-        it { should eq 'baz/bingo/doodle'}
+        it { should eq '/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 eq '/baz/bingo/doodle' }
       end
     end
   end
@@ -154,26 +228,26 @@ describe Cliver do
       context 'and primary sufficient' do
         let(:version_map) do
           {
-            'baz/bingo/primary' => '1.1',
-            'foo/bar/fallback' => '1.1'
+            '/baz/bingo/primary' => '1.1',
+            '/foo/bar/fallback' => '1.1'
           }
         end
         context '::detect' do
           let(:method) { :detect }
-          it { should eq 'baz/bingo/primary' }
+          it { should eq '/baz/bingo/primary' }
         end
       end
       context 'and primary insufficient' do
         let(:version_map) do
           {
-            'baz/bingo/primary' => '2.1',
-            'foo/bar/fallback' => '1.1'
+            '/baz/bingo/primary' => '2.1',
+            '/foo/bar/fallback' => '1.1'
           }
         end
         context 'the secondary' do
           context '::detect' do
             let(:method) { :detect }
-            it { should eq 'foo/bar/fallback' }
+            it { should eq '/foo/bar/fallback' }
           end
         end
       end
@@ -182,12 +256,12 @@ describe Cliver do
       context 'and sufficient secondary does' do
         let(:version_map) do
           {
-            'foo/bar/fallback' => '1.1'
+            '/foo/bar/fallback' => '1.1'
           }
         end
         context '::detect' do
           let(:method) { :detect }
-          it { should eq 'foo/bar/fallback' }
+          it { should eq '/foo/bar/fallback' }
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cliver
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-08 00:00:00.000000000 Z
+date: 2013-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,6 +128,7 @@ files:
 - lib/cliver/detector.rb
 - lib/cliver/filter.rb
 - lib/cliver/version.rb
+- lib/core_ext/file.rb
 - spec/cliver/detector_spec.rb
 - spec/cliver_spec.rb
 - spec/spec_helper.rb