ruby_jard 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4eaeb2003b2133100d1723d4fc5b3de3ea0ce6c1fd9f5e754a69ac7a489198d4
-  data.tar.gz: a1389c55f973eacda0e4fa6fdbf4b4f6f23feb6cf1ab38050f7fd3f8a1d689ed
+  metadata.gz: e5a458f6dbabbed48b8cb322d6ac9a3c52e664309b1a1bfde1e90f91921092b6
+  data.tar.gz: e54b2ddcebc06c72fd78b4cc34dc99aba60eb1ba7d20d6815e0c4d88c39d2076
 SHA512:
-  metadata.gz: 04f8ca93a51eef68e3139fa58a5d7acb5ece7f79023dcff53bde4796628518f7fdc86a40903df1d680f4e13c86542a9b48fdc228a899c15674bb9a18e33d8419
-  data.tar.gz: 73608c00fe978926adaf05361e7d1467a6c9da325e6cdeba71ed25ddb00e8d027b788ca9154c2c74c13f4b36dbe4502b2e9f12fb9c82ba815b0967c7fa84765e
+  metadata.gz: '079110d831bc4729fe3c5ac9a33726d396cd4df50b889890f5b7e602d7e8d6717cf6e48b6038c4e653e2de2ae2ae4d44da6a0790d6f63be67e573475d59a0980'
+  data.tar.gz: fe4711967e8d0f3a81962038b1d7d40b319934f323ed6d942bde0f918125971e76bc49a73c603347c4e6be07618bf3950236ef0e868b07c587a2d1583cf7cbe6

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+ko_fi: nguyenquangminh0711

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/documentation.yml

@@ -0,0 +1,65 @@
+name: documentation
+
+on:
+  pull_request:
+    branches: [master]
+  push:
+    branches: [master]
+
+jobs:
+  checks:
+    if: github.event_name != 'push'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '12.x'
+      - name: Test Build
+        run: |
+          cd website
+          if [ -e yarn.lock ]; then
+          yarn install --frozen-lockfile
+          elif [ -e package-lock.json ]; then
+          npm ci
+          else
+          npm i
+          fi
+          npm run build
+  gh-release:
+    if: github.event_name != 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '12.x'
+      - name: Add key to allow access to repository
+        env:
+          SSH_AUTH_SOCK: /tmp/ssh_agent.sock
+        run: |
+          mkdir -p ~/.ssh
+          ssh-keyscan github.com >> ~/.ssh/known_hosts
+          echo "${{ secrets.GH_PAGES_DEPLOY }}" > ~/.ssh/id_rsa
+          chmod 600 ~/.ssh/id_rsa
+          cat <<EOT >> ~/.ssh/config
+          Host github.com
+          HostName github.com
+          IdentityFile ~/.ssh/id_rsa
+          EOT
+      - name: Release to GitHub Pages
+        env:
+          USE_SSH: true
+          GIT_USER: git
+        run: |
+          git config --global user.email "actions@gihub.com"
+          git config --global user.name "gh-actions"
+          cd website
+          if [ -e yarn.lock ]; then
+          yarn install --frozen-lockfile
+          elif [ -e package-lock.json ]; then
+          npm ci
+          else
+          npm i
+          fi
+          npx docusaurus deploy

data/.github/workflows/rspec.yml

@@ -0,0 +1,96 @@
+name: Rspec
+
+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 dependencies
+      run: bundle install
+    - name: Checking offenses
+      run: bundle exec rubocop
+  test-ubuntu:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 2.6, 2.7.1, head]
+    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: Start dummy tmux session
+      run: tmux new-session -t dummy -d
+    - name: Wait for tmux
+      run: ruby spec/wait_for_tmux.rb
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec parallel_rspec spec/
+  test-macos:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 2.6, 2.7.1, head]
+    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: start dummy tmux session
+      run: tmux new-session -t dummy -d
+    - name: Wait for tmux
+      run: ruby spec/wait_for_tmux.rb
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec parallel_rspec -n 2 spec/
+  test-byebug:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      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: start dummy tmux session
+      run: tmux new-session -t dummy -d
+    - name: Wait for tmux
+      run: ruby spec/wait_for_tmux.rb
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec parallel_rspec spec/

data/.gitignore

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

data/.rubocop.yml

@@ -1,13 +1,101 @@
+require: rubocop-rspec
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+Lint/NonLocalExitFromIterator:
+  Enabled: false
+Naming/MethodParameterName:
+  Enabled: false
 Style/SymbolArray:
   Enabled: false
+Style/GuardClause:
+  Enabled: false
+Style/NumericPredicate:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
 Metrics/MethodLength:
-  Max: 20
+  Max: 30
 Metrics/PerceivedComplexity:
   Max: 15
+Metrics/CyclomaticComplexity:
+  Max: 15
+Metrics/AbcSize:
+  Enabled: false
 Metrics/ParameterLists:
   Enabled: false
 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
+Style/NilComparison:
+  Enabled: false
+Style/NonNilCheck:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/DescribeClass:
+  Enabled: false
+RSpec/NestedGroups:
+  Max: 4
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
 AllCops:
   TargetRubyVersion: 2.5
-
+  Exclude:
+      - '**/*_example.rb'

data/CHANGELOG.md

@@ -0,0 +1,112 @@
+# Changelog
+
+## [0.3.0 - Beta 1]
+- Filter feature
+- New variable screen look and feel
+- Improve website and documentation page.
+- Improve color-scheme command
+- Use Thread sequential label instead of Thread's object id
+- Complete testing infrastructure.
+- Fix multiple performance issues.
+
+### Bug fixes
+- Solve program output performance degrade ([#21](https://github.com/nguyenquangminh0711/ruby_jard/pull/21))
+
+## [0.2.3 - Final Alpha]
+
+### 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 4]
+
+### UX/UI
+- Add `wehereami` as an alias for `list` command
+- Add `theme` command to switch theme at runtime
+- Load configuration file when Jard starts
+
+### Bug fixes
+- Backward compatible issue: Array#filter is available in ruby 2.5.x and above.
+- Fix Jard is bypassed when writting something to stdout while debugging (https://github.com/nguyenquangminh0711/ruby_jard/pull/5)
+
+## [0.2.1 - Alpha 3] - Render mechanism and theme system
+### UX/UI
+- New color scheme: 256, as the default color scheme. It works well with all 256-color terminal emulators.
+- New color scheme: deep-space. It's a 24-bit color scheme.
+- UX change: swap positions of default panels:
+    ```
+      Source    | Backtrace
+      Variables | Threads
+    ```
+- New narrow layout, which consists of source and variables only. Useful when running tests.
+- Add aliases to common commands
+### Bug fixes
+- https://github.com/nguyenquangminh0711/ruby_jard/issues/2
+- Fix display bug that some rows are out of screen if above rows have word wraps.
+### Internal Refactoring
+- New rendering mechanism, that supports data windowing, selection locating, and cursor.
+- Improve compatibility, and add fallbacks in case io/console, or tput are not available.
+
+## [0.2.0 - Alpha 2] - UI completeness
+
+### UX/UI
+- Improve box drawing.
+- Isolate jard-related UI in an alternative termnial, just like Vim or Less.
+- Restore printed information from STDOUT and STDERR after jard exits.
+- Support keyboard shortcut.
+- Support erb, haml highlighting.
+- Increase contrast and enhance color scheme.
+- Remove `finish` command.
+- Add `frame` command.
+- Add `step-out` command.
+- Remove useless inline variables.
+- Indicate types and inline variables in variable screen.
+
+### Bug fixes
+- Fix line number and loc mismatching if the current source viewport is at the start of the file.
+- Multiple layout broken, overlapping text glitches.
+
+### Internal & Refactoring
+- Refactor screen's data flow.
+- Standardize control flow.
+- Replace `tty-cursor`, `tty-screen` by native Ruby alternative.
+- Replace `tty-box` by home-growing solution.
+- Remove text decorator.
+- Implement color decorator
+- Implement keybinding register and matching mechanism.
+- Implement ReplProxy to wrap around Pry instance.
+- Utility to debug and benchmark.
+
+## [0.1.0 - Alpha 1] - Alpha initial version
+**Release date**: July 1st 2020
+
+- Default Terminal UI, in which the layout and display are responsive to support different screen size.
+- Highlighted source code screen.
+- Stacktrace visulization and navigation.
+- Auto explore and display variables in the current context.
+- Multi-thread exploration and debugging.