Class: RuboCop::Cop::Naming::AsciiIdentifiers

Inherits:
Base
  • Object
show all
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/naming/ascii_identifiers.rb

Overview

Checks for non-ascii characters in identifier and constant names. Identifiers are always checked and whether constants are checked can be controlled using AsciiConstants config.

Examples:

# bad def καλημερα # Greek alphabet (non-ascii) end # bad def こんにちはと言う # Japanese character (non-ascii) end # bad def hello_🍣 # Emoji (non-ascii) end # good def say_hello end # bad 신장 = 10 # Hangul character (non-ascii)  # good height = 10 # bad params[:عرض_gteq] # Arabic character (non-ascii)  # good params[:width_gteq]

AsciiConstants: true (default)

# bad class Foö end FOÖ = "foo"

AsciiConstants: false

# good class Foö end FOÖ = "foo"

Constant Summary collapse

IDENTIFIER_MSG = 
'Use only ascii symbols in identifiers.'
CONSTANT_MSG = 
'Use only ascii symbols in constants.'

Constants included from RangeHelp

RangeHelp::BYTE_ORDER_MARK, RangeHelp::NOT_GIVEN

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_gem_version, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

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

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#on_new_investigation ⇒ Object 

 59 60 61 62 63 64 65 66
 
# File 'lib/rubocop/cop/naming/ascii_identifiers.rb', line 59 def on_new_investigation processed_source.tokens.each do |token| next if !should_check?(token) || token.text.ascii_only? message = token.type == :tIDENTIFIER ? IDENTIFIER_MSG : CONSTANT_MSG add_offense(first_offense_range(token), message: message) end end