Module: Physique::ToolLocator

Includes:
Albacore::Logging
Included in:
FluentMigrator::Config, SqlCmd::Config, TasksBuilder
Defined in:
lib/physique/tool_locator.rb

Defined Under Namespace

Classes: ToolNotFoundError

Instance Method Summary collapse

Instance Method Details

#locate_tool(paths, options = {}) ⇒ Object

Allows you to locate a tool on disk given a file specification. For example…

locate_tool 'C:/Program Files/Microsoft SQL Server/**/Tools/Binn/SQLCMD.EXE'

The tool sorts any matching executables in descending order to that the most recent version is returned. To change this behavior call the method with the reverse option.

locate_tool 'C:/path/to/**/tool.exe', find_latest: false

Throws a ToolNotFoundError if no tool could be found.

Raises:



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/physique/tool_locator.rb', line 18

def locate_tool(paths, options = {})
  # FileList only correctly handles forward-slashes, even on Windows
  paths = paths.gsub('\\', '/')

  debug { "Extracting paths from the following pattern #{paths}" }
  paths = FileList[paths] unless paths.respond_to?(:each)

  debug { "Attempting to locate tool in the following paths #{paths}" }
  opts = Map.options(options)
  opts = opts.apply :find_latest => true
  paths = paths.collect { |p| which(p) }.compact.sort
  paths = paths.reverse if opts[:find_latest]
  tool = paths.first

  raise ToolNotFoundError, "Could not find tool in the following paths: \n #{paths}" if tool.nil?
  tool
end

#which(exe) ⇒ Object 



36
37
38
 
# File 'lib/physique/tool_locator.rb', line 36

def which(exe)
  Albacore::CrossPlatformCmd.which(exe) ? exe : nil;
end