reek 5.6.0 → 6.0.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (250) hide show
  1. checksums.yaml +4 -4
  2. data/.github/dependabot.yml +9 -0
  3. data/.github/workflows/ruby.yml +52 -0
  4. data/.gitignore +1 -0
  5. data/.rubocop.yml +3 -1
  6. data/.rubocop_todo.yml +27 -20
  7. data/.simplecov +1 -0
  8. data/CHANGELOG.md +29 -0
  9. data/CONTRIBUTING.md +3 -0
  10. data/Dockerfile +2 -1
  11. data/Gemfile +14 -17
  12. data/README.md +11 -11
  13. data/bin/code_climate_reek +12 -2
  14. data/lib/reek.rb +1 -0
  15. data/lib/reek/ast/ast_node_class_map.rb +1 -1
  16. data/lib/reek/ast/node.rb +1 -1
  17. data/lib/reek/ast/sexp_extensions/arguments.rb +11 -0
  18. data/lib/reek/cli/options.rb +3 -3
  19. data/lib/reek/code_comment.rb +36 -29
  20. data/lib/reek/configuration/app_configuration.rb +4 -3
  21. data/lib/reek/configuration/configuration_converter.rb +2 -2
  22. data/lib/reek/configuration/directory_directives.rb +9 -3
  23. data/lib/reek/configuration/excluded_paths.rb +2 -1
  24. data/lib/reek/context/code_context.rb +1 -1
  25. data/lib/reek/context/module_context.rb +3 -1
  26. data/lib/reek/context/refinement_context.rb +16 -0
  27. data/lib/reek/context_builder.rb +16 -2
  28. data/lib/reek/errors/legacy_comment_separator_error.rb +36 -0
  29. data/lib/reek/report.rb +5 -7
  30. data/lib/reek/report/code_climate/code_climate_configuration.yml +1 -1
  31. data/lib/reek/report/code_climate/code_climate_formatter.rb +1 -3
  32. data/lib/reek/report/code_climate/code_climate_report.rb +2 -1
  33. data/lib/reek/report/simple_warning_formatter.rb +0 -7
  34. data/lib/reek/smell_detectors/base_detector.rb +2 -10
  35. data/lib/reek/smell_detectors/boolean_parameter.rb +3 -1
  36. data/lib/reek/smell_detectors/data_clump.rb +23 -56
  37. data/lib/reek/smell_detectors/nil_check.rb +1 -12
  38. data/lib/reek/smell_detectors/uncommunicative_variable_name.rb +1 -1
  39. data/lib/reek/smell_warning.rb +2 -3
  40. data/lib/reek/source/source_locator.rb +14 -13
  41. data/lib/reek/spec/smell_matcher.rb +2 -1
  42. data/lib/reek/version.rb +1 -1
  43. data/reek.gemspec +17 -7
  44. metadata +23 -246
  45. data/.travis.yml +0 -35
  46. data/docs/API.md +0 -174
  47. data/docs/Attribute.md +0 -39
  48. data/docs/Basic-Smell-Options.md +0 -85
  49. data/docs/Boolean-Parameter.md +0 -54
  50. data/docs/Class-Variable.md +0 -40
  51. data/docs/Code-Smells.md +0 -39
  52. data/docs/Command-Line-Options.md +0 -119
  53. data/docs/Control-Couple.md +0 -26
  54. data/docs/Control-Parameter.md +0 -32
  55. data/docs/Data-Clump.md +0 -46
  56. data/docs/Duplicate-Method-Call.md +0 -264
  57. data/docs/Feature-Envy.md +0 -93
  58. data/docs/How-To-Write-New-Detectors.md +0 -132
  59. data/docs/How-reek-works-internally.md +0 -114
  60. data/docs/Instance-Variable-Assumption.md +0 -163
  61. data/docs/Irresponsible-Module.md +0 -47
  62. data/docs/Large-Class.md +0 -16
  63. data/docs/Long-Parameter-List.md +0 -39
  64. data/docs/Long-Yield-List.md +0 -37
  65. data/docs/Manual-Dispatch.md +0 -30
  66. data/docs/Missing-Safe-Method.md +0 -92
  67. data/docs/Module-Initialize.md +0 -62
  68. data/docs/Nested-Iterators.md +0 -59
  69. data/docs/Nil-Check.md +0 -44
  70. data/docs/RSpec-matchers.md +0 -129
  71. data/docs/Rake-Task.md +0 -66
  72. data/docs/Reek-4-to-Reek-5-migration.md +0 -188
  73. data/docs/Reek-Driven-Development.md +0 -46
  74. data/docs/Repeated-Conditional.md +0 -47
  75. data/docs/Simulated-Polymorphism.md +0 -16
  76. data/docs/Smell-Suppression.md +0 -96
  77. data/docs/Style-Guide.md +0 -19
  78. data/docs/Subclassed-From-Core-Class.md +0 -79
  79. data/docs/Too-Many-Constants.md +0 -37
  80. data/docs/Too-Many-Instance-Variables.md +0 -43
  81. data/docs/Too-Many-Methods.md +0 -56
  82. data/docs/Too-Many-Statements.md +0 -54
  83. data/docs/Uncommunicative-Method-Name.md +0 -94
  84. data/docs/Uncommunicative-Module-Name.md +0 -92
  85. data/docs/Uncommunicative-Name.md +0 -18
  86. data/docs/Uncommunicative-Parameter-Name.md +0 -90
  87. data/docs/Uncommunicative-Variable-Name.md +0 -96
  88. data/docs/Unused-Parameters.md +0 -28
  89. data/docs/Unused-Private-Method.md +0 -101
  90. data/docs/Utility-Function.md +0 -56
  91. data/docs/Versioning-Policy.md +0 -7
  92. data/docs/YAML-Reports.md +0 -93
  93. data/docs/defaults.reek.yml +0 -129
  94. data/docs/templates/default/docstring/html/public_api_marker.erb +0 -3
  95. data/docs/templates/default/docstring/setup.rb +0 -37
  96. data/docs/templates/default/fulldoc/html/css/common.css +0 -1
  97. data/docs/yard_plugin.rb +0 -17
  98. data/features/command_line_interface/basic_usage.feature +0 -15
  99. data/features/command_line_interface/options.feature +0 -124
  100. data/features/command_line_interface/show_progress.feature +0 -33
  101. data/features/command_line_interface/smell_selection.feature +0 -15
  102. data/features/command_line_interface/smells_count.feature +0 -38
  103. data/features/command_line_interface/stdin.feature +0 -65
  104. data/features/configuration_files/accept_setting.feature +0 -87
  105. data/features/configuration_files/directory_specific_directives.feature +0 -274
  106. data/features/configuration_files/exclude_directives.feature +0 -35
  107. data/features/configuration_files/exclude_paths_directives.feature +0 -42
  108. data/features/configuration_files/masking_smells.feature +0 -94
  109. data/features/configuration_files/mix_accept_reject_setting.feature +0 -84
  110. data/features/configuration_files/reject_setting.feature +0 -89
  111. data/features/configuration_files/schema_validation.feature +0 -59
  112. data/features/configuration_files/show_configuration_file.feature +0 -44
  113. data/features/configuration_files/unused_private_method.feature +0 -68
  114. data/features/configuration_loading.feature +0 -91
  115. data/features/configuration_via_source_comments/erroneous_source_comments.feature +0 -68
  116. data/features/configuration_via_source_comments/well_formed_source_comments.feature +0 -116
  117. data/features/locales.feature +0 -32
  118. data/features/programmatic_access.feature +0 -41
  119. data/features/rake_task/rake_task.feature +0 -138
  120. data/features/reports/codeclimate.feature +0 -59
  121. data/features/reports/json.feature +0 -59
  122. data/features/reports/reports.feature +0 -219
  123. data/features/reports/yaml.feature +0 -52
  124. data/features/rspec_matcher.feature +0 -41
  125. data/features/samples.feature +0 -305
  126. data/features/step_definitions/.rubocop.yml +0 -5
  127. data/features/step_definitions/reek_steps.rb +0 -98
  128. data/features/step_definitions/sample_file_steps.rb +0 -63
  129. data/features/support/env.rb +0 -34
  130. data/features/todo_list.feature +0 -108
  131. data/samples/checkstyle.xml +0 -7
  132. data/samples/clean_source/clean.rb +0 -6
  133. data/samples/configuration/accepts_rejects_and_excludes_for_detectors.reek.yml +0 -29
  134. data/samples/configuration/accepts_rejects_and_excludes_for_directory_directives.reek.yml +0 -30
  135. data/samples/configuration/corrupt.reek +0 -1
  136. data/samples/configuration/empty.reek +0 -0
  137. data/samples/configuration/full_configuration.reek +0 -13
  138. data/samples/configuration/full_mask.reek +0 -6
  139. data/samples/configuration/home/home.reek.yml +0 -4
  140. data/samples/configuration/partial_mask.reek +0 -4
  141. data/samples/configuration/regular_configuration/.reek.yml +0 -4
  142. data/samples/configuration/regular_configuration/empty_sub_directory/.gitignore +0 -0
  143. data/samples/configuration/with_excluded_paths.reek +0 -5
  144. data/samples/no_config_file/.keep +0 -0
  145. data/samples/paths.rb +0 -5
  146. data/samples/smelly_source/inline.rb +0 -704
  147. data/samples/smelly_source/optparse.rb +0 -1788
  148. data/samples/smelly_source/redcloth.rb +0 -1130
  149. data/samples/smelly_source/ruby.rb +0 -368
  150. data/samples/smelly_source/smelly.rb +0 -7
  151. data/samples/source_with_exclude_paths/ignore_me/uncommunicative_method_name.rb +0 -5
  152. data/samples/source_with_exclude_paths/nested/ignore_me_as_well/irresponsible_module.rb +0 -2
  153. data/samples/source_with_exclude_paths/nested/uncommunicative_parameter_name.rb +0 -6
  154. data/samples/source_with_exclude_paths/nested/uncommunicative_variable_name.rb +0 -6
  155. data/samples/source_with_hidden_directories/.hidden/hidden.rb +0 -1
  156. data/samples/source_with_hidden_directories/not_hidden.rb +0 -1
  157. data/samples/source_with_non_ruby_files/gibberish +0 -1
  158. data/samples/source_with_non_ruby_files/python_source.py +0 -1
  159. data/samples/source_with_non_ruby_files/ruby.rb +0 -6
  160. data/spec/factories/factories.rb +0 -37
  161. data/spec/performance/reek/smell_detectors/runtime_speed_spec.rb +0 -17
  162. data/spec/quality/documentation_spec.rb +0 -40
  163. data/spec/quality/reek_source_spec.rb +0 -11
  164. data/spec/reek/ast/node_spec.rb +0 -211
  165. data/spec/reek/ast/object_refs_spec.rb +0 -83
  166. data/spec/reek/ast/reference_collector_spec.rb +0 -47
  167. data/spec/reek/ast/sexp_extensions_spec.rb +0 -516
  168. data/spec/reek/cli/application_spec.rb +0 -168
  169. data/spec/reek/cli/command/report_command_spec.rb +0 -44
  170. data/spec/reek/cli/command/todo_list_command_spec.rb +0 -86
  171. data/spec/reek/cli/options_spec.rb +0 -51
  172. data/spec/reek/cli/silencer_spec.rb +0 -28
  173. data/spec/reek/code_comment_spec.rb +0 -185
  174. data/spec/reek/configuration/app_configuration_spec.rb +0 -195
  175. data/spec/reek/configuration/configuration_file_finder_spec.rb +0 -230
  176. data/spec/reek/configuration/default_directive_spec.rb +0 -13
  177. data/spec/reek/configuration/directory_directives_spec.rb +0 -116
  178. data/spec/reek/configuration/excluded_paths_spec.rb +0 -16
  179. data/spec/reek/configuration/rake_task_converter_spec.rb +0 -33
  180. data/spec/reek/configuration/schema_validator_spec.rb +0 -165
  181. data/spec/reek/context/code_context_spec.rb +0 -192
  182. data/spec/reek/context/ghost_context_spec.rb +0 -60
  183. data/spec/reek/context/method_context_spec.rb +0 -72
  184. data/spec/reek/context/module_context_spec.rb +0 -55
  185. data/spec/reek/context/root_context_spec.rb +0 -12
  186. data/spec/reek/context/statement_counter_spec.rb +0 -24
  187. data/spec/reek/context_builder_spec.rb +0 -460
  188. data/spec/reek/detector_repository_spec.rb +0 -22
  189. data/spec/reek/documentation_link_spec.rb +0 -20
  190. data/spec/reek/errors/base_error_spec.rb +0 -13
  191. data/spec/reek/examiner_spec.rb +0 -309
  192. data/spec/reek/logging_error_handler_spec.rb +0 -24
  193. data/spec/reek/rake/task_spec.rb +0 -56
  194. data/spec/reek/report/code_climate/code_climate_configuration_spec.rb +0 -24
  195. data/spec/reek/report/code_climate/code_climate_fingerprint_spec.rb +0 -126
  196. data/spec/reek/report/code_climate/code_climate_formatter_spec.rb +0 -51
  197. data/spec/reek/report/code_climate/code_climate_report_spec.rb +0 -56
  198. data/spec/reek/report/html_report_spec.rb +0 -19
  199. data/spec/reek/report/json_report_spec.rb +0 -58
  200. data/spec/reek/report/location_formatter_spec.rb +0 -32
  201. data/spec/reek/report/progress_formatter_spec.rb +0 -68
  202. data/spec/reek/report/text_report_spec.rb +0 -89
  203. data/spec/reek/report/xml_report_spec.rb +0 -24
  204. data/spec/reek/report/yaml_report_spec.rb +0 -55
  205. data/spec/reek/report_spec.rb +0 -28
  206. data/spec/reek/smell_configuration_spec.rb +0 -56
  207. data/spec/reek/smell_detectors/attribute_spec.rb +0 -197
  208. data/spec/reek/smell_detectors/base_detector_spec.rb +0 -60
  209. data/spec/reek/smell_detectors/boolean_parameter_spec.rb +0 -93
  210. data/spec/reek/smell_detectors/class_variable_spec.rb +0 -106
  211. data/spec/reek/smell_detectors/control_parameter_spec.rb +0 -300
  212. data/spec/reek/smell_detectors/data_clump_spec.rb +0 -120
  213. data/spec/reek/smell_detectors/duplicate_method_call_spec.rb +0 -211
  214. data/spec/reek/smell_detectors/feature_envy_spec.rb +0 -295
  215. data/spec/reek/smell_detectors/instance_variable_assumption_spec.rb +0 -96
  216. data/spec/reek/smell_detectors/irresponsible_module_spec.rb +0 -226
  217. data/spec/reek/smell_detectors/long_parameter_list_spec.rb +0 -61
  218. data/spec/reek/smell_detectors/long_yield_list_spec.rb +0 -49
  219. data/spec/reek/smell_detectors/manual_dispatch_spec.rb +0 -75
  220. data/spec/reek/smell_detectors/missing_safe_method_spec.rb +0 -62
  221. data/spec/reek/smell_detectors/module_initialize_spec.rb +0 -77
  222. data/spec/reek/smell_detectors/nested_iterators_spec.rb +0 -333
  223. data/spec/reek/smell_detectors/nil_check_spec.rb +0 -100
  224. data/spec/reek/smell_detectors/repeated_conditional_spec.rb +0 -100
  225. data/spec/reek/smell_detectors/subclassed_from_core_class_spec.rb +0 -77
  226. data/spec/reek/smell_detectors/too_many_constants_spec.rb +0 -144
  227. data/spec/reek/smell_detectors/too_many_instance_variables_spec.rb +0 -132
  228. data/spec/reek/smell_detectors/too_many_methods_spec.rb +0 -54
  229. data/spec/reek/smell_detectors/too_many_statements_spec.rb +0 -90
  230. data/spec/reek/smell_detectors/uncommunicative_method_name_spec.rb +0 -78
  231. data/spec/reek/smell_detectors/uncommunicative_module_name_spec.rb +0 -78
  232. data/spec/reek/smell_detectors/uncommunicative_parameter_name_spec.rb +0 -147
  233. data/spec/reek/smell_detectors/uncommunicative_variable_name_spec.rb +0 -201
  234. data/spec/reek/smell_detectors/unused_parameters_spec.rb +0 -114
  235. data/spec/reek/smell_detectors/unused_private_method_spec.rb +0 -205
  236. data/spec/reek/smell_detectors/utility_function_spec.rb +0 -293
  237. data/spec/reek/smell_warning_spec.rb +0 -137
  238. data/spec/reek/source/source_code_spec.rb +0 -66
  239. data/spec/reek/source/source_locator_spec.rb +0 -166
  240. data/spec/reek/spec/should_reek_of_spec.rb +0 -154
  241. data/spec/reek/spec/should_reek_only_of_spec.rb +0 -91
  242. data/spec/reek/spec/should_reek_spec.rb +0 -52
  243. data/spec/reek/spec/smell_matcher_spec.rb +0 -87
  244. data/spec/reek/tree_dresser_spec.rb +0 -46
  245. data/spec/spec_helper.rb +0 -96
  246. data/tasks/configuration.rake +0 -19
  247. data/tasks/console.rake +0 -5
  248. data/tasks/reek.rake +0 -6
  249. data/tasks/rubocop.rake +0 -11
  250. data/tasks/test.rake +0 -32
@@ -1,47 +0,0 @@
1
- # Irresponsible Module
2
-
3
- ## Introduction
4
-
5
- Classes and modules are the units of reuse and release. It is therefore
6
- considered good practice to annotate every class and module with a brief
7
- comment outlining its responsibilities.
8
-
9
- For further guideline on how to write good documentation in Ruby, see these
10
- links:
11
- - [Rails API documentation guidelines](http://edgeguides.rubyonrails.org/api_documentation_guidelines.html)
12
- - [Comments tell you why](https://blog.codinghorror.com/code-tells-you-how-comments-tell-you-why/)
13
-
14
- ## Example
15
-
16
- Given
17
-
18
- ```Ruby
19
- class Dummy
20
- # Do things...
21
- end
22
- ```
23
-
24
- Reek would emit the following warning:
25
-
26
- ```
27
- test.rb -- 1 warning:
28
- [1]:IrresponsibleModule: Dummy has no descriptive comment
29
- ```
30
-
31
- Fixing this is simple - just an explaining comment:
32
-
33
- ```Ruby
34
- # The Dummy class is responsible for ...
35
- class Dummy
36
- # Do things...
37
- end
38
- ```
39
-
40
- ## Current Support in Reek
41
-
42
- _Irresponsible Module_ checks classes and modules, including those
43
- created through `Struct.new` and `Class.new` and directly assigned to a constant.
44
-
45
- ## Configuration
46
-
47
- _Irresponsible Module_ supports only the [Basic Smell Options](Basic-Smell-Options.md).
data/docs/Large-Class.md DELETED
@@ -1,16 +0,0 @@
1
- # Large Class
2
-
3
- ## Introduction
4
-
5
- A _Large Class_ is a class or module that has a large number of instance
6
- variables, methods or lines of code in any one piece of its specification.
7
- (That is, this smell relates to pieces of the class's specification, not to the
8
- size of the corresponding instance of `Class`.)
9
-
10
- ## Current Support in Reek
11
-
12
- Reek offers three checks in this category.
13
-
14
- * [Too Many Constants](Too-Many-Constants.md)
15
- * [Too Many Instance Variables](Too-Many-Instance-Variables.md)
16
- * [Too Many Methods](Too-Many-Methods.md)
@@ -1,39 +0,0 @@
1
- # Long Parameter List
2
-
3
- ## Introduction
4
-
5
- A _Long Parameter List_ occurs when a method has a lot of parameters.
6
-
7
- ## Example
8
-
9
- Given
10
-
11
- ```Ruby
12
- class Dummy
13
- def long_list(foo,bar,baz,fling,flung)
14
- puts foo,bar,baz,fling,flung
15
- end
16
- end
17
- ```
18
-
19
- Reek would report the following warning:
20
-
21
- ```
22
- test.rb -- 1 warning:
23
- [2]:Dummy#long_list has 5 parameters (LongParameterList)
24
- ```
25
-
26
- A common solution to this problem would be the introduction of parameter objects.
27
-
28
- ## Current Support in Reek
29
-
30
- _Long Parameter List_ reports any method or block with more than 3 parameters.
31
-
32
- ## Configuration
33
-
34
- Reek's _Long Parameter List_ detector supports the
35
- [Basic Smell Options](Basic-Smell-Options.md), plus:
36
-
37
- | Option | Value | Effect |
38
- | -------------|---------|---------|
39
- | `max_params` | integer | The maximum number of parameters allowed in a method or block before a warning is issued. Defaults to 3. |
@@ -1,37 +0,0 @@
1
- # Long Yield List
2
-
3
- ## Introduction
4
-
5
- A _Long Yield List_ occurs when a method yields a lot of arguments to the block
6
- it gets passed. It is a special case of [Long Parameter List](Long-Parameter-List.md).
7
-
8
- ## Example
9
-
10
- ```Ruby
11
- class Dummy
12
- def yields_a_lot(foo,bar,baz,fling,flung)
13
- yield foo,bar,baz,fling,flung
14
- end
15
- end
16
- ```
17
-
18
- Reek would report the following warning:
19
-
20
- ```
21
- test.rb -- 1 warning:
22
- [4]:Dummy#yields_a_lot yields 5 parameters (LongYieldList)
23
- ```
24
-
25
- A common solution to this problem would be the introduction of parameter objects.
26
-
27
- ## Current Support in Reek
28
-
29
- Currently _Long Yield List_ reports any method or block with more than 3 parameters.
30
-
31
- ## Configuration
32
-
33
- Reek's _Long Yield List_ detector supports the [Basic Smell Options](Basic-Smell-Options.md), plus:
34
-
35
- | Option | Value | Effect |
36
- | -------------|---------|---------|
37
- | `max_params` | integer | The maximum number of parameters allowed in a method or block before a warning is issued. Defaults to 3. |
@@ -1,30 +0,0 @@
1
- ## Introduction
2
-
3
- Reek reports a _Manual Dispatch_ smell if it finds source code that manually checks whether an object responds to a method before that method is called. Manual dispatch is a type of [Simulated Polymorphism](Simulated-Polymorphism.md) which leads to code that is harder to reason about, debug, and refactor.
4
-
5
- ## Example
6
-
7
- ```Ruby
8
- class MyManualDispatcher
9
- attr_reader :foo
10
-
11
- def initialize(foo)
12
- @foo = foo
13
- end
14
-
15
- def call
16
- foo.bar if foo.respond_to?(:bar)
17
- end
18
- end
19
- ```
20
-
21
- Reek would emit the following warning:
22
-
23
- ```
24
- test.rb -- 1 warning:
25
- [9]: MyManualDispatcher manually dispatches method call (ManualDispatch)
26
- ```
27
-
28
- ## Configuration
29
-
30
- _Manual Dispatch_ offers the [Basic Smell Options](Basic-Smell-Options.md).
@@ -1,92 +0,0 @@
1
- # Missing Safe Method
2
-
3
- ## Introduction
4
-
5
- Candidate methods for the _Missing Safe Method_ smell are methods whose names
6
- end with an exclamation mark.
7
-
8
- An exclamation mark in method names means (the explanation below is taken from
9
- [here](http://dablog.rubypal.com/2007/8/15/bang-methods-or-danger-will-rubyist)):
10
-
11
- > The ! in method names that end with ! means, “This method is dangerous”—or,
12
- > more precisely, this method is the “dangerous” version of an otherwise
13
- > equivalent method, with the same name minus the !. “Danger” is relative; the
14
- > ! doesn’t mean anything at all unless the method name it’s in corresponds to
15
- > a similar but bang-less method name.
16
- >
17
- > So, for example, gsub! is the dangerous version of gsub. exit! is the
18
- > dangerous version of exit. flatten! is the dangerous version of flatten. And
19
- > so forth.
20
-
21
- Such a method is called _Missing Safe Method_ if and only if the non-bang
22
- version does not exist and this method is reported as a smell.
23
-
24
- Missing Safe Method was formerly known as Prima Donna Method.
25
-
26
- ## Example
27
-
28
- Given
29
-
30
- ```Ruby
31
- class C
32
- def foo; end
33
- def foo!; end
34
- def bar!; end
35
- end
36
- ```
37
-
38
- Reek would report the _Missing Safe Method_ smell for `bar!`, but not for `foo!`.
39
-
40
- Reek reports this smell only in a class context, not in a module context in order to allow perfectly legit code like this:
41
-
42
-
43
- ```Ruby
44
- class Parent
45
- def foo; end
46
- end
47
-
48
- module Dangerous
49
- def foo!; end
50
- end
51
-
52
- class Son < Parent
53
- include Dangerous
54
- end
55
-
56
- class Daughter < Parent
57
- end
58
- ```
59
-
60
- In this example, Reek would not report the _Missing Safe Method_ smell for the
61
- method `foo` of the `Dangerous` module.
62
-
63
- ## Configuration
64
-
65
- _Missing Safe Method_ offers the [Basic Smell Options](Basic-Smell-Options.md).
66
-
67
- ## Example configuration via source comment
68
-
69
- Imagine code like this:
70
-
71
- ```Ruby
72
- class Alfa
73
- def bravo!
74
- end
75
- end
76
- ```
77
-
78
- This would report:
79
-
80
- >>
81
- ruby.rb -- 1 warning:
82
- [1]:MissingSafeMethod: Alfa has missing safe method 'bravo!'
83
-
84
- If you want to suppress this warning you can do this via source comment like this:
85
-
86
- ```Ruby
87
- # :reek:MissingSafeMethod { exclude: [ bravo! ] }
88
- class Alfa
89
- def bravo!
90
- end
91
- end
92
- ```
@@ -1,62 +0,0 @@
1
- # Module Initialize
2
-
3
- ## Introduction
4
-
5
- A module is usually a mixin, so when an `#initialize` method is present it is
6
- hard to tell initialization order and parameters so having `#initialize`
7
- in a module is usually a bad idea.
8
-
9
- ## Example
10
-
11
- The `Foo` module below contains a method `initialize`. Although class `B` inherits from `A`, the inclusion of `Foo` stops `A#initialize` from being called.
12
-
13
- ```Ruby
14
- class A
15
- def initialize(a)
16
- @a = a
17
- end
18
- end
19
-
20
- module Foo
21
- def initialize(foo)
22
- @foo = foo
23
- end
24
- end
25
-
26
- class B < A
27
- include Foo
28
-
29
- def initialize(b)
30
- super('bar')
31
- @b = b
32
- end
33
- end
34
- ```
35
-
36
- A simple solution is to rename `Foo#initialize` and call that method by name:
37
-
38
- ```Ruby
39
- module Foo
40
- def setup_foo_module(foo)
41
- @foo = foo
42
- end
43
- end
44
-
45
- class B < A
46
- include Foo
47
-
48
- def initialize(b)
49
- super 'bar'
50
- setup_foo_module('foo')
51
- @b = b
52
- end
53
- end
54
- ```
55
-
56
- ## Current Support in Reek
57
-
58
- Reek warns about module initialize when an instance method named `initialize` is present in a module.
59
-
60
- ## Configuration
61
-
62
- Module Initialize supports the [Basic Smell Options](Basic-Smell-Options.md).
@@ -1,59 +0,0 @@
1
- # Nested Iterators
2
-
3
- ## Introduction
4
-
5
- A _Nested Iterator_ occurs when a block contains another block.
6
-
7
- ## Example
8
-
9
- Given
10
-
11
- ```Ruby
12
- class Duck
13
- class << self
14
- def duck_names
15
- %i!tick trick track!.each do |surname|
16
- %i!duck!.each do |last_name|
17
- puts "full name is #{surname} #{last_name}"
18
- end
19
- end
20
- end
21
- end
22
- end
23
- ```
24
-
25
- Reek would report the following warning:
26
-
27
- ```
28
- test.rb -- 1 warning:
29
- [5]:Duck#duck_names contains iterators nested 2 deep (NestedIterators)
30
- ```
31
-
32
- ## Current Support in Reek
33
-
34
- _Nested Iterators_ reports failing methods only once.
35
- `Object#tap` is ignored by default and thus does not count as iterator.
36
- Furthermore iterators without block arguments are not counted, e.g.:
37
-
38
-
39
- ```Ruby
40
- def foo
41
- before do
42
- item.each do |part|
43
- puts part
44
- end
45
- end
46
- end
47
- ```
48
-
49
- would not smell of NestedIterators (given a maximum allowed nesting of 1) since the
50
- `before` would not be counted (because it doesn't pass any arguments to the block).
51
-
52
- ## Configuration
53
-
54
- _Nested Iterators_ offers the [Basic Smell Options](Basic-Smell-Options.md), plus:
55
-
56
- | Option | Value | Effect |
57
- | ----------------------|---------|---------|
58
- | `max_allowed_nesting` | integer | The maximum depth of nested iterators. Defaults to 1 |
59
- | `ignore_iterators` | Array | List of iterators to be excluded from the smell check. Includes only `tap` at the moment|
data/docs/Nil-Check.md DELETED
@@ -1,44 +0,0 @@
1
- # Nil Check
2
-
3
- ## Introduction
4
-
5
- A _Nil Check_ is a type check. Failures of _Nil Check_ violate the
6
- ["tell, don't ask"](http://robots.thoughtbot.com/tell-dont-ask) principle.
7
- Additionally to that, type checks often mask bigger problems in your source
8
- code like not using OOP and / or polymorphism when you should.
9
-
10
- The _Nil Check_ code smell is a case of [Simulated Polymorphism](Simulated-Polymorphism.md).
11
-
12
- ## Example
13
-
14
- Given
15
-
16
- ```Ruby
17
- class Klass
18
- def nil_checker(argument)
19
- if argument.nil?
20
- puts "argument is nil!"
21
- end
22
- end
23
- end
24
- ```
25
-
26
- Reek would emit the following warning:
27
-
28
- ```
29
- test.rb -- 1 warning:
30
- [3]:Klass#nil_checker performs a nil-check. (NilCheck)
31
- ```
32
-
33
- ## Current Support in Reek
34
-
35
- _Nil Check_ reports use of
36
-
37
- * <code>.nil?</code> method
38
- * <code>==</code> and <code>===</code> operators when checking vs. <code>nil</code>
39
- * case statements that use syntax like <code>when nil</code>
40
- * use of the safe navigation operator like `foo&.bar`
41
-
42
- ## Configuration
43
-
44
- _Nil Check_ offers the [Basic Smell Options](Basic-Smell-Options.md).
@@ -1,129 +0,0 @@
1
- # RSpec matchers
2
-
3
- ## Introduction
4
-
5
- Reek offers matchers for RSpec you can easily include into your project.
6
-
7
- There are 3 matchers available:
8
-
9
- - `reek`
10
- - `reek_of`
11
- - `reek_only_of`
12
-
13
- ## Quickstart
14
-
15
- Let's install the dependencies:
16
-
17
- ```
18
- gem install reek
19
- gem install rspec
20
- ```
21
-
22
- And then use it like that in your spec file:
23
-
24
- ```Ruby
25
- require 'reek'
26
- require 'reek/spec'
27
- require 'rspec'
28
-
29
- RSpec.describe 'Reek Integration' do
30
- it 'works with Reek' do
31
- smelly_class = 'class C; def m; end; end'
32
- expect(smelly_class).not_to reek
33
- end
34
- end
35
- ```
36
-
37
- Running this via
38
-
39
- ```
40
- rspec reek-integration-spec.rb
41
- ```
42
-
43
- would give you:
44
-
45
- ```
46
- Failures:
47
-
48
- 1) Reek Integration works with Reek
49
- Failure/Error: expect(smelly_class).not_to reek
50
- Expected no smells, but got:
51
- C has no descriptive comment (IrresponsibleModule)
52
- C has the name 'C' (UncommunicativeModuleName)
53
- C#m has the name 'm' (UncommunicativeMethodName)
54
- # ./reek-integration-spec.rb:8:in `block (2 levels) in <top (required)>'
55
-
56
- Finished in 0.00284 seconds (files took 0.28815 seconds to load)
57
- 1 example, 1 failure
58
-
59
- Failed examples:
60
-
61
- rspec ./reek-integration-spec.rb:6 # Reek Integration works with Reek
62
- ```
63
-
64
- ## The matchers explained
65
-
66
- ### `reek`
67
-
68
- A very generic matcher that basically just tells you if something reeks, but
69
- not after what exactly.
70
- See the "Quickstart" example from above.
71
-
72
- ### `reek_of`
73
-
74
- Checks the target source code for instances of "smell type"
75
- and returns true only if it can find one of them that matches.
76
-
77
- You can pass the smell type you want to check for as String or as Symbol:
78
-
79
- - `:UtilityFunction`
80
- - `"UtilityFunction"`
81
-
82
- It is recommended to pass this as a symbol like `:UtilityFunction`. However we
83
- don't enforce this.
84
-
85
- Additionally you can be more specific and pass in "smell_details" you want to
86
- check for as well e.g. "name" or "count" (see the examples below). The
87
- parameters you can check for are depending on the smell you are checking for.
88
- For instance "count" doesn't make sense everywhere whereas "name" does in most
89
- cases. If you pass in a parameter that doesn't exist (e.g. you make a typo like
90
- "namme") Reek will raise an ArgumentError to give you a hint that you passed
91
- something that doesn't make much sense.
92
-
93
- So in a nutshell `reek_of` takes the following two arguments:
94
-
95
- - `smell_type` - The "smell type" we check for.
96
- - `smells_details` - A hash containing "smell warning" parameters
97
-
98
- **Examples**
99
-
100
- Without smell_details:
101
-
102
- ```Ruby
103
- reek_of(:FeatureEnvy)
104
- reek_of(:UtilityFunction)
105
- ```
106
-
107
- With smell_details:
108
-
109
- ```Ruby
110
- reek_of(:UncommunicativeParameterName, name: 'x2')
111
- reek_of(:DataClump, count: 3)
112
- ```
113
-
114
- **Examples from a real spec**
115
-
116
- ```Ruby
117
- expect(src).to reek_of(:DuplicateMethodCall, name: '@other.thing')
118
- ```
119
-
120
- ### reek_only_of
121
-
122
- See the documentaton for `reek_of`.
123
-
124
- **Notable differences to `reek_of`:**
125
-
126
- 1. `reek_of` doesn't mind if there are other smells of a different type.
127
- "reek_only_of" will fail in that case.
128
-
129
- 2. `reek_only_of` doesn't support the additional smell_details hash.