Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stevenharman/which-rb
Find the full path to a command, based on the current $PATH and $PATHEXT (Windows).
https://github.com/stevenharman/which-rb
Last synced: 2 days ago
JSON representation
Find the full path to a command, based on the current $PATH and $PATHEXT (Windows).
- Host: GitHub
- URL: https://github.com/stevenharman/which-rb
- Owner: stevenharman
- License: mit
- Created: 2024-03-14T02:17:40.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-03-14T02:57:15.000Z (7 months ago)
- Last Synced: 2024-04-15T01:15:45.752Z (6 months ago)
- Language: Ruby
- Size: 13.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Which
Unix-like systems have long had a `which` command to identify the location of an executable.
`Which` is a Ruby library that does the same thing, across Unix-like systems and Windows.
It's meant for use within other Ruby libraries or applications, rather than as a command line tool itself.
For example `Which` might be used to auto-discover the path to a command line tool your application needs to shell out to.
Or similarly, to auto-configure the path to a command your tool is wrapping.
For example, a wrapper for [Ghostscript][ghostscript] might use `Which` to auto-configure the path to `gs`, and throw an error if it cannot be found.
`Which` works by searching for the specified command along `$PATH`.
It takes care to use OS-specific `$PATH`-separators, as well as Windows-specific executable file extensions (`$PATHEXT`).
`Which` also ensures the command is really is an executable file (and not a directory).
[ghostscript]: https://www.ghostscript.com "Ghostscript"
## Installation
Install the gem and add to the application's Gemfile:
```console
bundle add which
```
If Bundler is not being used to manage dependencies, install the gem:
``` console
gem install which
```
## Usage
When the command is on `$PATH`:
```ruby
Which.call("git") #=> "/opt/homebrew/bin/git"
# Or, an alternative syntax
Which.("git") #=> "/opt/homebrew/bin/git"
```
Searching for a command NOT on `$PATH`
```ruby
Which.call("foobar") #=> nil
```
Searching for a non-executable command:
```ruby
Which.call("plain.txt") #=> nil
```
Searching for a directory, even if it's on `$PATH`
```ruby
Which.call("somedir") #=> nil
```
`Which` can also handle absolute paths to a command.
This can be useful for validating a command you already know about exists, and is executable.
```ruby
Which.call("/usr/local/bin/vim") #=> "/usr/local/bin/vim"
Which.call("/usr/local/bin/emacs") #=> nil
```
## Development
After checking out the repo, run `bin/setup` to install dependencies.
Then, run `bin/spec` to run the tests.
You can also run `bin/console` for an interactive prompt that will allow you to experiment.
### Local Install
To install this gem onto your local machine, run `bin/rake install`.
### Cutting a new version
Update the version number in `version.rb`, and be sure the `CHANGELOG` is up to date.
Then run `bin/rake release`, which will
1. create a git tag for the version
1. push git commits and the created tag
1. push the `.gem` file to [rubygems.org][rubygems]
[rubygems]: https://rubygems.org "RubyGems | Your community gem host"
## Contributing
Bug reports and pull requests are welcome on GitHub at [https://github.com/stevenharman/which]().
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).