blob: d4f68711e784e57be15672a08ad86f10954f3013 (
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
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
126
127
128
129
130
131
132
133
134
135
136
|
# frozen_string_literal: true
require 'rubocop_spec_helper'
require_relative '../../../../rubocop/cop/api/ensure_string_detail'
RSpec.describe RuboCop::Cop::API::EnsureStringDetail do
context "when in_api? == true" do
before do
allow(cop).to receive(:in_api?).and_return(true)
end
context "when detail field uses a string" do
it "does not add an offense" do
expect_no_offenses(<<~CODE)
class SomeAPI
resource :projects do
desc 'Some API thing related to a project' do
detail "foo bar"
end
end
end
CODE
end
end
context "when detail field uses interpolation in a string" do
it "does not add an offense" do
baz = "bat"
expect_no_offenses(<<~CODE)
class SomeAPI
resource :projects do
desc 'Some API thing related to a project' do
detail "foo bar #{baz}"
end
end
end
CODE
end
end
context "when detail field uses a multiline string" do
it "does not add an offense" do
expect_no_offenses(<<~CODE)
class SomeAPI
resource :projects do
desc 'Some API thing related to a project' do
detail "foo bar"\
"baz bat"
end
end
end
CODE
end
end
context "when detail field uses a constant" do
it "does not add an offense" do
pending
expect_no_offenses(<<~CODE)
class SomeAPI
resource :projects do
DESCRIPTION = 'A string'
desc 'Some API thing related to a project' do
detail DESCRIPTION
end
end
end
CODE
end
end
context "when detail field uses a HEREDOC string" do
it "does not add an offense" do
expect_no_offenses(<<~CODE)
class SomeAPI
resource :projects do
desc 'Some API thing related to a project' do
detail <<~END
foo bar
baz bat
END
end
end
end
CODE
end
end
context "when detail field uses an array" do
it "adds an offense" do
expect_offense(<<~CODE)
class SomeAPI
resource :projects do
desc 'Some API thing related to a project' do
something 'else'
detail ["foo", "bar"]
^^^^^^^^^^^^^^^^^^^^^ Only String objects are permitted in API detail field.
end
end
end
CODE
end
end
context "when detail field is outside of desc block" do
it "does not add an offense" do
expect_no_offenses(<<~CODE)
class Foo
detail ["foo", "bar"]
end
CODE
end
end
end
context "when in_api? == false" do
before do
allow(cop).to receive(:in_api?).and_return(false)
end
it "does not add an offense" do
expect_no_offenses(<<~CODE)
class SomeAPI
resource :projects do
desc 'Some API thing related to a project' do
detail ["foo", "bar"]
end
end
end
CODE
end
end
end
|
