spec/rubocop/cop/gitlab/namespaced_class_spec.rb


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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

# frozen_string_literal: true

require 'fast_spec_helper'
require_relative '../../../../rubocop/cop/gitlab/namespaced_class'

RSpec.describe RuboCop::Cop::Gitlab::NamespacedClass do
  subject(:cop) { described_class.new }

  shared_examples 'enforces namespaced classes' do
    def namespaced(code)
      return code unless namespace

      <<~SOURCE
        module #{namespace}
        #{code}
        end
      SOURCE
    end

    it 'flags a class definition without additional namespace' do
      expect_offense(namespaced(<<~SOURCE))
        class MyClass
        ^^^^^^^^^^^^^ #{described_class::MSG}
        end
      SOURCE
    end

    it 'flags a compact class definition without additional namespace' do
      expect_offense(<<~SOURCE, namespace: namespace)
        class %{namespace}::MyClass
        ^{namespace}^^^^^^^^^^^^^^^ #{described_class::MSG}
        end
      SOURCE
    end

    it 'flags a class definition with inheritance without additional namespace' do
      expect_offense(namespaced(<<~SOURCE))
        class MyClass < ApplicationRecord
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ #{described_class::MSG}
          def some_method
            true
          end
        end
      SOURCE
    end

    it 'does not flag the class definition with namespace in separate lines' do
      expect_no_offenses(namespaced(<<~SOURCE))
        module MyModule
          class MyClass < ApplicationRecord
          end

          class MyOtherClass
            def other_method
              1 + 1
            end
          end
        end
      SOURCE
    end

    it 'does not flag the class definition with nested namespace in separate lines' do
      expect_no_offenses(namespaced(<<~SOURCE))
        module TopLevelModule
          module NestedModule
            class MyClass
            end
          end
        end
      SOURCE
    end

    it 'does not flag the class definition nested inside namespaced class' do
      expect_no_offenses(namespaced(<<~SOURCE))
        module TopLevelModule
          class TopLevelClass
            class MyClass
            end
          end
        end
      SOURCE
    end

    it 'does not flag the class definition nested inside compact namespace' do
      expect_no_offenses(<<~SOURCE)
        module #{namespace}::TopLevelModule
          class MyClass
          end
        end
      SOURCE
    end

    it 'does not flag a compact namespaced class definition' do
      expect_no_offenses(namespaced(<<~SOURCE))
        class MyModule::MyClass < ApplicationRecord
        end
      SOURCE
    end

    it 'does not flag a truly compact namespaced class definition' do
      expect_no_offenses(<<~SOURCE, namespace: namespace)
        class %{namespace}::MyModule::MyClass < ApplicationRecord
        end
      SOURCE
    end
  end

  context 'without top-level namespace' do
    let(:namespace) { nil }

    it_behaves_like 'enforces namespaced classes'
  end

  context 'with Gitlab namespace' do
    let(:namespace) { 'Gitlab' }

    it_behaves_like 'enforces namespaced classes'
  end

  context 'with ::Gitlab namespace' do
    let(:namespace) { '::Gitlab' }

    it_behaves_like 'enforces namespaced classes'
  end
end