Module: Pry::Helpers::DocumentationHelpers

Included in:
Command, Command::ShowDoc, Command::ShowSource, Method, WrappedModule::Candidate
Defined in:
lib/pry/helpers/documentation_helpers.rb

Overview

This class contains methods useful for extracting documentation from methods and classes.

Constant Summary collapse

YARD_TAGS = 
%w[
  param return option yield attr attr_reader attr_writer deprecate example
  raise
].freeze

Class Method Summary collapse

Class Method Details

.get_comment_content(comment) ⇒ String

Given a string that makes up a comment in a source-code file parse out the content that the user is intended to read. (i.e. without leading indentation, #-characters or shebangs)

Parameters:

  • comment (String)

Returns:

  • (String) 


67
68
69
70
71
72
73
74
75
 
# File 'lib/pry/helpers/documentation_helpers.rb', line 67

def get_comment_content(comment)
  comment = comment.dup
  # Remove #!/usr/bin/ruby
  comment.gsub!(/\A\#!.*$/, '')
  # Remove leading empty comment lines
  comment.gsub!(/\A\#+?$/, '')
  comment.gsub!(/^\s*#/, '')
  strip_leading_whitespace(comment)
end

.process_comment_markup(comment) ⇒ Object 



51
52
53
 
# File 'lib/pry/helpers/documentation_helpers.rb', line 51

def process_comment_markup(comment)
  process_yardoc process_rdoc(comment)
end

.process_rdoc(comment) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/pry/helpers/documentation_helpers.rb', line 15

def process_rdoc(comment)
  comment = comment.dup
  last_match_ruby = proc do
    SyntaxHighlighter.highlight(Regexp.last_match(1))
  end

  comment.gsub(%r{<code>(?:\s*\n)?(.*?)\s*</code>}m, &last_match_ruby)
    .gsub(%r{<em>(?:\s*\n)?(.*?)\s*</em>}m) { "\e[1m#{Regexp.last_match(1)}\e[0m" }
    .gsub(%r{<i>(?:\s*\n)?(.*?)\s*</i>}m) { "\e[1m#{Regexp.last_match(1)}\e[0m" }
    .gsub(%r{<tt>(?:\s*\n)?(.*?)\s*</tt>}m, &last_match_ruby)
    .gsub(/\B\+(\w+?)\+\B/) { "\e[32m#{Regexp.last_match(1)}\e[0m" }
    .gsub(/((?:^[ \t]+(?:(?!.+\e\[)).+(?:\n+|\Z))+)/, &last_match_ruby)
    .gsub(/`(?:\s*\n)?([^\e]*?)\s*`/) { "`#{last_match_ruby.call}`" }
end

.process_yardoc(comment) ⇒ Object 



45
46
47
48
49
 
# File 'lib/pry/helpers/documentation_helpers.rb', line 45

def process_yardoc(comment)
  (YARD_TAGS - %w[example])
    .inject(comment) { |a, v| process_yardoc_tag(a, v) }
    .gsub(/^@(#{YARD_TAGS.join("|")})/) { "\e[33m#{Regexp.last_match(1)}\e[0m" }
end

.process_yardoc_tag(comment, tag) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/pry/helpers/documentation_helpers.rb', line 30

def process_yardoc_tag(comment, tag)
  in_tag_block = nil
  comment.lines.map do |v|
    if in_tag_block && v !~ /^\S/
      Pry::Helpers::Text.strip_color Pry::Helpers::Text.strip_color(v)
    elsif in_tag_block
      in_tag_block = false
      v
    else
      in_tag_block = true if v =~ /^@#{tag}/
      v
    end
  end.join
end

.strip_comments_from_c_code(code) ⇒ String

Parameters:

  • code (String)

Returns:

  • (String) 


57
58
59
 
# File 'lib/pry/helpers/documentation_helpers.rb', line 57

def strip_comments_from_c_code(code)
  code.sub(%r{\A\s*/\*.*?\*/\s*}m, '')
end

.strip_leading_whitespace(text) ⇒ String

Parameters:

  • text (String)

Returns:

  • (String) 


79
80
81
 
# File 'lib/pry/helpers/documentation_helpers.rb', line 79

def strip_leading_whitespace(text)
  Pry::Helpers::CommandHelpers.unindent(text)
end