-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy path.rubocop.yml
More file actions
291 lines (257 loc) · 9.48 KB
/
.rubocop.yml
File metadata and controls
291 lines (257 loc) · 9.48 KB
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
plugins:
- rubocop-rspec
AllCops:
TargetRubyVersion: 2.7
NewCops: enable
SuggestExtensions: false
Style/Documentation:
Enabled: false
# `be > 0` is idiomatic RSpec for numeric comparisons; `be.positive?` is broken syntax.
Style/NumericPredicate:
Exclude:
- 'gem/*/spec/**/*'
Metrics/BlockLength:
Exclude:
- 'gem/bsv-wallet/lib/bsv/wallet_interface/wire/**/*'
- 'gem/bsv-wallet-postgres/lib/bsv/wallet_postgres/migrations/**/*'
- 'gem/bsv-sdk/lib/bsv/auth/**/*'
- 'gem/*/spec/**/*'
Naming/FileName:
Exclude:
- 'gem/bsv-sdk/lib/bsv-sdk.rb'
- 'gem/bsv-attest/lib/bsv-attest.rb'
- 'gem/bsv-wallet/lib/bsv-wallet.rb'
- 'gem/bsv-wallet-postgres/lib/bsv-wallet-postgres.rb'
# Cryptographic code uses standard short names (r, s, x, y, n, m, bn, etc.)
# a/b are used in secure_compare for constant-time comparison.
Naming/MethodParameterName:
AllowedNames:
- a
- b
- r
- s
- w
- z
- x
- y
- n
- m
- bn
- tx
- db
- ds
- p1
- p2
# BRC-100 method names use get_ prefix (get_height, get_header, etc.) — protocol names.
Naming/AccessorMethodName:
Exclude:
- 'gem/bsv-wallet/lib/bsv/wallet_interface/**/*'
- 'gem/bsv-wallet/spec/bsv/wallet_interface/**/*'
# verify(), verify_proof(), and cast_bool() are standard cryptographic/protocol API names.
# is_authenticated is the BRC-100 wire-protocol method name and cannot be renamed.
# delete_output/delete_certificate return bool success indicators, not predicates.
Naming/PredicateMethod:
AllowedMethods:
- verify
- verify_proof
- cast_bool
- execute
- is_authenticated
- delete_output
- delete_certificate
- delete_action
# is_authenticated uses the BRC-100 wire-protocol naming convention (is_ prefix).
Naming/PredicatePrefix:
AllowedMethods:
- is_authenticated
# Cryptographic and script-parsing code is inherently complex;
# splitting into tiny methods would harm readability and auditability.
Metrics/AbcSize:
Exclude:
- 'gem/*/lib/**/*'
- 'gem/*/spec/**/*'
Metrics/MethodLength:
Exclude:
- 'gem/*/lib/**/*'
- 'gem/*/spec/**/*'
Metrics/CyclomaticComplexity:
Exclude:
- 'gem/*/lib/**/*'
- 'gem/*/spec/**/*'
Metrics/PerceivedComplexity:
Exclude:
- 'gem/*/lib/**/*'
- 'gem/*/spec/**/*'
Metrics/ModuleLength:
Exclude:
- 'gem/bsv-sdk/lib/bsv/primitives/ecdsa.rb'
- 'gem/bsv-sdk/lib/bsv/primitives/ecies.rb'
- 'gem/bsv-sdk/lib/bsv/script/opcodes.rb'
- 'gem/bsv-sdk/lib/bsv/script/interpreter/operations/**/*'
- 'gem/bsv-wallet/lib/bsv/wallet_interface/**/*'
- 'gem/bsv-sdk/lib/bsv/auth/**/*'
- 'gem/bsv-sdk/lib/bsv/identity/**/*'
- 'gem/bsv-sdk/lib/bsv/registry/**/*'
- 'gem/bsv-sdk/lib/bsv/wire_format.rb'
- 'gem/*/spec/**/*'
Metrics/ClassLength:
Exclude:
- 'gem/bsv-sdk/lib/bsv/primitives/**/*'
- 'gem/bsv-sdk/lib/bsv/script/**/*'
- 'gem/bsv-sdk/lib/bsv/transaction/transaction.rb'
- 'gem/bsv-sdk/lib/bsv/transaction/merkle_path.rb'
- 'gem/bsv-sdk/lib/bsv/transaction/beef.rb'
- 'gem/bsv-sdk/lib/bsv/network/**/*'
- 'gem/bsv-wallet/lib/bsv/wallet_interface/**/*'
- 'gem/bsv-wallet-postgres/lib/bsv/wallet_postgres/**/*'
- 'gem/bsv-sdk/lib/bsv/auth/**/*'
- 'gem/bsv-sdk/lib/bsv/overlay/**/*'
- 'gem/bsv-sdk/lib/bsv/identity/**/*'
- 'gem/bsv-sdk/lib/bsv/registry/**/*'
- 'gem/bsv-sdk/lib/bsv/mcp/**/*'
Metrics/ParameterLists:
Exclude:
- 'gem/bsv-sdk/lib/bsv/primitives/**/*'
- 'gem/bsv-sdk/lib/bsv/script/**/*'
- 'gem/bsv-sdk/lib/bsv/transaction/**/*'
- 'gem/bsv-sdk/lib/bsv/network/**/*'
- 'gem/bsv-sdk/lib/bsv/overlay/**/*'
- 'gem/bsv-sdk/lib/bsv/identity/**/*'
- 'gem/bsv-sdk/lib/bsv/registry/**/*'
- 'gem/bsv-sdk/lib/bsv/auth/**/*'
- 'gem/bsv-wallet/lib/bsv/wallet_interface/**/*'
# The interpreter condition stack uses :true/:false symbols intentionally
# (matching the Go SDK pattern) to distinguish from boolean values.
# ProtoWallet implements the WalletInterface but intentionally ignores the
# originator: keyword on all methods (local-only wallet, no originator policy).
Lint/UnusedMethodArgument:
Exclude:
- 'gem/bsv-wallet/lib/bsv/wallet_interface/proto_wallet.rb'
Lint/BooleanSymbol:
Exclude:
- 'gem/bsv-sdk/lib/bsv/script/interpreter/**/*'
Layout/LineLength:
Max: 150
Exclude:
- 'gem/*/spec/**/*'
RSpec/ContextWording:
Exclude:
- 'gem/bsv-sdk/spec/bsv/primitives/**/*'
# Specs for low-level modules legitimately need multiple assertions
# per example and longer examples for thorough test coverage.
RSpec/MultipleExpectations:
Exclude:
- 'gem/bsv-sdk/spec/bsv/primitives/**/*'
- 'gem/bsv-sdk/spec/bsv/script/**/*'
- 'gem/bsv-sdk/spec/bsv/transaction/**/*'
- 'gem/bsv-sdk/spec/bsv/network/**/*'
- 'gem/bsv-sdk/spec/bsv/wallet/**/*'
- 'gem/bsv-wallet-postgres/spec/bsv/wallet_postgres/**/*'
- 'gem/bsv-attest/spec/bsv/attest_spec.rb'
- 'gem/bsv-attest/spec/bsv/attest/**/*'
- 'gem/bsv-sdk/spec/bsv/auth/**/*'
- 'gem/bsv-sdk/spec/bsv/overlay/**/*'
- 'gem/bsv-sdk/spec/bsv/identity/**/*'
- 'gem/bsv-sdk/spec/bsv/registry/**/*'
- 'gem/bsv-sdk/spec/bsv/mcp/**/*'
- 'gem/bsv-wallet/spec/bsv/wallet_interface/**/*'
- 'gem/*/spec/support/**/*'
- 'gem/bsv-sdk/spec/integration/**/*'
- 'gem/bsv-sdk/spec/conformance/**/*'
RSpec/MultipleMemoizedHelpers:
Exclude:
- 'gem/bsv-sdk/spec/bsv/primitives/**/*'
- 'gem/bsv-sdk/spec/bsv/script/**/*'
- 'gem/bsv-sdk/spec/bsv/transaction/**/*'
- 'gem/bsv-sdk/spec/bsv/auth/**/*'
- 'gem/bsv-sdk/spec/bsv/overlay/**/*'
- 'gem/bsv-sdk/spec/bsv/identity/**/*'
- 'gem/bsv-sdk/spec/bsv/registry/**/*'
- 'gem/bsv-sdk/spec/bsv/mcp/**/*'
- 'gem/bsv-sdk/spec/conformance/**/*'
- 'gem/bsv-wallet/spec/bsv/wallet_interface/**/*'
- 'gem/bsv-wallet-postgres/spec/bsv/wallet_postgres/**/*'
- 'gem/*/spec/support/**/*'
RSpec/ExampleLength:
Exclude:
- 'gem/bsv-sdk/spec/bsv/primitives/**/*'
- 'gem/bsv-sdk/spec/bsv/script/**/*'
- 'gem/bsv-sdk/spec/bsv/transaction/**/*'
- 'gem/bsv-sdk/spec/bsv/network/**/*'
- 'gem/bsv-sdk/spec/bsv/wallet/**/*'
- 'gem/bsv-wallet-postgres/spec/bsv/wallet_postgres/**/*'
- 'gem/bsv-attest/spec/bsv/attest_spec.rb'
- 'gem/bsv-attest/spec/bsv/attest/**/*'
- 'gem/bsv-sdk/spec/bsv/auth/**/*'
- 'gem/bsv-sdk/spec/bsv/overlay/**/*'
- 'gem/bsv-sdk/spec/bsv/identity/**/*'
- 'gem/bsv-sdk/spec/bsv/registry/**/*'
- 'gem/bsv-sdk/spec/bsv/mcp/**/*'
- 'gem/bsv-wallet/spec/bsv/wallet_interface/**/*'
- 'gem/*/spec/support/**/*'
- 'gem/bsv-sdk/spec/integration/**/*'
- 'gem/bsv-sdk/spec/conformance/**/*'
- 'gem/bsv-sdk/spec/bsv/wire_format_spec.rb'
# Bitcoin opcodes use numbered names (OP_1, OP_2, etc.) — protocol constants.
# Wire protocol helpers use base64_32 to denote 32-byte base64 values (protocol constraint).
Naming/VariableNumber:
Exclude:
- 'gem/bsv-wallet/lib/bsv/wallet_interface/wire/**/*'
- 'gem/*/spec/**/*'
# Interpreter sub-specs and conformance specs legitimately describe parent
# classes or use string descriptions for cross-cutting vector suites.
RSpec/SpecFilePathFormat:
Exclude:
- 'gem/bsv-sdk/spec/bsv/transaction/p2pkh_spec.rb'
- 'gem/bsv-sdk/spec/bsv/script/interpreter/**/*'
- 'gem/bsv-sdk/spec/bsv/primitives/shamir/**/*'
- 'gem/bsv-sdk/spec/bsv/transaction/benford_number/**/*'
- 'gem/bsv-sdk/spec/bsv/script/op_cat_spec.rb'
- 'gem/bsv-sdk/spec/bsv/transaction/live_policy_spec.rb'
- 'gem/bsv-sdk/spec/conformance/**/*'
- 'gem/bsv-wallet/spec/bsv/wallet_interface/**/*'
- 'gem/bsv-wallet-postgres/spec/bsv/wallet_postgres/**/*'
- 'gem/bsv-sdk/spec/bsv/registry/**/*'
# Vector and conformance specs use string describes for cross-cutting test suites.
# Hardening specs test multiple classes/modules together and use a string description.
RSpec/DescribeClass:
Exclude:
- 'gem/bsv-sdk/spec/bsv/transaction/tx_vectors_spec.rb'
- 'gem/bsv-sdk/spec/bsv/transaction/sighash_vectors_spec.rb'
- 'gem/bsv-sdk/spec/bsv/script/interpreter/script_vectors_spec.rb'
- 'gem/bsv-sdk/spec/bsv/script/interpreter/hardening_spec.rb'
- 'gem/bsv-sdk/spec/integration/**/*'
- 'gem/bsv-sdk/spec/conformance/**/*'
- 'gem/bsv-wallet/spec/bsv/wallet_interface/**/*'
- 'gem/bsv-sdk/spec/bsv/registry/**/*'
# Vector specs define constants at spec scope for shared test infrastructure.
Lint/ConstantDefinitionInBlock:
Exclude:
- 'gem/bsv-sdk/spec/bsv/script/interpreter/script_vectors_spec.rb'
RSpec/LeakyConstantDeclaration:
Exclude:
- 'gem/bsv-sdk/spec/bsv/script/interpreter/script_vectors_spec.rb'
# Dynamic test generation produces describe blocks populated at runtime.
RSpec/EmptyExampleGroup:
Exclude:
- 'gem/bsv-sdk/spec/bsv/script/interpreter/script_vectors_spec.rb'
# wallet_interface spec file covers multiple top-level modules in one file.
RSpec/MultipleDescribes:
Exclude:
- 'gem/bsv-wallet/spec/bsv/wallet_interface/**/*'
# Dynamic each loops with the same template string produce unique descriptions at runtime.
RSpec/RepeatedDescription:
Exclude:
- 'gem/bsv-wallet/spec/bsv/wallet_interface/**/*'
# Integration tests use before(:context) which requires instance variables.
RSpec/BeforeAfterAll:
Exclude:
- 'gem/bsv-sdk/spec/integration/**/*'
RSpec/InstanceVariable:
Exclude:
- 'gem/bsv-sdk/spec/integration/**/*'
# Callback registration tests need empty blocks to obtain a callback ID without
# triggering an actual callback action.
Lint/EmptyBlock:
Exclude:
- 'gem/*/spec/**/*'