Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nguyenquangminh0711/ruby_jard
Just Another Ruby Debugger. Provide a rich Terminal UI that visualizes everything your need, navigates your program with pleasure, stops at matter places only, reduces manual and mental efforts. You can now focus on real debugging.
https://github.com/nguyenquangminh0711/ruby_jard
console debugger hacktoberfest ruby ruby-debugger syntax-highlighting terminal tty visual
Last synced: 3 months ago
JSON representation
Just Another Ruby Debugger. Provide a rich Terminal UI that visualizes everything your need, navigates your program with pleasure, stops at matter places only, reduces manual and mental efforts. You can now focus on real debugging.
- Host: GitHub
- URL: https://github.com/nguyenquangminh0711/ruby_jard
- Owner: 0x2c7
- License: mit
- Archived: true
- Created: 2020-06-21T07:20:43.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-18T17:19:17.000Z (almost 2 years ago)
- Last Synced: 2024-06-12T19:44:02.963Z (5 months ago)
- Topics: console, debugger, hacktoberfest, ruby, ruby-debugger, syntax-highlighting, terminal, tty, visual
- Language: Ruby
- Homepage: https://rubyjard.org/
- Size: 17.7 MB
- Stars: 846
- Watchers: 15
- Forks: 28
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-vietnamese - Ruby JARD
README
[
](https://rubyjard.org/)
   [](https://webuild.community)
Ruby Jard provides a rich Terminal UI that visualizes everything your need, navigates your program with pleasure, stops at matter places only, reduces manual and mental efforts. You can now focus on real debugging.
Please visit [https://rubyjard.org/](https://rubyjard.org/) for more information.
[](https://asciinema.org/a/358874)
*[(Click for demo video)](https://asciinema.org/a/358874)*
**Note**: Ruby Jard is still under heavy development. Bugs and weird behaviors are expected. If you see one, please don't hesitate to [open an issue](https://github.com/nguyenquangminh0711/ruby_jard/issues). I'll try my best to fix.
## Install Ruby Jard
### Bundler
Add one of those lines into your Gemfile. **Note**: Ruby Jard is discouraged to use on production environment.
```ruby
gem 'ruby_jard', group: :development
```
```bash
❯ bundle install
```
If you would like to use Ruby Jard to debug a test, you can add to group test too.
```ruby
gem 'ruby_jard', group: [:development, :test]
```
If you would like to use edged developing version of Ruby Jard:
```ruby
gem 'ruby_jard', group: :development, git: 'https://github.com/nguyenquangminh0711/ruby_jard'
```
### Ruby Gem
If you want to install Ruby Jard independently from bundler:
```bash
gem install ruby_jard
```
If you want to install a specific version published on [Ruby gems](https://rubygems.org/gems/ruby_jard):
```bash
gem install [email protected]
```
## Run your program with Ruby Jard
To use Ruby Jard, you just need to put `jard` magic method **before** any places you want to stop. Jard supports stopping at anywhere, including top level binding, instance methods, class methods, string evaluation, or even inside a class declaration.
```ruby
def test_method(input)
a = 1
b = 2
jard # Debugger will stop here
c = a + b + input
end
class TestClass
jard # Yes, it can stop here too
@dirty_class_method = 1 + 1
def test_method
jard
end
def self.test_class_method
jard
end
end
jard
test_method(5)
```
Afterward, run your program, just like normally. If your program meets `jard` execution break point, it gonna stop, show the UI, and let you debug.
In case you meet error `undefined local variable or method jard`, please require ruby_jard manually at initializing scripts. If you use Ruby Jard with famous frameworks, ruby_jard will be loaded by default
```ruby
require 'ruby_jard'
```
Please visit [https://rubyjard.org/](https://rubyjard.org/) for more information.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/nguyenquangminh0711/ruby_jard. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/nguyenquangminh0711/ruby_jard/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the RubyJard project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ruby_jard/blob/master/CODE_OF_CONDUCT.md).