https://github.com/johansenja/open_source
Quickly open the source file of a Ruby Class, Module or Method in your $EDITOR
https://github.com/johansenja/open_source
debugging gem ruby
Last synced: 3 months ago
JSON representation
Quickly open the source file of a Ruby Class, Module or Method in your $EDITOR
- Host: GitHub
- URL: https://github.com/johansenja/open_source
- Owner: johansenja
- License: mit
- Created: 2022-01-07T14:41:06.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-01-08T14:59:35.000Z (over 4 years ago)
- Last Synced: 2025-10-08T01:28:35.255Z (9 months ago)
- Topics: debugging, gem, ruby
- Language: Ruby
- Homepage:
- Size: 13.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Open Source
Quickly open the source file of a Class, Module, or Method in your favourite editor, from Ruby.
## Usage
First make sure your EDITOR environment variable is set ([How do I find and set my $EDITOR environment variable?](https://askubuntu.com/questions/432524/how-do-i-find-and-set-my-editor-environment-variable)).
Then use as you wish
```ruby
# probably in a console, though doesn't have to be
require 'open_source' # not needed if it's in your Gemfile, and this environment is loaded by bundler
open_source "User" # opens file where User class is defined
oso User # same as above; use the aliases for ease of use!
oso Authenticable # opens file where Authenticable module is defined
oso :log # opens file where "log" method is defined
oso "log" # same
oso method :log # you get the idea
oso Rails.method(:application)
oso User.instance_method(:name)
```
Line numbers are supported too, currently for Vi and VsCode.
### Configuration
#### Using a specific editor for this gem
It's possible to use the `OPEN_SOURCE_GEM_EDITOR` env variable to set a specific editor for use with this gem, if you don't want to use your standard `EDITOR`.
For example:
```bash
# .bashrc or wherever
export EDITOR=vim # standard terminal based editor
export OPEN_SOURCE_GEM_EDITOR=gvim # a GUI version; opens in a different window. Takes priority over EDITOR
```
This is optional, and if you normally use a GUI editor anyway it probably won't be needed.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'open_source_location', require: "open_source"
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install open_source_location
Just make sure you then `require 'open_source'` where you need it.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/johansenja/open_source.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).