123456789_123456789_123456789_123456789_123456789_

Module: RuboCop::Cop::CommentsHelp

Overview

Help methods for working with nodes containing comments.

Instance Method Summary

Instance Method Details

#begin_pos_with_comment(node) (private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/mixin/comments_help.rb', line 46



def begin_pos_with_comment(node)
  first_comment = processed_source.ast_with_comments[node].first

  if first_comment && (first_comment.loc.line < node.loc.line)
    start_line_position(first_comment)
  else
    start_line_position(node)
  end
end


  








  

    #buffer   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/comments_help.rb', line 60



def buffer
  processed_source.buffer
end


  








  

    #comments_contain_disables?(node, cop_name)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/comments_help.rb', line 27



def comments_contain_disables?(node, cop_name)
  disabled_ranges = processed_source.disabled_line_ranges[cop_name]

  return false unless disabled_ranges

  node_range = node.source_range.line...find_end_line(node)

  disabled_ranges.any? do |disable_range|
    disable_range.cover?(node_range) || node_range.cover?(disable_range)
  end
end


  








  

    #comments_in_range(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/comments_help.rb', line 18



def comments_in_range(node)
  return [] unless node.source_range

  start_line = node.source_range.line
  end_line = find_end_line(node)

  processed_source.each_comment_in_lines(start_line...end_line)
end


  








  

    #contains_comments?(node)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/comments_help.rb', line 14



def contains_comments?(node)
  comments_in_range(node).any?
end


  








  

    #end_position_for(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/comments_help.rb', line 41



def end_position_for(node)
  end_line = buffer.line_for_position(node.source_range.end_pos)
  buffer.line_range(end_line).end_pos
end


  








  

    #find_end_line(node)   (private)
  



  

    


Returns the end line of a node, which might be a comment and not part of the AST
End line is considered either the line at which another node starts, or
the line at which the parent node ends.
 Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/comments_help.rb', line 68



def find_end_line(node)
  if node.if_type?
    if node.else?
      node.loc.else.line
    elsif node.ternary?
      node.else_branch.loc.line
    elsif node.elsif?
      node.each_ancestor(:if).find(&:if?).loc.end.line
    elsif node.if? && node.parent && parentheses?(node.parent)
      node.parent.loc.end.line
    end
  elsif node.block_type? || node.numblock_type?
    node.loc.end.line
  elsif (next_sibling = node.right_sibling) && next_sibling.is_a?(AST::Node) &&
        next_sibling.source_range
    next_sibling.loc.line
  elsif (parent = node.parent)
    if parent.loc.respond_to?(:end) && parent.loc.end
      parent.loc.end.line
    else
      parent.loc.line
    end
  end || node.loc.end.line
end


  








  

    #source_range_with_comment(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/comments_help.rb', line 7



def source_range_with_comment(node)
  begin_pos = begin_pos_with_comment(node)
  end_pos = end_position_for(node)

  Parser::Source::Range.new(buffer, begin_pos, end_pos)
end


  








  

    #start_line_position(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/comments_help.rb', line 56



def start_line_position(node)
  buffer.line_range(node.loc.line).begin_pos - 1
end