module Pry::Helpers::DocumentationHelpers

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

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 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
process_comment_markup(comment) click to toggle source
# File lib/pry/helpers/documentation_helpers.rb, line 43
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 10
def process_rdoc(comment)
  return comment unless Pry.color
  comment = comment.dup
  comment.gsub(/<code>(?:\s*\n)?(.*?)\s*<\/code>/) { CodeRay.scan($1, :ruby).term }.
    gsub(/<em>(?:\s*\n)?(.*?)\s*<\/em>/) { "\e[1m#{$1}\e[0m" }.
    gsub(/<i>(?:\s*\n)?(.*?)\s*<\/i>/) { "\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
process_yardoc(comment) click to toggle source
# 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
process_yardoc_tag(comment, tag) click to toggle source
# 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
strip_comments_from_c_code(code) click to toggle source

@param [String] code @return [String]

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

@param [String] text @return [String]

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