pryx 0.4.4 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f026b0034b9947eee339d8063f5fb839e747637e2a42ba3f64b337a2851eb86
-  data.tar.gz: a9f544c647ef0c0a9f844d72c20fd3a2b3b754c44c0186edce2a5de080a55629
+  metadata.gz: '09a8d65224c56092b01d8230556c4ef522637b1b6e1932c5333ce018c3f0ce93'
+  data.tar.gz: 5426012f47fa266763061e41ce8e8d45a34ab61ad0cf70de517a98312a40722b
 SHA512:
-  metadata.gz: cab620e8b026be0f92d73615cc3770dac0eb3932d20817da429a743a41e9395a3068ea0189884c7d38b0978d9204eeef0862085a50323b2991941292231aea66
-  data.tar.gz: '09f1655674251316bcdc7ae12cf6ce4b0cebc636b6c1f296c9f12028893b52c884a6260a2f06b43fff6efabb85785970e0d58f58a652da2915bb1e4c54504e90'
+  metadata.gz: 3df7840a906cbe572d6c60bda02e17b5ad5dff15568e34307a031ac7f1fdc9416445e55f62197983d7e983d769be4dc484ee722468545457e4f60c3cb6907878
+  data.tar.gz: 864ab3c3f5ec04563fda87ccfc7f3ad25097a75495bc977a613e123de0a2228ad4afea4e1c0b1d650e0230b860cf55f654345948ab9081cffad3f791a01064fb

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.
 
@@ -9,6 +9,8 @@ Don't add this gem into bundler's Gemfile.
 Instead, install it directly via RubyGems
 
     $ gem install pryx
+	
+Then use can use pryx cross all your's project.	
 
 ## Usage
 
@@ -30,9 +32,32 @@ $: RUBYOPT+='-rpryx' ruby your_file.rb  # add pry! in your_file for start pry se
 
 Then, try add `pry!` into your's ruby code, then run it, have fun!
 
-## useful command add directly to Kernel#
+Following is a example, assume we have test.rb, it content like this:
+
+```rb
+# test.rb
+3.times do
+  pry!
+  puts 'hello'
+end
+```
+
+Then, when you run `RUBYOPT='-rpryx' ruby test.rb`
+
+![pry.png](images/pry!.png)
+
+You can even connect to a pry session started from remote or background process 
+use http connection.
+
+![pry_remote.png](images/pry_remote.png)
+
+
+Until now, you've only seen the tip of the iceberg, please have a try.
+
 
-### pry!   
+## useful command which added directly to Kernel#
+
+### Kernel#pry!   
    
 start a pry session, this session only can be intercept once if add into a loop.
 when used with a rails/roda web server, it only intercept one per request.
@@ -45,23 +70,27 @@ $: 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)
+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)
-   
-### pry1 pry2  (sorry for this bad name, please create a issue you have a better one)
+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.
 
@@ -69,26 +98,29 @@ I haven use this hack for avoid pry session start on working place.
 
 You know what i means.
 
-### irb1 irb2 
+### Kernel#irb1 Kernel#irb2 
 
 IRB equivalent for pry1, pry2
 we have irb1 and irb2 too.
 
-### pry3
+### Kernel#pry3
 
 It just normal `binding.pry`, that is, will always be intercept if code can reach.
 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 have 3 binary, pryx, irbx, pry! installed
+### 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.
 
 irbx is same things for irb.
 
-pry! is same as pry-remote command, when `pry!` was intercepted in a background process, 
-you can run pry! in terminal connnect to it.
+pry! just a alias to `pry-remote` command, when `Kernel#pry!` was intercepted in a background process, 
+you can run `pry!` directly in terminal connect to it.
 
 if your's pry-remote server started background on another host, or on a container, you man need
 specify hostname and port, e.g. connnect to 192.168.1.100, with port 9876
@@ -99,12 +131,22 @@ $: 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
 
-  * MRI 2.2+
+  * MRI 2.6+
 
 ## History
 

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

@@ -1,11 +1,16 @@
-# frozen_string_literal: true
-
 require 'pry'
 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,32 +8,8 @@ class Binding
       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
-    # 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)
-      ENV['Pry_was_started'] = nil
-      throw(:breakout)
-    end
+    require 'pryx/common_plugins'
+    require 'pryx/pry_plugins'
 
     if host
       notify_send('loading remote pry ...')
@@ -78,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
@@ -96,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

@@ -0,0 +1,24 @@
+require 'pry-power_assert'
+
+require 'pry-doc'
+
+require 'pry-yes'
+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
+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)
+  ENV['Pry_was_started'] = nil
+  throw(:breakout)
+end

data/lib/pryx/version.rb

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

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.4.4
+  version: 0.6.1
 platform: ruby
 authors:
 - Billy.Zheng(zw963)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-23 00:00:00.000000000 Z
+date: 2022-04-24 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,10 +239,13 @@ 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
 - lib/pryx/version.rb
 - lib/pryx_irb.rb
@@ -217,7 +262,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.2
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="