class PuppetStrings::Yard::Handlers::Ruby::Base
Implements the base handler for Ruby language handlers.
Constants
- HEREDOC_START
A regular expression for detecting the start of a Ruby heredoc. Note: the first character of the heredoc start may have been cut off by YARD.
Protected Instance Methods
node_as_string(node)
click to toggle source
Converts the given Ruby AST node to a string representation. @param node The Ruby AST node to convert. @return [String] Returns a string representation of the node or nil if a string representation was not possible.
# File lib/puppet-strings/yard/handlers/ruby/base.rb, line 13 def node_as_string(node) return nil unless node case node.type when :symbol, :symbol_literal node.source[1..-1] when :label node.source[0..-2] when :dyna_symbol node.source when :string_literal content = node.jump(:tstring_content) return content.source if content != node # This attempts to work around a bug in YARD (https://github.com/lsegal/yard/issues/779) # Check to see if the string source appears to have a heredoc open tag (or "most" of one) # If so, remove the first line and the last line (if the latter contains the heredoc tag) source = node.source if source =~ HEREDOC_START lines = source.split("\n") source = lines[1..(lines.last.include?($1) ? -2 : -1)].join("\n") if lines.size > 1 end source end end