Welcome to mirror list, hosted at ThFree Co, Russian Federation.

prefer_class_methods_over_module.rb « cop « rubocop - gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: bd91c663e58b22bebfec279ef4dd25960b8b1950 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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