pry-inline 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccf76045d92a7d2fc6007dd1c25e50ecd132cd32
-  data.tar.gz: 57745615589a32560e63968cb342257b9591967a
+  metadata.gz: 90b17cf9bb9eb0a447283a2ad34d1e581ed045c9
+  data.tar.gz: 12fc419a7d493a318bd4797facab7f715a7c4091
 SHA512:
-  metadata.gz: adf5e3164713671c75e60575e0cf4976230f069482d8491ede24e4b43bcc0d669bc140100b65d320d1b621ae2418d3676a49efb2392d0cef6a29fdb29a8b213b
-  data.tar.gz: 81e37a0a848be77bda06062269b3ee8e6256b51b461fde7628271af3a5b00f7a468a21143a0d042d7d2c4ba76320778c92db882b17ef0eef6412e14a431d3547
+  metadata.gz: 942e74b75b54f63f4849d3f986159281ca1d79cc1bcb3cb5116966705e37920c519bec4d1be97bf2fc01c24940d6e391079a3349ce3527d35ddfddac5f35d91d
+  data.tar.gz: 46e61a948e6ba68a844d85034f7f304d1a0aab067d2c88e7959a4898d0dcc6ff0c8c0469303792c64899cd18deea4c6316872dad7f83c85e55847c754906288c

data/.rubocop.yml

@@ -6,9 +6,6 @@ AllCops:
 Metrics/LineLength:
   Max: 120
 
-Style/ClassVars:
-  Enabled: false
-
 Style/Documentation:
   Enabled: false
 

data/Gemfile

@@ -1,8 +1,3 @@
 source 'https://rubygems.org'
 
 gemspec
-
-group :development do
-  gem 'rubocop'
-  gem 'pry-theme'
-end

data/README.md

@@ -1,7 +1,7 @@
 # Pry Inline
 
 Pry Inline is a plugin for [pry](https://github.com/pry/pry/),
-which enables the inline debugging functionality like [RubyMine](https://www.jetbrains.com/ruby/help/inline-debugging.html).
+which enables the inline variables view like [RubyMine](https://www.jetbrains.com/ruby/help/inline-debugging.html).
 
 ![screenshot](./screenshot.png)
 
@@ -25,7 +25,7 @@ Or install it yourself as:
 
 There is no need to edit any configuration.
 After you have added the dependency in Gemfile,
-pry-inline will enable the inline debugging functionality.
+pry-inline will enable the inline variables view functionality.
 
 ## Development
 

data/Rakefile

@@ -8,6 +8,7 @@ task default: [:test]
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
+  t.ruby_opts = ['-r./test/helper']
   t.test_files = Dir['test/**/test_*.rb']
   t.verbose = true
 end

data/lib/pry-inline.rb

@@ -2,10 +2,11 @@ require 'pry'
 require 'ripper'
 require 'set'
 
-require 'pry-inline/inline_debuggable_code'
+require 'pry-inline/code_extension'
+require 'pry-inline/parser'
 
 Pry.config.hooks.add_hook(:when_started, :pry_inline) do
-  Pry::Code.send(:prepend, PryInline::InlineDebuggableCode)
+  Pry::Code.send(:prepend, PryInline::CodeExtension)
 end
 
 before_session_hooks = Pry.config.hooks.get_hooks(:before_session)
@@ -13,7 +14,7 @@ Pry.config.hooks.delete_hooks(:before_session)
 
 begin
   Pry.config.hooks.add_hook(:before_session, :pry_inline) do |_, target, _|
-    PryInline::InlineDebuggableCode.binding = target
+    PryInline::CodeExtension.current_binding = target
   end
 ensure
   before_session_hooks.each do |name, callable|

data/lib/pry-inline/code_extension.rb

@@ -0,0 +1,106 @@
+require 'unicode'
+
+module PryInline
+  # monkey patch for Pry::Code
+  module CodeExtension
+    def self.current_binding
+      @current_binding
+    end
+
+    def self.current_binding=(value)
+      @current_binding = value
+    end
+
+    def print_to_output(output, color = false)
+      begin
+        not_colorized_output_lines = super('', false).split("\n")
+        @lineno_to_variables = Hash.new { |h, k| h[k] = Set.new }
+        traverse_sexp(Parser.sexp(@lines.map(&:line).join("\n")))
+
+        @lineno_to_variables.each do |lineno, variables|
+          variables.each do |v|
+            next unless @lineno_to_variables.any? do |l, vs|
+              l > lineno && vs.include?(v)
+            end
+            variables.delete(v)
+          end
+        end
+
+        current_line = CodeExtension.current_binding.eval('__LINE__')
+        @lineno_to_variables.each do |lineno, variables|
+          next if lineno == 0 || @lines.length <= lineno
+          next if lineno > (current_line - @lines[0].lineno)
+
+          original_width = Unicode.width(not_colorized_output_lines[lineno - 1], true)
+          debug_info_width = terminal_width - original_width % terminal_width + 1
+          debug_info_width += terminal_width if debug_info_width < min_debug_info_width
+
+          @lines[lineno - 1].tuple[0] +=
+            debug_info(variables)
+            .slice(0, debug_info_width)
+            .split('')
+            .map { |c| [c, Unicode.width(c, true)] }
+            .reduce([]) { |a, e| a + [[e[0], e[1] + (a.empty? ? 0 : a[-1][1])]] }
+            .take_while { |_, w| w < debug_info_width }
+            .map(&:first)
+            .join
+        end
+      ensure
+        ret = super(output, color)
+      end
+      ret
+    end
+
+    private
+
+    def terminal_width
+      `tput cols`.to_i
+    end
+
+    def traverse_sexp(sexp)
+      return unless sexp.is_a?(Array)
+      event = sexp[0]
+
+      return sexp.each { |s| traverse_sexp(s) } if event.is_a?(Array)
+      return traverse_sexp_in_assignment(sexp[1]) if %i( assign opassign massign ).include?(event)
+      return traverse_sexp_in_assignment(sexp[1..-1]) if event == :params
+      traverse_sexp(sexp[1..-1]) unless event.to_s.start_with?('@')
+    end
+
+    def traverse_sexp_in_assignment(sexp)
+      return unless sexp.is_a?(Array)
+      event = sexp[0]
+
+      return sexp.each { |s| traverse_sexp_in_assignment(s) } if event.is_a?(Array)
+      if %i( @ident @cvar @ivar @gvar ).include?(event)
+        return @lineno_to_variables[sexp[2][0]] << sexp[1]
+      elsif %i( @label ).include?(event)
+        return @lineno_to_variables[sexp[2][0]] << sexp[1].slice(0..-2)
+      end
+
+      traverse_sexp_in_assignment(sexp[1..-1])
+    end
+
+    def defined_variables
+      return [] unless CodeExtension.current_binding
+      %w(local_variables global_variables
+         self.instance_variables self.class.class_variables).map do |exp|
+        CodeExtension.current_binding.eval(exp)
+      end.flatten.to_set.map(&:to_s)
+    end
+
+    def debug_info(variables)
+      return '' if !variables || (variables & defined_variables).size <= 0
+      ' # ' + variables.select { |k| defined_variables.include?(k) }
+        .map { |k| "#{k}: #{CodeExtension.current_binding.eval(k).inspect.delete("\n")}" }
+        .join(', ')
+    end
+
+    def min_debug_info_width
+      if Pry.config.inline.is_a?(Hash)
+        min_width = Pry.config.inline[:min_debug_info_width]
+      end
+      min_width || 16
+    end
+  end
+end

data/lib/pry-inline/parser.rb

@@ -0,0 +1,37 @@
+require 'ripper'
+
+module PryInline
+  class Parser < Ripper
+    attr_reader :ret
+
+    def self.sexp(src, filename = '-', lineno = 1)
+      parser = Parser.new(src, filename, lineno)
+      parser.parse || parser.ret
+    end
+
+    Ripper::PARSER_EVENTS.each do |event|
+      module_eval(<<-End, __FILE__, __LINE__ + 1)
+        def on_#{event}(*args)
+          args.unshift :#{event}
+          @ret = args
+        end
+      End
+    end
+
+    Ripper::SCANNER_EVENTS.each do |event|
+      module_eval(<<-End, __FILE__, __LINE__ + 1)
+        def on_#{event}(tok)
+          @ret = [:@#{event}, tok, [lineno(), column()]]
+        end
+      End
+    end
+
+    def compile_error(_)
+      @ret
+    end
+
+    def on_parse_error(_)
+      @ret
+    end
+  end
+end

data/lib/pry-inline/version.rb

@@ -1,3 +1,3 @@
 module PryInline
-  VERSION = '0.1.2'
+  VERSION = '1.0.0'
 end

data/pry-inline.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Seiichi KONDO']
   spec.email         = ['seikichi@kmc.gr.jp']
 
-  spec.summary       = 'Inline debugging like RubyMine'
-  spec.description   = 'This Pry plugin enables inline debugging like RubyMine!'
+  spec.summary       = 'Inline variables view like RubyMine'
+  spec.description   = 'This Pry plugin enables inline variables view like RubyMine!'
   spec.homepage      = 'https://github.com/seikichi/pry-inline'
   spec.license       = 'MIT'
 
@@ -19,7 +19,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'pry', '~> 0.10.0'
+  spec.add_dependency 'unicode', '~> 0.4.4'
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'simplecov', '~> 0.10.0'
   spec.add_development_dependency 'test-unit', '>= 3.0.0'
+
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'pry-theme'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pry-inline
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Seiichi KONDO
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-06 00:00:00.000000000 Z
+date: 2015-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: unicode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +94,35 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
-description: This Pry plugin enables inline debugging like RubyMine!
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-theme
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This Pry plugin enables inline variables view like RubyMine!
 email:
 - seikichi@kmc.gr.jp
 executables: []
@@ -81,10 +137,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - lib/pry-inline.rb
-- lib/pry-inline/inline_debuggable_code.rb
+- lib/pry-inline/code_extension.rb
+- lib/pry-inline/parser.rb
 - lib/pry-inline/version.rb
 - pry-inline.gemspec
 - screenshot.png
@@ -111,6 +166,6 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Inline debugging like RubyMine
+summary: Inline variables view like RubyMine
 test_files: []
 has_rdoc: 

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'pry/inline'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start

data/bin/setup

@@ -1,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/pry-inline/inline_debuggable_code.rb

@@ -1,71 +0,0 @@
-module PryInline
-  # monkey patch for Pry::Code
-  module InlineDebuggableCode
-    MAX_DEBUG_INFO_LENGTH = 80
-
-    @@binding = nil
-
-    def self.binding=(value)
-      @@binding = value
-    end
-
-    def print_to_output(output, color = false)
-      begin
-        @lineno_to_variables = Hash.new { |h, k| h[k] = Set.new }
-        traverse_sexp(Ripper.sexp(@lines.map(&:line).join("\n")))
-        @lineno_to_variables.each do |lineno, variables|
-          next if lineno == 0 || @lines.length <= lineno
-          next if @with_marker && lineno > (@marker_lineno - @lines[0].lineno)
-          add_debug_info(@lines[lineno - 1], variables)
-        end
-      ensure
-        ret = super(output, color)
-      end
-      ret
-    end
-
-    private
-
-    def traverse_sexp(sexp)
-      return unless sexp.is_a?(Array)
-      event = sexp[0]
-
-      return sexp.each { |s| traverse_sexp(s) } if event.is_a?(Array)
-      return traverse_sexp_in_assignment(sexp[1]) if %i( assign massign ).include?(event)
-      return traverse_sexp_in_assignment(sexp[1..-1]) if event == :params
-      traverse_sexp(sexp[1..-1]) unless event.to_s.start_with?('@')
-    end
-
-    def traverse_sexp_in_assignment(sexp)
-      return unless sexp.is_a?(Array)
-      event = sexp[0]
-
-      return sexp.each { |s| traverse_sexp_in_assignment(s) } if event.is_a?(Array)
-      if %i( @ident @cvar @ivar ).include?(event)
-        return @lineno_to_variables[sexp[2][0]] << sexp[1]
-      end
-
-      traverse_sexp_in_assignment(sexp[1..-1])
-    end
-
-    def add_debug_info(loc, variables)
-      return if !variables || (variables & defined_variables).size <= 0
-      info = debug_info(variables)
-      loc.tuple[0] += " # #{info[0..MAX_DEBUG_INFO_LENGTH]}"
-      loc.tuple[0] += ' ...' if info.length > MAX_DEBUG_INFO_LENGTH
-    end
-
-    def defined_variables
-      return [] unless @@binding
-      @@binding.eval('local_variables').map(&:to_s) |
-        @@binding.eval('self.instance_variables').map(&:to_s) |
-        @@binding.eval('self.class.class_variables').map(&:to_s)
-    end
-
-    def debug_info(variables)
-      variables.select { |k| defined_variables.include?(k) }
-        .map { |k| "#{k}: #{@@binding.eval(k).inspect}" }
-        .join(', ')
-    end
-  end
-end