module RuboCop::Cop::HashShorthandSyntax

This module checks for Ruby 3.1's hash value omission syntax.

Constants

DO_NOT_MIX_EXPLICIT_VALUE_MSG
DO_NOT_MIX_MSG_PREFIX
DO_NOT_MIX_OMIT_VALUE_MSG
EXPLICIT_HASH_VALUE_MSG
OMIT_HASH_VALUE_MSG

Public Instance Methods

on_hash_for_mixed_shorthand(hash_node) click to toggle source
# File lib/rubocop/cop/mixin/hash_shorthand_syntax.rb, line 13
def on_hash_for_mixed_shorthand(hash_node)
  return if ignore_mixed_hash_shorthand_syntax?(hash_node)

  hash_value_type_breakdown = breakdown_value_types_of_hash(hash_node)

  if hash_with_mixed_shorthand_syntax?(hash_value_type_breakdown)
    mixed_shorthand_syntax_check(hash_value_type_breakdown)
  else
    no_mixed_shorthand_syntax_check(hash_value_type_breakdown)
  end
end
on_pair(node) click to toggle source
# File lib/rubocop/cop/mixin/hash_shorthand_syntax.rb, line 25
def on_pair(node)
  return if ignore_hash_shorthand_syntax?(node)

  hash_key_source = node.key.source

  if enforced_shorthand_syntax == 'always'
    return if node.value_omission? || require_hash_value?(hash_key_source, node)

    message = OMIT_HASH_VALUE_MSG
    replacement = "#{hash_key_source}:"
    self.config_to_allow_offenses = { 'Enabled' => false }
  else
    return unless node.value_omission?

    message = EXPLICIT_HASH_VALUE_MSG
    replacement = "#{hash_key_source}: #{hash_key_source}"
  end

  register_offense(node, message, replacement)
end

Private Instance Methods

breakdown_value_types_of_hash(hash_node) click to toggle source
# File lib/rubocop/cop/mixin/hash_shorthand_syntax.rb, line 109
def breakdown_value_types_of_hash(hash_node)
  hash_node.pairs.group_by do |pair_node|
    if pair_node.value_omission?
      :value_omitted
    elsif require_hash_value?(pair_node.key.source, pair_node)
      :value_needed
    else
      :value_omittable
    end
  end
end
each_omittable_value_pair(hash_value_type_breakdown, &block) click to toggle source
# File lib/rubocop/cop/mixin/hash_shorthand_syntax.rb, line 133
def each_omittable_value_pair(hash_value_type_breakdown, &block)
  hash_value_type_breakdown[:value_omittable]&.each(&block)
end
each_omitted_value_pair(hash_value_type_breakdown, &block) click to toggle source
# File lib/rubocop/cop/mixin/hash_shorthand_syntax.rb, line 129
def each_omitted_value_pair(hash_value_type_breakdown, &block)
  hash_value_type_breakdown[:value_omitted]&.each(&block)
end
enforced_shorthand_syntax() click to toggle source
# File lib/rubocop/cop/mixin/hash_shorthand_syntax.rb, line 65
def enforced_shorthand_syntax
  cop_config.fetch('EnforcedShorthandSyntax', 'always')
end
hash_with_mixed_shorthand_syntax?(hash_value_type_breakdown) click to toggle source
# File lib/rubocop/cop/mixin/hash_shorthand_syntax.rb, line 121
def hash_with_mixed_shorthand_syntax?(hash_value_type_breakdown)
  hash_value_type_breakdown.keys.size > 1
end
hash_with_values_that_cant_be_omitted?(hash_value_type_breakdown) click to toggle source
# File lib/rubocop/cop/mixin/hash_shorthand_syntax.rb, line 125
def hash_with_values_that_cant_be_omitted?(hash_value_type_breakdown)
  hash_value_type_breakdown[:value_needed]&.any?
end
ignore_hash_shorthand_syntax?(pair_node) click to toggle source
# File lib/rubocop/cop/mixin/hash_shorthand_syntax.rb, line 59
def ignore_hash_shorthand_syntax?(pair_node)
  target_ruby_version <= 3.0 || enforced_shorthand_syntax == 'either' ||
    enforced_shorthand_syntax == 'consistent' ||
    !pair_node.parent.hash_type?
end
ignore_mixed_hash_shorthand_syntax?(hash_node) click to toggle source
# File lib/rubocop/cop/mixin/hash_shorthand_syntax.rb, line 54
def ignore_mixed_hash_shorthand_syntax?(hash_node)
  target_ruby_version <= 3.0 || enforced_shorthand_syntax != 'consistent' ||
    !hash_node.hash_type?
end
mixed_shorthand_syntax_check(hash_value_type_breakdown) click to toggle source
# File lib/rubocop/cop/mixin/hash_shorthand_syntax.rb, line 137
def mixed_shorthand_syntax_check(hash_value_type_breakdown)
  if hash_with_values_that_cant_be_omitted?(hash_value_type_breakdown)
    each_omitted_value_pair(hash_value_type_breakdown) do |pair_node|
      hash_key_source = pair_node.key.source
      replacement = "#{hash_key_source}: #{hash_key_source}"
      register_offense(pair_node, DO_NOT_MIX_EXPLICIT_VALUE_MSG, replacement)
    end
  else
    each_omittable_value_pair(hash_value_type_breakdown) do |pair_node|
      hash_key_source = pair_node.key.source
      replacement = "#{hash_key_source}:"
      register_offense(pair_node, DO_NOT_MIX_OMIT_VALUE_MSG, replacement)
    end
  end
end
no_mixed_shorthand_syntax_check(hash_value_type_breakdown) click to toggle source
# File lib/rubocop/cop/mixin/hash_shorthand_syntax.rb, line 153
def no_mixed_shorthand_syntax_check(hash_value_type_breakdown)
  return if hash_with_values_that_cant_be_omitted?(hash_value_type_breakdown)

  each_omittable_value_pair(hash_value_type_breakdown) do |pair_node|
    hash_key_source = pair_node.key.source
    replacement = "#{hash_key_source}:"
    register_offense(pair_node, OMIT_HASH_VALUE_MSG, replacement)
  end
end
register_offense(node, message, replacement) click to toggle source
# File lib/rubocop/cop/mixin/hash_shorthand_syntax.rb, line 48
def register_offense(node, message, replacement)
  add_offense(node.value, message: message) do |corrector|
    corrector.replace(node, replacement)
  end
end
require_hash_value?(hash_key_source, node) click to toggle source
# File lib/rubocop/cop/mixin/hash_shorthand_syntax.rb, line 69
def require_hash_value?(hash_key_source, node)
  return true if !node.key.sym_type? || require_hash_value_for_around_hash_literal?(node)

  hash_value = node.value
  return true unless hash_value.send_type? || hash_value.lvar_type?

  hash_key_source != hash_value.source || hash_key_source.end_with?('!', '?')
end
require_hash_value_for_around_hash_literal?(node) click to toggle source
# File lib/rubocop/cop/mixin/hash_shorthand_syntax.rb, line 78
def require_hash_value_for_around_hash_literal?(node)
  return false unless (ancestor = node.parent.parent)
  return false if ancestor.send_type? && ancestor.method?(:[])

  !node.parent.braces? && !use_element_of_hash_literal_as_receiver?(ancestor, node.parent) &&
    (use_modifier_form_without_parenthesized_method_call?(ancestor) ||
     without_parentheses_call_expr_follows?(ancestor))
end
use_element_of_hash_literal_as_receiver?(ancestor, parent) click to toggle source
# File lib/rubocop/cop/mixin/hash_shorthand_syntax.rb, line 87
def use_element_of_hash_literal_as_receiver?(ancestor, parent)
  # `{value:}.do_something` is a valid syntax.
  ancestor.send_type? && ancestor.receiver == parent
end
use_modifier_form_without_parenthesized_method_call?(ancestor) click to toggle source
# File lib/rubocop/cop/mixin/hash_shorthand_syntax.rb, line 92
def use_modifier_form_without_parenthesized_method_call?(ancestor)
  return false if ancestor.respond_to?(:parenthesized?) && ancestor.parenthesized?

  ancestor.ancestors.any? { |node| node.respond_to?(:modifier_form?) && node.modifier_form? }
end
without_parentheses_call_expr_follows?(ancestor) click to toggle source
# File lib/rubocop/cop/mixin/hash_shorthand_syntax.rb, line 98
def without_parentheses_call_expr_follows?(ancestor)
  return false unless ancestor.respond_to?(:parenthesized?) && !ancestor.parenthesized?

  right_sibling = ancestor.right_sibling
  right_sibling ||= ancestor.each_ancestor.find do |node|
    node.assignment? || node.send_type?
  end&.right_sibling

  !!right_sibling
end