ruby_jard 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fb53f5406279a5047c3f73ec387bcb889e98e31ed7352393a459d8bc2611e08
-  data.tar.gz: f136e3adb604ce7b469d3528fdf5af617776e25feeeb303f45a94189a94803b2
+  metadata.gz: 61f5671a65db3b0ee5292d98b0310ca43668a52582bc88db04a377d26715bfff
+  data.tar.gz: 60c444c9870f556569077b9022e145602c693178f1b0c1ec02a6783a75a99796
 SHA512:
-  metadata.gz: f44eebc7ef5d413fb8b6ac44b5575a4ac31b71ad419a7800be68884d1c32564738c2d84276d471704c22bdad4cc36173f30bcfe8111f1081a002d7d343fcd400
-  data.tar.gz: 353d35eabfc1a3eb33e32a2c193bb3261b68e794c9a2293f335245f57b23fdf45405b70c6fb9071d10867c56a1051ac4f987c20199931fd5224af0d1d92a545e
+  metadata.gz: c149e4a6482b4792279a956a2f51287c6af95361213b13a63d69101925f71bf7719b04bae4a9ee9cb4526ab1a86bba9c546a290241acd1d9baee0fe2a218108e
+  data.tar.gz: 4825219c8b45ba878d31fe2159e45d0e89a73ae44d2f3acabee15e58b16901bb37adf14aeb6d833d2dafab9b8cbf3a7115ad334d07c22f0ebd8586644bd5f5f1

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+ - OS: [e.g. Ubuntu 20, MacOS Big Suck, FreeBSD]
+ - Terminal Emulator [e.g Alacritty, Terminal.app (Mac's default one), GNOME Terminal (Ubuntu's default one), etc.]
+- Output when you run `tput colors` in your terminal
+- Output when you run `echo $TERM` in your terminal
+- Output when you run `stty`
+- Do you use tmux/screen or similar tty multiplexer?

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/workflows/ruby.yml

@@ -0,0 +1,85 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.5
+    - name: Install tmux
+      run: sudo apt install -y tmux
+    - name: Start tmux
+      run: tmux start-server
+    - name: Install dependencies
+      run: bundle install
+    - name: Checking offenses
+      run: bundle exec rubocop
+  test-ubuntu:
+    strategy:
+      matrix:
+        ruby: [2.5, 2.6, 2.7.1]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install tmux
+      run: sudo apt install -y tmux
+    - name: Start tmux
+      run: tmux start-server
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rspec
+  test-macos:
+    strategy:
+      matrix:
+        ruby: [2.5, 2.6, 2.7.1]
+    runs-on: macos-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install tmux
+      run: brew install tmux
+    - name: Start tmux
+      run: tmux start-server
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rspec
+  test-previous-byebug:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        byebug: [9.1.0, 10.0.2]
+    env:
+      BUNDLE_GEMFILE: "./spec/gemfiles/Gemfile-byebug-${{ matrix.byebug }}"
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.5
+    - name: Install tmux
+      run: sudo apt install -y tmux
+    - name: Start tmux
+      run: tmux start-server
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -9,4 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+.ruby-version
 Gemfile.lock

data/.rubocop.yml

@@ -1,3 +1,8 @@
+require: rubocop-rspec
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
 Lint/NonLocalExitFromIterator:
   Enabled: false
 Naming/MethodParameterName:
@@ -11,9 +16,11 @@ Style/NumericPredicate:
 Style/IfUnlessModifier:
   Enabled: false
 Metrics/MethodLength:
-  Max: 20
+  Max: 30
 Metrics/PerceivedComplexity:
   Max: 15
+Metrics/CyclomaticComplexity:
+  Max: 15
 Metrics/AbcSize:
   Enabled: false
 Metrics/ParameterLists:
@@ -22,5 +29,67 @@ Metrics/ClassLength:
   Enabled: false
 Layout/HashAlignment:
   Enabled: false
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/DuplicateElsifCondition:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/AccessorGrouping:
+  Enabled: true
+Style/ArrayCoercion:
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Enabled: true
+Style/CaseLikeIf:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashAsLastArrayItem:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashLikeCase:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+Style/EvalWithLocation:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/DescribeClass:
+  Enabled: false
+RSpec/NestedGroups:
+  Max: 4
+
 AllCops:
   TargetRubyVersion: 2.5
+  Exclude:
+      - '**/*_example.rb'

data/CHANGELOG.md

@@ -1,5 +1,36 @@
 # Changelog
 
+## [0.2.3 - Alpha 4]
+
+### UX/UI
+- Add `gruvbox`, `256-light`, `one-half-dark`, and `one-half-light` color scheme
+- Add `jard output` command
+- Add `jard hide` command
+- Add `jard show` command
+- Add `alias_to_debugger`, `enabled_screens` option
+- Add responsive layouts to fit into different screen sizes
+- Auto-adjust screens to utilize spaces on the screen
+- Move variable screen to the right again (sorry :pray:)
+- Small colorless friendly adjustment to variable and thread marks
+
+### Bug fixes
+- Jard doesn't work when place at the end of a method, or a block.
+- Box title overflow
+- Source screen doesn't work well with anonymous evaluation, or `ruby -e`
+- Auto-completion with tab of pry (actually readline) is broken
+- Could not exit when starting Jard inside irb
+- Repl is broken if the keyboard repeat rate is too high.
+- Fix broken frame command
+
+### Internal & Refactoring
+- Add tests for critical sections
+- Use PTY to feed output from pry to actual STDOUT
+- Use a custom pager to allow internal customization
+- Improve performance of Jard when working with process with plenty of threads
+- Handle key-binding spamming well
+- Lazily load screen data
+- Support byebug >= 9.1.0
+
 ## [0.2.2 - Alpha 3]
 
 ### UX/UI

data/Gemfile

@@ -4,9 +4,12 @@ source 'http://rubygems.org'
 
 gemspec
 
-gem 'aruba', '~> 1.0.2'
 gem 'byebug', '~> 11.1.0'
-gem 'pry', '~> 0.13.0'
 gem 'rake', '~> 12.0'
 gem 'rspec', '~> 3.0'
-gem 'rubocop', '~> 0.86'
+gem 'rubocop', '~> 0.88'
+gem 'rubocop-rspec', require: false
+
+group :test do
+  gem 'rspec-retry'
+end

data/README.md

@@ -1,6 +1,6 @@
 ![Ruby Jard](./docs/logo.jpg)
 
-Jard stands for Just Another Ruby Debugger, aims to provide a better experience while debugging Ruby. Ruby Jard provides modular visual interfaces to show relevant information about your debugging program. Those interfaces are optimized for usability, and highly friendly to developers, especially new comers. They help you reduce the commands you need to type, the mental efforts wasted trying to navigate and grab the information you need. As a result, you can now focus more on the debug flow. 
+Jard stands for Just Another Ruby Debugger, aims to provide a better experience while debugging Ruby. Ruby Jard provides modular visual interfaces to show relevant information about your debugging program. Those interfaces are optimized for usability, and highly friendly to developers, especially new comers. They help you reduce the commands you need to type, the mental efforts wasted trying to navigate and grab the information you need. As a result, you can now focus more on the debug flow.
 
 [![Ruby Jard Demo](./docs/demo.png)](https://asciinema.org/a/350233)
 
@@ -94,7 +94,7 @@ Show all the threads running at the moment. This panel is useful when you are wo
 
 An interactive Repl for you to interact with your program, inspect values, update values, or control the debug flow as you want. The heart of Jard's repl is [Pry](https://github.com/pry/pry), a masterpiece gem. When you type a command, Jard parses, and does corresponding actions if what you type matches supported command. Otherwise, they are evaluated as Ruby code.
 
-## Commands
+## Flow Commands
 
 ### List
 
@@ -114,6 +114,13 @@ Refresh the whole terminal UI. This command doesn't move you to other steps, nor
 
 **Alias**: `s`
 
+**Examples:**
+
+```
+step     # Step once
+step 3   # Step 3 times
+```
+
 Detect and step into a method call or block in the current line. If there isn't anything to step in, the program continues to next line. In case there are multiple methods on the same line, Jard hornors Ruby's execution order.
 
 ### Step out
@@ -124,7 +131,14 @@ Detect and step into a method call or block in the current line. If there isn't
 
 **Alias**: `so`
 
-The opposite of step out. This command is used to finish the execution of current frame, and jump to the next line of upper frame. In other words, this command is equivalent to the sequence `up` and `next`. If the neighbor frame already finishes, it continues with even higher frame.
+**Examples:**
+
+```
+step-out     # Step out once
+step-out 3   # Step out 3 times
+```
+
+The opposite of step. This command is used to finish the execution of current frame, and jump to the next line of upper frame. In other words, this command is equivalent to the sequence `up` and `next`. If the neighbor frame already finishes, it continues with even higher frame.
 
 This command is useful when you loose your interest in frame, and want to quickly go up again. One example is that you accidentally step into a longgggg loop with nothing useful. Another example is that you step into the library source code and don't really care what it does underlying.
 
@@ -136,6 +150,13 @@ This command is useful when you loose your interest in frame, and want to quickl
 
 **Alias**: `n`
 
+**Examples:**
+
+```
+next     # Next instruction
+next 3   # Next 3 next instructions
+```
+
 Continue to the next line in the current frame, by pass any steppable method call or blocks in the mid way unless they contains dynamic breakpoint or any `jard` attachment command. If the current frame already reaches the end, it continues to the next line of upper frame and so on.
 
 ### Continue
@@ -154,6 +175,13 @@ Continue the execution of your program to the end, or stop at the first dynamic
 
 **Key binding**: F6
 
+**Examples:**
+
+```
+up     # Move to upper frame
+up 3   # Move to upper 3 frames
+```
+
 Explore the upper frame. When you use this command, all associated displaying screens will be updated accordingly, but your program current position is still at the latest frame. This command is mostly used to explore, and view the trace, input parameters, or how your program stops at the current position. When use this command, you should have a glance at Variable panel, and Source panel to see the variables at destination frame.
 
 You can combine with `next` or `step` to perform powerful execution redirection at the destination frame. Let's look at an example. You are debugging a chain of 10 rack middlewares, you go deep into the #9 middleware, found something, then want to go back to #5 middleware. It's pretty boring and frustrated to just use `next` or `step-out` and hope it eventually goes back. Now use `up` for some times (or `frame`, described below) to go to your desired frame, and use `next` there. Tada, it's magical, just like teleport.
@@ -166,24 +194,108 @@ One note is that you cannot explore a frame in c.
 
 **Key binding**: Shift+F6
 
+**Examples:**
+
+```
+down     # Move to lower frame
+down 3   # Move to lower 3 frames
+```
+
 Explore the lower frame. See `up` command for more information.
 
 ### Frame
 
-**Repl command**: `frame <frame_id>`
+**Repl command**: `frame [-h] [frame_id]`
 
 **Key binding:** None
 
-**Examples**:`frame 10`
+**Examples:**
+
+```
+frame 0     # Jump to frame 0
+frame 7     # Jump to frame 7
+```
 
 Explore a particular frame with id `<frame_id>`. It's faster than `up` and `down`. See `up` command for more information.
 
+## Control commands
+
+All control commands start with`jard` namespaces. This class of commands are used to control the visual interfaces, configuration, or specific operations provided by Jard.
+
+### Color scheme
+
+**Repl command**: `jard color-scheme [-l|-h] [frame_id]`
+
+**Key binding:** None
+
+**Examples:**
+
+```
+jard color-scheme -l # List all available color schemes
+# Output:
+# jard >>
+# 256
+# deep-space
+# gruvbox
+jard color-scheme deep-space # Switch to color scheme deep-space
+```
+
+List all available color schemes, or switch to a particular color scheme at runtime.
+
+### Show
+
+**Repl command**: `jard show [screen]`
+
+**Key binding:** None
+
+**Examples:**
+
+```
+jard show variables
+jard show threads
+```
+
+Show a particular screen on the current interface. 
+
+### Hide
+
+**Repl command**: `jard hide [screen]`
+
+**Key binding:** None
+
+**Examples:**
+
+```
+jard hide variables
+jard hide threads
+```
+
+Hide a particular screen from the current interface. 
+
+### Output
+
+**Repl command**: `jard output`
+
+**Key binding:** None
+
+**Examples:**
+
+```
+jard output
+```
+
+Show all the program output in a pager, allowing navigation, searching (powered by GNU Less). Note that the output are only captured only after Jard already started. All the previous output could not be captured.
+
 ## Color schemes
 
 | Name                                                         | Screenshots                                                  |
 | ------------------------------------------------------------ | ------------------------------------------------------------ |
 | `256` <br />Default theme, 256 basic colors, supported by all terminals | <img src="./docs/color_schemes/256.png" style="max-width: 400px;" /> |
+| `256-light`                                                  | <img src="./docs/color_schemes/256-light.png" style="max-width: 400px;" /> |
 | `deep-space`                                                 | <img src="./docs/color_schemes/deep-space.png" style="max-width: 400px;" /> |
+| `gruvbox`                                                    | <img src="./docs/color_schemes/gruvbox.png" style="max-width: 400px;" /> |
+| `one-half-dark`                                              | <img src="./docs/color_schemes/one-half-dark.png" style="max-width: 400px;" /> |
+| `one-half-light`                                             | <img src="./docs/color_schemes/one-half-light.png" style="max-width: 400px;" /> |
 
 
 
@@ -196,14 +308,16 @@ Ruby Jard supports customization via pre-loaded configuration files. You can con
 
 There are some supported configurations:
 
-| Name           | Description                                                  | Default |
-| -------------- | ------------------------------------------------------------ | ------- |
-| `color_scheme` | Choose your favorite color scheme. The list of color schemes can be looke up in [Color schemes session](#color-schemes), or from `color-scheme -l` command in REPL. | `256`   |
+| Name                | Description                                                  | Default |
+| ------------------- | ------------------------------------------------------------ | ------- |
+| `color_scheme`      | Choose your favorite color scheme. The list of color schemes can be looke up in [Color schemes session](#color-schemes), or from `jard color-scheme -l` command in REPL. | `256`   |
+| `alias_to_debugger` | Use `debugger` instead of `jard` when debugging. | `false`   |
 
 This is a complete example of a configuration file:
 
 ```ruby
 config.color_scheme = "deep-space"
+config.alias_to_debugger = true
 ```
 
 ## Roadmap