123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::DirectiveComment

Relationships & Source Files
Inherits: Object
Defined in: lib/rubocop/directive_comment.rb

Overview

This class wraps the Parser::Source::Comment object that represents a special rubocop:disable and rubocop:enable comment and exposes what cops it contains.

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(comment, cop_registry = Cop::Registry.global) ⇒ DirectiveComment

[ GitHub ] 

  


# File 'lib/rubocop/directive_comment.rb', line 52



def initialize(comment, cop_registry = Cop::Registry.global)
  @comment = comment
  @cop_registry = cop_registry
  @match_data = comment.text.match(DIRECTIVE_COMMENT_REGEXP)
  @mode, @cops = match_captures
end


  







Class Method Details



  

    .before_comment(line)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 46



def self.before_comment(line)
  line.split(DIRECTIVE_COMMENT_REGEXP).first
end


  







Instance Attribute Details



  

    #all_cops?  ⇒ Boolean  (readonly)
  



  

    


Checks if all cops specified in this directive



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 145



def all_cops?
  cops == 'all'
end


  








  

    #comment   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 50



attr_reader :comment, :cop_registry, :mode, :cops


  








  

    #cop_registry   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 50



attr_reader :comment, :cop_registry, :mode, :cops


  








  

    #cops   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 50



attr_reader :comment, :cop_registry, :mode, :cops


  








  

    #disabled?  ⇒ Boolean  (readonly)
  



  

    


Checks if this directive disables cops



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 110



def disabled?
  %w[disable todo].include?(mode)
end


  








  

    #disabled_all?  ⇒ Boolean  (readonly)
  



  

    


Checks if this directive disables all cops



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 140



def disabled_all?
  disabled? && all_cops?
end


  








  

    #enabled?  ⇒ Boolean  (readonly)
  



  

    


Checks if this directive enables cops



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 115



def enabled?
  mode == 'enable'
end


  








  

    #enabled_all?  ⇒ Boolean  (readonly)
  



  

    


Checks if this directive enables all cops



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 135



def enabled_all?
  !disabled? && all_cops?
end


  








  

    #malformed?  ⇒ Boolean  (readonly)
  



  

    


Checks if the comment is malformed as a # rubocop: directive



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 65



def malformed?
  return true if !start_with_marker? || @match_data.nil?
  return true if missing_cop_name?

  tail = @match_data.post_match.lstrip
  !(tail.empty? || tail.start_with?(TRAILING_COMMENT_MARKER))
end


  








  

    #missing_cop_name?  ⇒ Boolean  (readonly)
  



  

    


Checks if the directive comment is missing a cop name



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 74



def missing_cop_name?
  return false if push? || pop?

  MALFORMED_DIRECTIVE_WITHOUT_COP_NAME_REGEXP.match?(comment.text)
end


  








  

    #mode   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 50



attr_reader :comment, :cop_registry, :mode, :cops


  








  

    #pop?  ⇒ Boolean  (readonly)
  



  

    


Checks if this directive is a pop



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 125



def pop?
  mode == 'pop'
end


  








  

    #push?  ⇒ Boolean  (readonly)
  



  

    


Checks if this directive is a push



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 120



def push?
  mode == 'push'
end


  








  

    #single_line?  ⇒ Boolean  (readonly)
  



  

    


Checks if this directive relates to single line



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 81



def single_line?
  !comment.text.start_with?(DIRECTIVE_COMMENT_REGEXP)
end


  








  

    #start_with_marker?  ⇒ Boolean  (readonly)
  



  

    


Checks if the comment starts with # rubocop: marker



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 60



def start_with_marker?
  comment.text.start_with?(DIRECTIVE_MARKER_REGEXP)
end


  







Instance Method Details



  

    #all_cop_names   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 197



def all_cop_names
  exclude_lint_department_cops(cop_registry.names)
end


  








  

    #cop_names  
  



  

    


Returns array of specified in this directive cop names



  



  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 150



def cop_names
  @cop_names ||= all_cops? ? all_cop_names : parsed_cop_names
end


  








  

    #cop_names_for_department(department)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 201



def cop_names_for_department(department)
  names = cop_registry.names_for_department(department)
  department == LINT_DEPARTMENT ? exclude_lint_department_cops(names) : names
end


  








  

    #department?(name)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 193



def department?(name)
  cop_registry.department?(name)
end


  








  

    #department_names  
  



  

    


Returns array of specified in this directive department names
when all department disabled



  



  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 161



def department_names
  raw_cop_names.select { |cop| department?(cop) }
end


  








  

    #directive_count  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 175



def directive_count
  raw_cop_names.count
end


  








  

    #exclude_lint_department_cops(cops)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 206



def exclude_lint_department_cops(cops)
  cops - [LINT_REDUNDANT_DIRECTIVE_COP, LINT_SYNTAX_COP]
end


  








  

    #in_directive_department?(cop)  ⇒ Boolean 
  



  

    


Checks if directive departments include cop



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 166



def in_directive_department?(cop)
  department_names.any? { |department| cop.start_with?(department) }
end


  








  

    #line_number  
  



  

    


Returns line number for directive



  



  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 180



def line_number
  comment.source_range.line
end


  








  

    #match?(cop_names)  ⇒ Boolean 
  



  

    


Checks if this directive contains all the given cop names



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 86



def match?(cop_names)
  parsed_cop_names.uniq.sort == cop_names.uniq.sort
end


  








  

    #match_captures  
  



  

    


Returns match captures to directive comment pattern



  



  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 99



def match_captures
  @match_captures ||= @match_data && begin
    captures = @match_data.captures
    mode = captures[0]
    # COPS_PATTERN is at captures[1], PUSH_POP_ARGS_PATTERN is at captures[4]
    cops = captures[1] || captures[4]
    [mode, cops]
  end
end


  








  

    #overridden_by_department?(cop)  ⇒ Boolean 
  



  

    


Checks if cop department has already used in directive comment



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 171



def overridden_by_department?(cop)
  in_directive_department?(cop) && raw_cop_names.include?(cop)
end


  








  

    #parse_push_args   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 210



def parse_push_args
  return {} unless push? && cops

  args = {}
  cops.split.each do |cop_spec|
    op = cop_spec[0]
    cop_name = cop_spec[1..]
    args[op] ||= []
    args[op] << cop_name
  end
  args
end


  








  

    #parsed_cop_names   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 186



def parsed_cop_names
  cops = raw_cop_names.map do |name|
    department?(name) ? cop_names_for_department(name) : name
  end.flatten
  cops - [LINT_SYNTAX_COP]
end


  








  

    #push_args  
  



  

    


Returns the push arguments as a hash of cop names with their operations



  



  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 130



def push_args
  @push_args ||= parse_push_args
end


  








  

    #range  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 90



def range
  match = comment.text.match(DIRECTIVE_COMMENT_REGEXP)
  begin_pos = comment.source_range.begin_pos
  Parser::Source::Range.new(
    comment.source_range.source_buffer, begin_pos + match.begin(0), begin_pos + match.end(0)
  )
end


  








  

    #raw_cop_names  
  



  

    


Returns an array of cops for this directive comment, without resolving departments



  



  [ GitHub ]


  

  


# File 'lib/rubocop/directive_comment.rb', line 155



def raw_cop_names
  @raw_cop_names ||= (cops || '').split(/,\s*/)
end