pry-doc 0.12.0 → 0.13.0pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dddcde8d4130ee9d1cf1e2b11342be1e5aac4708c8c8cab9b89d3c667ad34f0
-  data.tar.gz: 7f9c47861ba003f7f67d5882da498a6c5c6d13476e8b09260103799fe3461264
+  metadata.gz: 971c24126e91d04263621b3ad0493fb11b88ae8192d400a0e8ee8d70b68a4003
+  data.tar.gz: 6c7886db101a8dd7b3e342ebd650938648bbbe10be1315c398a2f0b6576a0538
 SHA512:
-  metadata.gz: f848ad58137f8732722081f92d3d68ed32054813ff7a1a2eec2acf5dd62c2a7b80e55820684b8d10ce2471fa90a32556f8bd24ab446570056b084e3a0b867e76
-  data.tar.gz: dd80231ecf32471e38a3780cc2efc2e6f843d86da9bdebfc0458868c04c3df23a7a1de3c56cae89d892a4fe6998e5679fa36531514a92723b60124df7aef0b10
+  metadata.gz: b170e72d7225b341aec06a40eb57eaf7c811ff6194a5a72fa55ce2cb65b73150ef2d9de1bc48e0c898bf306b5ea6d301d371147a054edcbbb4c8db6310db35f4
+  data.tar.gz: 5bc9c766dfe3d95ad39d0d1b21063a7344ed6e14b5dfec4deaa8f6529d6a44988719432483540252a835cece5bb43c381f9c2b9f50952aef00c30c5504d1ac1b

data/Rakefile

@@ -15,7 +15,7 @@ require "#{direc}/lib/#{PROJECT_NAME}/version"
 desc "reinstall gem"
 task :reinstall => :gems do
   sh "gem uninstall pry-doc" rescue nil
-  sh "gem install #{direc}/pkg/pry-doc-#{PryDoc::VERSION}.gem"
+  sh "gem install #{direc}/pkg/pry-doc-#{PryDoc::VERSION}.gem --no-document"
 end
 
 desc "build all platform gems at once"

data/lib/pry-doc/pry_ext/method_info.rb

@@ -1,3 +1,5 @@
+require_relative "show_source_with_c_internals"
+
 class Pry
   module MethodInfo
     class << self

data/lib/pry-doc/pry_ext/show_source_with_c_internals.rb

@@ -0,0 +1,34 @@
+require_relative "show_source_with_c_internals/c_extractor"
+
+class ShowSourceWithCInternals < Pry::Command::ShowSource
+  def options(opt)
+    super(opt)
+    opt.on :c, "c-source", "Show source of a C symbol in MRI"
+  end
+
+  def extract_c_source
+    if opts.present?(:all)
+      result = CExtractor.new(opts).show_all_definitions(obj_name)
+    else
+      result = CExtractor.new(opts).show_first_definition(obj_name)
+    end
+    if result
+      _pry_.pager.page result
+    else
+      raise CommandError, no_definition_message
+    end
+  end
+
+  def process
+    if opts.present?(:c)
+      extract_c_source
+      return
+    else
+      super
+    end
+  rescue Pry::CommandError
+    extract_c_source
+  end
+
+  Pry::Commands.add_command(ShowSourceWithCInternals)
+end

data/lib/pry-doc/pry_ext/show_source_with_c_internals/c_extractor.rb

@@ -0,0 +1,195 @@
+require 'fileutils'
+require_relative 'c_file'
+
+class CExtractor
+  include Pry::Helpers::Text
+
+  class << self
+    attr_accessor :file_cache
+  end
+  @file_cache = {}
+
+  attr_reader :opts
+
+  def initialize(opts)
+    @opts = opts
+  end
+
+  def balanced?(str)
+    tokens = CodeRay.scan(str, :c).tokens.each_slice(2).to_a
+    tokens.count { |v|
+      v.first =~ /{/ && v.last == :operator } == tokens.count { |v|
+      v.first =~ /}/ && v.last == :operator
+    }
+  end
+
+  def extract_struct(info)
+    source_file = source_from_file(info.file)
+    offset = 1
+    loop do
+      code = source_file[info.line, offset].join
+      break code if balanced?(code)
+      offset += 1
+    end
+  end
+
+  def extract_typedef_struct(info)
+    source_file = source_from_file(info.file)
+    offset = 1
+    loop do
+      code = source_file[info.line - offset..info.line].join
+      break code if balanced?(code)
+      offset += 1
+    end
+  end
+
+  def extract_macro(info)
+    source_file = source_from_file(info.file)
+    offset = 1
+    loop do
+      code = source_file[info.line, offset].join
+      break code unless source_file[info.line + offset - 1].strip.end_with?('\\')
+      offset += 1
+    end
+  end
+
+  def extract_typedef_oneliner(info)
+    source_file = source_from_file(info.file)
+    return source_file[info.line]
+  end
+
+  def extract_function(info)
+    source_file = source_from_file(info.file)
+    offset = 1
+
+    if source_file[info.line] !~ /\w+\s+\w\(/ && source_file[info.line - 1].strip =~ /[\w\*]$/
+      start_line = info.line - 1
+      offset += 1
+    else
+      start_line = info.line
+    end
+
+    if !source_file[info.line].strip.end_with?("{")
+      offset += 1
+    end
+
+    loop do
+      code = source_file[start_line, offset].join
+      break code if balanced?(code)
+      offset += 1
+    end
+  end
+
+  def file_cache
+    self.class.file_cache
+  end
+
+  def file_cache=(v)
+    self.class.file_cache = v
+  end
+
+  def full_path_for(file)
+    File.join(File.expand_path("~/.pry.d/ruby-#{ruby_version}"), file)
+  end
+
+  def source_from_file(file)
+    if file_cache.key?(file)
+      file_cache[file]
+    else
+      file_cache[file] = File.read(full_path_for(file)).lines
+      file_cache[file].unshift("\n")
+    end
+  end
+
+  def use_line_numbers?
+    opts.present?(:b) || opts.present?(:l)
+  end
+
+  def show_all_definitions(x)
+    infos = self.class.symbol_map[x]
+    return unless infos
+
+    result = ""
+    infos.count.times do |index|
+      result << show_first_definition(x, index) << "\n"
+    end
+    result
+  end
+
+  def show_first_definition(x, index=nil)
+    infos = self.class.symbol_map[x]
+    return unless infos
+
+    count = infos.count
+    info = infos[index || 0]
+    code = if info.original_symbol.start_with?("#define")
+             extract_macro(info)
+           elsif info.original_symbol =~ /\s*struct\s*/ || info.original_symbol.start_with?("enum")
+             extract_struct(info)
+           elsif info.original_symbol.start_with?("}")
+             extract_typedef_struct(info)
+           elsif info.original_symbol =~/^typedef.*;$/
+             extract_typedef_oneliner(info)
+           else
+             extract_function(info)
+           end
+
+    h = "\n#{bold('From: ')}#{info.file} @ line #{info.line}:\n"
+    h << "#{bold('Number of implementations:')} #{count}\n" unless index
+    h << "#{bold('Number of lines: ')} #{code.lines.count}\n\n"
+    h << Pry::Code.new(code, start_line_for(info.line), :c).
+           with_line_numbers(use_line_numbers?).highlighted
+  end
+
+  def start_line_for(line)
+    if opts.present?(:'base-one')
+      1
+    else
+      line || 1
+    end
+  end
+
+  def self.install_and_setup_ruby_source
+    puts "Downloading and setting up Ruby #{ruby_version} source..."
+    FileUtils.mkdir_p(File.expand_path("~/.pry.d/"))
+    FileUtils.cd(File.expand_path("~/.pry.d")) do
+      %x{ curl -L https://github.com/ruby/ruby/archive/v#{ruby_version}.tar.gz | tar xzvf - > /dev/null 2>&1 }
+    end
+
+    FileUtils.cd(File.expand_path("~/.pry.d/ruby-#{ruby_version}")) do
+      puts "Generating tagfile!"
+      %x{ find . -type f -name "*.[chy]" | etags -  -o tags }
+    end
+    puts "...Finished!"
+  end
+
+  def self.tagfile
+    if !File.directory?(File.expand_path("~/.pry.d/ruby-#{ruby_version}"))
+      install_and_setup_ruby_source
+    end
+
+    @tagfile ||= File.read(File.expand_path("~/.pry.d/ruby-#{ruby_version}/tags"))
+  end
+
+  def ruby_version
+    self.class.ruby_version
+  end
+
+  # normalized
+  def self.ruby_version
+    RUBY_VERSION.tr(".", "_")
+  end
+
+  def self.parse_tagfile
+    @c_files ||= tagfile.split("\f\n")[1..-1].map do |v|
+      CFile.from_str(v)
+    end
+  end
+
+  def self.symbol_map
+    parse_tagfile
+    @symbol_map ||= @c_files.each_with_object({}) do |v, h|
+      h.merge!(v.symbols) { |k, old_val, new_val| old_val + new_val }
+    end
+  end
+end

data/lib/pry-doc/pry_ext/show_source_with_c_internals/c_file.rb

@@ -0,0 +1,33 @@
+class CFile
+  SourceLocation = Struct.new(:file, :line, :original_symbol)
+
+  attr_accessor :symbols, :file_name
+
+  def self.from_str(str)
+    new(str).tap(&:process_symbols)
+  end
+
+  def initialize(str)
+    @lines = str.lines
+    @file_name = @lines.shift.split(",").first
+  end
+
+  def process_symbols
+    @symbols = @lines.map do |v|
+      symbol, line_number = v.split("\x7f")
+      [cleanup_symbol(symbol),
+       [SourceLocation.new(@file_name, cleanup_linenumber(line_number), symbol.strip)]]
+    end.to_h
+  end
+
+  private
+
+  def cleanup_symbol(symbol)
+    symbol = symbol.split.last
+    symbol.chomp("(").chomp("*").chomp(";")
+  end
+
+  def cleanup_linenumber(line_number)
+    line_number.split.first.to_i
+  end
+end

data/lib/pry-doc/version.rb

@@ -1,3 +1,3 @@
 module PryDoc
-  VERSION = '0.12.0'
+  VERSION = '0.13.0pre1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pry-doc
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0pre1
 platform: ruby
 authors:
 - John Mair (banisterfiend)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-21 00:00:00.000000000 Z
+date: 2018-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -128,6 +128,9 @@ files:
 - lib/pry-doc/docs/25/objects/root.dat
 - lib/pry-doc/docs/25/proxy_types
 - lib/pry-doc/pry_ext/method_info.rb
+- lib/pry-doc/pry_ext/show_source_with_c_internals.rb
+- lib/pry-doc/pry_ext/show_source_with_c_internals/c_extractor.rb
+- lib/pry-doc/pry_ext/show_source_with_c_internals/c_file.rb
 - lib/pry-doc/version.rb
 - pry-doc.gemspec
 - spec/gem_with_cext/gems/ext/extconf.rb
@@ -151,9 +154,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.3