pry-doc 0.13.2pre7 → 0.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a92e58a3ca468b0210dcebc21c7a7a466ab8167c0fff8b6ef78f634c0d938db
-  data.tar.gz: 416ea1f86b706da35c66bcb2e4e4b20969d0533abca761ecc9d71e6829124a46
+  metadata.gz: 103e744238b577ba5dd9be3e6f68d968d0a5d8389f0e644bcd47097db94615d3
+  data.tar.gz: 8a3648f1a0fc7cb95d681dc9d1b4448c9e368c2e51aae18b1c93b3f22f67b557
 SHA512:
-  metadata.gz: 68ccf8ee9fd41abda6ed98013335f71cc4bb2e7dad1909fc5c31301e462e2fef2d62b5e8589cf5efa287f05b21e02038bdc186218f738a16f78781fe287d3028
-  data.tar.gz: a958ebf650666981c40ab95626c6316ef70290193c2d07bd482abafa903b87df0452a246f7561b2fbf43d5d90e40dfae6970fc89d570a171a7507accb304dc2c
+  metadata.gz: 8600e1cc9e840f0b1e5506fd034dd9a176f89a854fd002da8f3e8dd9747742a31f7662ef16ecb2d4cfbbeb702b284749c9b14e2e1a08571fa3075fb3233e8531
+  data.tar.gz: '063338b70acd7313ce718f1314968aed4cc39e3e7f696803cac63a72db322898b19aecb4945a5dd48039ee27676c471f92ffbb5e8dd096c69c2e48c2659310eb'

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

@@ -8,72 +8,76 @@
 # First line is the name of the file
 # Following lines are the symbols followed by line number with char 127 as separator.
 module Pry::CInternals
-  class CFile
-    SourceLocation = Struct.new(:file, :line, :symbol_type)
+  class ETagParser
+    class CFile
+      # Used to separate symbol from line number
+      SYMBOL_SEPARATOR = "\x7f"
+      ALTERNATIVE_SEPARATOR = "\x1"
 
-    # Used to separate symbol from line number
-    SYMBOL_SEPARATOR = "\x7f"
-    ALTERNATIVE_SEPARATOR = "\x1"
+      attr_accessor :file_name
+      attr_reader :ruby_source_folder
 
-    attr_accessor :symbols, :file_name
-    attr_reader :ruby_source_folder
-
-    def initialize(str, ruby_source_folder: nil)
-      @ruby_source_folder = ruby_source_folder
-      @lines = str.lines
-      @file_name = @lines.shift.split(",").first
-    end
+      def initialize(file_name: file_name, content: content, ruby_source_folder: nil)
+        @ruby_source_folder = ruby_source_folder
+        @content = content
+        @file_name = file_name
+      end
 
-    def process_symbols
-      @symbols = @lines.each_with_object({}) do |v, h|
-        sep = v.include?(ALTERNATIVE_SEPARATOR) ? ALTERNATIVE_SEPARATOR : SYMBOL_SEPARATOR
-        symbol, line_number = v.split(sep)
-        next if symbol.strip =~ /^\w+$/ # these symbols are usually errors in etags
-        h[cleanup_symbol(symbol)] = [source_location_for(symbol, line_number)]
+      # Convert a C file to a map of symbols => SourceLocation that are found in that file
+      # e.g
+      # { "foo" => [SourceLocation], "bar"  => [SourceLocation] }
+      def symbol_map
+        return @symbol_map if @symbol_map
+        @symbol_map = @content.each_with_object({}) do |v, h|
+          sep = v.include?(ALTERNATIVE_SEPARATOR) ? ALTERNATIVE_SEPARATOR : SYMBOL_SEPARATOR
+          symbol, line_number = v.split(sep)
+          next if symbol.strip =~ /^\w+$/ # these symbols are usually errors in etags
+          h[cleanup_symbol(symbol)] = [source_location_for(symbol, line_number)]
+        end
       end
-    end
 
-    private
+      private
 
-    def source_location_for(symbol, line_number)
-      SourceLocation.new(full_path_for(@file_name),
-                         cleanup_linenumber(line_number), symbol_type_for(symbol.strip))
-    end
+      def source_location_for(symbol, line_number)
+        SourceLocation.new(full_path_for(@file_name),
+                           cleanup_linenumber(line_number), symbol_type_for(symbol.strip))
+      end
 
-    def full_path_for(file_name)
-      if Pry::Platform.windows?
-        # windows etags already has the path expanded, wtf
-        file_name
-      else
-        File.join(ruby_source_folder, @file_name)
+      def full_path_for(file_name)
+        if Pry::Platform.windows?
+          # windows etags already has the path expanded, wtf
+          file_name
+        else
+          File.join(ruby_source_folder, @file_name)
+        end
       end
-    end
 
-    def symbol_type_for(symbol)
-      if symbol =~ /#\s*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
+      def symbol_type_for(symbol)
+        if symbol =~ /#\s*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
-    end
 
-    def cleanup_symbol(symbol)
-      symbol = symbol.split.last
-      symbol.gsub(/\W/, '')
-    end
+      def cleanup_symbol(symbol)
+        symbol = symbol.split.last
+        symbol.gsub(/\W/, '')
+      end
 
-    def cleanup_linenumber(line_number)
-      line_number.split.first.to_i
+      def cleanup_linenumber(line_number)
+        line_number.split.first.to_i
+      end
     end
   end
 end

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

@@ -1,6 +1,6 @@
 require 'fileutils'
-require_relative 'c_file'
 require_relative 'symbol_extractor'
+require_relative 'etag_parser'
 require_relative 'ruby_source_installer'
 
 module Pry::CInternals
@@ -10,6 +10,7 @@ module Pry::CInternals
     class << self
       attr_accessor :ruby_source_folder
       attr_accessor :ruby_source_installer
+      attr_accessor :symbol_map
     end
 
     # The Ruby version that corresponds to a downloadable release
@@ -73,26 +74,16 @@ module Pry::CInternals
       line_number_style == :'base-one' ? 1 : line || 1
     end
 
+    # Returns a hash that maps C symbols to an array of SourceLocations
+    # e.g: symbol_map["VALUE"] #=> [SourceLocation_1, SourceLocation_2]
+    # A SourceLocation is defined like this: Struct.new(:file, :line, :symbol_type)
+    # e.g file: "foo.c", line: 20, symbol_type: "function"
     def self.symbol_map
-      @symbol_map ||= (
-        parse_tagfile
-        @c_files.each_with_object({}) do |v, h|
-          h.merge!(v.symbols) { |k, old_val, new_val| old_val + new_val }
-        end)
-    end
+      return @symbol_map if @symbol_map
 
-    def self.parse_tagfile
-      @c_files ||= tagfile.split("\f\n")[1..-1].map do |v|
-        CFile.new(v, ruby_source_folder: ruby_source_folder).tap(&:process_symbols)
-      end
-    end
-
-    def self.tagfile
-      tags = File.join(ruby_source_folder, "TAGS")
-      if !File.exists?(tags)
-        ruby_source_installer.install
-      end
-      @tagfile ||= File.read(tags)
+      tags_path = File.join(ruby_source_folder, "TAGS")
+      ruby_source_installer.install unless File.exists?(tags_path)
+      @symbol_map = ETagParser.symbol_map_for(tags_path, ruby_source_folder)
     end
   end
 end

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

@@ -0,0 +1,58 @@
+require_relative 'c_file'
+
+module Pry::CInternals
+  class ETagParser
+    SourceLocation = Struct.new(:file, :line, :symbol_type)
+
+    attr_reader :tags_path
+    attr_reader :ruby_source_folder
+
+    def self.symbol_map_for(tags_path, ruby_source_folder)
+      new(tags_path, ruby_source_folder).symbol_map
+    end
+
+    def initialize(tags_path, ruby_source_folder)
+      @tags_path = tags_path
+      @ruby_source_folder = ruby_source_folder
+    end
+
+    def symbol_map
+      parse_tagfile.each_with_object({}) do |c_file, hash|
+        # Append all the SourceLocations for a symbol to the same array
+        # e.g
+        # { "foo" => [SourceLocation_1] }
+        # { "foo" => [SourceLocation_2] }
+        # => { "foo" => [SourceLocation_1, SourceLocation_2] }
+        hash.merge!(c_file.symbol_map) { |key, old_val, new_val| old_val + new_val }
+      end
+    end
+
+    private
+
+    # \f\n  indicates a new C file boundary in the etags file.
+    # The first line is the name of the C file, e.g foo.c
+    # The successive lines contain information about the symbols for that file.
+    def parse_tagfile
+      tagfile_sections = tagfile.split("\f\n")
+      tagfile_sections.shift # first section is blank
+
+      tagfile_sections.map do |c_file_section|
+        file_name, content = file_name_and_content_for(c_file_section)
+        CFile.new(file_name: file_name, content: content, ruby_source_folder: ruby_source_folder)
+      end
+    end
+
+    def file_name_and_content_for(c_file_section)
+      file_name, *content = c_file_section.lines
+      [clean_file_name(file_name), content]
+    end
+
+    def tagfile
+      File.read(tags_path)
+    end
+
+    def clean_file_name(file_name)
+      file_name.split(",").first
+    end
+  end
+end

data/lib/pry-doc/version.rb

@@ -1,3 +1,3 @@
 module PryDoc
-  VERSION = '0.13.2pre7'
+  VERSION = '0.13.2'
 end

data/spec/pry-doc_spec.rb

@@ -18,6 +18,7 @@ RSpec.describe PryDoc do
     end
 
     before do
+      described_class.symbol_map = nil
       described_class.ruby_source_folder = File.join(File.dirname(__FILE__), "fixtures/c_source")
     end
 
@@ -27,9 +28,9 @@ RSpec.describe PryDoc do
         expect(described_class.ruby_source_installer).to receive(:install)
 
         # will try to read from the 'created' tags file, this will error, so rescue
-        # (since we're stubbing out `install_and_setup_ruby_source` no tags file
+        # (since we're stubbing out `install` no tags file
         # ever gets created)
-        described_class.tagfile rescue nil
+        described_class.symbol_map rescue nil
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pry-doc
 version: !ruby/object:Gem::Version
-  version: 0.13.2pre7
+  version: 0.13.2
 platform: ruby
 authors:
 - John Mair (banisterfiend)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-24 00:00:00.000000000 Z
+date: 2018-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -131,6 +131,7 @@ files:
 - lib/pry-doc/pry_ext/show_source_with_c_internals.rb
 - lib/pry-doc/pry_ext/show_source_with_c_internals/c_file.rb
 - lib/pry-doc/pry_ext/show_source_with_c_internals/code_fetcher.rb
+- lib/pry-doc/pry_ext/show_source_with_c_internals/etag_parser.rb
 - lib/pry-doc/pry_ext/show_source_with_c_internals/ruby_source_installer.rb
 - lib/pry-doc/pry_ext/show_source_with_c_internals/symbol_extractor.rb
 - lib/pry-doc/version.rb
@@ -162,9 +163,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.3