pry-doc 0.13.0pre7 → 0.13.0pre8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecf2ae29bffe6f81c0a6ec6dce2e15c2ce364d09
-  data.tar.gz: 20fd2f5ae0a4f1cb9eab9c736e199991d40834ff
+  metadata.gz: 4f18f3949c483ac69e2b6b7786a72b176e9d7212
+  data.tar.gz: e6a1bbc5787add79d0d3ed0b75aba42f39545136
 SHA512:
-  metadata.gz: de7b2c32043e9917fce673b8bf10b2070ce17e091cd08bc9708ec4d51441f22e9a6ba5c16af886cab9684f8aa29a34c62d817d6dc65c54c8eb912833e15ff122
-  data.tar.gz: 0273e48b4b2c3bfcdc0480204b065c85e3465827c13049c065edcd890a265b90005c6866c2adaa189d1e22a598fe1615aae073af1aae7b89e215d0e6486f97f0
+  metadata.gz: 870ceb665ca6397cfcdf4995879f44a1f45972f05b3f259651d4f01a22983538c2e138b0dc424a06ab559d64d55b58fdb9ad536ffaed02461955811b79723bc0
+  data.tar.gz: e0c1d2da207f8a96bfcfceb71f8f243c81873dc13c00d2accc6d00e428b2dc636a26e44b43b70ac95dbc267c9779f370cb263b7ab6d7f67fad8c0c2201ecc3a0

data/Rakefile

@@ -17,6 +17,11 @@ task :pry_fixture do
   sh %{pry -I./lib -r pry-doc -e "Pry::CInternals::CodeFetcher.ruby_source_folder = './spec/fixtures/c_source'"}
 end
 
+desc "start pry with pry-doc code loaded"
+task :pry do
+  sh "pry -I./lib -r pry-doc"
+end
+
 desc "generate fixture etags"
 task :etags do
   sh 'etags --no-members spec/fixtures/c_source/*.c -o spec/fixtures/c_source/tags'

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

@@ -22,13 +22,14 @@ module Pry::CInternals
     end
 
     def process
-      if opts.present?(:c)
+      if opts.present?(:c) && !Pry.config.skip_mri_source
         show_c_source
         return
       else
         super
       end
     rescue Pry::CommandError
+      raise if Pry.config.skip_mri_source
       show_c_source
     end
 

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

@@ -96,7 +96,17 @@ module Pry::CInternals
       raise Pry::CommandError, message if $?.to_i != 0
     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"
+
+      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"
+        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..."
       FileUtils.mkdir_p(ruby_source_folder)
       FileUtils.cd(File.dirname(ruby_source_folder)) do

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

@@ -50,17 +50,14 @@ module Pry::CInternals
 
     def extract_function(info)
       source_file = source_from_file(info.file)
-      offset = 1
-      start_line = info.line
+      offset, start_line = 1, info.line
 
       if !complete_function_signature?(source_file[info.line]) && function_return_type?(source_file[info.line - 1])
         start_line = info.line - 1
         offset += 1
       end
 
-      if !source_file[info.line].strip.end_with?("{")
-        offset += 1
-      end
+      offset += 1 if !source_file[info.line].strip.end_with?("{")
 
       extract_code(info, offset: offset, start_line: start_line) do |code|
         return code if balanced?(code)
@@ -70,13 +67,11 @@ module Pry::CInternals
     def extract_code(info, offset: 1, start_line: info.line, direction: :forward, &block)
       source_file = source_from_file(info.file)
 
+      code_proc = direction == :reverse ? -> { source_file[start_line - offset..info.line].join }
+                  : -> { source_file[start_line, offset].join }
+
       loop do
-        code = if direction == :reverse
-                 source_file[start_line - offset..info.line].join
-               else
-                 source_file[start_line, offset].join
-               end
-        yield code
+        yield code_proc.()
         offset += 1
       end
     end

data/lib/pry-doc/version.rb

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

data/spec/fixtures/c_source/hello.c

@@ -29,3 +29,15 @@ typedef struct {
   int lovely;
   char horse;
 } cutie_pie;
+
+void tinkywinky(void) {
+}
+
+void lala(void)
+{
+}
+
+int*
+po(void)
+{
+}

data/spec/fixtures/c_source/tags

@@ -2,7 +2,7 @@
 goodbye.c,9
 foo(2,5
 
-hello.c,256
+hello.c,309
 foo(2,4
 #define baby 5,19
 typedef int wassup;9,73
@@ -17,3 +17,6 @@ typedef enum cute_enum_e 22,169
   lilt25,217
 } baby_enum;26,224
 } cutie_pie;31,283
+void tinkywinky(33,297
+void lala(36,324
+po(41,350

data/spec/pry-doc_spec.rb

@@ -100,7 +100,7 @@ int
 foo(void) {
 }
 EOF
-        ).or include <<EOF
+                                       ).or include <<EOF
 char
 foo(int*) {
   return 'a';
@@ -162,6 +162,52 @@ typedef enum cute_enum_e {
 EOF
       end
 
+      context "function definitions" do
+        context "return type is on same line" do
+          subject do
+            decolor described_class.new(line_number_style: nil)
+                      .fetch_first_definition("tinkywinky")
+                      .first
+          end
+
+          it do is_expected.to include <<EOF
+void tinkywinky(void) {
+}
+EOF
+          end
+        end
+
+        context "curl brackets on subsequent line" do
+          subject do
+            decolor described_class.new(line_number_style: nil)
+                      .fetch_first_definition("lala")
+                      .first
+          end
+
+          it do is_expected.to include <<EOF
+void lala(void)
+{
+}
+EOF
+          end
+        end
+
+        context "return type on prior line and curly brackets on subsequent" do
+          subject do
+            decolor described_class.new(line_number_style: nil)
+                      .fetch_first_definition("po")
+                      .first
+          end
+
+          it do is_expected.to include <<EOF
+int*
+po(void)
+{
+}
+EOF
+          end
+        end
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pry-doc
 version: !ruby/object:Gem::Version
-  version: 0.13.0pre7
+  version: 0.13.0pre8
 platform: ruby
 authors:
 - John Mair (banisterfiend)