module Pry::Helpers::DocumentationHelpers

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

Constants

YARD_TAGS

Public Instance Methods

get_comment_content(comment) click to toggle source

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)

@param [String] comment @return [String]

# File lib/pry/helpers/documentation_helpers.rb, line 66
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) click to toggle source
# File lib/pry/helpers/documentation_helpers.rb, line 50
def process_comment_markup(comment)
  process_yardoc process_rdoc(comment)
end
process_rdoc(comment) click to toggle source
# 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]+.+(?:\n+|\Z))+)/, &last_match_ruby)
    .gsub(/`(?:\s*\n)?([^\e]*?)\s*`/) { "`#{last_match_ruby.call}`" }
end
process_yardoc(comment) click to toggle source
# File lib/pry/helpers/documentation_helpers.rb, line 44
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) click to toggle source
# File lib/pry/helpers/documentation_helpers.rb, line 29
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) click to toggle source

@param [String] code @return [String]

# File lib/pry/helpers/documentation_helpers.rb, line 56
def strip_comments_from_c_code(code)
  code.sub(%r{\A\s*/\*.*?\*/\s*}m, '')
end
strip_leading_whitespace(text) click to toggle source

@param [String] text @return [String]

# File lib/pry/helpers/documentation_helpers.rb, line 78
def strip_leading_whitespace(text)
  Pry::Helpers::CommandHelpers.unindent(text)
end