pry-doc 0.13.0pre8 → 0.13.0pre9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f18f3949c483ac69e2b6b7786a72b176e9d7212
-  data.tar.gz: e6a1bbc5787add79d0d3ed0b75aba42f39545136
+  metadata.gz: bc2cce15654d5274eafc32d64f55017731f9c886
+  data.tar.gz: ab085546cca4977bd51a7d4be0c80804cd12af9c
 SHA512:
-  metadata.gz: 870ceb665ca6397cfcdf4995879f44a1f45972f05b3f259651d4f01a22983538c2e138b0dc424a06ab559d64d55b58fdb9ad536ffaed02461955811b79723bc0
-  data.tar.gz: e0c1d2da207f8a96bfcfceb71f8f243c81873dc13c00d2accc6d00e428b2dc636a26e44b43b70ac95dbc267c9779f370cb263b7ab6d7f67fad8c0c2201ecc3a0
+  metadata.gz: 7b0811fb74814d2f15f0c0ef562231ef7690eb889e1bcd9aff49babb8238eb6ee2fbd6f358149937194baf3c45bfdce6d05ba3e716322925a483e681a565700d
+  data.tar.gz: 6f21469f06a59961638c6db297b3fe2dc14a055946d18751a2c93423221acfb88bd4721dbbcd87a875086ba7d47a95b4a330110640b3a51dadeefb34d82a91f4

data/Rakefile

@@ -2,6 +2,7 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+task test: :spec
 
 dlext = RbConfig::CONFIG['DLEXT']
 direc = File.dirname(__FILE__)

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

@@ -4,14 +4,16 @@ module Pry::CInternals
   class ShowSourceWithCInternals < Pry::Command::ShowSource
     def options(opt)
       super(opt)
-      opt.on :c, "c-source", "Show source of a C symbol in MRI"
+      opt.on :c, "c-source", "Show source of a C identifier in MRI (rather than Ruby method of same name)"
     end
 
     def show_c_source
       if opts.present?(:all)
-        result, file = CodeFetcher.new(line_number_style).fetch_all_definitions(obj_name)
+        result, file = CodeFetcher.new(line_number_style: line_number_style)
+                         .fetch_all_definitions(obj_name)
       else
-        result, file = CodeFetcher.new(line_number_style).fetch_first_definition(obj_name)
+        result, file = CodeFetcher.new(line_number_style: line_number_style)
+                         .fetch_first_definition(obj_name)
       end
       if result
         set_file_and_dir_locals(file)
@@ -22,14 +24,14 @@ module Pry::CInternals
     end
 
     def process
-      if opts.present?(:c) && !Pry.config.skip_mri_source
+      if opts.present?(:c) && !Pry.config.skip_cruby_source
         show_c_source
         return
       else
         super
       end
     rescue Pry::CommandError
-      raise if Pry.config.skip_mri_source
+      raise if Pry.config.skip_cruby_source
       show_c_source
     end
 
@@ -38,15 +40,13 @@ module Pry::CInternals
     # We can number lines with their actual line numbers
     # or starting with 1 (base-one)
     def line_number_style
-      style = if opts.present?(:'base-one')
-                :'base-one'
-              elsif opts.present?(:'line-numbers')
-                :'line-numbers'
-              else
-                nil
-              end
-
-      { line_number_style: style }
+      if opts.present?(:'base-one')
+        :'base-one'
+      elsif opts.present?(:'line-numbers')
+        :'line-numbers'
+      else
+        nil
+      end
     end
 
     Pry::Commands.add_command(ShowSourceWithCInternals)

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

@@ -9,37 +9,56 @@
 # Following lines are the symbols followed by line number with char 127 as separator.
 module Pry::CInternals
   class CFile
-    SourceLocation = Struct.new(:file, :line, :original_symbol)
+    SourceLocation = Struct.new(:file, :line, :symbol_type)
 
     # Used to separate symbol from line number
     SYMBOL_SEPARATOR = "\x7f"
 
     attr_accessor :symbols, :file_name
+    attr_reader :ruby_source_folder
 
-    def self.from_str(str)
-      new(str).tap(&:process_symbols)
-    end
-
-    def initialize(str)
+    def initialize(str, ruby_source_folder: nil)
+      @ruby_source_folder = ruby_source_folder
       @lines = str.lines
       @file_name = @lines.shift.split(",").first
     end
 
     def process_symbols
-      array = @lines.map do |v|
+      @symbols = @lines.each_with_object({}) do |v, h|
         symbol, line_number = v.split(SYMBOL_SEPARATOR)
-        [cleanup_symbol(symbol),
-         [SourceLocation.new(@file_name, cleanup_linenumber(line_number), symbol.strip)]]
+        next if symbol.strip =~ /^\w+$/ # these symbols are usually errors in etags
+        h[cleanup_symbol(symbol)] = [source_location_for(symbol, line_number)]
       end
-
-      @symbols = Hash[array]
     end
 
     private
 
+    def source_location_for(symbol, line_number)
+      SourceLocation.new(File.join(ruby_source_folder, @file_name),
+                         cleanup_linenumber(line_number), symbol_type_for(symbol.strip))
+    end
+
+    def symbol_type_for(symbol)
+      if symbol.start_with?("#define")
+        :macro
+      elsif symbol =~ /\bstruct\b/
+        :struct
+      elsif symbol =~ /\benum\b/
+        :enum
+      elsif symbol.start_with?("}")
+        :typedef_struct
+      elsif symbol =~/^typedef.*;$/
+        :typedef_oneliner
+      elsif symbol =~ /\($/
+        :function
+      else
+        :unknown
+      end
+    end
+
     def cleanup_symbol(symbol)
       symbol = symbol.split.last
-      symbol.chomp("(").chomp("*").chomp(";")
+      symbol.gsub(/\W/, '')
     end
 
     def cleanup_linenumber(line_number)

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

@@ -10,8 +10,15 @@ module Pry::CInternals
       attr_accessor :ruby_source_folder
     end
 
-    # normalized
-    def self.ruby_version() RUBY_VERSION.tr(".", "_") end
+    # The Ruby version that corresponds to a downloadable release
+    # Note that after Ruby 2.1.0 they exclude the patchlevel from the release name
+    def self.ruby_version
+      if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.1.0")
+        RUBY_VERSION.tr(".", "_")
+      else
+        RUBY_VERSION.tr(".", "_") + "_#{RUBY_PATCHLEVEL}"
+      end
+    end
 
     self.ruby_source_folder = File.join(File.expand_path("~/.pry.d"), "ruby-#{ruby_version}")
 
@@ -27,13 +34,12 @@ module Pry::CInternals
       infos = self.class.symbol_map[symbol]
       return unless infos
 
-      "".tap do |result|
-        infos.count.times do |index|
-          result << fetch_first_definition(symbol, index).first << "\n"
-        end
-
-        return [result, full_path_for(infos.first.file)]
+      result = ""
+      infos.count.times do |index|
+        result << fetch_first_definition(symbol, index).first << "\n"
       end
+
+      return [result, infos.first.file]
     end
 
     def fetch_first_definition(symbol, index=nil)
@@ -43,33 +49,25 @@ module Pry::CInternals
       info = infos[index || 0]
       code = symbol_extractor.extract(info)
 
-      "".tap do |result|
-        result << "\n#{bold('From: ')}#{info.file} @ line #{info.line}:\n"
-        result << "#{bold('Number of implementations:')} #{infos.count}\n" unless index
-        result << "#{bold('Number of lines: ')} #{code.lines.count}\n\n"
-        result << Pry::Code.new(code, start_line_for(info.line), :c).
-                    with_line_numbers(use_line_numbers?).highlighted
+      result = ""
+      result << "\n#{bold('From: ')}#{info.file} @ line #{info.line}:\n"
+      result << "#{bold('Number of implementations:')} #{infos.count}\n" unless index
+      result << "#{bold('Number of lines: ')} #{code.lines.count}\n\n"
+      result << Pry::Code.new(code, start_line_for(info.line), :c).
+                  with_line_numbers(use_line_numbers?).highlighted
+
+      return [result, info.file]
 
-        return [result, full_path_for(info.file)]
-      end
     end
 
     private
 
-    def full_path_for(file)
-      File.join(self.class.ruby_source_folder, file)
-    end
-
     def use_line_numbers?
       !!line_number_style
     end
 
     def start_line_for(line)
-      if line_number_style == :'base-one'
-        1
-      else
-        line || 1
-      end
+      line_number_style == :'base-one' ? 1 : line || 1
     end
 
     def self.symbol_map
@@ -81,7 +79,7 @@ module Pry::CInternals
 
     def self.parse_tagfile
       @c_files ||= tagfile.split("\f\n")[1..-1].map do |v|
-        CFile.from_str(v)
+        CFile.new(v, ruby_source_folder: ruby_source_folder).tap(&:process_symbols)
       end
     end
 
@@ -92,34 +90,47 @@ module Pry::CInternals
       @tagfile ||= File.read(tags)
     end
 
-    def self.check_for_error(message)
-      raise Pry::CommandError, message if $?.to_i != 0
+    # @param [String] message Message to display on error
+    # @param [&Block] block Optional assertion
+    def self.check_for_error(message, &block)
+      raise Pry::CommandError, message if $?.to_i != 0 || block && !block.call
     end
 
     def self.ask_for_install
-      puts "Method/class Not found - do you want to install MRI sources to attempt to resolve the lookup there? (This allows the lookup of C internals) Y/N"
+      print "Identifier not found - do you want to install CRuby sources to attempt to resolve the identifier there?\n(This allows the lookup of C internals) Y/N "
 
       if $stdin.gets !~ /^y/i
-        puts "MRI sources not installed. To prevent being asked again, add `Pry.config.skip_mri_source = true` to your ~/.pryrc"
+        puts "CRuby sources not installed. To prevent being asked again, add `Pry.config.skip_cruby_source = true` to your ~/.pryrc"
         raise Pry::CommandError, "No definition found."
       end
     end
 
     def self.install_and_setup_ruby_source
       ask_for_install
-      puts "Downloading and setting up Ruby #{ruby_version} source in attempt to resolve symbol..."
+      puts "Downloading and setting up Ruby #{ruby_version} source..."
+      download_ruby
+      generate_tagfile
+      puts "...Finished!"
+    end
+
+    def self.download_ruby
+      curl_cmd = "curl --show-error --fail-early --fail -L https://github.com/ruby/ruby/archive/v#{ruby_version}.tar.gz | tar xzvf - 2> /dev/null"
+
       FileUtils.mkdir_p(ruby_source_folder)
       FileUtils.cd(File.dirname(ruby_source_folder)) do
-        %x{ curl -L https://github.com/ruby/ruby/archive/v#{ruby_version}.tar.gz | tar xzvf - > /dev/null 2>&1 }
-        check_for_error("curl")
+        %x{ #{curl_cmd} }
+        check_for_error(curl_cmd) { Dir.entries(ruby_source_folder).count > 5 }
       end
+    end
+
+    def self.generate_tagfile
+      find_cmd = "find . -type f -name '*.[chy]' | etags - --no-members -o tags"
 
       FileUtils.cd(ruby_source_folder) do
         puts "Generating tagfile!"
-        %x{ find . -type f -name "*.[chy]" | etags - --no-members -o tags }
-        check_for_error("find | etags")
+        %x{ #{find_cmd} }
+        check_for_error(find_cmd) { File.size(File.join(ruby_source_folder, "tags")) > 500 }
       end
-      puts "...Finished!"
     end
   end
 end

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

@@ -10,16 +10,20 @@ module Pry::CInternals
     end
 
     def extract(info)
-      if info.original_symbol.start_with?("#define")
+      case info.symbol_type
+      when :macro
         extract_macro(info)
-      elsif info.original_symbol =~ /\s+(struct|enum)\s+/
+      when :struct, :enum
         extract_struct(info)
-      elsif info.original_symbol.start_with?("}")
+      when :typedef_struct
         extract_typedef_struct(info)
-      elsif info.original_symbol =~/^typedef.*;$/
-        extract_typedef_oneliner(info)
-      else
+      when :typedef_oneliner
+        extract_oneliner(info)
+      when :function
         extract_function(info)
+      else
+        # if we dont know what it is, just extract out a single line
+        extract_oneliner(info)
       end
     end
 
@@ -43,7 +47,7 @@ module Pry::CInternals
       end
     end
 
-    def extract_typedef_oneliner(info)
+    def extract_oneliner(info)
       source_file = source_from_file(info.file)
       return source_file[info.line]
     end
@@ -57,7 +61,13 @@ module Pry::CInternals
         offset += 1
       end
 
-      offset += 1 if !source_file[info.line].strip.end_with?("{")
+      (0..4).each do |v|
+        line = source_file[info.line + v]
+        if line && line.strip.end_with?("{")
+          offset += v
+          break
+        end
+      end
 
       extract_code(info, offset: offset, start_line: start_line) do |code|
         return code if balanced?(code)
@@ -81,35 +91,21 @@ module Pry::CInternals
     end
 
     def function_return_type?(str)
-      str.strip =~ /[\w\*]$/
+      str.strip =~ /\w\s*\*?$/
     end
 
     def balanced?(str)
       tokens = CodeRay.scan(str, :c).tokens.each_slice(2)
-      token_count(tokens, /{/) == token_count(tokens, /}/)
+      token_count(tokens, '{') == token_count(tokens, '}')
     end
 
     def token_count(tokens, token)
-      tokens.count { |v|  v.first =~ token && v.last == :operator }
+      tokens.count { |v| v.first.to_s.include?(token) && v.last == :operator }
     end
 
     def source_from_file(file)
-      file_cache = self.class.file_cache
-      if file_cache.key?(file)
-        file_cache[file]
-      else
-        # inject a "\n" as first element to align array index and line number
-        file_cache[file] = ["\n", *File.read(full_path_for(file)).lines]
-      end
-    end
-
-    def full_path_for(file)
-      File.join(@ruby_source_folder, file)
-    end
-
-    # normalized
-    def ruby_version
-      RUBY_VERSION.tr(".", "_")
+      # inject a leading "\n" to align array index and line number
+      self.class.file_cache[file] ||= ["\n", *File.read(file).lines]
     end
   end
 end

data/lib/pry-doc/version.rb

@@ -1,3 +1,3 @@
 module PryDoc
-  VERSION = '0.13.0pre8'
+  VERSION = '0.13.0pre9'
 end

data/pry-doc.gemspec

@@ -23,7 +23,7 @@ DESCR
   s.required_ruby_version = '>= 2.0'
 
   s.add_dependency 'yard', "~> 0.9.11"
-  s.add_dependency 'pry', ">= 0.11.3"
+  s.add_dependency 'pry', "~> 0.11.3"
   s.add_development_dependency 'latest_ruby', '~> 0.0'
   s.add_development_dependency 'rspec', '~> 3.5'
   s.add_development_dependency 'rake', "~> 10.0"

data/spec/pry-doc_spec.rb

@@ -47,8 +47,14 @@ RSpec.describe PryDoc do
     end
 
     describe "#fetch_all_definitions" do
+      it "returns both code and file name" do
+        file_ = described_class.symbol_map["foo"].first.file
+        _, file = described_class.new.fetch_all_definitions("foo")
+        expect(file).to eq file_
+      end
+
       it "returns the code for all symbols" do
-        code, = described_class.new(line_number_style: nil).fetch_all_definitions("foo")
+        code, = described_class.new.fetch_all_definitions("foo")
         expect(decolor code).to include <<EOF
 int
 foo(void) {
@@ -65,6 +71,12 @@ EOF
     end
 
     describe "#fetch_first_definition" do
+      it "returns both code and file name" do
+        code, file = described_class.new.fetch_first_definition("wassup")
+        expect(decolor code).to include "typedef int wassup;"
+        expect(file).to eq File.join(__dir__, "fixtures/c_source/hello.c")
+      end
+
       context "with line numbers" do
         context "normal style (actual line numbers)" do
           it "displays actual line numbers" do
@@ -94,7 +106,7 @@ EOF
       end
 
       it "returns the code for a function" do
-        code, = described_class.new(line_number_style: nil).fetch_first_definition("foo")
+        code, = described_class.new.fetch_first_definition("foo")
         expect(decolor code).to include(<<EOF
 int
 foo(void) {
@@ -109,7 +121,7 @@ EOF
       end
 
       it "returns the code for an enum" do
-        code, = described_class.new(line_number_style: nil).fetch_first_definition("bar")
+        code, = described_class.new.fetch_first_definition("bar")
         expect(decolor code).to include <<EOF
 enum bar {
   alpha,
@@ -120,19 +132,19 @@ EOF
       end
 
       it "returns the code for a macro" do
-        code, = described_class.new(line_number_style: nil).fetch_first_definition("baby")
+        code, = described_class.new.fetch_first_definition("baby")
         expect(decolor code).to include('#define baby do {')
         expect(decolor code).to include('printf("baby");')
         expect(decolor code).to include('while(0)')
       end
 
       it "returns the code for a typedef" do
-        code, = described_class.new(line_number_style: nil).fetch_first_definition("wassup")
+        code, = described_class.new.fetch_first_definition("wassup")
         expect(decolor code).to include('typedef int wassup;')
       end
 
       it "returns the code for a struct" do
-        code, = described_class.new(line_number_style: nil).fetch_first_definition("baz")
+        code, = described_class.new.fetch_first_definition("baz")
         expect(decolor code).to include <<EOF
 struct baz {
   int x;
@@ -142,7 +154,7 @@ EOF
       end
 
       it "returns the code for a typedef'd struct" do
-        code, = described_class.new(line_number_style: nil).fetch_first_definition("cutie_pie")
+        code, = described_class.new.fetch_first_definition("cutie_pie")
         expect(decolor code).to include <<EOF
 typedef struct {
   int lovely;
@@ -152,7 +164,7 @@ EOF
       end
 
       it "returns the code for a typedef'd enum" do
-        code, = described_class.new(line_number_style: nil).fetch_first_definition("baby_enum")
+        code, = described_class.new.fetch_first_definition("baby_enum")
         expect(decolor code).to include <<EOF
 typedef enum cute_enum_e {
   lillybing,
@@ -165,7 +177,7 @@ EOF
       context "function definitions" do
         context "return type is on same line" do
           subject do
-            decolor described_class.new(line_number_style: nil)
+            decolor described_class.new
                       .fetch_first_definition("tinkywinky")
                       .first
           end
@@ -177,9 +189,9 @@ EOF
           end
         end
 
-        context "curl brackets on subsequent line" do
+        context "curly brackets on subsequent line" do
           subject do
-            decolor described_class.new(line_number_style: nil)
+            decolor described_class.new
                       .fetch_first_definition("lala")
                       .first
           end
@@ -194,7 +206,7 @@ EOF
 
         context "return type on prior line and curly brackets on subsequent" do
           subject do
-            decolor described_class.new(line_number_style: nil)
+            decolor described_class.new
                       .fetch_first_definition("po")
                       .first
           end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: pry-doc
 version: !ruby/object:Gem::Version
-  version: 0.13.0pre8
+  version: 0.13.0pre9
 platform: ruby
 authors:
 - John Mair (banisterfiend)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-08 00:00:00.000000000 Z
+date: 2018-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.11
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.11.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.11.3
 - !ruby/object:Gem::Dependency
   name: latest_ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 description: |
@@ -92,9 +92,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- ".yardopts"
+- .gitignore
+- .travis.yml
+- .yardopts
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -153,17 +153,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - '>'
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Provides YARD and extended documentation support for Pry