forked from rubocop/rubocop-rails
-
Notifications
You must be signed in to change notification settings - Fork 0
/
http_status.rb
160 lines (133 loc) · 4.19 KB
/
http_status.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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
# frozen_string_literal: true
module RuboCop
module Cop
module Rails
# Enforces use of symbolic or numeric value to define HTTP status.
#
# @example EnforcedStyle: symbolic (default)
# # bad
# render :foo, status: 200
# render json: { foo: 'bar' }, status: 200
# render plain: 'foo/bar', status: 304
# redirect_to root_url, status: 301
#
# # good
# render :foo, status: :ok
# render json: { foo: 'bar' }, status: :ok
# render plain: 'foo/bar', status: :not_modified
# redirect_to root_url, status: :moved_permanently
#
# @example EnforcedStyle: numeric
# # bad
# render :foo, status: :ok
# render json: { foo: 'bar' }, status: :not_found
# render plain: 'foo/bar', status: :not_modified
# redirect_to root_url, status: :moved_permanently
#
# # good
# render :foo, status: 200
# render json: { foo: 'bar' }, status: 404
# render plain: 'foo/bar', status: 304
# redirect_to root_url, status: 301
#
class HttpStatus < Cop
include ConfigurableEnforcedStyle
def_node_matcher :http_status, <<~PATTERN
{
(send nil? {:render :redirect_to} _ $hash)
(send nil? {:render :redirect_to} $hash)
}
PATTERN
def_node_matcher :status_code, <<~PATTERN
(hash <(pair (sym :status) ${int sym}) ...>)
PATTERN
def on_send(node)
http_status(node) do |hash_node|
status = status_code(hash_node)
return unless status
checker = checker_class.new(status)
return unless checker.offensive?
add_offense(checker.node, message: checker.message)
end
end
def autocorrect(node)
lambda do |corrector|
checker = checker_class.new(node)
corrector.replace(node.loc.expression, checker.preferred_style)
end
end
private
def checker_class
case style
when :symbolic
SymbolicStyleChecker
when :numeric
NumericStyleChecker
end
end
# :nodoc:
class SymbolicStyleChecker
MSG = 'Prefer `%<prefer>s` over `%<current>s` ' \
'to define HTTP status code.'
DEFAULT_MSG = 'Prefer `symbolic` over `numeric` ' \
'to define HTTP status code.'
attr_reader :node
def initialize(node)
@node = node
end
def offensive?
!node.sym_type? && !custom_http_status_code?
end
def message
format(MSG, prefer: preferred_style, current: number.to_s)
end
def preferred_style
symbol.inspect
end
private
def symbol
::Rack::Utils::SYMBOL_TO_STATUS_CODE.key(number)
end
def number
node.children.first
end
def custom_http_status_code?
node.int_type? &&
!::Rack::Utils::SYMBOL_TO_STATUS_CODE.value?(number)
end
end
# :nodoc:
class NumericStyleChecker
MSG = 'Prefer `%<prefer>s` over `%<current>s` ' \
'to define HTTP status code.'
DEFAULT_MSG = 'Prefer `numeric` over `symbolic` ' \
'to define HTTP status code.'
PERMITTED_STATUS = %i[error success missing redirect].freeze
attr_reader :node
def initialize(node)
@node = node
end
def offensive?
!node.int_type? && !permitted_symbol?
end
def message
format(MSG, prefer: preferred_style, current: symbol.inspect)
end
def preferred_style
number.to_s
end
private
def number
::Rack::Utils::SYMBOL_TO_STATUS_CODE[symbol]
end
def symbol
node.value
end
def permitted_symbol?
node.sym_type? && PERMITTED_STATUS.include?(node.value)
end
end
end
end
end
end