truemail-rspec 0.1.3 → 0.3.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (30) hide show
  1. checksums.yaml +4 -4
  2. data/.codeclimate.yml +1 -0
  3. data/.github/BRANCH_NAMING_CONVENTION.md +36 -0
  4. data/.github/ISSUE_TEMPLATE/bug_report.md +28 -0
  5. data/.github/ISSUE_TEMPLATE/feature_request.md +27 -0
  6. data/.github/{ISSUE_TEMPLATE.md → ISSUE_TEMPLATE/issue_report.md} +16 -5
  7. data/.github/ISSUE_TEMPLATE/question.md +22 -0
  8. data/.github/PULL_REQUEST_TEMPLATE.md +3 -0
  9. data/.reek.yml +6 -0
  10. data/.rubocop.yml +139 -60
  11. data/CHANGELOG.md +53 -0
  12. data/CONTRIBUTING.md +15 -14
  13. data/Gemfile.lock +52 -42
  14. data/README.md +41 -10
  15. data/lib/truemail/rspec.rb +2 -0
  16. data/lib/truemail/rspec/auditor_helper.rb +20 -0
  17. data/lib/truemail/rspec/configuration_helper.rb +2 -2
  18. data/lib/truemail/rspec/validator_helper.rb +9 -7
  19. data/lib/truemail/rspec/version.rb +1 -1
  20. data/truemail-rspec.gemspec +18 -8
  21. metadata +88 -41
  22. data/docs/.nojekyll +0 -0
  23. data/docs/_coverpage.md +0 -8
  24. data/docs/_sidebar.md +0 -9
  25. data/docs/contact-support.md +0 -14
  26. data/docs/index.html +0 -40
  27. data/docs/introduction.md +0 -18
  28. data/docs/quick-start.md +0 -33
  29. data/docs/truemail-family.md +0 -11
  30. data/docs/usage.md +0 -47
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: da5963e4ac15443d4412310fe26af7b908a459a5697d4975532149741dbc3a62
4
- data.tar.gz: e4e478a4f490fc6f48ee4d975203becf8efd91d4014ef8d0bfd6dc287dbdefa8
3
+ metadata.gz: 4f30fae25fc68dfd65b890b816256d2076e5f510dd00603af2a323ffa3a600a8
4
+ data.tar.gz: '01493c4350fa53c4097330d5aafae2ace03658bedb7ca4bbee80a43badaa2e10'
5
5
  SHA512:
6
- metadata.gz: 2eb99db638aaa8ad2e7f8bd33fb595421fcafb3d6885ea67f1e81a62a9e09fc489a7b00bf29d85ef0f09dcc3f7a489eeb4da0a737779a56584449fa63354705e
7
- data.tar.gz: a8e61ef6b120d3a05bd7ffcc33c98eb6bd1b934ccfc5fd5d70da1b1a919e59eb9d2737da1aa4c4d59856dfde3fc5f00c5e9bde5bc4c401b1aa16eafc105b95a1
6
+ metadata.gz: aac117deb690988d802f91c78b564cbd4a38d833d8299e9868b7903624da59002d36dd11d3ae83417c00ce682d9a9a7979d90bc65ed1ae1fa46a3159f66807e0
7
+ data.tar.gz: 79210f6ea12426c567e11458af6b41764275ffe8192b8dde316067607404588d71a37b6066718dbd1d122e4796318bf33e489e4b86e62f78adfe348aa9bdfb26
data/.codeclimate.yml CHANGED
@@ -7,6 +7,7 @@ checks:
7
7
  plugins:
8
8
  rubocop:
9
9
  enabled: true
10
+ channel: rubocop-1-50
10
11
 
11
12
  reek:
12
13
  enabled: true
data/.github/BRANCH_NAMING_CONVENTION.md ADDED
@@ -0,0 +1,36 @@
1
+ # Branch naming convention
2
+
3
+ ## Branch naming
4
+
5
+ > Please note for new pull requests create new branches from current `develop` branch only.
6
+
7
+ Branch name should include type of your contribution and context. Please follow next pattern for naming your branches:
8
+
9
+ ```bash
10
+ feature/add-some-feature
11
+ technical/some-technical-improvements
12
+ bugfix/fix-some-bug-name
13
+ ```
14
+
15
+ ## Before PR actions
16
+
17
+ ### Squash commits
18
+
19
+ Please squash all branch commits into the one before openning your PR from your fork. It's simple to do with the git:
20
+
21
+ ```bash
22
+ git rebase -i [hash your first commit of your branch]~1
23
+ git rebase -i 6467fe36232401fa740af067cfd8ac9ec932fed2~1 # example
24
+ ```
25
+
26
+ ### Add commit description
27
+
28
+ Please complete your commit description folowing next pattern:
29
+
30
+ ```
31
+ Technical/Add info files # should be the same name as your branch name
32
+
33
+ * Added license, changelog, contributing, code of conduct docs
34
+ * Added GitHub templates
35
+ * Updated project license link
36
+ ```
data/.github/ISSUE_TEMPLATE/bug_report.md ADDED
@@ -0,0 +1,28 @@
1
+ ---
2
+ name: Bug report
3
+ about: Create a report to help us improve
4
+ title: "[BUG] Your bug report title here"
5
+ labels: bug
6
+ assignees: bestwebua
7
+
8
+ ---
9
+
10
+ <!-- Thanks for helping to make Truemail better! Before submit your bug, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->
11
+
12
+ ### New bug checklist
13
+
14
+ - [ ] I have updated `truemail-rspec` to the latest version
15
+ - [ ] I have read the [Contribution Guidelines](https://github.com/truemail-rb/truemail-rspec/blob/master/CONTRIBUTING.md)
16
+ - [ ] I have read the [documentation](https://truemail-rb.org/truemail-rspec)
17
+ - [ ] I have searched for [existing GitHub issues](https://github.com/truemail-rb/truemail-rspec/issues)
18
+
19
+ <!-- Please use next pattern for your bug report title: [BUG] Your bug report title here -->
20
+
21
+ ### Bug description
22
+ <!-- Please include what's happening, expected behavior, and any relevant code samples -->
23
+
24
+ ##### Complete output when running truemail-rspec, including the stack trace and command used
25
+
26
+ <details>
27
+ <pre>[INSERT OUTPUT HERE]</pre>
28
+ </details>
data/.github/ISSUE_TEMPLATE/feature_request.md ADDED
@@ -0,0 +1,27 @@
1
+ ---
2
+ name: Feature request
3
+ about: Suggest an idea for Truemail
4
+ title: "[FEATURE] Your feature request title here"
5
+ labels: enhancement
6
+ assignees: bestwebua
7
+
8
+ ---
9
+
10
+ <!-- Thanks for helping to make Truemail better! Before submit your new feature request, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->
11
+
12
+ ### New feature request checklist
13
+
14
+ - [ ] I have updated `truemail-rspec` to the latest version
15
+ - [ ] I have read the [Contribution Guidelines](https://github.com/truemail-rb/truemail-rspec/blob/master/CONTRIBUTING.md)
16
+ - [ ] I have read the [documentation](https://truemail-rb.org/truemail-rspec)
17
+ - [ ] I have searched for [existing GitHub issues](https://github.com/truemail-rb/truemail-rspec/issues)
18
+
19
+ <!-- Please use next pattern for your feature request title: [FEATURE] Your feature request title here -->
20
+
21
+ ### Feature description
22
+
23
+ <!-- Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
24
+
25
+ Describe the solution you'd like. A clear and concise description of what you want to happen.
26
+
27
+ Describe alternatives you've considered. A clear and concise description of any alternative solutions or features you've considered. -->
data/.github/{ISSUE_TEMPLATE.md → ISSUE_TEMPLATE/issue_report.md} RENAMED
@@ -1,16 +1,27 @@
1
+ ---
2
+ name: Issue report
3
+ about: Create a report to help us improve
4
+ title: "[ISSUE] Your issue report title here"
5
+ labels: ''
6
+ assignees: bestwebua
7
+
8
+ ---
9
+
1
10
  <!-- Thanks for helping to make Truemail better! Before submit your issue, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->
2
11
 
3
- ### New Issue Checklist
12
+ ### New issue checklist
4
13
 
5
- - [ ] I have updated truemail-rspec to the latest version
14
+ - [ ] I have updated `truemail-rspec` to the latest version
6
15
  - [ ] I have read the [Contribution Guidelines](https://github.com/truemail-rb/truemail-rspec/blob/master/CONTRIBUTING.md)
7
- - [ ] I have read the [documentation](https://github.com/truemail-rb/truemail-rspec/blob/master/README.md)
16
+ - [ ] I have read the [documentation](https://truemail-rb.org/truemail-rspec)
8
17
  - [ ] I have searched for [existing GitHub issues](https://github.com/truemail-rb/truemail-rspec/issues)
9
18
 
10
- ### Issue Description
19
+ <!-- Please use next pattern for your issue report title: [ISSUE] Your issue report title here -->
20
+
21
+ ### Issue description
11
22
  <!-- Please include what's happening, expected behavior, and any relevant code samples -->
12
23
 
13
- ##### Complete output when running truemail, including the stack trace and command used
24
+ ##### Complete output when running truemail-rspec, including the stack trace and command used
14
25
 
15
26
  <details>
16
27
  <pre>[INSERT OUTPUT HERE]</pre>
data/.github/ISSUE_TEMPLATE/question.md ADDED
@@ -0,0 +1,22 @@
1
+ ---
2
+ name: Question
3
+ about: Ask your question to Truemail team
4
+ title: "[QUESTION] Your question title here"
5
+ labels: question
6
+ assignees: bestwebua
7
+
8
+ ---
9
+
10
+ <!-- Thanks for helping to make Truemail better! Before submit your question, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->
11
+
12
+ ### New question checklist
13
+
14
+ - [ ] I have read the [Contribution Guidelines](https://github.com/truemail-rb/truemail-rspec/blob/master/CONTRIBUTING.md)
15
+ - [ ] I have read the [documentation](https://truemail-rb.org/truemail-rspec)
16
+ - [ ] I have searched for [existing GitHub issues](https://github.com/truemail-rb/truemail-rspec/issues)
17
+
18
+ <!-- Please use next pattern for your question title: [QUESTION] Your question title here -->
19
+
20
+ ### Question
21
+
22
+ <!-- Your question context here -->
data/.github/PULL_REQUEST_TEMPLATE.md CHANGED
@@ -1,6 +1,9 @@
1
1
  # PR Details
2
2
 
3
3
  <!-- Provide a general summary of your changes in the Title above -->
4
+ <!-- PR name should the same name as your branch name, example: -->
5
+ <!-- Branch name is: feature/add-some-feature -->
6
+ <!-- PR name should be: Feature/Add some feature -->
4
7
 
5
8
  ## Description
6
9
 
data/.reek.yml CHANGED
@@ -6,6 +6,11 @@ detectors:
6
6
  exclude:
7
7
  - Truemail::RSpec::ConfigurationHelper#create_configuration
8
8
  - Truemail::RSpec::ValidatorHelper#request_instance
9
+ - Truemail::RSpec::AuditorHelper#create_auditor
10
+
11
+ ControlParameter:
12
+ exclude:
13
+ - Truemail::RSpec::AuditorHelper#create_auditor
9
14
 
10
15
  NestedIterators:
11
16
  exclude:
@@ -14,6 +19,7 @@ detectors:
14
19
  BooleanParameter:
15
20
  exclude:
16
21
  - Truemail::RSpec::ValidatorHelper#create_validator
22
+ - Truemail::RSpec::AuditorHelper#create_auditor
17
23
 
18
24
  DuplicateMethodCall:
19
25
  exclude:
data/.rubocop.yml CHANGED
@@ -1,5 +1,6 @@
1
1
  require:
2
2
  - rubocop-rspec
3
+ - rubocop-performance
3
4
 
4
5
  AllCops:
5
6
  DisplayCopNames: true
@@ -39,6 +40,96 @@ Style/EmptyCaseCondition:
39
40
  Style/RescueStandardError:
40
41
  Enabled: false
41
42
 
43
+ Style/AccessorGrouping:
44
+ Enabled: true
45
+
46
+ Style/ArrayCoercion:
47
+ Enabled: true
48
+
49
+ Style/BisectedAttrAccessor:
50
+ Enabled: true
51
+
52
+ Style/CaseLikeIf:
53
+ Enabled: true
54
+
55
+ Style/ExplicitBlockArgument:
56
+ Enabled: true
57
+
58
+ Style/ExponentialNotation:
59
+ Enabled: true
60
+
61
+ Style/GlobalStdStream:
62
+ Enabled: true
63
+
64
+ Style/HashAsLastArrayItem:
65
+ Enabled: true
66
+
67
+ Style/HashEachMethods:
68
+ Enabled: true
69
+
70
+ Style/HashLikeCase:
71
+ Enabled: true
72
+
73
+ Style/HashTransformKeys:
74
+ Enabled: true
75
+
76
+ Style/HashTransformValues:
77
+ Enabled: true
78
+
79
+ Style/OptionalBooleanParameter:
80
+ Enabled: true
81
+
82
+ Style/RedundantAssignment:
83
+ Enabled: true
84
+
85
+ Style/RedundantFetchBlock:
86
+ Enabled: true
87
+
88
+ Style/RedundantFileExtensionInRequire:
89
+ Enabled: true
90
+
91
+ Style/RedundantRegexpCharacterClass:
92
+ Enabled: true
93
+
94
+ Style/RedundantRegexpEscape:
95
+ Enabled: true
96
+
97
+ Style/SingleArgumentDig:
98
+ Enabled: true
99
+
100
+ Style/SlicingWithRange:
101
+ Enabled: true
102
+
103
+ Style/StringConcatenation:
104
+ Enabled: true
105
+
106
+ Style/ArgumentsForwarding:
107
+ Enabled: true
108
+
109
+ Style/CollectionCompact:
110
+ Enabled: true
111
+
112
+ Style/DocumentDynamicEvalDefinition:
113
+ Enabled: true
114
+
115
+ Style/NegatedIfElseCondition:
116
+ Enabled: true
117
+
118
+ Style/NilLambda:
119
+ Enabled: true
120
+
121
+ Style/RedundantArgument:
122
+ Enabled: true
123
+
124
+ Style/SwapValues:
125
+ Enabled: true
126
+
127
+ Layout/EmptyLinesAroundAttributeAccessor:
128
+ Enabled: true
129
+
130
+ Layout/SpaceAroundMethodCallOperator:
131
+ Enabled: true
132
+
42
133
  Layout/LineLength:
43
134
  Max: 140
44
135
 
@@ -49,15 +140,9 @@ Layout/ClassStructure:
49
140
  - include
50
141
  - prepend
51
142
  - extend
52
- associations:
53
- - has_one
54
- - has_many
55
- - belongs_to
56
- - has_and_belongs_to_many
57
143
  ExpectedOrder:
58
144
  - module_inclusion
59
145
  - constants
60
- - associations
61
146
  - public_class_methods
62
147
  - initializer
63
148
  - public_methods
@@ -70,39 +155,6 @@ Layout/EmptyLineAfterGuardClause:
70
155
  Lint/NonDeterministicRequireOrder:
71
156
  Enabled: false
72
157
 
73
- RSpec/ExampleLength:
74
- Enabled: false
75
-
76
- RSpec/NestedGroups:
77
- Enabled: false
78
-
79
- RSpec/MultipleExpectations:
80
- Enabled: false
81
-
82
- RSpec/MessageChain:
83
- Enabled: false
84
-
85
- RSpec/ContextWording:
86
- Enabled: false
87
-
88
- RSpec/AnyInstance:
89
- Enabled: false
90
-
91
- RSpec/MessageSpies:
92
- Enabled: false
93
-
94
- RSpec/MultipleDescribes:
95
- Enabled: false
96
-
97
- RSpec/MultipleMemoizedHelpers:
98
- Enabled: false
99
-
100
- Layout/EmptyLinesAroundAttributeAccessor:
101
- Enabled: true
102
-
103
- Layout/SpaceAroundMethodCallOperator:
104
- Enabled: true
105
-
106
158
  Lint/BinaryOperatorWithIdenticalOperands:
107
159
  Enabled: true
108
160
 
@@ -145,65 +197,92 @@ Lint/TopLevelReturnWithArgument:
145
197
  Lint/UnreachableLoop:
146
198
  Enabled: true
147
199
 
148
- Style/AccessorGrouping:
200
+ Lint/DuplicateBranch:
149
201
  Enabled: true
150
202
 
151
- Style/ArrayCoercion:
203
+ Lint/DuplicateRegexpCharacterClassElement:
152
204
  Enabled: true
153
205
 
154
- Style/BisectedAttrAccessor:
206
+ Lint/EmptyBlock:
155
207
  Enabled: true
156
208
 
157
- Style/CaseLikeIf:
209
+ Lint/EmptyClass:
158
210
  Enabled: true
159
211
 
160
- Style/ExplicitBlockArgument:
212
+ Lint/NoReturnInBeginEndBlocks:
161
213
  Enabled: true
162
214
 
163
- Style/ExponentialNotation:
215
+ Lint/ToEnumArguments:
164
216
  Enabled: true
165
217
 
166
- Style/GlobalStdStream:
218
+ Lint/UnexpectedBlockArity:
167
219
  Enabled: true
168
220
 
169
- Style/HashAsLastArrayItem:
221
+ Lint/UnmodifiedReduceAccumulator:
170
222
  Enabled: true
171
223
 
172
- Style/HashEachMethods:
224
+ Performance/AncestorsInclude:
173
225
  Enabled: true
174
226
 
175
- Style/HashLikeCase:
227
+ Performance/BigDecimalWithNumericArgument:
176
228
  Enabled: true
177
229
 
178
- Style/HashTransformKeys:
230
+ Performance/RedundantSortBlock:
179
231
  Enabled: true
180
232
 
181
- Style/HashTransformValues:
233
+ Performance/RedundantStringChars:
182
234
  Enabled: true
183
235
 
184
- Style/OptionalBooleanParameter:
236
+ Performance/ReverseFirst:
185
237
  Enabled: true
186
238
 
187
- Style/RedundantAssignment:
239
+ Performance/SortReverse:
188
240
  Enabled: true
189
241
 
190
- Style/RedundantFetchBlock:
242
+ Performance/Squeeze:
191
243
  Enabled: true
192
244
 
193
- Style/RedundantFileExtensionInRequire:
245
+ Performance/StringInclude:
194
246
  Enabled: true
195
247
 
196
- Style/RedundantRegexpCharacterClass:
248
+ Performance/BlockGivenWithExplicitBlock:
197
249
  Enabled: true
198
250
 
199
- Style/RedundantRegexpEscape:
251
+ Performance/CollectionLiteralInLoop:
200
252
  Enabled: true
201
253
 
202
- Style/SingleArgumentDig:
254
+ Performance/ConstantRegexp:
203
255
  Enabled: true
204
256
 
205
- Style/SlicingWithRange:
257
+ Performance/MethodObjectAsBlock:
206
258
  Enabled: true
207
259
 
208
- Style/StringConcatenation:
260
+ Performance/Sum:
209
261
  Enabled: true
262
+
263
+ RSpec/ExampleLength:
264
+ Enabled: false
265
+
266
+ RSpec/NestedGroups:
267
+ Enabled: false
268
+
269
+ RSpec/MultipleExpectations:
270
+ Enabled: false
271
+
272
+ RSpec/MessageChain:
273
+ Enabled: false
274
+
275
+ RSpec/ContextWording:
276
+ Enabled: false
277
+
278
+ RSpec/AnyInstance:
279
+ Enabled: false
280
+
281
+ RSpec/MessageSpies:
282
+ Enabled: false
283
+
284
+ RSpec/MultipleDescribes:
285
+ Enabled: false
286
+
287
+ RSpec/MultipleMemoizedHelpers:
288
+ Enabled: false