pryx 0.8.6 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2abbd74097d3935a2c891a174964906f3670f432c9098ed29c49a2d627af5ee8
-  data.tar.gz: 34a2d005fc80f393398acc48ca584a79867f12b5f8f5b39ce4fa8cb99a4e738e
+  metadata.gz: 2feb9ad3cf24d155fd61504945371bc47c1c31b111249e7f387624bcb76a2cad
+  data.tar.gz: f4a8f822b8843a546400e0a3418248b5bcd581c54236775b42f58bfb61218015
 SHA512:
-  metadata.gz: a2d570d7dcf1a6450c242539b7cec72d7204a1d71544d2d277bd161e2b5dcc4afb712265af8b0b8ce0a3b913a51a55373a4add3fc3299a938782c1b50333169a
-  data.tar.gz: 5accbceecc2f0639458bce8481a00704bf8c88f3bdac5539b54f12e32d748252e3f9d813c07c3d7e327eb4f9e5d10c4483f311f95cb1981dd1bab80645ff481f
+  metadata.gz: 519a408c47c2ee75c0c37b3bb5cd0bf184a60c8b8eeb3bc33aedc085c0ed63f22985c2971584b85040ecb9e965d720364eff0b73d1434f1cd3c0c0b60a5adb20
+  data.tar.gz: b4e95675496e2a12c58bdeb7e0a3b46115d1f16258316158620bb1c9ff7b03befc6551b887aa708a8463d96cd0828614bcef1817c68919a3e186f8b15114fec6

data/README.md

@@ -10,7 +10,7 @@ Instead, install it directly via RubyGems
 
     $ gem install pryx
 	
-Then use can use pryx cross all your's project.	
+Then user can use pryx cross all your's project.	
 
 ## Usage
 
@@ -26,13 +26,14 @@ $: ruby your_file.rb              # add pry! in your_file for start pry session
 
 or Run your's code directly use:
 
+
 ```sh
 $: RUBYOPT+='-rpryx' ruby your_file.rb  # add pry! in your_file for start pry session
 ```
 
 Then, try add `pry!` into your's ruby code, then run it, have fun!
 
-Following is a example, assume we have test.rb, it content like this:
+Following is a example, assume there is a `test.rb` with content:
 
 ```rb
 # test.rb
@@ -51,58 +52,46 @@ 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.
 
 
-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
-```
+the preferred way to use pryx is add `export RUBYOPT+=' -rpryx'` to system start script.
 
-__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.
+It should almost not affect your's code too much, only special methods defined into Kernel#, 
+no any gem be required before you invoke those added methods.
 
 ## useful command which added directly to Kernel#
 
-### Kernel#pry!   
-   
+### 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.
 
-we have IRB equivalent, named `irb!`, for use more nice feature, use following code instead:
-
-```sh
-$: RUBYOPT+='-rpryx_irb' ruby your_file.rb # add irb! in your_file for start pry session
-```
+we have IRB equivalent, named `irb!`, though, only a little feature support it.
 
 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) [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)
+1.  Add `Kernel#ls1`(use ls1 to avoid conflict with pry builtin ls command), see [looksee](https://github.com/oggy/looksee)
+2.  Use `ap` for pretty print. see [awesome-print](https://github.com/awesome-print/awesome_print)
+3.  Use `Clipboard.copy` or `Clipboard.paste` to interactive with system clipboard. see [clipboard](https://github.com/janlelis/clipboard)
 
-Following is pry command available only after start a Pry session:
+Following feature available only for a Pry session:
 
-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
+1.  Add `next/step/continue/up/down` command for debug, use [pry-nav](https://github.com/nixme/pry-nav) [pry-stack_explorer](https://github.com/pry/pry-stack_explorer)
+2.  Add `$/?` command for see source, see [pry-doc](https://github.com/pry/pry-doc)
+3.  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)
-7.  Add `yes` or `y` command, see [pry-yes](https://github.com/christofferh/pry-yes)
+4.  Add `pa` command, see [pry-power_assert](https://github.com/yui-knk/pry-power_assert)
+5.  Add `hier` command for print the class hierarchies, see [pry-hier](https://github.com/phaul/pry-hier)
+6.  Add `pry-aa_ancestors` command for print the class hierarchy, see [pry-aa_ancestors](https://github.com/tbpgr/pry-aa_ancestors)
+7.  Add `up/down/frame/stack` command, see [pry-stack_explorer](https://github.com/pry/pry-stack_explorer)
+8.  Add `yes` or `y` command, see [pry-yes](https://github.com/christofferh/pry-yes)
 9.  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)
+### Kernel#pry1 Kernel#pry2  (sorry for the 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.
 
@@ -153,8 +142,10 @@ But, you should only use it in development, though, it was tested is run in cont
 
 ## 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
+  1. When use looksee with irb for Ruby 3.1.x, looksee output color was not correct displayed.
+     check: https://github.com/oggy/looksee/issues/57
+  2. Pry's show auto-watch when not work, because `Enter` key rebinding to `run the last command`.
+     i consider this is more useful, you can always use `w` alias to see the watch changes.
 
 ## Support
 

data/bin/irbx

@@ -9,4 +9,8 @@
 require 'irb'
 require 'pryx_cli'
 
+# Fix `irb: warn: can't alias ls from irb_ls` issue.
+# See: https://github.com/oggy/looksee/issues/56
+Looksee.rename :_ls
+
 IRB.start(__FILE__)

data/bin/pryx

@@ -7,8 +7,8 @@
 $0 = 'pry'
 
 require 'pry'
-require 'pryx/pry_plugins'
 require 'pryx_cli'
+require 'pryx/pry_plugins'
 
 # Process command line options and run Pry
 opts = Pry::CLI.parse_options

data/lib/pry-state/hook_action.rb

@@ -13,6 +13,12 @@ class HookAction
   end
 
   def act
+    # when using guard, locals :e, :lib, :pry_state_prev get printed.
+    # this 'if' cuts them off.
+    if @binding.eval("self.class") == Object
+      return
+    end
+
     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'

data/lib/pryx/ap_hack.rb

@@ -8,6 +8,7 @@ if defined? AwesomePrint
   if defined? Pry
     AwesomePrint.pry!
   else
+    # auto ap only works when running with `irbx`
     AwesomePrint.irb!
   end
 end

data/lib/pryx/common_plugins.rb

@@ -1,12 +1,3 @@
-require 'binding_of_caller'
 require 'clipboard'
-
-# HACK: for ap 可以确保，当使用 irb! 时，looksee ls1 输出显示正确，同时不用关闭 irb :USE_COLORIZE 设置。
-# See https://github.com/oggy/looksee/issues/57
-# 但是，ap_hack 必须放到 break_hack 前面，调换顺序，上面的 hack 失效。
-# WARN: 下面两行 require 代码顺序不要换。
 require 'pryx/ap_hack'
-require 'break'
-Pry.commands.alias_command 'n', 'next'
-Pry.commands.alias_command 's', 'step'
-Pry.commands.alias_command 'w', 'watch' # watch is pry builtin
+require 'pryx/looksee_hack'

data/lib/pryx/irb_hack.rb

@@ -2,17 +2,7 @@ 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
+    require 'pryx/common_plugins'
 
     self.irb
   end
@@ -24,8 +14,6 @@ module Kernel
 
     ENV['IRB_was_started'] = 'true'
 
-    require 'binding_of_caller'
-
     irb3(2)
   end
 
@@ -40,9 +28,6 @@ module Kernel
   def irb2
     if ENV['IRB2_should_start'] == 'true'
       ENV['IRB2_should_start'] = nil
-
-      require 'binding_of_caller'
-
       irb3(2)
     end
   end

data/lib/pryx/looksee_hack.rb

@@ -11,12 +11,8 @@
 
 module Kernel
   def _load_looksee
-    case RbConfig::CONFIG['ruby_version']
-    when '1.9.0'...'2.1.0'
-      require 'old_looksee'
-    when '2.1.0'...'3.2.0'
-      require 'looksee'
-    end
+    require 'looksee'
+
     Looksee.rename :ls_looksee
 
     Looksee.editor = '.emacsclient +%l %f' # e.g. [].ls1.edit :to_set

data/lib/pryx/pry_hack.rb

@@ -9,6 +9,8 @@ class Binding
     end
 
     require 'pryx/common_plugins'
+
+    # NOTICE: Ensure pry-navs (in pry_plugins) always required after pry-remote
     require 'pryx/pry_plugins'
 
     if host
@@ -24,8 +26,11 @@ end
 
 module Kernel
   # 运行 pry! 会被拦截, 且只会被拦截一次.
-  def pry!(host: nil, port: 9876, state: true)
-    require 'pry-state' if state
+  def pry!(host: nil, port: 9876, state: false)
+    # You can use environment variables SHOW_GLOBAL_VARIABLES,
+    # HIDE_INSTANCE_VARIABLES and HIDE_LOCAL_VARIABLES
+    # to customise the kind of variables shown.
+    require_relative '../pry-state' if state
 
     if Pryx::Background.foreground? and host.nil?
       return unless ENV['Pry_was_started'].nil?
@@ -43,19 +48,6 @@ module Kernel
     ENV['Pry_was_started'] = nil
   end
 
-  # 和 pry! 的差别就是，pry? 使用 pry-state 插件输出当前 context 的很多变量内容。
-  # 注意：不需要总是开启 pry-state，因为有时候会输出太多内容，造成刷屏。
-  def pry?(host: nil, port: 9876)
-    return unless ENV['Pry_was_started'].nil?
-
-    require 'pry-state'
-    ENV['Pry_was_started'] = 'true'
-
-    pry3(2, host: host, port: port)
-
-    # 这里如果有代码, 将会让 pry! 进入这个方法, 因此保持为空.
-  end
-
   def pry1
     ENV['Pry2_should_start'] = 'true'
   end

data/lib/pryx/pry_plugins.rb

@@ -17,8 +17,10 @@ Pry::Commands.alias_command 'aa', 'aa_ancestors'
 require 'pry-stack_explorer' # Add command `up/down/frame[n]/stack`
 require 'pryx/pry-stack_explorer_hack'
 
+require 'pry-nav'
+
 # Add command `cc`
-Pry::Commands.block_command 'cc', 'Continue, but stop in pry! breakpoint' do
+Pry::Commands.block_command 'cc', 'Continue, but stop in pry! breakpoint too' do
   Pry.instance_variable_set(:@initial_session, true)
   ENV['Pry_was_started'] = nil
   throw(:breakout)
@@ -26,7 +28,9 @@ end
 
 Pry.commands.alias_command 'wai', 'whereami' # Add command alias `wai`
 
-# Hit Enter repeat last command
+# Hit Enter repeat last command, this feature will make auto-watch unavailable.
 Pry::Commands.command(/^$/, 'repeat last command') do
-  pry_instance.run_command Pry.history.to_a.last
+  run Pry.history.to_a.last
 end
+# So, add a new alias w for user use it manually
+Pry.commands.alias_command 'w', 'watch' # watch is pry builtin

data/lib/pryx/version.rb

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

data/lib/pryx.rb

@@ -3,7 +3,6 @@
 require 'pryx/version'
 require 'pryx/background'
 require 'pryx/trap_backtrace'
-require 'pryx/looksee_hack'
 require 'pryx/pry_hack'
 require 'pryx/irb_hack'
 

data/lib/pryx_cli.rb

@@ -1,12 +1,7 @@
-require 'clipboard'
-
-require 'pryx/ap_hack'
-
 # This require is needed, because can't require looksee in method when use with bundler.
 # bundler remove looksee from $LOAD_PATH when start with rails.
 require 'looksee'
-require 'pryx/looksee_hack'
-
+require 'pryx/common_plugins'
 require 'pryx'
 
 if File.exist? 'config/environment.rb'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pryx
 version: !ruby/object:Gem::Version
-  version: 0.8.6
+  version: 0.9.0
 platform: ruby
 authors:
 - Billy.Zheng(zw963)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-08 00:00:00.000000000 Z
+date: 2022-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -25,61 +25,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.9'
 - !ruby/object:Gem::Dependency
-  name: break
+  name: clipboard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: clipboard
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
-  name: looksee
+  name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: looksee
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '4.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '4.4'
 - !ruby/object:Gem::Dependency
   name: pry-aa_ancestors
   requirement: !ruby/object:Gem::Requirement
@@ -164,20 +164,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: pry-state
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.10
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.10
 - !ruby/object:Gem::Dependency
   name: m
   requirement: !ruby/object:Gem::Requirement
@@ -261,7 +247,6 @@ files:
 - lib/pryx/trap_backtrace.rb
 - lib/pryx/version.rb
 - lib/pryx_cli.rb
-- lib/pryx_irb.rb
 homepage: http://github.com/zw963/pryx
 licenses:
 - MIT
@@ -282,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: pry extension tools!

data/lib/pryx_irb.rb

@@ -1,9 +0,0 @@
-# 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.
-
-require 'pryx/common_plugins'
-require 'pryx'