pryx 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d32d158a55d6f60171d02a8cd461db6cfe297367dcb45d83e9373f6a700af13
-  data.tar.gz: 07f75f1b4519f23d1b78bd786f18a2fe429bb152026249c769b84c548ff99ac4
+  metadata.gz: 2a6ae2e11955f264a9c73ecf4b11b06be4449e5ca5700010e8d1cb0790cee06b
+  data.tar.gz: 5bb01a1eb5eb2115ef31711a8d160afa25abaf0677b1172b2a383bbcc53d279c
 SHA512:
-  metadata.gz: b963742fd62610857bd1dbdb423f437adacd1457d2bbd453d44b106ac4ef893cb083029bdf89b98664e0787f519973be63c64ab19737dcbca46838bb1ebcc779
-  data.tar.gz: fa57e77ccf9805f0f6937a89e798f106e729335eb4e450b37f0b5b9c6a369046645a30d123d6e2cbeab3feb2e6be94a3c34492495ee06414c37fb6e2a0a6d9c0
+  metadata.gz: 78b9fe62e3330c1b8619f8638f7d5121e4e9806eee6e5e242d9e91cb572c238462761bd9fcde671c882cd806e5b5559bcf93ddfb7228f250d014ce386c436e5c
+  data.tar.gz: 6c68b315d94c28d7dba89d87e548b52fe3506dcecea7660571a7dd7eb41bf7b3cc835ce34bc2a05e04756d8d0e3343e5c1b5ea9938e7bb46750889e239e6c43e

data/bin/irbx

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+#
+#   irb.rb - interactive ruby
+#       $Release Version: 0.9.6 $
+#       $Revision$
+#       by Keiju ISHITSUKA(keiju@ruby-lang.org)
+#
+
+require 'irb'
+require 'pryx_irb'
+
+IRB.start(__FILE__)

data/bin/pryx

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# (C) John Mair (banisterfiend)
+# MIT license
+
+$0 = 'pry'
+
+require 'pry'
+require 'pryx'
+
+# Process command line options and run Pry
+opts = Pry::CLI.parse_options
+Pry::CLI.start(opts)

data/lib/pry-state/hook_action.rb

@@ -0,0 +1,61 @@
+require 'pry-state/printer'
+
+class HookAction
+  IGNORABLE_LOCAL_VARS = [:__, :_, :_ex_, :_pry_, :_out_, :_in_, :_dir_, :_file_]
+
+  CONTROLLER_INSTANCE_VARIABLES = [:@_request, :@_response, :@_routes]
+  RSPEC_INSTANCE_VARIABLES = [:@__inspect_output, :@__memoized]
+  IGNORABLE_INSTANCE_VARS = CONTROLLER_INSTANCE_VARIABLES + RSPEC_INSTANCE_VARIABLES
+  IGNORABLE_GLOBAL_VARS = [:$@]
+
+  def initialize binding, pry
+    @binding, @pry = binding, pry
+  end
+
+  def act
+    if ENV['SHOW_GLOBAL_VARIABLES']
+      (binding.eval('global_variables').sort - IGNORABLE_GLOBAL_VARS).each do |var|
+        eval_and_print var, var_color: 'white', value_colore: 'yellow'
+      end
+    end
+
+    unless ENV['HIDE_INSTANCE_VARIABLES']
+      (binding.eval('instance_variables').sort - IGNORABLE_INSTANCE_VARS).each do |var|
+        eval_and_print var, var_color: 'green'
+      end
+    end
+
+    unless ENV['HIDE_LOCAL_VARIABLES']
+      (binding.eval('local_variables').sort - IGNORABLE_LOCAL_VARS).each do |var|
+        eval_and_print var, var_color: 'cyan'
+      end
+    end
+  end
+
+  private
+  attr_reader :binding, :pry
+
+  def eval_and_print var, var_color: 'green', value_color: 'white'
+    value = binding.eval(var.to_s)
+    if value_changed? var, value
+      var_color = "bright_#{var_color}"; value_color = 'bright_yellow'
+    end
+    PryState::Printer.trunc_and_print var, value, var_color, value_color
+    stick_value! var, value # to refer the value in next
+  end
+
+  def value_changed? var, value
+    prev_state[var] and prev_state[var] != value
+  end
+
+  def stick_value! var, value
+    prev_state[var] = value
+  end
+
+  def prev_state
+    # init a hash to store state to be used in next session
+    # in finding diff
+    pry.config.extra_sticky_locals[:pry_state_prev] ||= {}
+  end
+
+end

data/lib/pry-state/printer.rb

@@ -0,0 +1,51 @@
+module PryState
+  module Printer
+    extend self
+
+    WIDTH = ENV['COLUMNS'] ? ENV['COLUMNS'].to_i : 80
+    MAX_LEFT_COLUMN_WIDTH = 25
+    # Ratios are 1:3 left:right, or 1/4 left
+    COLUMN_RATIO = 3 # right column to left ratio
+    LEFT_COLUMN_WIDTH = [(WIDTH / (COLUMN_RATIO + 1)).floor, MAX_LEFT_COLUMN_WIDTH].min
+
+    # Defaults to true
+    TRUNCATE = ENV['PRY_STATE_TRUNCATE'] != 'false'
+
+    def trunc_and_print var, value, var_color, value_color
+      var_name_adjusted = var.to_s.ljust(LEFT_COLUMN_WIDTH)
+      # Ensure at least 1 space between left and right columns
+      left_column_text = truncate(var_name_adjusted, LEFT_COLUMN_WIDTH - 1) + ' '
+      print Pry::Helpers::Text.send(var_color, left_column_text)
+      print stringified_val_or_nil(value, value_color, WIDTH - LEFT_COLUMN_WIDTH)
+      print "\n"
+    end
+
+    private
+    def truncate text, length
+      if text.nil? then return end
+      return text unless ENV['TRUNCATE']
+      l = length - "...".length
+      (text.chars.to_a.size > length ? text.chars.to_a[0...l].join + "..." : text).to_s
+    end
+
+    def stringified_val_or_nil value, color, length
+      value = stringify_value value
+      if value.empty?
+        Pry::Helpers::Text.red 'nil'
+      else
+        text = truncate(value, length)
+        Pry::Helpers::Text.send(color, text)
+      end
+    end
+
+    def stringify_value value
+      if value.class == String
+        "\"#{value}\""
+      elsif value.class == Array
+        "len:#{value.count} #{value.inspect}"
+      else
+        value.inspect
+      end
+    end
+  end
+end

data/lib/pry-state.rb

@@ -0,0 +1,7 @@
+require "pry"
+require 'pry-state/hook_action'
+
+
+Pry.hooks.add_hook(:before_session, "pry_state_hook") do |output, binding, pry|
+  HookAction.new(binding, pry).act
+end

data/lib/pry-yes.rb

@@ -0,0 +1,37 @@
+Pry::Commands.create_command "yes" do
+  description 'Re-runs previous command with "Did you mean?" suggestion.'
+  def options(opt)
+    opt.on :d, :debug, 'Debug mode.'
+  end
+
+  def process
+    ex = target.eval("defined?(_ex_) and _ex_")
+    return unless ex && ex.message.include?("Did you mean?")
+
+    matched_exception = ex.message.match(
+      /undefined.*`(.*)'|uninitialized constant (.*)\n/)
+    return unless matched_exception
+
+    typo = matched_exception.captures.compact.first
+    return unless typo
+
+    typo_guess = ex.message.split('Did you mean?  ').last.split.first
+    last_command = Pry.history.to_a[-2]
+    guessed_command = last_command.gsub(typo, typo_guess)
+
+    pry_instance.input = StringIO.new(guessed_command)
+  rescue => e
+    # Schhh
+    raise e if opts.present?(:debug)
+  ensure
+    if opts.present?(:debug)
+      puts "matched_exception: #{matched_exception}"
+      puts "typo: #{typo}"
+      puts "typo_guess: #{typo_guess}"
+      puts "last_command: #{last_command}"
+      puts "guessed_command: #{guessed_command}"
+    end
+  end
+end
+
+module PryYes; end

data/lib/pryx/ap_hack.rb

@@ -1,8 +1,8 @@
 require 'awesome_print'
 
-AwesomePrint.defaults = {
-  index: false
-}
+# AwesomePrint.defaults = {
+#   index: false
+# }
 
 if defined? AwesomePrint
   if defined? Pry

data/lib/pryx/background.rb

@@ -0,0 +1,20 @@
+module Pryx::Background
+  # 如果是前台进程，则这个进程的组ID（pgid）一定会等于当前 terminal 的gid （tpgid）
+  # 否则，如果不等，那么就是后台进程。
+  # system("\\cat /proc/#{pid}/stat |awk '$5==$8 {exit 1}'")
+  def self.background?(pid=$$)
+    # 这个实现似乎有错, 因为针对 nohup 1.rb& 这种情况，返回为前台进程。
+    # 执行 reverse 再处理，是因为要考虑文件名包含空格因素。例如：‘hello) (world’
+    # ary = File.read("/proc/#{pid}/stat").split(' ').reverse
+    # is_bg = (ary[46] != ary[48])
+
+    # 这个实现依赖于一些 linux 下基本工具，但是准确
+    is_bg = system("ps -e -o pid,pgid,tpgid |grep '^\s*#{pid}' |awk '$2==$3 {exit 1}'")
+
+    is_bg && !$stdout.tty?
+  end
+
+  def self.foreground?(pid=$$)
+    not background?(pid)
+  end
+end

data/lib/pryx/break_hack.rb

@@ -1,2 +1,6 @@
 require 'break'
 load "#{__dir__}/../break/pry/extensions.rb"
+
+Pry.commands.alias_command 'n', 'next'
+Pry.commands.alias_command 's', 'step'
+Pry.commands.alias_command 'w', 'watch' # watch is pry builtin

data/lib/pryx/irb_hack.rb

@@ -0,0 +1,46 @@
+require 'binding_of_caller'
+
+class Binding
+  def _irb(_host=nil)
+    warn 'loading irb ...'
+
+    if defined? Break and defined? IRB
+      # This is need for work with looksee better.
+      # See discuss on https://github.com/oggy/looksee/issues/57
+      IRB.conf[:USE_COLORIZE] = false
+    else
+      warn "For work with Break and Looksee, please set
+export RUBYOPT='-rpryx_irb'
+instead of
+export RUBYOPT='-rpryx'
+"
+    end
+
+    self.irb
+  end
+end
+
+module Kernel
+  def irb!
+    return unless ENV['IRB_was_started'].nil?
+
+    ENV['IRB_was_started'] = 'true'
+
+    binding.of_caller(1)._irb
+  end
+
+  def reirb!
+    ENV['IRB_was_started'] = nil
+  end
+
+  def irb1
+    ENV['IRB2_should_start'] = 'true'
+  end
+
+  def irb2(caller=1, remote: nil, port: 9876)
+    if ENV['IRB2_should_start'] == 'true'
+      ENV['IRB2_should_start'] = nil
+      binding.of_caller(caller)._irb
+    end
+  end
+end

data/lib/pryx/pry_hack.rb

@@ -9,10 +9,27 @@ class Binding
     else
       require 'pry'
     end
+
     require 'pryx/ap_hack'
+
     require 'pryx/break_hack'
+
+    require 'pry-power_assert'
+
+    require 'pry-doc'
+
+    require 'pry-yes'
+    Pry.commands.alias_command 'y', 'yes'
+
+    require 'pry-hier'
+
+    require 'pry-aa_ancestors'
+    Pry::Commands.alias_command 'aa', 'aa_ancestors'
+
     # 这个必须在最后才有效, 但是目前存在一个问题，就是会将 pry3, pry! 加入 stacks
-    require 'pry-stack_explorer'
+    # stack 显示 stack 的列表，frame 显示当前所在 stack, stack N 也可以根据数字跳转到 N
+    require 'pry-stack_explorer' # Support: up, down, bottom, top, stack, frame
+
 
     Pry::Commands.block_command 'cc', 'Continue, but stop in pry! breakpoint' do
       Pry.instance_variable_set(:@initial_session, true)
@@ -29,38 +46,20 @@ class Binding
       self.pry
     end
   end
-
-  def _irb(_host=nil)
-    warn 'loading irb ...'
-
-    IRB.conf[:USE_COLORIZE] = false
-
-    self.irb
-  end
 end
 
 module Kernel
   # 运行 pry! 会被拦截, 且只会被拦截一次.
-  def pry!(caller=2, remote: nil, port: 9876)
+  def pry!(remote: nil, port: 9876)
     return unless ENV['Pry_was_started'].nil?
 
     ENV['Pry_was_started'] = 'true'
 
-    if background?
-      remote = '0.0.0.0'
-      port = 9876
-    end
-
-    pry3(caller, remote: remote, port: port)
+    pry3(2, remote: remote, port: port)
 
     # 这里如果有代码, 将会让 pry! 进入这个方法, 因此保持为空.
   end
 
-  # 注意：pryr 总是会被拦截。
-  def pryr
-    pry3(caller=2, remote: '0.0.0.0', port: 9876)
-  end
-
   # 在 pry! 之前如果输入这个，会让下次执行的 pry! 被拦截一次， 而不管之前是否有执行过 pry!
   def repry!
     ENV['Pry_was_started'] = nil
@@ -68,13 +67,13 @@ module Kernel
 
   # 和 pry! 的差别就是，pry? 使用 pry-state 插件输出当前 context 的很多变量内容。
   # 注意：不需要总是开启 pry-state，因为有时候会输出太多内容，造成刷屏。
-  def pry?(caller=2, remote: nil, port: 9876)
+  def pry?(remote: nil, port: 9876)
     return unless ENV['Pry_was_started'].nil?
 
     require 'pry-state'
     ENV['Pry_was_started'] = 'true'
 
-    pry3(caller, remote: remote, port: port)
+    pry3(2, remote: remote, port: port)
 
     # 这里如果有代码, 将会让 pry! 进入这个方法, 因此保持为空.
   end
@@ -82,6 +81,8 @@ module Kernel
   # 等价于默认的 binding.pry, 会反复被拦截。
   # 起成 pry3 这个名字，也是为了方便直接使用。
   def pry3(caller=1, remote: nil, port: 9876)
+    remote = '0.0.0.0' if Pryx::Background.background?
+
     binding.of_caller(caller)._pry(remote, port)
   end
 
@@ -94,75 +95,49 @@ module Kernel
 
   def pry2(caller=1, remote: nil, port: 9876)
     if ENV['Pry2_should_start'] == 'true'
-      # 首先恢复 Pry2_is_start 为未启动, 避免稍后的 pry2 再次被拦截.
       ENV['Pry2_should_start'] = nil
       binding.of_caller(caller)._pry(remote, port)
     end
   end
 
-  def reirb!
-    ENV['IRB_was_started'] = nil
-  end
-
-  def irb!
-    return unless ENV['IRB_was_started'].nil?
-
-    ENV['IRB_was_started'] = 'true'
-
-    binding.of_caller(1)._irb
-  end
+  def notify_send(msg)
+    system("notify-send \"#{msg}\"") if system 'which notify-send &>/dev/null'
 
-  def irb1
-    ENV['IRB2_should_start'] = 'true'
+    system('aplay "#{__dir__}/drip.wav" &>/dev/null') if system 'which aplay &>/dev/null'
+    warn "#{msg}"
   end
+end
 
-  def irb2(caller=1, remote: nil, port: 9876)
-    if ENV['IRB2_should_start'] == 'true'
-      # 首先恢复 Pry2_is_start 为未启动, 避免稍后的 pry2 再次被拦截.
-      ENV['IRB2_should_start'] = nil
-      binding.of_caller(caller)._irb
-    end
-  end
+# Hack for roda/rails, 在每一次发送请求之前，总是设定 ENV['Pry_was_started'] to nil.
+# 这可以确保，pry! 总是会被拦截，但是仅仅只会被拦截一次。
 
-  # 如果是前台进程，则这个进程的组ID（pgid）一定会等于当前 terminal 的gid （tpgid）
-  # 否则，如果不等，那么就是后台进程。
-  # system("ps -e -o pid,pgid,tpgid |grep '^\s*#{pid}' |awk '$2==$3 {exit 1}'")
-  # system("\\cat /proc/#{pid}/stat |awk '$5==$8 {exit 1}'")
-  def background?(pid=$$)
-    # 考虑是否需要验证
-    ary = File.read("/proc/#{pid}/stat").split(' ').reverse
-    # 执行 reverse 再处理，是因为要考虑文件名包含空格因素。例如：‘hello) (world’
-    (ary[46] != ary[48]) && !$stdout.tty?
-  end
+class Pryx::PryHackForRodaRailsMiddleware
+  attr_reader :app
 
-  def foreground?(pid=$$)
-    not background?(pid)
+  def initialize(app)
+    @app = app
   end
 
-  def notify_send(msg)
-    system("notify-send \"#{msg}\"") if system 'which notify-send &>/dev/null'
-
-    system('aplay "#{__dir__}/drip.wav" &>/dev/null') if system 'which aplay &>/dev/null'
-    warn "#{msg}"
+  def call(env)
+    ENV['Pry_was_started'] = nil
+    @app.call(env)
   end
 end
 
-# Hack roda, 在每一次发送请求之前，总是设定 ENV['Pry_was_started'] to nil.
-# 这可以确保，pry! 总是会被拦截，但是仅仅只会被拦截一次。
 begin
   require 'roda'
-  class PryHackRodaMiddleware
-    attr_reader :app
-
-    def initialize(app)
-      @app = app
-    end
+  Roda.use Pryx::PryHackForRodaRailsMiddleware
+rescue LoadError
+end
 
-    def call(env)
-      ENV['Pry_was_started'] = nil
-      @app.call(env)
-    end
+begin
+  require 'active_support/lazy_load_hooks'
+  ActiveSupport.on_load(:before_configuration) do
+    # because exits less command error when use in container, use irb instead.
+    # require 'pry'
+    # require 'pryx'
+    # Rails.application.config.console = Pry
+    Rails.application.config.middleware.use Pryx::PryHackForRodaRailsMiddleware
   end
-  Roda.use PryHackRodaMiddleware
 rescue LoadError
 end

data/lib/pryx/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Pryx
-  VERSION = [0, 2, 2]
+  VERSION = [0, 4, 0]
 
   class << VERSION
     include Comparable

data/lib/pryx.rb

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 
 require 'pryx/version'
+require 'pryx/background'
 require 'pryx/trap_backtrace'
 require 'pryx/looksee_hack'
 require 'pryx/pry_hack'
+require 'pryx/irb_hack'
 
 # Add the non-bundler managermented gems back
 # this step is necessory when install pryx in docker-compose
 ENV['RUBYLIB'] = $LOAD_PATH.grep(/gems/).join(':')
 
+# set export RUBYOPT+=" -rpryx" to work with pryx.
 module Pryx
 end

data/lib/pryx_irb.rb

@@ -1,3 +1,14 @@
+# We need apply those hack before irb was loaded for work with irb.
+# So we have to add it here, same hacks for Pry is add to method
+# Binding#_pry which defined in lib/pryx/pry_hack.rb
+
+# we need set `export RUBYOPT+=" -rpryx_irb"` instead of `-rpryx` to make
+# irb work with break and ap gem.
+
+# ap_hack 可以确保，当时用 irb! 的时候，输入代码是彩色的，并且 looksee 也正常显示
+# 但是，ap_hack 不可以放到 break_hack 后面，否则会失效。
+# WARN: 下面两行代码顺序不要换。
 require 'pryx/ap_hack'
 require 'pryx/break_hack'
+
 require 'pryx'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pryx
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Billy.Zheng(zw963)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-21 00:00:00.000000000 Z
+date: 2022-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -94,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: pry-hier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: pry-aa_ancestors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-stack_explorer
   requirement: !ruby/object:Gem::Requirement
@@ -140,13 +168,17 @@ description: ''
 email:
 - vil963@gmail.com
 executables:
+- irbx
 - pry!
+- pryx
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- bin/irbx
 - bin/pry!
+- bin/pryx
 - lib/break/pry/extensions.rb
 - lib/pry-byebug.rb
 - lib/pry-byebug/WARN
@@ -157,10 +189,16 @@ files:
 - lib/pry-disasm.rb
 - lib/pry-disasm/commands.rb
 - lib/pry-remote.rb
+- lib/pry-state.rb
+- lib/pry-state/hook_action.rb
+- lib/pry-state/printer.rb
+- lib/pry-yes.rb
 - lib/pryx.rb
 - lib/pryx/ap_hack.rb
+- lib/pryx/background.rb
 - lib/pryx/break_hack.rb
 - lib/pryx/drip.wav
+- lib/pryx/irb_hack.rb
 - lib/pryx/looksee_hack.rb
 - lib/pryx/pry_hack.rb
 - lib/pryx/trap_backtrace.rb
@@ -189,5 +227,5 @@ requirements: []
 rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
-summary: ''
+summary: pry extension tools!
 test_files: []