reek 6.0.1 → 6.0.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (237) hide show
  1. checksums.yaml +4 -4
  2. data/.github/dependabot.yml +9 -0
  3. data/.github/workflows/ruby.yml +52 -0
  4. data/.rubocop.yml +2 -20
  5. data/.rubocop_todo.yml +27 -20
  6. data/CHANGELOG.md +22 -0
  7. data/CONTRIBUTING.md +3 -0
  8. data/Dockerfile +1 -1
  9. data/Gemfile +6 -6
  10. data/README.md +1 -1
  11. data/bin/code_climate_reek +2 -3
  12. data/lib/reek.rb +1 -0
  13. data/lib/reek/ast/ast_node_class_map.rb +1 -1
  14. data/lib/reek/ast/node.rb +1 -1
  15. data/lib/reek/cli/options.rb +1 -1
  16. data/lib/reek/configuration/app_configuration.rb +4 -3
  17. data/lib/reek/configuration/directory_directives.rb +2 -2
  18. data/lib/reek/configuration/excluded_paths.rb +2 -1
  19. data/lib/reek/context/code_context.rb +1 -1
  20. data/lib/reek/context/module_context.rb +3 -1
  21. data/lib/reek/context/refinement_context.rb +16 -0
  22. data/lib/reek/context_builder.rb +16 -2
  23. data/lib/reek/report/code_climate/code_climate_configuration.yml +1 -1
  24. data/lib/reek/report/code_climate/code_climate_formatter.rb +1 -3
  25. data/lib/reek/smell_detectors/base_detector.rb +1 -1
  26. data/lib/reek/smell_detectors/boolean_parameter.rb +3 -1
  27. data/lib/reek/smell_detectors/uncommunicative_variable_name.rb +1 -1
  28. data/lib/reek/smell_warning.rb +2 -3
  29. data/lib/reek/source/source_locator.rb +14 -13
  30. data/lib/reek/version.rb +1 -1
  31. data/reek.gemspec +14 -3
  32. metadata +29 -232
  33. data/.travis.yml +0 -36
  34. data/docs/API.md +0 -174
  35. data/docs/Attribute.md +0 -39
  36. data/docs/Basic-Smell-Options.md +0 -85
  37. data/docs/Boolean-Parameter.md +0 -54
  38. data/docs/Class-Variable.md +0 -40
  39. data/docs/Code-Smells.md +0 -39
  40. data/docs/Command-Line-Options.md +0 -119
  41. data/docs/Control-Couple.md +0 -26
  42. data/docs/Control-Parameter.md +0 -32
  43. data/docs/Data-Clump.md +0 -46
  44. data/docs/Duplicate-Method-Call.md +0 -264
  45. data/docs/Feature-Envy.md +0 -93
  46. data/docs/How-To-Write-New-Detectors.md +0 -132
  47. data/docs/How-reek-works-internally.md +0 -114
  48. data/docs/Instance-Variable-Assumption.md +0 -163
  49. data/docs/Irresponsible-Module.md +0 -47
  50. data/docs/Large-Class.md +0 -16
  51. data/docs/Long-Parameter-List.md +0 -39
  52. data/docs/Long-Yield-List.md +0 -37
  53. data/docs/Manual-Dispatch.md +0 -30
  54. data/docs/Missing-Safe-Method.md +0 -92
  55. data/docs/Module-Initialize.md +0 -62
  56. data/docs/Nested-Iterators.md +0 -59
  57. data/docs/Nil-Check.md +0 -47
  58. data/docs/RSpec-matchers.md +0 -129
  59. data/docs/Rake-Task.md +0 -66
  60. data/docs/Reek-4-to-Reek-5-migration.md +0 -188
  61. data/docs/Reek-Driven-Development.md +0 -46
  62. data/docs/Repeated-Conditional.md +0 -47
  63. data/docs/Simulated-Polymorphism.md +0 -16
  64. data/docs/Smell-Suppression.md +0 -96
  65. data/docs/Style-Guide.md +0 -19
  66. data/docs/Subclassed-From-Core-Class.md +0 -79
  67. data/docs/Too-Many-Constants.md +0 -37
  68. data/docs/Too-Many-Instance-Variables.md +0 -43
  69. data/docs/Too-Many-Methods.md +0 -56
  70. data/docs/Too-Many-Statements.md +0 -54
  71. data/docs/Uncommunicative-Method-Name.md +0 -94
  72. data/docs/Uncommunicative-Module-Name.md +0 -92
  73. data/docs/Uncommunicative-Name.md +0 -18
  74. data/docs/Uncommunicative-Parameter-Name.md +0 -90
  75. data/docs/Uncommunicative-Variable-Name.md +0 -96
  76. data/docs/Unused-Parameters.md +0 -28
  77. data/docs/Unused-Private-Method.md +0 -101
  78. data/docs/Utility-Function.md +0 -56
  79. data/docs/Versioning-Policy.md +0 -7
  80. data/docs/YAML-Reports.md +0 -93
  81. data/docs/defaults.reek.yml +0 -129
  82. data/docs/templates/default/docstring/html/public_api_marker.erb +0 -3
  83. data/docs/templates/default/docstring/setup.rb +0 -37
  84. data/docs/templates/default/fulldoc/html/css/common.css +0 -1
  85. data/docs/yard_plugin.rb +0 -17
  86. data/features/command_line_interface/basic_usage.feature +0 -15
  87. data/features/command_line_interface/options.feature +0 -123
  88. data/features/command_line_interface/show_progress.feature +0 -33
  89. data/features/command_line_interface/smell_selection.feature +0 -15
  90. data/features/command_line_interface/smells_count.feature +0 -38
  91. data/features/command_line_interface/stdin.feature +0 -65
  92. data/features/configuration_files/accept_setting.feature +0 -87
  93. data/features/configuration_files/directory_specific_directives.feature +0 -274
  94. data/features/configuration_files/exclude_directives.feature +0 -35
  95. data/features/configuration_files/exclude_paths_directives.feature +0 -42
  96. data/features/configuration_files/masking_smells.feature +0 -94
  97. data/features/configuration_files/mix_accept_reject_setting.feature +0 -84
  98. data/features/configuration_files/reject_setting.feature +0 -89
  99. data/features/configuration_files/schema_validation.feature +0 -59
  100. data/features/configuration_files/show_configuration_file.feature +0 -44
  101. data/features/configuration_files/unused_private_method.feature +0 -68
  102. data/features/configuration_loading.feature +0 -91
  103. data/features/configuration_via_source_comments/erroneous_source_comments.feature +0 -68
  104. data/features/configuration_via_source_comments/well_formed_source_comments.feature +0 -116
  105. data/features/locales.feature +0 -32
  106. data/features/programmatic_access.feature +0 -41
  107. data/features/rake_task/rake_task.feature +0 -138
  108. data/features/reports/codeclimate.feature +0 -59
  109. data/features/reports/json.feature +0 -59
  110. data/features/reports/reports.feature +0 -219
  111. data/features/reports/yaml.feature +0 -52
  112. data/features/rspec_matcher.feature +0 -41
  113. data/features/samples.feature +0 -305
  114. data/features/step_definitions/.rubocop.yml +0 -5
  115. data/features/step_definitions/reek_steps.rb +0 -102
  116. data/features/step_definitions/sample_file_steps.rb +0 -63
  117. data/features/support/env.rb +0 -33
  118. data/features/todo_list.feature +0 -108
  119. data/samples/checkstyle.xml +0 -7
  120. data/samples/clean_source/clean.rb +0 -6
  121. data/samples/configuration/accepts_rejects_and_excludes_for_detectors.reek.yml +0 -29
  122. data/samples/configuration/accepts_rejects_and_excludes_for_directory_directives.reek.yml +0 -30
  123. data/samples/configuration/corrupt.reek +0 -1
  124. data/samples/configuration/empty.reek +0 -0
  125. data/samples/configuration/full_configuration.reek +0 -13
  126. data/samples/configuration/full_mask.reek +0 -6
  127. data/samples/configuration/home/home.reek.yml +0 -4
  128. data/samples/configuration/partial_mask.reek +0 -4
  129. data/samples/configuration/regular_configuration/.reek.yml +0 -4
  130. data/samples/configuration/regular_configuration/empty_sub_directory/.gitignore +0 -0
  131. data/samples/configuration/with_excluded_paths.reek +0 -5
  132. data/samples/no_config_file/.keep +0 -0
  133. data/samples/paths.rb +0 -5
  134. data/samples/smelly_source/inline.rb +0 -704
  135. data/samples/smelly_source/optparse.rb +0 -1788
  136. data/samples/smelly_source/redcloth.rb +0 -1130
  137. data/samples/smelly_source/ruby.rb +0 -368
  138. data/samples/smelly_source/smelly.rb +0 -7
  139. data/samples/source_with_exclude_paths/ignore_me/uncommunicative_method_name.rb +0 -5
  140. data/samples/source_with_exclude_paths/nested/ignore_me_as_well/irresponsible_module.rb +0 -2
  141. data/samples/source_with_exclude_paths/nested/uncommunicative_parameter_name.rb +0 -6
  142. data/samples/source_with_exclude_paths/nested/uncommunicative_variable_name.rb +0 -6
  143. data/samples/source_with_hidden_directories/.hidden/hidden.rb +0 -1
  144. data/samples/source_with_hidden_directories/not_hidden.rb +0 -1
  145. data/samples/source_with_non_ruby_files/gibberish +0 -1
  146. data/samples/source_with_non_ruby_files/python_source.py +0 -1
  147. data/samples/source_with_non_ruby_files/ruby.rb +0 -6
  148. data/spec/performance/reek/smell_detectors/runtime_speed_spec.rb +0 -17
  149. data/spec/quality/documentation_spec.rb +0 -40
  150. data/spec/quality/reek_source_spec.rb +0 -11
  151. data/spec/reek/ast/node_spec.rb +0 -211
  152. data/spec/reek/ast/object_refs_spec.rb +0 -83
  153. data/spec/reek/ast/reference_collector_spec.rb +0 -47
  154. data/spec/reek/ast/sexp_extensions_spec.rb +0 -498
  155. data/spec/reek/cli/application_spec.rb +0 -168
  156. data/spec/reek/cli/command/report_command_spec.rb +0 -44
  157. data/spec/reek/cli/command/todo_list_command_spec.rb +0 -86
  158. data/spec/reek/cli/options_spec.rb +0 -51
  159. data/spec/reek/cli/silencer_spec.rb +0 -28
  160. data/spec/reek/code_comment_spec.rb +0 -184
  161. data/spec/reek/configuration/app_configuration_spec.rb +0 -195
  162. data/spec/reek/configuration/configuration_file_finder_spec.rb +0 -230
  163. data/spec/reek/configuration/default_directive_spec.rb +0 -13
  164. data/spec/reek/configuration/directory_directives_spec.rb +0 -122
  165. data/spec/reek/configuration/excluded_paths_spec.rb +0 -16
  166. data/spec/reek/configuration/rake_task_converter_spec.rb +0 -33
  167. data/spec/reek/configuration/schema_validator_spec.rb +0 -165
  168. data/spec/reek/context/code_context_spec.rb +0 -192
  169. data/spec/reek/context/ghost_context_spec.rb +0 -60
  170. data/spec/reek/context/method_context_spec.rb +0 -72
  171. data/spec/reek/context/module_context_spec.rb +0 -55
  172. data/spec/reek/context/root_context_spec.rb +0 -12
  173. data/spec/reek/context/statement_counter_spec.rb +0 -24
  174. data/spec/reek/context_builder_spec.rb +0 -457
  175. data/spec/reek/detector_repository_spec.rb +0 -22
  176. data/spec/reek/documentation_link_spec.rb +0 -20
  177. data/spec/reek/errors/base_error_spec.rb +0 -13
  178. data/spec/reek/examiner_spec.rb +0 -309
  179. data/spec/reek/logging_error_handler_spec.rb +0 -24
  180. data/spec/reek/rake/task_spec.rb +0 -56
  181. data/spec/reek/report/code_climate/code_climate_configuration_spec.rb +0 -22
  182. data/spec/reek/report/code_climate/code_climate_fingerprint_spec.rb +0 -126
  183. data/spec/reek/report/code_climate/code_climate_formatter_spec.rb +0 -51
  184. data/spec/reek/report/code_climate/code_climate_report_spec.rb +0 -56
  185. data/spec/reek/report/html_report_spec.rb +0 -19
  186. data/spec/reek/report/json_report_spec.rb +0 -58
  187. data/spec/reek/report/location_formatter_spec.rb +0 -32
  188. data/spec/reek/report/progress_formatter_spec.rb +0 -68
  189. data/spec/reek/report/text_report_spec.rb +0 -89
  190. data/spec/reek/report/xml_report_spec.rb +0 -24
  191. data/spec/reek/report/yaml_report_spec.rb +0 -55
  192. data/spec/reek/report_spec.rb +0 -28
  193. data/spec/reek/smell_configuration_spec.rb +0 -56
  194. data/spec/reek/smell_detectors/attribute_spec.rb +0 -197
  195. data/spec/reek/smell_detectors/base_detector_spec.rb +0 -50
  196. data/spec/reek/smell_detectors/boolean_parameter_spec.rb +0 -93
  197. data/spec/reek/smell_detectors/class_variable_spec.rb +0 -106
  198. data/spec/reek/smell_detectors/control_parameter_spec.rb +0 -300
  199. data/spec/reek/smell_detectors/data_clump_spec.rb +0 -134
  200. data/spec/reek/smell_detectors/duplicate_method_call_spec.rb +0 -211
  201. data/spec/reek/smell_detectors/feature_envy_spec.rb +0 -295
  202. data/spec/reek/smell_detectors/instance_variable_assumption_spec.rb +0 -96
  203. data/spec/reek/smell_detectors/irresponsible_module_spec.rb +0 -226
  204. data/spec/reek/smell_detectors/long_parameter_list_spec.rb +0 -61
  205. data/spec/reek/smell_detectors/long_yield_list_spec.rb +0 -49
  206. data/spec/reek/smell_detectors/manual_dispatch_spec.rb +0 -75
  207. data/spec/reek/smell_detectors/missing_safe_method_spec.rb +0 -68
  208. data/spec/reek/smell_detectors/module_initialize_spec.rb +0 -77
  209. data/spec/reek/smell_detectors/nested_iterators_spec.rb +0 -333
  210. data/spec/reek/smell_detectors/nil_check_spec.rb +0 -100
  211. data/spec/reek/smell_detectors/repeated_conditional_spec.rb +0 -100
  212. data/spec/reek/smell_detectors/subclassed_from_core_class_spec.rb +0 -77
  213. data/spec/reek/smell_detectors/too_many_constants_spec.rb +0 -144
  214. data/spec/reek/smell_detectors/too_many_instance_variables_spec.rb +0 -132
  215. data/spec/reek/smell_detectors/too_many_methods_spec.rb +0 -54
  216. data/spec/reek/smell_detectors/too_many_statements_spec.rb +0 -90
  217. data/spec/reek/smell_detectors/uncommunicative_method_name_spec.rb +0 -78
  218. data/spec/reek/smell_detectors/uncommunicative_module_name_spec.rb +0 -78
  219. data/spec/reek/smell_detectors/uncommunicative_parameter_name_spec.rb +0 -147
  220. data/spec/reek/smell_detectors/uncommunicative_variable_name_spec.rb +0 -201
  221. data/spec/reek/smell_detectors/unused_parameters_spec.rb +0 -114
  222. data/spec/reek/smell_detectors/unused_private_method_spec.rb +0 -205
  223. data/spec/reek/smell_detectors/utility_function_spec.rb +0 -293
  224. data/spec/reek/smell_warning_spec.rb +0 -137
  225. data/spec/reek/source/source_code_spec.rb +0 -79
  226. data/spec/reek/source/source_locator_spec.rb +0 -166
  227. data/spec/reek/spec/should_reek_of_spec.rb +0 -153
  228. data/spec/reek/spec/should_reek_only_of_spec.rb +0 -91
  229. data/spec/reek/spec/should_reek_spec.rb +0 -52
  230. data/spec/reek/spec/smell_matcher_spec.rb +0 -87
  231. data/spec/reek/tree_dresser_spec.rb +0 -46
  232. data/spec/spec_helper.rb +0 -110
  233. data/tasks/configuration.rake +0 -19
  234. data/tasks/console.rake +0 -5
  235. data/tasks/reek.rake +0 -6
  236. data/tasks/rubocop.rake +0 -11
  237. data/tasks/test.rake +0 -32
@@ -1,129 +0,0 @@
1
- ---
2
- detectors:
3
- Attribute:
4
- enabled: true
5
- exclude: []
6
- BooleanParameter:
7
- enabled: true
8
- exclude: []
9
- ClassVariable:
10
- enabled: true
11
- exclude: []
12
- ControlParameter:
13
- enabled: true
14
- exclude: []
15
- DataClump:
16
- enabled: true
17
- exclude: []
18
- max_copies: 2
19
- min_clump_size: 2
20
- DuplicateMethodCall:
21
- enabled: true
22
- exclude: []
23
- max_calls: 1
24
- allow_calls: []
25
- FeatureEnvy:
26
- enabled: true
27
- exclude: []
28
- InstanceVariableAssumption:
29
- enabled: true
30
- exclude: []
31
- IrresponsibleModule:
32
- enabled: true
33
- exclude: []
34
- LongParameterList:
35
- enabled: true
36
- exclude: []
37
- max_params: 3
38
- overrides:
39
- initialize:
40
- max_params: 5
41
- LongYieldList:
42
- enabled: true
43
- exclude: []
44
- max_params: 3
45
- ManualDispatch:
46
- enabled: true
47
- exclude: []
48
- MissingSafeMethod:
49
- enabled: true
50
- exclude: []
51
- ModuleInitialize:
52
- enabled: true
53
- exclude: []
54
- NestedIterators:
55
- enabled: true
56
- exclude: []
57
- max_allowed_nesting: 1
58
- ignore_iterators:
59
- - tap
60
- NilCheck:
61
- enabled: true
62
- exclude: []
63
- RepeatedConditional:
64
- enabled: true
65
- exclude: []
66
- max_ifs: 2
67
- SubclassedFromCoreClass:
68
- enabled: true
69
- exclude: []
70
- TooManyConstants:
71
- enabled: true
72
- exclude: []
73
- max_constants: 5
74
- TooManyInstanceVariables:
75
- enabled: true
76
- exclude: []
77
- max_instance_variables: 4
78
- TooManyMethods:
79
- enabled: true
80
- exclude: []
81
- max_methods: 15
82
- TooManyStatements:
83
- enabled: true
84
- exclude:
85
- - initialize
86
- max_statements: 5
87
- UncommunicativeMethodName:
88
- enabled: true
89
- exclude: []
90
- reject:
91
- - "/^[a-z]$/"
92
- - "/[0-9]$/"
93
- - "/[A-Z]/"
94
- accept: []
95
- UncommunicativeModuleName:
96
- enabled: true
97
- exclude: []
98
- reject:
99
- - "/^.$/"
100
- - "/[0-9]$/"
101
- accept: []
102
- UncommunicativeParameterName:
103
- enabled: true
104
- exclude: []
105
- reject:
106
- - "/^.$/"
107
- - "/[0-9]$/"
108
- - "/[A-Z]/"
109
- - "/^_/"
110
- accept: []
111
- UncommunicativeVariableName:
112
- enabled: true
113
- exclude: []
114
- reject:
115
- - "/^.$/"
116
- - "/[0-9]$/"
117
- - "/[A-Z]/"
118
- accept:
119
- - "/^_$/"
120
- UnusedParameters:
121
- enabled: true
122
- exclude: []
123
- UnusedPrivateMethod:
124
- enabled: false
125
- exclude: []
126
- UtilityFunction:
127
- enabled: true
128
- exclude: []
129
- public_methods_only: false
@@ -1,3 +0,0 @@
1
- <div class="note public">
2
- <div class="inline"><p>This <%= object.type %> is part of Reek's public API.</p></div>
3
- </div>
@@ -1,37 +0,0 @@
1
- def init
2
- super
3
- return unless show_api_marker_section?
4
-
5
- if sections.first
6
- sections.first.place(:api_marker).before(:private)
7
- else
8
- sections :index, [:api_marker]
9
- end
10
- end
11
-
12
- def api_marker
13
- return if object.type == :root
14
-
15
- erb(:private) unless ['public', 'private'].include? api_text
16
- end
17
-
18
- private
19
-
20
- def api_text
21
- api_text = object.has_tag?(:api) && object.tag(:api).text
22
- api_text = 'public' if object.has_tag?(:public)
23
- api_text
24
- end
25
-
26
- def show_api_marker_section?
27
- return false if object.type == :root
28
-
29
- case api_text
30
- when 'public'
31
- false
32
- when 'private'
33
- false
34
- else
35
- true
36
- end
37
- end
@@ -1 +0,0 @@
1
- .note.public { background: #c5ffc5; border-color: #aaecaa; }
data/docs/yard_plugin.rb DELETED
@@ -1,17 +0,0 @@
1
- require 'yard'
2
-
3
- # Template helper to modify processing of links in HTML generated from our
4
- # markdown files.
5
- module LocalLinkHelper
6
- # Rewrites links to (assumed local) markdown files so they're processed as
7
- # {file: } directives.
8
- def resolve_links(text)
9
- text = text.gsub(%r{<a href="([^"]*.md)">([^<]*)</a>}, '{file:\1 \2}')
10
- super text
11
- end
12
- end
13
-
14
- YARD::Templates::Template.extra_includes << LocalLinkHelper
15
- YARD::Tags::Library.define_tag('Guaranteed public API', :public)
16
- YARD::Tags::Library.define_tag('Code quality configuration', :quality)
17
- YARD::Templates::Engine.register_template_path File.join(File.dirname(__FILE__), 'templates')
@@ -1,15 +0,0 @@
1
- Feature: The Reek CLI maintains backwards compatibility
2
- In order to use Reek without fuss
3
- As a developer
4
- I want to have a stable basic command line interface
5
-
6
- Scenario: the example from README reports as expected
7
- Given the smelly file 'smelly.rb'
8
- When I run reek smelly.rb
9
- Then the exit status indicates smells
10
- And it reports:
11
- """
12
- smelly.rb -- 2 warnings:
13
- [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
14
- [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
15
- """
@@ -1,123 +0,0 @@
1
- Feature: Reek can be controlled using command-line options
2
- In order to change Reek's default behaviour
3
- As a developer
4
- I want to supply options on the command line
5
-
6
- Scenario: return non-zero status on bad option
7
- When I run reek --no-such-option
8
- Then the exit status indicates an error
9
- And it reports the error "Error: invalid option: --no-such-option"
10
- And there is no output on stdout
11
-
12
- Scenario: display the current version number
13
- When I run reek --version
14
- Then it succeeds
15
- And it reports the current version
16
-
17
- Scenario: return given status code when using --failure-exit-code
18
- Given the smelly file 'smelly.rb'
19
- When I run reek smelly.rb --failure-exit-code 23
20
- Then the exit status is 23
21
-
22
- Scenario: return given status code when using --success-exit-code
23
- Given the clean file "clean.rb"
24
- When I run reek clean.rb --success-exit-code 42
25
- Then the exit status is 42
26
-
27
- Scenario: display the help information
28
- When I run reek --help
29
- Then it succeeds
30
- And it reports:
31
- """
32
- Usage: reek [options] [files]
33
-
34
- Examples:
35
-
36
- reek lib/*.rb
37
- reek -s lib
38
- cat my_class.rb | reek
39
-
40
- See https://github.com/troessner/reek for detailed help.
41
-
42
- Configuration:
43
- -c, --config FILE Read configuration options from FILE
44
- --smell SMELL Only look for a specific smell.
45
- Call it like this: reek --smell MissingSafeMethod source.rb
46
- Check out https://github.com/troessner/reek/blob/v6.0.1/docs/Code-Smells.md for a list of smells
47
- --stdin-filename FILE When passing code in via pipe, assume this filename when checking file or directory rules in the config.
48
-
49
- Generate a todo list:
50
- -t, --todo Generate a todo list
51
-
52
- Report format:
53
- -f, --format FORMAT Report smells in the given format:
54
- html
55
- text (default)
56
- yaml
57
- json
58
- xml
59
-
60
- Text format options:
61
- --[no-]color Use colors for the output (default: true)
62
- -V, --[no-]empty-headings Show headings for smell-free source files (default: false)
63
- -U, --[no-]documentation Show link to related documentation page for each smell (default: true)
64
- --[no-]show-configuration-path
65
- Show which configuration file Reek is using (default: false)
66
- -n, --[no-]line-numbers Show line numbers in the output (default: true)
67
- -s, --single-line Show location in editor-compatible single-line-per-smell format
68
- -P, --[no-]progress Show progress of each source as it is examined (default: true)
69
- --sort-by SORTING Sort reported files by the given criterium:
70
- smelliness ("smelliest" files first)
71
- none (default - output in processing order)
72
- --force-exclusion Force excluding files specified in the configuration `exclude_paths`
73
- even if they are explicitly passed as arguments
74
-
75
- Exit codes:
76
- --success-exit-code CODE The exit code when no smells are found (default: 0)
77
- --failure-exit-code CODE The exit code when smells are found (default: 2)
78
-
79
- Utility options:
80
- -h, --help Show this message
81
- -l, --list List all available smell detectors
82
- -v, --version Show version
83
- """
84
-
85
- Scenario: List all available smell detectors
86
- When I run reek --list
87
- Then it succeeds
88
- And it reports:
89
- """
90
- All available smell detectors:
91
-
92
- Attribute
93
- BooleanParameter
94
- ClassVariable
95
- ControlParameter
96
- DataClump
97
- DuplicateMethodCall
98
- FeatureEnvy
99
- InstanceVariableAssumption
100
- IrresponsibleModule
101
- LongParameterList
102
- LongYieldList
103
- ManualDispatch
104
- MissingSafeMethod
105
- ModuleInitialize
106
- NestedIterators
107
- NilCheck
108
- RepeatedConditional
109
- SubclassedFromCoreClass
110
- TooManyConstants
111
- TooManyInstanceVariables
112
- TooManyMethods
113
- TooManyStatements
114
- UncommunicativeMethodName
115
- UncommunicativeModuleName
116
- UncommunicativeParameterName
117
- UncommunicativeVariableName
118
- UnusedParameters
119
- UnusedPrivateMethod
120
- UtilityFunction
121
-
122
- Check out https://github.com/troessner/reek/blob/v6.0.1/docs/Code-Smells.md for a details on each detector
123
- """
@@ -1,33 +0,0 @@
1
- Feature: Show progress
2
- In order to see the progress of the examiners
3
- As a developer
4
- I want to be able to selectively activate progress reporting
5
-
6
- # Note that --progress is the default on TTYs, but needs to be explicitely
7
- # enabled here because output in the cucumber scenarios does not go to a TTY.
8
- Scenario: shows progress output on mixed files by default
9
- Given a directory called 'mixed_files' containing some clean and smelly files
10
- When I run reek --progress mixed_files
11
- Then the exit status indicates smells
12
- And it reports:
13
- """
14
- Inspecting 2 file(s):
15
- .S
16
-
17
- mixed_files/dirty.rb -- 2 warnings:
18
- [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
19
- [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
20
- 2 total warnings
21
- """
22
-
23
- Scenario: --no-progress disables progress output
24
- Given a directory called 'mixed_files' containing some clean and smelly files
25
- When I run reek --no-progress mixed_files
26
- Then the exit status indicates smells
27
- And it reports:
28
- """
29
- mixed_files/dirty.rb -- 2 warnings:
30
- [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
31
- [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
32
- 2 total warnings
33
- """
@@ -1,15 +0,0 @@
1
- Feature: Smell selection
2
- In order to focus on particular code smells
3
- As a developer
4
- I want to be able to selectively activate smell detectors
5
-
6
- Scenario: --smell selects a smell to detect
7
- Given the smelly file 'smelly.rb'
8
- And a configuration file 'partial_mask.reek'
9
- When I run reek --no-line-numbers --smell UncommunicativeVariableName smelly.rb
10
- Then the exit status indicates smells
11
- And it reports:
12
- """
13
- smelly.rb -- 1 warning:
14
- UncommunicativeVariableName: Smelly#x has the variable name 'y'
15
- """
@@ -1,38 +0,0 @@
1
- Feature: Reports total number of code smells
2
- In order to monitor the total number of smells
3
- Reek outputs the total number of smells among all files inspected.
4
-
5
- Scenario: Does not output total number of smells when inspecting single file
6
- Given the smelly file 'smelly.rb'
7
- When I run reek smelly.rb
8
- Then the exit status indicates smells
9
- And it reports:
10
- """
11
- smelly.rb -- 2 warnings:
12
- [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
13
- [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
14
- """
15
-
16
- Scenario: Output total number of smells when inspecting multiple files
17
- Given a directory called 'smelly' containing two smelly files
18
- When I run reek smelly
19
- Then the exit status indicates smells
20
- And it reports:
21
- """
22
- smelly/dirty_one.rb -- 2 warnings:
23
- [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
24
- [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
25
- smelly/dirty_two.rb -- 2 warnings:
26
- [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
27
- [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
28
- 4 total warnings
29
- """
30
-
31
- Scenario: Output total number of smells even if total equals 0
32
- Given a directory called 'clean' containing two clean files
33
- When I run reek clean
34
- Then it succeeds
35
- And it reports:
36
- """
37
- 0 total warnings
38
- """
@@ -1,65 +0,0 @@
1
- Feature: Reek reads from $stdin when no files are given
2
- In order to use reek with pipelines
3
- As a developer
4
- I want to pipe source code on stdin
5
-
6
- Scenario: return zero status with no smells
7
- When I pass "def simple() @fred = 3 end" to reek
8
- Then it succeeds
9
- And it reports nothing
10
-
11
- Scenario: outputs nothing on empty stdin
12
- When I pass "" to reek
13
- Then it succeeds
14
- And it reports nothing
15
-
16
- Scenario: outputs header only on empty stdin in verbose mode
17
- When I pass "" to reek -V
18
- Then it succeeds
19
- And it reports:
20
- """
21
- STDIN -- 0 warnings
22
- """
23
-
24
- Scenario: return non-zero status when there are smells
25
- When I pass "class Turn; def y() @x = 3; end end" to reek
26
- Then the exit status indicates smells
27
- And it reports:
28
- """
29
- STDIN -- 3 warnings:
30
- [1]:IrresponsibleModule: Turn has no descriptive comment
31
- [1]:UncommunicativeMethodName: Turn#y has the name 'y'
32
- [1]:UncommunicativeVariableName: Turn has the variable name '@x'
33
- """
34
-
35
- Scenario: syntax error causes the source to be ignored
36
- When I pass "= invalid syntax =" to reek
37
- Then it succeeds
38
- And it reports the error "Parser::SyntaxError: unexpected token tEQL"
39
-
40
- Scenario: providing a filename to use for the config to match against
41
- Given a file named "web_app/config.reek" with:
42
- """
43
- ---
44
- directories:
45
- "web_app/app/controllers":
46
- IrresponsibleModule:
47
- enabled: false
48
- NestedIterators:
49
- enabled: false
50
- InstanceVariableAssumption:
51
- enabled: false
52
- """
53
- When I pass a stdin to reek --config web_app/config.reek --stdin-filename web_app/app/controllers/users_controller with:
54
- """
55
- class UsersController < ApplicationController
56
- def show
57
- respond_with do |format|
58
- format.json { |json| @user.to_custom_json }
59
- format.xml { |xml| @user.to_fancy_xml }
60
- end
61
- end
62
- end
63
- """
64
- Then it succeeds
65
- And it reports nothing