pryx 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9d67d15a83b0d92beee0841d429cb42bc2c91ce2c0aea21b4a8ebb68cc88125
-  data.tar.gz: 828770b2b1bb5e958058d74136e9c759b461eac7ad8ff12c907ab92fa6b943f2
+  metadata.gz: '09eac82758bc4ccc6f232842efacfb4d6949bc2e4ed5a4a0e3277a6b239915b0'
+  data.tar.gz: f8244fb13a69f0db1973c80d24d6ca01fa63f54a486d968556e9844ec62cdc5a
 SHA512:
-  metadata.gz: 1d6f3688c0709bc039167c55aea81b6cee322381631b40f1507abdb4d18067c8e92a196d5deeb2899df61588a8bfd4397f8954301507c0e0357ab849995831fb
-  data.tar.gz: 8540e5b11640d70305e6f21f94459b7756bf13260ea441a87f62c89d3c4c90b308c021d0c5c59ea5d119300b31bbf1cba668620b394a316b8ae872c3a24728fb
+  metadata.gz: e827a19c29a4ec79ea836675183649ed897abaedbee169cf920f64940efe0b83a11af8102f22957f0ba139b35edc4cfcb067a9eaee30a36cbbdff75f9bb3a922
+  data.tar.gz: 5e7cd1b9e5d80ba3cd4d74fc20422f2151566958c2247e9a5eb92d869596a0b6a0f1d3e1aa2e73308daa1803917bb3f21ca2738ab15526f807b973a33673d43f

data/README.md

@@ -1,6 +1,7 @@
-# Pryx [![Build Status](https://travis-ci.org/zw963/pryx.svg?branch=master)](https://travis-ci.org/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://travis-ci.com/zw963/pryx) [![Gem Version](https://badge.fury.io/rb/pryx.svg)](http://badge.fury.io/rb/pryx)
+
+Three Virtues of a Programmer: Laziness, Impatience, and Hubris. -- Larry Wall, the author of Perl Programming language.
 
-TODO: Write a gem description
 
 ## Philosophy
 
@@ -8,24 +9,86 @@ TODO: Write philosophy
 
 ## Getting Started
 
-Install via Rubygems
+Don't add this gem into bundler's Gemfile.
+
+Instead, install it directly via RubyGems
 
     $ gem install pryx
 
-OR ...
+## Usage
+
+Before use it, you need set `RUBYOPT` variable.
 
-Add to your Gemfile
+You can do this two way in a terminal.
 
-    gem 'pryx'
+```sh
+$: export RUBYOPT+=' -rpryx'
+$: ruby your_file.rb              # add pry! in your_file for start pry session
 
-## Usage
+```
+
+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!
+
+## useful command add directly to 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
+```
+
+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]
+
+Following feature only available when start 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
+    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)
+
+pry2 do nothing, but it will be interceptd and start a pry session only after pry1 is running.
+
+I haven use this hack for avoid pry session start on working place.
+
+You know what i means.
+
+### irb1 irb2 
+
+IRB equivalent for pry1, pry2
+we have irb1 and irb2 too.
+
+### pry3
+
+It just normal `binding.pry`, that is, will always be intercept if code can reach.
+but above plugins and library all correct configured.
 
-TODO: Write usage instructions here
+we have another Kernel#pry?, which enable `pry-state` automatically, see [pry-state](https://github.com/SudhagarS/pry-state)
 
 ## Support
 
-  * MRI 1.9.3+
-  * Rubinius 2.2+
+  * MRI 2.2+
 
 ## Dependency
 
@@ -46,6 +109,8 @@ No known limit.
     * Commit your changes: `git commit -am 'Add some feature'`.
     * Push to the branch: `git push origin my-new-feature`.
     * Send a pull request :D.
+	
+	Not listed famous pry plugins is welcome!!
 
 ## license
 

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/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/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)
@@ -93,20 +110,34 @@ end
 
 # Hack for roda/rails, 在每一次发送请求之前，总是设定 ENV['Pry_was_started'] to nil.
 # 这可以确保，pry! 总是会被拦截，但是仅仅只会被拦截一次。
+
+class Pryx::PryHackForRodaRailsMiddleware
+  attr_reader :app
+
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    ENV['Pry_was_started'] = nil
+    @app.call(env)
+  end
+end
+
 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, 3, 0]
+  VERSION = [0, 4, 1]
 
   class << VERSION
     include Comparable

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pryx
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Billy.Zheng(zw963)
@@ -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,6 +189,10 @@ 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
@@ -191,5 +227,5 @@ requirements: []
 rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
-summary: ''
+summary: pry extension tools!
 test_files: []