pryx 0.3.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcb416c6abf10f2f3445ba1f230cc22f2839fd2056e0eb789d292bc611a463c5
-  data.tar.gz: 560f480272bee2673cb6b415267dc224f30d618015123734f75d9a97ed3be311
+  metadata.gz: 8dc55b47663a1ef4812e8c462d08d69816ca9e8034c39cf73f118e57c020eada
+  data.tar.gz: ea4bc22be549f9dcd3ba149ae8c1946f258564d10b9a4126c150115fe3cd6df1
 SHA512:
-  metadata.gz: f042cb7cbe7d0ca0ceec859a39ef85d90fe871ca45fe1d34151a4fb87f094a9658f0ee35ef70a4900bd1a0f7e957e766127c82e4083f219b46150ba7f9b07b2a
-  data.tar.gz: e695d828a869dd19a654e91d087ea3c3ad777a5c951b2f07cb54e832e721d7a4d0f4f3e54a993cde6dedc86a2957b5f51a0417d5393ef7f43c8d83934e8ec706
+  metadata.gz: 5b8dacec92274b90a844479b7a0c1b473fc1a84e530a9da411a021dfe32476283a86b91c3219a1c8e8d3459319cf1838ce271a0070880bde6a8338130ad64286
+  data.tar.gz: 1e36fb07f093e6d53079fb8d4a074b3c391cceebab425602fc60df8e5bfec55cd3647232dd87de6a949f584a73ad448847245d8218c61565afc365de46f1ee26

data/README.md

@@ -1,35 +1,100 @@
-# 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)
 
-TODO: Write a gem description
-
-## Philosophy
-
-TODO: Write philosophy
+Three Virtues of a Programmer: Laziness, Impatience, and Hubris. -- Larry Wall, the author of Perl Programming language.
 
 ## 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
 
-Add to your Gemfile
+Before use it, you need set `RUBYOPT` variable.
 
-    gem 'pryx'
+You can do this two way in a terminal.
 
-## Usage
+```sh
+$: export RUBYOPT+=' -rpryx'
+$: ruby your_file.rb              # add pry! in your_file for start pry session
 
-TODO: Write usage instructions here
+```
 
-## Support
+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:
 
-  * MRI 1.9.3+
-  * Rubinius 2.2+
+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)
 
-## Dependency
+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 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 two binary, pryx, irbx
+
+pryx is same as pry, but, with plugins and libraries correct configured.
+
+irbx is same for irb.
+
+## 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.
+
+## Support
 
-No known limit.
+  * MRI 2.2+
 
 ## History
 
@@ -46,6 +111,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/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/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)

data/lib/pryx/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pryx
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.2
 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
@@ -161,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