123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::PercentLiteralDelimiters

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::AutoCorrector, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
self, ::RuboCop::Cop::PercentLiteral, ::RuboCop::Cop::RangeHelp, ::RuboCop::Cop::Base, ::RuboCop::Cop::AutocorrectLogic, ::RuboCop::Cop::IgnoredNode, ::RuboCop::Util, RuboCop::AST::Sexp
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/style/percent_literal_delimiters.rb

Overview

Enforces the consistent usage of %-literal delimiters.

Specify the 'default' key to set all preferred delimiters at once. You can continue to specify individual preferred delimiters to override the default.

Examples:

# Style/PercentLiteralDelimiters:
#   PreferredDelimiters:
#     default: '[]'
#     '%i':    '()'

# good
%w[alpha beta] + %i(gamma delta)

# bad
%W(alpha #{beta})

# bad
%I(alpha beta)

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

support_autocorrect?

::RuboCop::Cop::Base - Inherited

.gem_requirements, .lint?,
.support_autocorrect?

Returns if class supports autocorrect.
.support_multiple_source?

Override if your cop should be called repeatedly for multiple investigations Between calls to on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

Class Method Summary

::RuboCop::Cop::Base - Inherited

.autocorrect_incompatible_with

List of cops that should not try to autocorrect at the same time as this cop.
.badge

Naming.
.callbacks_needed, .cop_name, .department,
.documentation_url

Returns a url to view this cops documentation online.
.exclude_from_registry

Call for abstract Cop classes.
.inherited,
.joining_forces

Override and return the Force class(es) you need to join.
.match?

Returns true if the cop name or the cop namespace matches any of the given names.
.new,
.requires_gem

Register a version requirement for the given gem name.
.restrict_on_send

::RuboCop::ExcludeLimit - Extended

exclude_limit

Sets up a configuration option to have an exclude limit tracked.
transform

Instance Attribute Summary

::RuboCop::Cop::Base - Inherited

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #string_literals_frozen_by_default?, #target_satisfies_all_gem_version_requirements?

::RuboCop::Cop::AutocorrectLogic - Included

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Instance Method Summary

::RuboCop::Cop::PercentLiteral - Included

#begin_source, #percent_literal?, #process, #type

::RuboCop::Cop::RangeHelp - Included

#add_range,
#arguments_range

A range containing the first to the last argument of a method call or method definition.
#column_offset_between,
#contents_range

A range containing only the contents of a literal with delimiters (e.g.
#directions,
#effective_column

Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value.
#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range

::RuboCop::Cop::Base - Inherited

#add_global_offense

Adds an offense that has no particular location.
#add_offense

Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.
#begin_investigation

Called before any investigation.
#callbacks_needed,
#cop_config

Configuration Helpers.
#cop_name, #excluded_file?,
#external_dependency_checksum

This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:
#inspect,
#message

Gets called if no message is specified when calling add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.
#name

Alias for Base#cop_name.
#offenses,
#on_investigation_end

Called after all on_…​
#on_new_investigation

Called before all on_…​
#on_other_file

Called instead of all on_…​
#parse

There should be very limited reasons for a Cop to do it’s own parsing.
#parser_engine,
#ready

Called between investigations.
#relevant_file?,
#target_gem_version

Returns a gems locked versions (i.e.
#target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument

Reserved for Cop::Cop.
#complete_investigation

Called to complete an investigation.
#correct, #current_corrector,
#current_offense_locations

Reserved for Commissioner:
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.
#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #eol_comment, #eol_comment_would_be_inside_literal?, #heredoc_range, #line_with_eol_comment_too_long?, #max_line_length, #multiline_ranges, #multiline_string?,
#range_by_lines

Expand the given range to include all of any lines it covers.
#range_of_first_line, #string_continuation?, #surrounding_heredoc?, #surrounding_percent_array?

::RuboCop::Cop::IgnoredNode - Included

#ignore_node, #ignored_node?, #part_of_ignored_node?, #ignored_nodes

Constructor Details

This class inherits a constructor from RuboCop::Cop::Base

Instance Method Details

#contains_delimiter?(node, delimiters) ⇒ Boolean (private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 93



def contains_delimiter?(node, delimiters)
  delimiters_regexp = Regexp.union(delimiters)

  node.children.filter_map { |n| string_source(n) }.any?(delimiters_regexp)
end


  








  

    #contains_preferred_delimiter?(node, type)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 82



def contains_preferred_delimiter?(node, type)
  contains_delimiter?(node, preferred_delimiters_for(type))
end


  








  

    #include_same_character_as_used_for_delimiter?(node, type)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 86



def include_same_character_as_used_for_delimiter?(node, type)
  return false unless %w[%w %i].include?(type)

  used_delimiters = matchpairs(begin_source(node)[-1])
  contains_delimiter?(node, used_delimiters)
end


  








  

    #matchpairs(begin_delimiter)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 107



def matchpairs(begin_delimiter)
  {
    '(' => %w[( )],
    '[' => %w[[ ]],
    '{' => %w[{ }],
    '<' => %w[< >]
  }.fetch(begin_delimiter, [begin_delimiter])
end


  








  

    #message(type)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 67



def message(type)
  delimiters = preferred_delimiters_for(type)

  "`#{type}`-literals should be delimited by " \
    "`#{delimiters[0]}` and `#{delimiters[1]}`."
end


  








  

    #on_array(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 30



def on_array(node)
  process(node, '%w', '%W', '%i', '%I')
end


  








  

    #on_dstr(node)  
  



  

    


Alias for #on_str.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 41



alias on_dstr on_str


  








  

    #on_percent_literal(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 53



def on_percent_literal(node)
  type = type(node)
  return if uses_preferred_delimiter?(node, type) ||
            contains_preferred_delimiter?(node, type) ||
            include_same_character_as_used_for_delimiter?(node, type)

  add_offense(node, message: message(type)) do |corrector|
    opening_delimiter, closing_delimiter = preferred_delimiters_for(type)

    corrector.replace(node.loc.begin, "#{type}#{opening_delimiter}")
    corrector.replace(node.loc.end, closing_delimiter)
  end
end


  








  

    #on_regexp(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 34



def on_regexp(node)
  process(node, '%r')
end


  








  

    #on_str(node)  
    Also known as: #on_dstr
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 38



def on_str(node)
  process(node, '%', '%Q', '%q')
end


  








  

    #on_sym(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 43



def on_sym(node)
  process(node, '%s')
end


  








  

    #on_xstr(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 47



def on_xstr(node)
  process(node, '%x')
end


  








  

    #preferred_delimiters_for(type)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 74



def preferred_delimiters_for(type)
  PreferredDelimiters.new(type, @config, nil).delimiters
end


  








  

    #string_source(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 99



def string_source(node)
  if node.is_a?(String)
    node.scrub
  elsif node.respond_to?(:type) && node.type?(:str, :sym)
    node.source
  end
end


  








  

    #uses_preferred_delimiter?(node, type)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/percent_literal_delimiters.rb', line 78



def uses_preferred_delimiter?(node, type)
  preferred_delimiters_for(type)[0] == begin_source(node)[-1]
end