diff --git a/lib/rubocop/cop/github/enum_keyword_args.rb b/lib/rubocop/cop/github/enum_keyword_args.rb new file mode 100644 index 00000000..691dab9c --- /dev/null +++ b/lib/rubocop/cop/github/enum_keyword_args.rb @@ -0,0 +1,100 @@ +# frozen_string_literal: true + +module RuboCop + module Cop + module Rails + # Looks for enums written with keyword arguments. + # + # Defining enums with keyword arguments is deprecated + # and will be removed in Rails 7.3. + # + # Positional arguments should be used instead: + # + # @example + # # bad + # enum status: { active: 0, archived: 1 }, _prefix: true + # + # # good + # enum :status, { active: 0, archived: 1 }, prefix: true + # + class EnumKeywordArgs < Base + extend AutoCorrector + + MSG_ARGS = 'Enum defined with keyword arguments found in `%s` enum declaration. Use positional arguments instead.' + MSG_OPTS = 'Enum defined with deprecated options found in `%s` enum declaration. Use options without the `_` prefix.' + RESTRICT_ON_SEND = %i[enum].freeze + + def_node_matcher :enum?, <<~PATTERN + (send nil? :enum (hash $...)) + PATTERN + + def_node_matcher :enum_with_keyword_args?, <<~PATTERN + (send nil? :enum $_ ${array hash} $_) + PATTERN + + def_node_matcher :enum_values, <<~PATTERN + (pair $_ ${array hash}) + PATTERN + + def_node_matcher :enum_options, <<~PATTERN + (pair $_ $_) + PATTERN + + def on_send(node) + enum?(node) do |pairs| + pairs.each do |pair| + key, array = enum_values(pair) + if key + add_offense(array, message: format(MSG_ARGS, enum: enum_name(key))) do |corrector| + corrected_options = pairs[1..].map do |pair| + name = if pair.key.source[0] == "_" + pair.key.source[1..] + else + pair.key.source + end + + "#{name}: #{pair.value.source}" + end.join(", ") + corrected_options = ", " + corrected_options unless corrected_options.empty? + + corrector.replace(node, "enum #{source(key)}, #{array.source}#{corrected_options}") + end + end + end + end + + enum_with_keyword_args?(node) do |key, _, options| + options.children.each do |option| + name, value = enum_options(option) + if name.source[0] == "_" + add_offense(name, message: format(MSG_OPTS, enum: enum_name(key))) + end + end + end + end + + private + + def enum_name(key) + case key.type + when :sym, :str + key.value + else + key.source + end + end + + def source(elem) + case elem.type + when :str + elem.value.dump + when :sym + elem.value.inspect + else + elem.source + end + end + end + end + end +end pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy