pryx 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d32d158a55d6f60171d02a8cd461db6cfe297367dcb45d83e9373f6a700af13
-  data.tar.gz: 07f75f1b4519f23d1b78bd786f18a2fe429bb152026249c769b84c548ff99ac4
+  metadata.gz: a9d67d15a83b0d92beee0841d429cb42bc2c91ce2c0aea21b4a8ebb68cc88125
+  data.tar.gz: 828770b2b1bb5e958058d74136e9c759b461eac7ad8ff12c907ab92fa6b943f2
 SHA512:
-  metadata.gz: b963742fd62610857bd1dbdb423f437adacd1457d2bbd453d44b106ac4ef893cb083029bdf89b98664e0787f519973be63c64ab19737dcbca46838bb1ebcc779
-  data.tar.gz: fa57e77ccf9805f0f6937a89e798f106e729335eb4e450b37f0b5b9c6a369046645a30d123d6e2cbeab3feb2e6be94a3c34492495ee06414c37fb6e2a0a6d9c0
+  metadata.gz: 1d6f3688c0709bc039167c55aea81b6cee322381631b40f1507abdb4d18067c8e92a196d5deeb2899df61588a8bfd4397f8954301507c0e0357ab849995831fb
+  data.tar.gz: 8540e5b11640d70305e6f21f94459b7756bf13260ea441a87f62c89d3c4c90b308c021d0c5c59ea5d119300b31bbf1cba668620b394a316b8ae872c3a24728fb

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/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

@@ -29,38 +29,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 +50,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 +64,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,51 +78,11 @@ 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 irb1
-    ENV['IRB2_should_start'] = 'true'
-  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
-
-  # 如果是前台进程，则这个进程的组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
-
-  def foreground?(pid=$$)
-    not background?(pid)
-  end
-
   def notify_send(msg)
     system("notify-send \"#{msg}\"") if system 'which notify-send &>/dev/null'
 
@@ -147,7 +91,7 @@ module Kernel
   end
 end
 
-# Hack roda, 在每一次发送请求之前，总是设定 ENV['Pry_was_started'] to nil.
+# Hack for roda/rails, 在每一次发送请求之前，总是设定 ENV['Pry_was_started'] to nil.
 # 这可以确保，pry! 总是会被拦截，但是仅仅只会被拦截一次。
 begin
   require 'roda'

data/lib/pryx/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Pryx
-  VERSION = [0, 2, 2]
+  VERSION = [0, 3, 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.3.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
@@ -159,8 +159,10 @@ files:
 - lib/pry-remote.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