Module: Pry::Helpers::DocumentationHelpers

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

Overview

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

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (String) get_comment_content(comment)

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)


59
60
61
62
63
64
65
66
67
# File 'lib/pry/helpers/documentation_helpers.rb', line 59

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

+ (Object) process_comment_markup(comment)



43
44
45
# File 'lib/pry/helpers/documentation_helpers.rb', line 43

def process_comment_markup(comment)
  process_yardoc process_rdoc(comment)
end

+ (Object) process_rdoc(comment)



10
11
12
13
14
15
16
17
18
19
# File 'lib/pry/helpers/documentation_helpers.rb', line 10

def process_rdoc(comment)
  return comment unless Pry.color
  comment = comment.dup
  comment.gsub(/<code>(?:\s*\n)?(.*?)\s*<\/code>/m) { CodeRay.scan($1, :ruby).term }.
    gsub(/<em>(?:\s*\n)?(.*?)\s*<\/em>/m) { "\e[1m#{$1}\e[0m" }.
    gsub(/<i>(?:\s*\n)?(.*?)\s*<\/i>/m) { "\e[1m#{$1}\e[0m" }.
    gsub(/\B\+(\w+?)\+\B/)  { "\e[32m#{$1}\e[0m" }.
    gsub(/((?:^[ \t]+.+(?:\n+|\Z))+)/)  { CodeRay.scan($1, :ruby).term }.
    gsub(/`(?:\s*\n)?([^\e]*?)\s*`/) { "`#{CodeRay.scan($1, :ruby).term}`" }
end

+ (Object) process_yardoc(comment)



36
37
38
39
40
41
# File 'lib/pry/helpers/documentation_helpers.rb', line 36

def process_yardoc(comment)
  yard_tags = ["param", "return", "option", "yield", "attr", "attr_reader", "attr_writer",
               "deprecate", "example", "raise"]
  (yard_tags - ["example"]).inject(comment) { |a, v| process_yardoc_tag(a, v) }.
    gsub(/^@(#{yard_tags.join("|")})/) { Pry.color ? "\e[33m#{$1}\e[0m": $1 }
end

+ (Object) process_yardoc_tag(comment, tag)



21
22
23
24
25
26
27
28
29
30
31
32
33
34
# File 'lib/pry/helpers/documentation_helpers.rb', line 21

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

+ (String) strip_comments_from_c_code(code)

Parameters:

  • code (String)

Returns:

  • (String)


49
50
51
# File 'lib/pry/helpers/documentation_helpers.rb', line 49

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

+ (String) strip_leading_whitespace(text)

Parameters:

  • text (String)

Returns:

  • (String)


71
72
73
# File 'lib/pry/helpers/documentation_helpers.rb', line 71

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

Instance Method Details

- (String) get_comment_content(comment) (private)

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)


59
60
61
62
63
64
65
66
67
# File 'lib/pry/helpers/documentation_helpers.rb', line 59

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

- (Object) process_comment_markup(comment) (private)



43
44
45
# File 'lib/pry/helpers/documentation_helpers.rb', line 43

def process_comment_markup(comment)
  process_yardoc process_rdoc(comment)
end

- (Object) process_rdoc(comment) (private)



10
11
12
13
14
15
16
17
18
19
# File 'lib/pry/helpers/documentation_helpers.rb', line 10

def process_rdoc(comment)
  return comment unless Pry.color
  comment = comment.dup
  comment.gsub(/<code>(?:\s*\n)?(.*?)\s*<\/code>/m) { CodeRay.scan($1, :ruby).term }.
    gsub(/<em>(?:\s*\n)?(.*?)\s*<\/em>/m) { "\e[1m#{$1}\e[0m" }.
    gsub(/<i>(?:\s*\n)?(.*?)\s*<\/i>/m) { "\e[1m#{$1}\e[0m" }.
    gsub(/\B\+(\w+?)\+\B/)  { "\e[32m#{$1}\e[0m" }.
    gsub(/((?:^[ \t]+.+(?:\n+|\Z))+)/)  { CodeRay.scan($1, :ruby).term }.
    gsub(/`(?:\s*\n)?([^\e]*?)\s*`/) { "`#{CodeRay.scan($1, :ruby).term}`" }
end

- (Object) process_yardoc(comment) (private)



36
37
38
39
40
41
# File 'lib/pry/helpers/documentation_helpers.rb', line 36

def process_yardoc(comment)
  yard_tags = ["param", "return", "option", "yield", "attr", "attr_reader", "attr_writer",
               "deprecate", "example", "raise"]
  (yard_tags - ["example"]).inject(comment) { |a, v| process_yardoc_tag(a, v) }.
    gsub(/^@(#{yard_tags.join("|")})/) { Pry.color ? "\e[33m#{$1}\e[0m": $1 }
end

- (Object) process_yardoc_tag(comment, tag) (private)



21
22
23
24
25
26
27
28
29
30
31
32
33
34
# File 'lib/pry/helpers/documentation_helpers.rb', line 21

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

- (String) strip_comments_from_c_code(code) (private)

Parameters:

  • code (String)

Returns:

  • (String)


49
50
51
# File 'lib/pry/helpers/documentation_helpers.rb', line 49

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

- (String) strip_leading_whitespace(text) (private)

Parameters:

  • text (String)

Returns:

  • (String)


71
72
73
# File 'lib/pry/helpers/documentation_helpers.rb', line 71

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