whodunit-chronicles 0.2.0 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +22 -179
- data/LICENSE +1 -1
- data/README.md +96 -599
- data/exe/whodunit-chronicles +6 -0
- data/lib/whodunit/chronicles/chronicler.rb +62 -0
- data/lib/whodunit/chronicles/cli.rb +131 -0
- data/lib/whodunit/chronicles/errors.rb +17 -0
- data/lib/whodunit/chronicles/ledger.rb +69 -0
- data/lib/whodunit/chronicles/ledger_entry.rb +143 -0
- data/lib/whodunit/chronicles/ledger_factory.rb +66 -0
- data/lib/whodunit/chronicles/ledgers/file_ledger.rb +56 -0
- data/lib/whodunit/chronicles/ledgers/memory_ledger.rb +29 -0
- data/lib/whodunit/chronicles/ledgers/sqlite_ledger.rb +172 -0
- data/lib/whodunit/chronicles/version.rb +2 -1
- data/lib/whodunit/chronicles.rb +13 -71
- data/lib/whodunit-chronicles.rb +0 -1
- data/sig/whodunit/chronicles/chronicler.rbs +14 -0
- data/sig/whodunit/chronicles/cli.rbs +17 -0
- data/sig/whodunit/chronicles/errors.rbs +15 -0
- data/sig/whodunit/chronicles/ledger.rbs +13 -0
- data/sig/whodunit/chronicles/ledger_entry.rbs +62 -0
- data/sig/whodunit/chronicles/ledger_factory.rbs +14 -0
- data/sig/whodunit/chronicles/ledgers/file_ledger.rbs +14 -0
- data/sig/whodunit/chronicles/ledgers/memory_ledger.rbs +12 -0
- data/sig/whodunit/chronicles/ledgers/sqlite_ledger.rbs +30 -0
- data/sig/whodunit/chronicles.rbs +5 -0
- metadata +44 -295
- data/.codeclimate.yml +0 -50
- data/.rubocop.yml +0 -93
- data/.yardopts +0 -14
- data/CODE_OF_CONDUCT.md +0 -132
- data/Rakefile +0 -18
- data/examples/images/campaign-performance-analytics.png +0 -0
- data/examples/images/candidate-journey-analytics.png +0 -0
- data/examples/images/recruitment-funnel-analytics.png +0 -0
- data/lib/.gitkeep +0 -0
- data/lib/whodunit/chronicles/adapters/mysql.rb +0 -261
- data/lib/whodunit/chronicles/adapters/postgresql.rb +0 -278
- data/lib/whodunit/chronicles/change_event.rb +0 -201
- data/lib/whodunit/chronicles/configuration.rb +0 -112
- data/lib/whodunit/chronicles/connection.rb +0 -88
- data/lib/whodunit/chronicles/persistence.rb +0 -129
- data/lib/whodunit/chronicles/processor.rb +0 -127
- data/lib/whodunit/chronicles/service.rb +0 -207
- data/lib/whodunit/chronicles/stream_adapter.rb +0 -91
- data/lib/whodunit/chronicles/table.rb +0 -120
- data/whodunit-chronicles.gemspec +0 -65
metadata
CHANGED
|
@@ -1,338 +1,87 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: whodunit-chronicles
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.4.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Ken C. Demanawa
|
|
8
|
-
- Spherical Cow
|
|
9
8
|
bindir: exe
|
|
10
9
|
cert_chain: []
|
|
11
10
|
date: 1980-01-02 00:00:00.000000000 Z
|
|
12
11
|
dependencies:
|
|
13
12
|
- !ruby/object:Gem::Dependency
|
|
14
|
-
name:
|
|
13
|
+
name: cdc-core
|
|
15
14
|
requirement: !ruby/object:Gem::Requirement
|
|
16
15
|
requirements:
|
|
17
|
-
- - "
|
|
16
|
+
- - ">="
|
|
18
17
|
- !ruby/object:Gem::Version
|
|
19
|
-
version: '1
|
|
18
|
+
version: '0.1'
|
|
20
19
|
type: :runtime
|
|
21
20
|
prerelease: false
|
|
22
21
|
version_requirements: !ruby/object:Gem::Requirement
|
|
23
22
|
requirements:
|
|
24
|
-
- - "
|
|
23
|
+
- - ">="
|
|
25
24
|
- !ruby/object:Gem::Version
|
|
26
|
-
version: '1
|
|
25
|
+
version: '0.1'
|
|
27
26
|
- !ruby/object:Gem::Dependency
|
|
28
|
-
name:
|
|
27
|
+
name: sqlite3
|
|
29
28
|
requirement: !ruby/object:Gem::Requirement
|
|
30
29
|
requirements:
|
|
31
|
-
- - "
|
|
30
|
+
- - ">="
|
|
32
31
|
- !ruby/object:Gem::Version
|
|
33
|
-
version: '
|
|
32
|
+
version: '2.0'
|
|
34
33
|
type: :runtime
|
|
35
34
|
prerelease: false
|
|
36
35
|
version_requirements: !ruby/object:Gem::Requirement
|
|
37
36
|
requirements:
|
|
38
|
-
- - "
|
|
37
|
+
- - ">="
|
|
39
38
|
- !ruby/object:Gem::Version
|
|
40
|
-
version: '
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
- - "~>"
|
|
46
|
-
- !ruby/object:Gem::Version
|
|
47
|
-
version: '1.0'
|
|
48
|
-
type: :runtime
|
|
49
|
-
prerelease: false
|
|
50
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
51
|
-
requirements:
|
|
52
|
-
- - "~>"
|
|
53
|
-
- !ruby/object:Gem::Version
|
|
54
|
-
version: '1.0'
|
|
55
|
-
- !ruby/object:Gem::Dependency
|
|
56
|
-
name: pg
|
|
57
|
-
requirement: !ruby/object:Gem::Requirement
|
|
58
|
-
requirements:
|
|
59
|
-
- - "~>"
|
|
60
|
-
- !ruby/object:Gem::Version
|
|
61
|
-
version: '1.5'
|
|
62
|
-
type: :runtime
|
|
63
|
-
prerelease: false
|
|
64
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
65
|
-
requirements:
|
|
66
|
-
- - "~>"
|
|
67
|
-
- !ruby/object:Gem::Version
|
|
68
|
-
version: '1.5'
|
|
69
|
-
- !ruby/object:Gem::Dependency
|
|
70
|
-
name: trilogy
|
|
71
|
-
requirement: !ruby/object:Gem::Requirement
|
|
72
|
-
requirements:
|
|
73
|
-
- - "~>"
|
|
74
|
-
- !ruby/object:Gem::Version
|
|
75
|
-
version: '2.9'
|
|
76
|
-
type: :runtime
|
|
77
|
-
prerelease: false
|
|
78
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
79
|
-
requirements:
|
|
80
|
-
- - "~>"
|
|
81
|
-
- !ruby/object:Gem::Version
|
|
82
|
-
version: '2.9'
|
|
83
|
-
- !ruby/object:Gem::Dependency
|
|
84
|
-
name: bigdecimal
|
|
85
|
-
requirement: !ruby/object:Gem::Requirement
|
|
86
|
-
requirements:
|
|
87
|
-
- - "~>"
|
|
88
|
-
- !ruby/object:Gem::Version
|
|
89
|
-
version: '3.1'
|
|
90
|
-
type: :runtime
|
|
91
|
-
prerelease: false
|
|
92
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
93
|
-
requirements:
|
|
94
|
-
- - "~>"
|
|
95
|
-
- !ruby/object:Gem::Version
|
|
96
|
-
version: '3.1'
|
|
97
|
-
- !ruby/object:Gem::Dependency
|
|
98
|
-
name: kramdown
|
|
99
|
-
requirement: !ruby/object:Gem::Requirement
|
|
100
|
-
requirements:
|
|
101
|
-
- - "~>"
|
|
102
|
-
- !ruby/object:Gem::Version
|
|
103
|
-
version: '2.5'
|
|
104
|
-
type: :development
|
|
105
|
-
prerelease: false
|
|
106
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
107
|
-
requirements:
|
|
108
|
-
- - "~>"
|
|
109
|
-
- !ruby/object:Gem::Version
|
|
110
|
-
version: '2.5'
|
|
111
|
-
- !ruby/object:Gem::Dependency
|
|
112
|
-
name: minitest
|
|
113
|
-
requirement: !ruby/object:Gem::Requirement
|
|
114
|
-
requirements:
|
|
115
|
-
- - "~>"
|
|
116
|
-
- !ruby/object:Gem::Version
|
|
117
|
-
version: '5.20'
|
|
118
|
-
type: :development
|
|
119
|
-
prerelease: false
|
|
120
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
121
|
-
requirements:
|
|
122
|
-
- - "~>"
|
|
123
|
-
- !ruby/object:Gem::Version
|
|
124
|
-
version: '5.20'
|
|
125
|
-
- !ruby/object:Gem::Dependency
|
|
126
|
-
name: mocha
|
|
127
|
-
requirement: !ruby/object:Gem::Requirement
|
|
128
|
-
requirements:
|
|
129
|
-
- - "~>"
|
|
130
|
-
- !ruby/object:Gem::Version
|
|
131
|
-
version: '2.1'
|
|
132
|
-
type: :development
|
|
133
|
-
prerelease: false
|
|
134
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
135
|
-
requirements:
|
|
136
|
-
- - "~>"
|
|
137
|
-
- !ruby/object:Gem::Version
|
|
138
|
-
version: '2.1'
|
|
139
|
-
- !ruby/object:Gem::Dependency
|
|
140
|
-
name: pry
|
|
141
|
-
requirement: !ruby/object:Gem::Requirement
|
|
142
|
-
requirements:
|
|
143
|
-
- - "~>"
|
|
144
|
-
- !ruby/object:Gem::Version
|
|
145
|
-
version: '0.14'
|
|
146
|
-
type: :development
|
|
147
|
-
prerelease: false
|
|
148
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
149
|
-
requirements:
|
|
150
|
-
- - "~>"
|
|
151
|
-
- !ruby/object:Gem::Version
|
|
152
|
-
version: '0.14'
|
|
153
|
-
- !ruby/object:Gem::Dependency
|
|
154
|
-
name: rake
|
|
155
|
-
requirement: !ruby/object:Gem::Requirement
|
|
156
|
-
requirements:
|
|
157
|
-
- - "~>"
|
|
158
|
-
- !ruby/object:Gem::Version
|
|
159
|
-
version: '13.0'
|
|
160
|
-
type: :development
|
|
161
|
-
prerelease: false
|
|
162
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
163
|
-
requirements:
|
|
164
|
-
- - "~>"
|
|
165
|
-
- !ruby/object:Gem::Version
|
|
166
|
-
version: '13.0'
|
|
167
|
-
- !ruby/object:Gem::Dependency
|
|
168
|
-
name: rspec_junit_formatter
|
|
169
|
-
requirement: !ruby/object:Gem::Requirement
|
|
170
|
-
requirements:
|
|
171
|
-
- - "~>"
|
|
172
|
-
- !ruby/object:Gem::Version
|
|
173
|
-
version: 0.6.0
|
|
174
|
-
type: :development
|
|
175
|
-
prerelease: false
|
|
176
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
177
|
-
requirements:
|
|
178
|
-
- - "~>"
|
|
179
|
-
- !ruby/object:Gem::Version
|
|
180
|
-
version: 0.6.0
|
|
181
|
-
- !ruby/object:Gem::Dependency
|
|
182
|
-
name: rubocop
|
|
183
|
-
requirement: !ruby/object:Gem::Requirement
|
|
184
|
-
requirements:
|
|
185
|
-
- - "~>"
|
|
186
|
-
- !ruby/object:Gem::Version
|
|
187
|
-
version: '1.60'
|
|
188
|
-
type: :development
|
|
189
|
-
prerelease: false
|
|
190
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
191
|
-
requirements:
|
|
192
|
-
- - "~>"
|
|
193
|
-
- !ruby/object:Gem::Version
|
|
194
|
-
version: '1.60'
|
|
195
|
-
- !ruby/object:Gem::Dependency
|
|
196
|
-
name: rubocop-minitest
|
|
197
|
-
requirement: !ruby/object:Gem::Requirement
|
|
198
|
-
requirements:
|
|
199
|
-
- - "~>"
|
|
200
|
-
- !ruby/object:Gem::Version
|
|
201
|
-
version: '0.34'
|
|
202
|
-
type: :development
|
|
203
|
-
prerelease: false
|
|
204
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
205
|
-
requirements:
|
|
206
|
-
- - "~>"
|
|
207
|
-
- !ruby/object:Gem::Version
|
|
208
|
-
version: '0.34'
|
|
209
|
-
- !ruby/object:Gem::Dependency
|
|
210
|
-
name: rubocop-performance
|
|
211
|
-
requirement: !ruby/object:Gem::Requirement
|
|
212
|
-
requirements:
|
|
213
|
-
- - "~>"
|
|
214
|
-
- !ruby/object:Gem::Version
|
|
215
|
-
version: '1.19'
|
|
216
|
-
type: :development
|
|
217
|
-
prerelease: false
|
|
218
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
219
|
-
requirements:
|
|
220
|
-
- - "~>"
|
|
221
|
-
- !ruby/object:Gem::Version
|
|
222
|
-
version: '1.19'
|
|
223
|
-
- !ruby/object:Gem::Dependency
|
|
224
|
-
name: simplecov
|
|
225
|
-
requirement: !ruby/object:Gem::Requirement
|
|
226
|
-
requirements:
|
|
227
|
-
- - "~>"
|
|
228
|
-
- !ruby/object:Gem::Version
|
|
229
|
-
version: '0.22'
|
|
230
|
-
type: :development
|
|
231
|
-
prerelease: false
|
|
232
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
233
|
-
requirements:
|
|
234
|
-
- - "~>"
|
|
235
|
-
- !ruby/object:Gem::Version
|
|
236
|
-
version: '0.22'
|
|
237
|
-
- !ruby/object:Gem::Dependency
|
|
238
|
-
name: simplecov-cobertura
|
|
239
|
-
requirement: !ruby/object:Gem::Requirement
|
|
240
|
-
requirements:
|
|
241
|
-
- - "~>"
|
|
242
|
-
- !ruby/object:Gem::Version
|
|
243
|
-
version: '3.0'
|
|
244
|
-
type: :development
|
|
245
|
-
prerelease: false
|
|
246
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
247
|
-
requirements:
|
|
248
|
-
- - "~>"
|
|
249
|
-
- !ruby/object:Gem::Version
|
|
250
|
-
version: '3.0'
|
|
251
|
-
- !ruby/object:Gem::Dependency
|
|
252
|
-
name: yard
|
|
253
|
-
requirement: !ruby/object:Gem::Requirement
|
|
254
|
-
requirements:
|
|
255
|
-
- - "~>"
|
|
256
|
-
- !ruby/object:Gem::Version
|
|
257
|
-
version: '0.9'
|
|
258
|
-
type: :development
|
|
259
|
-
prerelease: false
|
|
260
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
261
|
-
requirements:
|
|
262
|
-
- - "~>"
|
|
263
|
-
- !ruby/object:Gem::Version
|
|
264
|
-
version: '0.9'
|
|
265
|
-
- !ruby/object:Gem::Dependency
|
|
266
|
-
name: brakeman
|
|
267
|
-
requirement: !ruby/object:Gem::Requirement
|
|
268
|
-
requirements:
|
|
269
|
-
- - "~>"
|
|
270
|
-
- !ruby/object:Gem::Version
|
|
271
|
-
version: '7.1'
|
|
272
|
-
type: :development
|
|
273
|
-
prerelease: false
|
|
274
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
275
|
-
requirements:
|
|
276
|
-
- - "~>"
|
|
277
|
-
- !ruby/object:Gem::Version
|
|
278
|
-
version: '7.1'
|
|
279
|
-
- !ruby/object:Gem::Dependency
|
|
280
|
-
name: bundler-audit
|
|
281
|
-
requirement: !ruby/object:Gem::Requirement
|
|
282
|
-
requirements:
|
|
283
|
-
- - "~>"
|
|
284
|
-
- !ruby/object:Gem::Version
|
|
285
|
-
version: '0.9'
|
|
286
|
-
type: :development
|
|
287
|
-
prerelease: false
|
|
288
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
289
|
-
requirements:
|
|
290
|
-
- - "~>"
|
|
291
|
-
- !ruby/object:Gem::Version
|
|
292
|
-
version: '0.9'
|
|
293
|
-
description: While Whodunit tracks who made changes, Chronicles captures what changed
|
|
294
|
-
by streaming database events into comprehensive audit trails with zero Rails application
|
|
295
|
-
overhead.
|
|
39
|
+
version: '2.0'
|
|
40
|
+
description: |
|
|
41
|
+
Whodunit Chronicles records CDC change events as immutable ledger entries.
|
|
42
|
+
It provides a tiny Chronicler processor, a Ledger abstraction,
|
|
43
|
+
and simple ledger implementations without owning replication, runtime execution, or orchestration.
|
|
296
44
|
email:
|
|
297
45
|
- kenneth.c.demanawa@gmail.com
|
|
298
|
-
executables:
|
|
46
|
+
executables:
|
|
47
|
+
- whodunit-chronicles
|
|
299
48
|
extensions: []
|
|
300
49
|
extra_rdoc_files: []
|
|
301
50
|
files:
|
|
302
|
-
- ".codeclimate.yml"
|
|
303
|
-
- ".rubocop.yml"
|
|
304
|
-
- ".yardopts"
|
|
305
51
|
- CHANGELOG.md
|
|
306
|
-
- CODE_OF_CONDUCT.md
|
|
307
52
|
- LICENSE
|
|
308
53
|
- README.md
|
|
309
|
-
-
|
|
310
|
-
- examples/images/campaign-performance-analytics.png
|
|
311
|
-
- examples/images/candidate-journey-analytics.png
|
|
312
|
-
- examples/images/recruitment-funnel-analytics.png
|
|
313
|
-
- lib/.gitkeep
|
|
54
|
+
- exe/whodunit-chronicles
|
|
314
55
|
- lib/whodunit-chronicles.rb
|
|
315
56
|
- lib/whodunit/chronicles.rb
|
|
316
|
-
- lib/whodunit/chronicles/
|
|
317
|
-
- lib/whodunit/chronicles/
|
|
318
|
-
- lib/whodunit/chronicles/
|
|
319
|
-
- lib/whodunit/chronicles/
|
|
320
|
-
- lib/whodunit/chronicles/
|
|
321
|
-
- lib/whodunit/chronicles/
|
|
322
|
-
- lib/whodunit/chronicles/
|
|
323
|
-
- lib/whodunit/chronicles/
|
|
324
|
-
- lib/whodunit/chronicles/
|
|
325
|
-
- lib/whodunit/chronicles/table.rb
|
|
57
|
+
- lib/whodunit/chronicles/chronicler.rb
|
|
58
|
+
- lib/whodunit/chronicles/cli.rb
|
|
59
|
+
- lib/whodunit/chronicles/errors.rb
|
|
60
|
+
- lib/whodunit/chronicles/ledger.rb
|
|
61
|
+
- lib/whodunit/chronicles/ledger_entry.rb
|
|
62
|
+
- lib/whodunit/chronicles/ledger_factory.rb
|
|
63
|
+
- lib/whodunit/chronicles/ledgers/file_ledger.rb
|
|
64
|
+
- lib/whodunit/chronicles/ledgers/memory_ledger.rb
|
|
65
|
+
- lib/whodunit/chronicles/ledgers/sqlite_ledger.rb
|
|
326
66
|
- lib/whodunit/chronicles/version.rb
|
|
327
|
-
- whodunit
|
|
328
|
-
|
|
67
|
+
- sig/whodunit/chronicles.rbs
|
|
68
|
+
- sig/whodunit/chronicles/chronicler.rbs
|
|
69
|
+
- sig/whodunit/chronicles/cli.rbs
|
|
70
|
+
- sig/whodunit/chronicles/errors.rbs
|
|
71
|
+
- sig/whodunit/chronicles/ledger.rbs
|
|
72
|
+
- sig/whodunit/chronicles/ledger_entry.rbs
|
|
73
|
+
- sig/whodunit/chronicles/ledger_factory.rbs
|
|
74
|
+
- sig/whodunit/chronicles/ledgers/file_ledger.rbs
|
|
75
|
+
- sig/whodunit/chronicles/ledgers/memory_ledger.rbs
|
|
76
|
+
- sig/whodunit/chronicles/ledgers/sqlite_ledger.rbs
|
|
77
|
+
homepage: https://github.com/kanutocd/whodunit-chronicles
|
|
329
78
|
licenses:
|
|
330
79
|
- MIT
|
|
331
80
|
metadata:
|
|
332
81
|
allowed_push_host: https://rubygems.org
|
|
333
|
-
homepage_uri: https://github.com/
|
|
334
|
-
source_code_uri: https://github.com/
|
|
335
|
-
changelog_uri: https://github.com/
|
|
82
|
+
homepage_uri: https://github.com/kanutocd/whodunit-chronicles
|
|
83
|
+
source_code_uri: https://github.com/kanutocd/whodunit-chronicles/tree/main
|
|
84
|
+
changelog_uri: https://github.com/kanutocd/whodunit-chronicles/blob/main/CHANGELOG.md
|
|
336
85
|
rubygems_mfa_required: 'true'
|
|
337
86
|
rdoc_options: []
|
|
338
87
|
require_paths:
|
|
@@ -341,14 +90,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
341
90
|
requirements:
|
|
342
91
|
- - ">="
|
|
343
92
|
- !ruby/object:Gem::Version
|
|
344
|
-
version: 3.
|
|
93
|
+
version: '3.4'
|
|
345
94
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
346
95
|
requirements:
|
|
347
96
|
- - ">="
|
|
348
97
|
- !ruby/object:Gem::Version
|
|
349
98
|
version: '0'
|
|
350
99
|
requirements: []
|
|
351
|
-
rubygems_version:
|
|
100
|
+
rubygems_version: 4.0.15
|
|
352
101
|
specification_version: 4
|
|
353
|
-
summary:
|
|
102
|
+
summary: A minimal CDC audit sink for immutable ledger entries
|
|
354
103
|
test_files: []
|
data/.codeclimate.yml
DELETED
|
@@ -1,50 +0,0 @@
|
|
|
1
|
-
version: "2"
|
|
2
|
-
checks:
|
|
3
|
-
argument-count:
|
|
4
|
-
config:
|
|
5
|
-
threshold: 4
|
|
6
|
-
complex-logic:
|
|
7
|
-
config:
|
|
8
|
-
threshold: 4
|
|
9
|
-
file-lines:
|
|
10
|
-
config:
|
|
11
|
-
threshold: 250
|
|
12
|
-
method-complexity:
|
|
13
|
-
config:
|
|
14
|
-
threshold: 5
|
|
15
|
-
method-count:
|
|
16
|
-
config:
|
|
17
|
-
threshold: 20
|
|
18
|
-
method-lines:
|
|
19
|
-
config:
|
|
20
|
-
threshold: 25
|
|
21
|
-
nested-control-flow:
|
|
22
|
-
config:
|
|
23
|
-
threshold: 4
|
|
24
|
-
return-statements:
|
|
25
|
-
config:
|
|
26
|
-
threshold: 4
|
|
27
|
-
similar-code:
|
|
28
|
-
config:
|
|
29
|
-
threshold: # language-specific defaults. an integer indicates the minimum number of lines within a block of similar code.
|
|
30
|
-
identical-code:
|
|
31
|
-
config:
|
|
32
|
-
threshold: # language-specific defaults. an integer indicates the minimum number of lines within a block of identical code.
|
|
33
|
-
plugins:
|
|
34
|
-
rubocop:
|
|
35
|
-
enabled: true
|
|
36
|
-
config:
|
|
37
|
-
file: .rubocop.yml
|
|
38
|
-
exclude_patterns:
|
|
39
|
-
- "config/"
|
|
40
|
-
- "db/"
|
|
41
|
-
- "dist/"
|
|
42
|
-
- "features/"
|
|
43
|
-
- "**/node_modules/"
|
|
44
|
-
- "script/"
|
|
45
|
-
- "**/spec/"
|
|
46
|
-
- "**/test/"
|
|
47
|
-
- "**/tests/"
|
|
48
|
-
- "**/vendor/"
|
|
49
|
-
- "**/*_test.rb"
|
|
50
|
-
- "**/*_spec.rb"
|
data/.rubocop.yml
DELETED
|
@@ -1,93 +0,0 @@
|
|
|
1
|
-
# Ruby version
|
|
2
|
-
AllCops:
|
|
3
|
-
TargetRubyVersion: 3.1
|
|
4
|
-
NewCops: enable
|
|
5
|
-
Exclude:
|
|
6
|
-
- 'vendor/**/*'
|
|
7
|
-
- 'tmp/**/*'
|
|
8
|
-
- 'bin/**/*'
|
|
9
|
-
- 'node_modules/**/*'
|
|
10
|
-
- 'examples/**/*'
|
|
11
|
-
|
|
12
|
-
# Use plugins for extensions
|
|
13
|
-
plugins:
|
|
14
|
-
- rubocop-performance
|
|
15
|
-
- rubocop-minitest
|
|
16
|
-
|
|
17
|
-
# Layout cops
|
|
18
|
-
Layout/LineLength:
|
|
19
|
-
Max: 120
|
|
20
|
-
AllowedPatterns: ['\A\s*#']
|
|
21
|
-
|
|
22
|
-
Layout/MultilineMethodCallBraceLayout:
|
|
23
|
-
Enabled: false
|
|
24
|
-
|
|
25
|
-
Layout/ArgumentAlignment:
|
|
26
|
-
EnforcedStyle: with_fixed_indentation
|
|
27
|
-
|
|
28
|
-
# Metrics cops - relax for complex business logic
|
|
29
|
-
Metrics/ClassLength:
|
|
30
|
-
Max: 250 # Allow larger classes for database adapters and processors
|
|
31
|
-
Exclude:
|
|
32
|
-
- 'test/**/*' # Test classes can be longer
|
|
33
|
-
|
|
34
|
-
Metrics/MethodLength:
|
|
35
|
-
Max: 50 # Allow longer methods for SQL generation and complex logic
|
|
36
|
-
|
|
37
|
-
Metrics/AbcSize:
|
|
38
|
-
Max: 40 # Allow higher complexity for database operations
|
|
39
|
-
|
|
40
|
-
Metrics/CyclomaticComplexity:
|
|
41
|
-
Max: 15 # Allow more complex conditional logic
|
|
42
|
-
|
|
43
|
-
Metrics/PerceivedComplexity:
|
|
44
|
-
Max: 15
|
|
45
|
-
|
|
46
|
-
Metrics/ParameterLists:
|
|
47
|
-
Max: 12 # Allow more params for configuration objects and event initialization
|
|
48
|
-
|
|
49
|
-
# Style cops
|
|
50
|
-
Style/Documentation:
|
|
51
|
-
Enabled: false # We have YARD docs
|
|
52
|
-
|
|
53
|
-
Style/FrozenStringLiteralComment:
|
|
54
|
-
Enabled: true
|
|
55
|
-
EnforcedStyle: always
|
|
56
|
-
|
|
57
|
-
Style/StringLiterals:
|
|
58
|
-
EnforcedStyle: single_quotes
|
|
59
|
-
|
|
60
|
-
Style/HashSyntax:
|
|
61
|
-
EnforcedStyle: ruby19
|
|
62
|
-
|
|
63
|
-
Style/TrailingCommaInArguments:
|
|
64
|
-
EnforcedStyleForMultiline: comma
|
|
65
|
-
|
|
66
|
-
Style/TrailingCommaInArrayLiteral:
|
|
67
|
-
EnforcedStyleForMultiline: comma
|
|
68
|
-
|
|
69
|
-
Style/TrailingCommaInHashLiteral:
|
|
70
|
-
EnforcedStyleForMultiline: comma
|
|
71
|
-
|
|
72
|
-
# Naming
|
|
73
|
-
Naming/FileName:
|
|
74
|
-
Exclude:
|
|
75
|
-
- 'lib/whodunit-chronicles.rb' # Main gem file
|
|
76
|
-
|
|
77
|
-
# Gemspec
|
|
78
|
-
Gemspec/DevelopmentDependencies:
|
|
79
|
-
Enabled: false # We're fine with dev dependencies in gemspec
|
|
80
|
-
|
|
81
|
-
# Minitest specific cops
|
|
82
|
-
Minitest/MultipleAssertions:
|
|
83
|
-
Max: 10 # Allow more assertions in comprehensive tests
|
|
84
|
-
|
|
85
|
-
Minitest/AssertNil:
|
|
86
|
-
Enabled: false # Prefer assert_nil over assert_equal(nil, ...)
|
|
87
|
-
|
|
88
|
-
# Performance cops
|
|
89
|
-
Performance/Casecmp:
|
|
90
|
-
Enabled: true
|
|
91
|
-
|
|
92
|
-
Performance/StringReplacement:
|
|
93
|
-
Enabled: true
|
data/.yardopts
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
--markup markdown
|
|
2
|
-
--markup-provider kramdown
|
|
3
|
-
--main README.md
|
|
4
|
-
--output-dir docs
|
|
5
|
-
--protected
|
|
6
|
-
--private
|
|
7
|
-
--title "Whodunit Chronicles API Documentation"
|
|
8
|
-
--readme README.md
|
|
9
|
-
--files CHANGELOG.md,LICENSE
|
|
10
|
-
lib/**/*.rb
|
|
11
|
-
-
|
|
12
|
-
README.md
|
|
13
|
-
CHANGELOG.md
|
|
14
|
-
LICENSE
|
data/CODE_OF_CONDUCT.md
DELETED
|
@@ -1,132 +0,0 @@
|
|
|
1
|
-
# Contributor Covenant Code of Conduct
|
|
2
|
-
|
|
3
|
-
## Our Pledge
|
|
4
|
-
|
|
5
|
-
We as members, contributors, and leaders pledge to make participation in our
|
|
6
|
-
community a harassment-free experience for everyone, regardless of age, body
|
|
7
|
-
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
8
|
-
identity and expression, level of experience, education, socio-economic status,
|
|
9
|
-
nationality, personal appearance, race, caste, color, religion, or sexual
|
|
10
|
-
identity and orientation.
|
|
11
|
-
|
|
12
|
-
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
13
|
-
diverse, inclusive, and healthy community.
|
|
14
|
-
|
|
15
|
-
## Our Standards
|
|
16
|
-
|
|
17
|
-
Examples of behavior that contributes to a positive environment for our
|
|
18
|
-
community include:
|
|
19
|
-
|
|
20
|
-
* Demonstrating empathy and kindness toward other people
|
|
21
|
-
* Being respectful of differing opinions, viewpoints, and experiences
|
|
22
|
-
* Giving and gracefully accepting constructive feedback
|
|
23
|
-
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
24
|
-
and learning from the experience
|
|
25
|
-
* Focusing on what is best not just for us as individuals, but for the overall
|
|
26
|
-
community
|
|
27
|
-
|
|
28
|
-
Examples of unacceptable behavior include:
|
|
29
|
-
|
|
30
|
-
* The use of sexualized language or imagery, and sexual attention or advances of
|
|
31
|
-
any kind
|
|
32
|
-
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
33
|
-
* Public or private harassment
|
|
34
|
-
* Publishing others' private information, such as a physical or email address,
|
|
35
|
-
without their explicit permission
|
|
36
|
-
* Other conduct which could reasonably be considered inappropriate in a
|
|
37
|
-
professional setting
|
|
38
|
-
|
|
39
|
-
## Enforcement Responsibilities
|
|
40
|
-
|
|
41
|
-
Community leaders are responsible for clarifying and enforcing our standards of
|
|
42
|
-
acceptable behavior and will take appropriate and fair corrective action in
|
|
43
|
-
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
44
|
-
or harmful.
|
|
45
|
-
|
|
46
|
-
Community leaders have the right and responsibility to remove, edit, or reject
|
|
47
|
-
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
48
|
-
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
49
|
-
decisions when appropriate.
|
|
50
|
-
|
|
51
|
-
## Scope
|
|
52
|
-
|
|
53
|
-
This Code of Conduct applies within all community spaces, and also applies when
|
|
54
|
-
an individual is officially representing the community in public spaces.
|
|
55
|
-
Examples of representing our community include using an official email address,
|
|
56
|
-
posting via an official social media account, or acting as an appointed
|
|
57
|
-
representative at an online or offline event.
|
|
58
|
-
|
|
59
|
-
## Enforcement
|
|
60
|
-
|
|
61
|
-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
62
|
-
reported to the community leaders responsible for enforcement at
|
|
63
|
-
[INSERT CONTACT METHOD].
|
|
64
|
-
All complaints will be reviewed and investigated promptly and fairly.
|
|
65
|
-
|
|
66
|
-
All community leaders are obligated to respect the privacy and security of the
|
|
67
|
-
reporter of any incident.
|
|
68
|
-
|
|
69
|
-
## Enforcement Guidelines
|
|
70
|
-
|
|
71
|
-
Community leaders will follow these Community Impact Guidelines in determining
|
|
72
|
-
the consequences for any action they deem in violation of this Code of Conduct:
|
|
73
|
-
|
|
74
|
-
### 1. Correction
|
|
75
|
-
|
|
76
|
-
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
77
|
-
unprofessional or unwelcome in the community.
|
|
78
|
-
|
|
79
|
-
**Consequence**: A private, written warning from community leaders, providing
|
|
80
|
-
clarity around the nature of the violation and an explanation of why the
|
|
81
|
-
behavior was inappropriate. A public apology may be requested.
|
|
82
|
-
|
|
83
|
-
### 2. Warning
|
|
84
|
-
|
|
85
|
-
**Community Impact**: A violation through a single incident or series of
|
|
86
|
-
actions.
|
|
87
|
-
|
|
88
|
-
**Consequence**: A warning with consequences for continued behavior. No
|
|
89
|
-
interaction with the people involved, including unsolicited interaction with
|
|
90
|
-
those enforcing the Code of Conduct, for a specified period of time. This
|
|
91
|
-
includes avoiding interactions in community spaces as well as external channels
|
|
92
|
-
like social media. Violating these terms may lead to a temporary or permanent
|
|
93
|
-
ban.
|
|
94
|
-
|
|
95
|
-
### 3. Temporary Ban
|
|
96
|
-
|
|
97
|
-
**Community Impact**: A serious violation of community standards, including
|
|
98
|
-
sustained inappropriate behavior.
|
|
99
|
-
|
|
100
|
-
**Consequence**: A temporary ban from any sort of interaction or public
|
|
101
|
-
communication with the community for a specified period of time. No public or
|
|
102
|
-
private interaction with the people involved, including unsolicited interaction
|
|
103
|
-
with those enforcing the Code of Conduct, is allowed during this period.
|
|
104
|
-
Violating these terms may lead to a permanent ban.
|
|
105
|
-
|
|
106
|
-
### 4. Permanent Ban
|
|
107
|
-
|
|
108
|
-
**Community Impact**: Demonstrating a pattern of violation of community
|
|
109
|
-
standards, including sustained inappropriate behavior, harassment of an
|
|
110
|
-
individual, or aggression toward or disparagement of classes of individuals.
|
|
111
|
-
|
|
112
|
-
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
113
|
-
community.
|
|
114
|
-
|
|
115
|
-
## Attribution
|
|
116
|
-
|
|
117
|
-
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
118
|
-
version 2.1, available at
|
|
119
|
-
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
|
120
|
-
|
|
121
|
-
Community Impact Guidelines were inspired by
|
|
122
|
-
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
|
123
|
-
|
|
124
|
-
For answers to common questions about this code of conduct, see the FAQ at
|
|
125
|
-
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
|
126
|
-
[https://www.contributor-covenant.org/translations][translations].
|
|
127
|
-
|
|
128
|
-
[homepage]: https://www.contributor-covenant.org
|
|
129
|
-
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
|
130
|
-
[Mozilla CoC]: https://github.com/mozilla/diversity
|
|
131
|
-
[FAQ]: https://www.contributor-covenant.org/faq
|
|
132
|
-
[translations]: https://www.contributor-covenant.org/translations
|