piotrmurach / tty-which

Cross-platform implementation of Unix `which` command

TTY::Which

Platform independent implementation of Unix which utility that searches for executable file in the path variable.

TTY::Which provides cross-platform executables search component for TTY toolkit.

Installation

Add this line to your application's Gemfile:

gem "tty-which"

And then execute:

$ bundle

Or install it yourself as:

$ gem install tty-which

Usage

TTY::Which has which method that searches set of directories for an executable file based on the PATH environment variable.

When the path to an executable program exists, an absolute path is returned, otherwise nil.

For example, to find location for an executable program do:

TTY::Which.which("less")  # => "/usr/bin/less"
TTY::Which.which("git")   # => "C:\Program Files\Git\bin\git"

You can also check an absolute path to executable:

TTY::Which.which("/usr/bin/ruby")  # => "/usr/bin/ruby"

You can also specify directly the paths to search using :paths keyword:

TTY::Which.which("ruby", paths: ["/usr/local/bin", "/usr/bin", "/bin"])
# => "/usr/local/bin/ruby"

When you're only interesting in knowing that an executable exists on the system use the exist? call:

TTY::Which.exist?("ruby") # => true

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/piotrmurach/tty-which. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

1. Fork it ( https://github.com/piotrmurach/tty-which/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Copyright

Copyright (c) 2015 Piotr Murach. See LICENSE for further details.

tty-which's Issues

Test failures

Hi,

There are some test failures:

FFF..............

Failures:

  1) TTY::Which#which with extension handles path with executable file C:\Program Files\Git\bin\git
     Failure/Error: expect(Which.which(path_with_exe_file)).to eq(expected_path)
     
     RuntimeError:
       CRITICAL: RUBYGEMS_ACTIVATION_MONITOR.owned?: before false -> after true
     # ./spec/unit/which_spec.rb:86:in `block (3 levels) in <top (required)>'
     # ------------------
     # --- Caused by: ---
     # NameError:
     #   uninitialized constant RSpec::Support::Differ
     #   ./spec/unit/which_spec.rb:86:in `block (3 levels) in <top (required)>'

  2) TTY::Which#which with extension searches path for executable git
     Failure/Error: expect(Which.which(cmd)).to eq(expected_path)
     
     NameError:
       uninitialized constant RSpec::Support::Differ
     # ./spec/unit/which_spec.rb:122:in `block (3 levels) in <top (required)>'

  3) TTY::Which#which with extension searches path for executable git.exe
     Failure/Error: expect(Which.which(cmd)).to eq(expected_path)
     
     NameError:
       uninitialized constant RSpec::Support::Differ
     # ./spec/unit/which_spec.rb:103:in `block (3 levels) in <top (required)>'

Top 2 slowest examples (0.01244 seconds, 36.8% of total time):
  TTY::Which#which with extension handles path with executable file C:\Program Files\Git\bin\git
    0.00952 seconds ./spec/unit/which_spec.rb:72
  TTY::Which#exist? fails to find executable in the path
    0.00292 seconds ./spec/unit/exist_spec.rb:11

Top 2 slowest example groups:
  TTY::Which#which
    0.00319 seconds average (0.02234 seconds / 7 examples) ./spec/unit/which_spec.rb:3
  TTY::Which#exist?
    0.00185 seconds average (0.0037 seconds / 2 examples) ./spec/unit/exist_spec.rb:3

Finished in 0.03384 seconds (files took 0.1605 seconds to load)
17 examples, 3 failures

Failed examples:

rspec ./spec/unit/which_spec.rb:72 # TTY::Which#which with extension handles path with executable file C:\Program Files\Git\bin\git
rspec ./spec/unit/which_spec.rb:107 # TTY::Which#which with extension searches path for executable git
rspec ./spec/unit/which_spec.rb:89 # TTY::Which#which with extension searches path for executable git.exe

Randomized with seed 58345

Any clue about the fix?

Fails on windows for file with custom extension

On windows you can run TTY::Which.which('something.py') for example and it will return false no matter if .py is in PATHEXT or not. It looks like File.executable? returns false in this case, possibly because it does not know how to deal with windows ACLs.

It looks like File.stat returns 0644 for a file such as this, even though I have the Read & Execute ACL. This may be a bug in ruby or in whatever ruby is using to translate windows ACLs into POSIX mode bits.