pryx 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4f8e26858d1dfc13351ca2e8287a4aae69a1be7bf123f98ff7556f006a706a2
-  data.tar.gz: c921a886c8a596e129037bf74c8837a97e2d934b7943aa78b923945c6cc04855
+  metadata.gz: ce341aed30736e74c9555f58904c279e3df2c8e9b34927b5a3ea0a203d56f48a
+  data.tar.gz: b910b99fd34921918bac6baccf2153518f0ca9c46d00245e4af507f80121df1e
 SHA512:
-  metadata.gz: 734080308ca63da288f250c333c60fece9de7d29612f705953859f78241768bfcacb2c7ef7a5e414f54f65d9eacc99c16508f91230de8ad8bfb90cb72c21e250
-  data.tar.gz: 429e9841ff95fa3327b1c48f39c588f6fac4c0b5d418589ab1723f15e29f183ab10114ba81df96b027af63615152f05a21c8876776597651d9b4f23eb4dab686
+  metadata.gz: 39b07122fe28eb18ef6b69ce6719fa59a75eb0d5aad2d6407de9684298dd9b80396a3d547294d043e8566043168ee4f14d61c22674d94efb1443f4ec9325e9a8
+  data.tar.gz: 335180f0b216cc9997118bf6e692b5bfb95f8a70d5cc5b1c28049f3955d96dd2696072e516a06fd963e8bb35b4fae4a006879adcf2903b929f193733ee94e791

data/README.md

@@ -1,4 +1,4 @@
-# Pryx [![Build Status](https://travis-ci.com/zw963/pryx.svg?branch=master)](https://travis-ci.com/zw963/pryx) [![Gem Version](https://badge.fury.io/rb/pryx.svg)](http://badge.fury.io/rb/pryx)
+# Pryx [![Build Status](https://travis-ci.com/zw963/pryx.svg?branch=master)](https://app.travis-ci.com/github/zw963/pryx)[![Gem Version](https://badge.fury.io/rb/pryx.svg)](http://badge.fury.io/rb/pryx)![](https://ruby-gem-downloads-badge.herokuapp.com/pryx?type=total)
 
 Three Virtues of a Programmer: Laziness, Impatience, and Hubris. -- Larry Wall, the author of Perl Programming language.
 
@@ -55,6 +55,18 @@ use http connection.
 Until now, you've only seen the tip of the iceberg, please have a try.
 
 
+If you prefer to use IRB over Pry, use can add following code instead.
+
+```sh
+$: export RUBYOPT+=' -rpryx_irb'
+$: ruby your_file.rb              # add pry! in your_file for start pry session
+```
+
+__WARN__: `require 'pryx_irb'` will enable many gems by default in your's ruby code.
+so, prefer to use `require 'pryx'`, because latter almost not affect your's code,
+only several methods added into Kernel#, and gems only be require if you run invoke
+those added methods.
+
 ## useful command which added directly to Kernel#
 
 ### Kernel#pry!   
@@ -70,22 +82,26 @@ $: RUBYOPT+='-rpryx_irb' ruby your_file.rb # add irb! in your_file for start pry
 
 Following feature both available when start a Pry or IRB session:
 
-1.  add `next/step/up/down` command for debug, use [break](https://github.com/gsamokovarov/break)
-2.  add `Kernel#ls1`(use ls1 to avoid conflict with pry builtin ls command), see [looksee](https://github.com/oggy/looksee)
-3.  Use AwesomePrint for printer. see [https://github.com/awesome-print/awesome_print]
+1.  Add `next/step/up/down` command for debug, use [break](https://github.com/gsamokovarov/break) [pry-stack_explorer](https://github.com/pry/pry-stack_explorer)
+2.  Add `Kernel#ls1`(use ls1 to avoid conflict with pry builtin ls command), see [looksee](https://github.com/oggy/looksee)
+3.  Use `ap` for pretty print. see [awesome-print](https://github.com/awesome-print/awesome_print)
+4.  Use `Clipboard.copy` or `Clipboard.paste` to interactive with system clipboard. see [clipboard](https://github.com/janlelis/clipboard)
 
-Following feature only available when start a Pry session:
+Following is pry command available only after start a Pry session:
 
-1.  add `$/?` command for see source, see [pry-doc](https://github.com/pry/pry-doc)
+1.  Add `$/?` command for see source, see [pry-doc](https://github.com/pry/pry-doc)
 2.  pry-remote debug support. you still use `pry!` no changes, it will use `pry-remote` automatically
     if current ruby process was running on backround, then, it will use pry-remote, and listen on 0.0.0.0:9876,
     Then, you can connect to it from another terminal! see [pry-remote](https://github.com/Mon-Ouie/pry-remote)
-3.  add `pa` command, see [pry-power_assert](https://github.com/yui-knk/pry-power_assert)
-4.  add `hier` command for print the class hierarchies, see [pry-hier](https://github.com/phaul/pry-hier)
-5.  add `pry-aa_ancestors` command for print the class hierarchy, see [pry-aa_ancestors](https://github.com/tbpgr/pry-aa_ancestors)
-6.  add `up/down/frame/stack` command, see [pry-stack_explorer](https://github.com/pry/pry-stack_explorer)
-2.  add `yes` or `y` command, see [pry-yes](https://github.com/christofferh/pry-yes)
-   
+3.  Add `pa` command, see [pry-power_assert](https://github.com/yui-knk/pry-power_assert)
+4.  Add `hier` command for print the class hierarchies, see [pry-hier](https://github.com/phaul/pry-hier)
+5.  Add `pry-aa_ancestors` command for print the class hierarchy, see [pry-aa_ancestors](https://github.com/tbpgr/pry-aa_ancestors)
+6.  Add `up/down/frame/stack` command, see [pry-stack_explorer](https://github.com/pry/pry-stack_explorer)
+7.  Add `yes` or `y` command, see [pry-yes](https://github.com/christofferh/pry-yes)
+8.  Add `pry-disam`, Check following screenshot for a example:
+
+![pry-disasm](images/disasm.png)
+
 ### Kernel#pry1 Kernel#pry2  (sorry for this bad name, please create a issue you have a better one)
 
 pry2 do nothing, but it will be interceptd and start a pry session only after pry1 is running.
@@ -106,7 +122,10 @@ but above plugins and libraries all correct configured.
 
 we have another Kernel#pry?, which enable `pry-state` automatically, see [pry-state](https://github.com/SudhagarS/pry-state)
 
-### We add three command line command, pryx, irbx, pry!
+### Add command from command line, rescue, kill-pry-rescue, pryx, irbx, pry!
+
+`rescue` and `kill-pry-rescue` come from `pry-rescue` gem, it not load by default, but you can use rescue command from command line directly.
+see [pry-rescue](https://github.com/ConradIrwin/pry-rescue)
 
 pryx is same as pry, but, with plugins and libraries correct configured.
 
@@ -124,8 +143,17 @@ $: pry! -s 192.168.1.100 -p 9876
 
 ## Philosophy
 
-This gem is design to maximum limit take effect current ruby program, so, it should be safe to use it.
-But, you should only use it when development, though, it was tested when use in docker-compose container too.
+This gem is design to Minimal impact on target ruby code, in fact, after `require 'pryx'` or `RUBYOPT='-rpryx'`
+(they do same thing), only several instance method be defined on Kernel, and several gems add to $LOAD_PATH, 
+but not load, ready to require it, no more. so, it should be safe to use it, either affect performance nor
+namespace/variables etc.
+
+But, you should only use it in development, though, it was tested is run in container(alpine) too.
+
+## Limit
+
+  1. `break` not work well if you add more than one break point, but still use `next` goto the next break point,
+     See https://github.com/gsamokovarov/break/issues/12
 
 ## Support
 

data/lib/pry-disasm/commands.rb

@@ -6,7 +6,7 @@ Pry::Commands.create_command 'disasm' do
   group 'Context'
 
   def process
-    expr = eval(arg_string)
+    expr = target.eval(arg_string)
     PryDisasm.process(expr)
   end
 end

data/lib/pry-disasm.rb

@@ -3,7 +3,14 @@ require 'pry-disasm/commands'
 
 class PryDisasm
   def self.process(expr)
-    str = RubyVM::InstructionSequence.disasm(expr)
+    case expr
+    when Method, Proc
+      str = RubyVM::InstructionSequence.disasm(expr)
+    when String
+      str = RubyVM::InstructionSequence.compile(expr).disasm
+    else
+      return puts "Error: The command 'disasm' requires Method/Proc/String instance."
+    end
 
     lines = str.split("\n")
     lines[0].gsub!(/=+/) { |s| "\033[0;32m#{s}\033[0m" }

data/lib/pryx/common_plugins.rb

@@ -0,0 +1,9 @@
+require 'binding_of_caller'
+require 'clipboard'
+
+# ap_hack 可以确保，当使用 irb! 时，looksee ls1 输出显示正确，同时不用关闭 irb :USE_COLORIZE 设置。
+# See https://github.com/oggy/looksee/issues/57
+# 但是，ap_hack 必须放到 break_hack 前面，调换顺序，上面的 hack 失效。
+# WARN: 下面两行代码顺序不要换。
+require 'pryx/ap_hack'
+require 'pryx/break_hack'

data/lib/pryx/irb_hack.rb

@@ -1,5 +1,3 @@
-require 'binding_of_caller'
-
 class Binding
   def _irb(_host=nil)
     warn 'loading irb ...'
@@ -26,7 +24,9 @@ module Kernel
 
     ENV['IRB_was_started'] = 'true'
 
-    binding.of_caller(1)._irb
+    require 'binding_of_caller'
+
+    irb3(2)
   end
 
   def reirb!
@@ -37,10 +37,19 @@ module Kernel
     ENV['IRB2_should_start'] = 'true'
   end
 
-  def irb2(caller=1, remote: nil, port: 9876)
+  def irb2
     if ENV['IRB2_should_start'] == 'true'
       ENV['IRB2_should_start'] = nil
-      binding.of_caller(caller)._irb
+
+      require 'binding_of_caller'
+
+      irb3(2)
     end
   end
+
+  def irb3(caller=1)
+    require 'binding_of_caller'
+
+    binding.of_caller(caller)._irb
+  end
 end

data/lib/pryx/looksee_hack.rb

@@ -10,7 +10,7 @@
 # 被覆写的方法 灰色 30
 
 module Kernel
-  def load_looksee
+  def _load_looksee
     case RbConfig::CONFIG['ruby_version']
     when '1.9.0'...'2.1.0'
       require 'old_looksee'
@@ -23,12 +23,12 @@ module Kernel
   end
 
   def ls1(*args)
-    load_looksee unless defined? Looksee
+    _load_looksee unless defined? Looksee
     Looksee[self, *args, :noprivate]
   end
 
   def ls2(*args)
-    load_looksee unless defined? Looksee
+    _load_looksee unless defined? Looksee
     Looksee[self, *args]
   end
 end

data/lib/pryx/pry-stack_explorer_hack.rb

@@ -0,0 +1,12 @@
+module PryStackExplorer
+  module FrameManagerHack
+    def initialize(bindings, _pry)
+      super
+      self.bindings = bindings.reject do |b|
+        b.source_location[0].match? %r{/pryx/pry_hack.rb}
+      end
+    end
+  end
+
+  FrameManager.prepend FrameManagerHack
+end

data/lib/pryx/pry_hack.rb

@@ -1,7 +1,5 @@
 # 注意如果开启 pry-stack_explorer, 就不要使用 debugger, 因为进入新的上下文后, pry-stack_explorer 将失效.
 
-require 'binding_of_caller'
-
 class Binding
   def _pry(host=nil, port=nil, options={})
     if host
@@ -10,8 +8,7 @@ class Binding
       require 'pry'
     end
 
-    require 'pryx/ap_hack'
-    require 'pryx/break_hack'
+    require 'pryx/common_plugins'
     require 'pryx/pry_plugins'
 
     if host
@@ -55,14 +52,6 @@ module Kernel
     # 这里如果有代码, 将会让 pry! 进入这个方法, 因此保持为空.
   end
 
-  # 等价于默认的 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
-
   def pry1
     ENV['Pry2_should_start'] = 'true'
   end
@@ -73,10 +62,20 @@ module Kernel
   def pry2(caller=1, remote: nil, port: 9876)
     if ENV['Pry2_should_start'] == 'true'
       ENV['Pry2_should_start'] = nil
-      binding.of_caller(caller)._pry(remote, port)
+      pry3(2, remote: remote, port: port)
     end
   end
 
+  # 等价于默认的 binding.pry, 会反复被拦截。
+  # 起成 pry3 这个名字，也是为了方便直接使用。
+  def pry3(caller=1, remote: nil, port: 9876)
+    remote = '0.0.0.0' if Pryx::Background.background?
+
+    require 'binding_of_caller'
+
+    binding.of_caller(caller)._pry(remote, port)
+  end
+
   def notify_send(msg)
     system("notify-send \"#{msg}\"") if system 'which notify-send &>/dev/null'
 

data/lib/pryx/pry_plugins.rb

@@ -1,3 +1,4 @@
+# power_assert is ruby 3 builtin gem
 require 'pry-power_assert'
 
 require 'pry-doc'
@@ -7,12 +8,15 @@ Pry.commands.alias_command 'y', 'yes'
 
 require 'pry-hier'
 
+require 'pry-disasm'
+
 require 'pry-aa_ancestors'
 Pry::Commands.alias_command 'aa', 'aa_ancestors'
 
-# 这个必须在最后才有效, 但是目前存在一个问题，就是会将 pry3, pry! 加入 stacks
-# stack 显示 stack 的列表，frame 显示当前所在 stack, stack N 也可以根据数字跳转到 N
-require 'pry-stack_explorer' # Support: up, down, bottom, top, stack, frame
+# stack 显示 stack 的列表，
+# frame 显示当前所在 stack, frame N 也可以根据数字跳转到 N
+require 'pry-stack_explorer'
+require 'pryx/pry-stack_explorer_hack'
 
 Pry::Commands.block_command 'cc', 'Continue, but stop in pry! breakpoint' do
   Pry.instance_variable_set(:@initial_session, true)

data/lib/pryx/version.rb

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

data/lib/pryx.rb

@@ -9,7 +9,7 @@ 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(':')
+ENV['RUBYLIB'] = "#{ENV['RUBYLIB']}:#{$LOAD_PATH.grep(/gems/).join(':')}"
 
 # set export RUBYOPT+=" -rpryx" to work with pryx.
 module Pryx

data/lib/pryx_irb.rb

@@ -5,10 +5,5 @@
 # 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/common_plugins'
 require 'pryx'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pryx
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Billy.Zheng(zw963)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-23 00:00:00.000000000 Z
+date: 2022-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: clipboard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -112,16 +126,16 @@ dependencies:
   name: pry-aa_ancestors
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.1
 - !ruby/object:Gem::Dependency
   name: pry-stack_explorer
   requirement: !ruby/object:Gem::Requirement
@@ -137,7 +151,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry-rescue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -150,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: ritual
   requirement: !ruby/object:Gem::Requirement
@@ -197,9 +239,11 @@ files:
 - lib/pryx/ap_hack.rb
 - lib/pryx/background.rb
 - lib/pryx/break_hack.rb
+- lib/pryx/common_plugins.rb
 - lib/pryx/drip.wav
 - lib/pryx/irb_hack.rb
 - lib/pryx/looksee_hack.rb
+- lib/pryx/pry-stack_explorer_hack.rb
 - lib/pryx/pry_hack.rb
 - lib/pryx/pry_plugins.rb
 - lib/pryx/trap_backtrace.rb