From 2f0327b7d8ac46fcb30d957d54fab32b27f8625f Mon Sep 17 00:00:00 2001 From: Jacopo Date: Sat, 25 Aug 2018 00:08:34 +0200 Subject: Adds Rubocop rule to enforce class_methods over module ClassMethods --- rubocop/cop/prefer_class_methods_over_module.rb | 48 +++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 rubocop/cop/prefer_class_methods_over_module.rb (limited to 'rubocop/cop') diff --git a/rubocop/cop/prefer_class_methods_over_module.rb b/rubocop/cop/prefer_class_methods_over_module.rb new file mode 100644 index 00000000000..bd91c663e58 --- /dev/null +++ b/rubocop/cop/prefer_class_methods_over_module.rb @@ -0,0 +1,48 @@ +# frozen_string_literal: true + +module RuboCop + module Cop + # Enforces the use of 'class_methods' instead of 'module ClassMethods' + # For more information see: https://gitlab.com/gitlab-org/gitlab-ce/issues/50414 + # + # @example + # # bad + # module Foo + # module ClassMethods + # def a_class_method + # end + # end + # end + # + # # good + # module Foo + # class_methods do + # def a_class_method + # end + # end + # end + # + class PreferClassMethodsOverModule < RuboCop::Cop::Cop + include RangeHelp + + MSG = 'Do not use module ClassMethods, use class_methods block instead.' + + def on_module(node) + add_offense(node) if node.defined_module_name == 'ClassMethods' + end + + def autocorrect(node) + lambda do |corrector| + corrector.replace(module_range(node), 'class_methods do') + end + end + + private + + def module_range(node) + module_node, _ = *node + range_between(node.loc.keyword.begin_pos, module_node.source_range.end_pos) + end + end + end +end -- cgit v1.2.3