ruby_jard 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4eaeb2003b2133100d1723d4fc5b3de3ea0ce6c1fd9f5e754a69ac7a489198d4
+  data.tar.gz: a1389c55f973eacda0e4fa6fdbf4b4f6f23feb6cf1ab38050f7fd3f8a1d689ed
+SHA512:
+  metadata.gz: 04f8ca93a51eef68e3139fa58a5d7acb5ece7f79023dcff53bde4796628518f7fdc86a40903df1d680f4e13c86542a9b48fdc228a899c15674bb9a18e33d8419
+  data.tar.gz: 73608c00fe978926adaf05361e7d1467a6c9da325e6cdeba71ed25ddb00e8d027b788ca9154c2c74c13f4b36dbe4502b2e9f12fb9c82ba815b0967c7fa84765e

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+Style/SymbolArray:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 20
+Metrics/PerceivedComplexity:
+  Max: 15
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+AllCops:
+  TargetRubyVersion: 2.5
+

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at nguyenquangminh0711@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://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'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Minh Nguyen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,16 @@
+# RubyJard
+
+ Just another ruby debugger. Jard provides an unified experience debugging Ruby source code in different platforms and editors. Jard is heavily under development. So, nothing to see here :smile:. When everything is ready, I'll update this file.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/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/[USERNAME]/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).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ruby_jard'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'pry'
+Pry.start(__FILE__)

data/lib/ruby_jard.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'pry'
+require 'coderay'
+require 'byebug/core'
+require 'byebug/attacher'
+require 'tty-cursor'
+require 'tty-box'
+require 'tty-screen'
+
+require 'ruby_jard/commands/continue_command'
+require 'ruby_jard/commands/up_command'
+require 'ruby_jard/commands/down_command'
+require 'ruby_jard/commands/next_command'
+require 'ruby_jard/commands/step_command'
+require 'ruby_jard/commands/finish_command'
+require 'ruby_jard/commands/frame_command'
+
+require 'ruby_jard/repl_processor'
+require 'ruby_jard/screen_manager'
+
+require 'ruby_jard/session'
+require 'ruby_jard/version'
+
+##
+# Jard stands for Just Another Ruby Debugger. It implements a layer of UI
+# wrapping around byebug, aims to provide a unified experience when debug
+# Ruby source code. Ruby Jard supports the following major features:
+#
+# * 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.
+# * Minimal layout configuration.
+# * Fully layout configuration with Tmux (coming soon).
+# * Integrate with Vim (coming soon).
+# * Integrate with Visual Studio Code (coming soon).
+# * Encrypted remote debugging (coming soon).
+# * Some handful debug tools and data visulization (coming soom).
+#
+# Ruby Jard's core is Byebug, an awesome de factor debugger for Ruby.
+# Therefore, Ruby Jard supports most of Byebug's functionalities.
+#
+module RubyJard
+  class Error < StandardError; end
+
+  def self.current_session
+    @current_session ||= RubyJard::Session.new
+  end
+end
+
+##
+# Monkey-patch Kernel module to allow putting jard command anywhere.
+module Kernel
+  def jard
+    RubyJard.current_session.attach
+  end
+end
+
+##
+# Globally configure Byebug. Byebug doesn't allow configuration by instance.
+# So, I have no choice.
+# TODO: Byebug autoloaded configuration may override those values.
+Byebug::Setting[:autolist] = false
+Byebug::Setting[:autoirb] = false
+Byebug::Setting[:autopry] = false
+Byebug::Context.processor = RubyJard::ReplProcessor
+# Exclude all files in Ruby Jard source code from the stacktrace.
+Byebug::Context.ignored_files = Byebug::Context.all_files + Dir.glob(
+  File.join(
+    File.expand_path(__dir__, '../lib'),
+    '**',
+    '*.rb'
+  )
+)

data/lib/ruby_jard/commands/continue_command.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RubyJard
+  module Commands
+    # Command used to continue program execution.
+    # Data attached in the throw:
+    # * command: constant symbol (:continue)
+    # * pry: current context pry instance
+    class ContinueCommand < Pry::ClassCommand
+      group 'RubyJard'
+      description 'Continue program execution.'
+
+      match 'continue'
+
+      banner <<-BANNER
+      Usage: continue
+
+      Continue program execution. The program will stop at the next breakpoint, or run until it finishes.
+
+      Examples:
+        continue
+      BANNER
+
+      def process
+        throw :control_flow, command: :continue, pry: pry_instance
+      ensure
+        Byebug.stop if Byebug.stoppable?
+      end
+    end
+  end
+end
+
+Pry::Commands.add_command(RubyJard::Commands::ContinueCommand)

data/lib/ruby_jard/commands/down_command.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RubyJard
+  module Commands
+    # Command used to explore stacktrace.
+    # Data attached in the throw:
+    # * command: constant symbol (:down)
+    # * pry: current context pry instance
+    class DownCommand < Pry::ClassCommand
+      group 'RubyJard'
+      description 'Explore the frames bellow the current stopped line in the backtrace'
+
+      match 'down'
+
+      banner <<-BANNER
+      Usage: down
+
+      Explore the frames bellow the current stopped line in the backtrace.
+
+      Examples:
+        down
+      BANNER
+
+      def process
+        throw :control_flow, command: :down, pry: pry_instance
+      end
+    end
+  end
+end
+
+Pry::Commands.add_command(RubyJard::Commands::DownCommand)

data/lib/ruby_jard/commands/finish_command.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RubyJard
+  module Commands
+    # Command used to finish up the current frame.
+    # Data attached in the throw:
+    # * command: constant symbol (:finish)
+    # * pry: current context pry instance
+    class FinishCommand < Pry::ClassCommand
+      group 'RubyJard'
+      description 'Finish the execution of the current frame.'
+
+      match 'finish'
+
+      banner <<-BANNER
+      Usage: finish
+
+      Finish the execution of the current frame.
+
+      Examples:
+        finish
+      BANNER
+
+      def process
+        throw :control_flow, command: :finish, pry: pry_instance
+      end
+    end
+  end
+end
+
+Pry::Commands.add_command(RubyJard::Commands::FinishCommand)

data/lib/ruby_jard/commands/frame_command.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RubyJard
+  module Commands
+    # Command used to explore stacktrace.
+    # Data attached in the throw:
+    # * command: constant symbol (:frame)
+    # * pry: current context pry instance
+    # * frame (optional): frame id of the destination frame
+    class FrameCommand < Pry::ClassCommand
+      group 'RubyJard'
+      description 'Explore to any frame of current stacktrace.'
+
+      match 'frame'
+
+      banner <<-BANNER
+      Usage: frame
+
+      Explore to any frame of current stacktrace.
+
+      Examples:
+        frame [FRAME_ID]
+      BANNER
+
+      def process
+        throw :control_flow,
+              command: :frame,
+              pry: pry_instance,
+              # TODO: Remove redundant options
+              options: { frame: args.first }
+      end
+    end
+  end
+end
+
+Pry::Commands.add_command(RubyJard::Commands::FrameCommand)

data/lib/ruby_jard/commands/next_command.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RubyJard
+  module Commands
+    # Command used to continue program execution to the next line.
+    # Data attached in the throw:
+    # * command: constant symbol (:next)
+    # * pry: current context pry instance
+    class NextCommand < Pry::ClassCommand
+      group 'RubyJard'
+      description 'Next into the execution of the current line'
+
+      match 'next'
+
+      banner <<-BANNER
+      Usage: next
+
+      Continue program execution to the next line. If the current frame reaches the end, it continue the next line of upper frame.
+
+      Examples:
+        next
+      BANNER
+
+      def process
+        throw :control_flow, command: :next, pry: pry_instance
+      end
+    end
+  end
+end
+
+Pry::Commands.add_command(RubyJard::Commands::NextCommand)