reek 6.0.2 → 6.1.4

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.
Files changed (247) hide show
  1. checksums.yaml +4 -4
  2. data/.github/dependabot.yml +13 -0
  3. data/.github/workflows/ruby.yml +57 -0
  4. data/.rubocop.yml +6 -4
  5. data/.rubocop_todo.yml +6 -4
  6. data/CHANGELOG.md +42 -0
  7. data/CONTRIBUTING.md +4 -1
  8. data/Dockerfile +1 -1
  9. data/Gemfile +7 -7
  10. data/README.md +2 -2
  11. data/bin/code_climate_reek +2 -3
  12. data/lib/reek/ast/ast_node_class_map.rb +1 -1
  13. data/lib/reek/ast/node.rb +1 -1
  14. data/lib/reek/ast/sexp_extensions/arguments.rb +20 -0
  15. data/lib/reek/ast/sexp_extensions/case.rb +1 -1
  16. data/lib/reek/ast/sexp_extensions/if.rb +1 -1
  17. data/lib/reek/ast/sexp_extensions/send.rb +1 -1
  18. data/lib/reek/cli/command/todo_list_command.rb +2 -2
  19. data/lib/reek/cli/options.rb +6 -6
  20. data/lib/reek/code_comment.rb +22 -17
  21. data/lib/reek/configuration/configuration_file_finder.rb +2 -1
  22. data/lib/reek/configuration/excluded_paths.rb +2 -1
  23. data/lib/reek/context/code_context.rb +1 -1
  24. data/lib/reek/context/module_context.rb +4 -0
  25. data/lib/reek/context/refinement_context.rb +16 -0
  26. data/lib/reek/context/send_context.rb +6 -0
  27. data/lib/reek/context_builder.rb +17 -3
  28. data/lib/reek/rake/task.rb +5 -5
  29. data/lib/reek/report/code_climate/code_climate_configuration.yml +3 -3
  30. data/lib/reek/report/code_climate/code_climate_formatter.rb +1 -3
  31. data/lib/reek/smell_detectors/base_detector.rb +1 -1
  32. data/lib/reek/smell_detectors/class_variable.rb +2 -2
  33. data/lib/reek/smell_detectors/control_parameter_helpers/candidate.rb +6 -6
  34. data/lib/reek/smell_detectors/duplicate_method_call.rb +5 -5
  35. data/lib/reek/smell_detectors/unused_private_method.rb +1 -0
  36. data/lib/reek/smell_warning.rb +1 -1
  37. data/lib/reek/source/source_locator.rb +1 -3
  38. data/lib/reek/spec/should_reek_of.rb +11 -9
  39. data/lib/reek/spec.rb +1 -1
  40. data/lib/reek/version.rb +2 -2
  41. data/reek.gemspec +28 -25
  42. metadata +13 -240
  43. data/.travis.yml +0 -40
  44. data/docs/API.md +0 -174
  45. data/docs/Attribute.md +0 -39
  46. data/docs/Basic-Smell-Options.md +0 -85
  47. data/docs/Boolean-Parameter.md +0 -54
  48. data/docs/Class-Variable.md +0 -40
  49. data/docs/Code-Smells.md +0 -39
  50. data/docs/Command-Line-Options.md +0 -119
  51. data/docs/Control-Couple.md +0 -26
  52. data/docs/Control-Parameter.md +0 -32
  53. data/docs/Data-Clump.md +0 -46
  54. data/docs/Duplicate-Method-Call.md +0 -264
  55. data/docs/Feature-Envy.md +0 -93
  56. data/docs/How-To-Write-New-Detectors.md +0 -132
  57. data/docs/How-reek-works-internally.md +0 -114
  58. data/docs/Instance-Variable-Assumption.md +0 -163
  59. data/docs/Irresponsible-Module.md +0 -47
  60. data/docs/Large-Class.md +0 -16
  61. data/docs/Long-Parameter-List.md +0 -39
  62. data/docs/Long-Yield-List.md +0 -37
  63. data/docs/Manual-Dispatch.md +0 -30
  64. data/docs/Missing-Safe-Method.md +0 -92
  65. data/docs/Module-Initialize.md +0 -62
  66. data/docs/Nested-Iterators.md +0 -59
  67. data/docs/Nil-Check.md +0 -47
  68. data/docs/RSpec-matchers.md +0 -129
  69. data/docs/Rake-Task.md +0 -66
  70. data/docs/Reek-4-to-Reek-5-migration.md +0 -188
  71. data/docs/Reek-Driven-Development.md +0 -46
  72. data/docs/Repeated-Conditional.md +0 -47
  73. data/docs/Simulated-Polymorphism.md +0 -16
  74. data/docs/Smell-Suppression.md +0 -96
  75. data/docs/Style-Guide.md +0 -19
  76. data/docs/Subclassed-From-Core-Class.md +0 -79
  77. data/docs/Too-Many-Constants.md +0 -37
  78. data/docs/Too-Many-Instance-Variables.md +0 -43
  79. data/docs/Too-Many-Methods.md +0 -56
  80. data/docs/Too-Many-Statements.md +0 -54
  81. data/docs/Uncommunicative-Method-Name.md +0 -94
  82. data/docs/Uncommunicative-Module-Name.md +0 -92
  83. data/docs/Uncommunicative-Name.md +0 -18
  84. data/docs/Uncommunicative-Parameter-Name.md +0 -90
  85. data/docs/Uncommunicative-Variable-Name.md +0 -96
  86. data/docs/Unused-Parameters.md +0 -28
  87. data/docs/Unused-Private-Method.md +0 -101
  88. data/docs/Utility-Function.md +0 -56
  89. data/docs/Versioning-Policy.md +0 -7
  90. data/docs/YAML-Reports.md +0 -93
  91. data/docs/defaults.reek.yml +0 -129
  92. data/docs/templates/default/docstring/html/public_api_marker.erb +0 -3
  93. data/docs/templates/default/docstring/setup.rb +0 -37
  94. data/docs/templates/default/fulldoc/html/css/common.css +0 -1
  95. data/docs/yard_plugin.rb +0 -17
  96. data/features/command_line_interface/basic_usage.feature +0 -15
  97. data/features/command_line_interface/options.feature +0 -123
  98. data/features/command_line_interface/show_progress.feature +0 -33
  99. data/features/command_line_interface/smell_selection.feature +0 -15
  100. data/features/command_line_interface/smells_count.feature +0 -38
  101. data/features/command_line_interface/stdin.feature +0 -65
  102. data/features/configuration_files/accept_setting.feature +0 -87
  103. data/features/configuration_files/directory_specific_directives.feature +0 -274
  104. data/features/configuration_files/exclude_directives.feature +0 -35
  105. data/features/configuration_files/exclude_paths_directives.feature +0 -42
  106. data/features/configuration_files/masking_smells.feature +0 -94
  107. data/features/configuration_files/mix_accept_reject_setting.feature +0 -84
  108. data/features/configuration_files/reject_setting.feature +0 -89
  109. data/features/configuration_files/schema_validation.feature +0 -59
  110. data/features/configuration_files/show_configuration_file.feature +0 -44
  111. data/features/configuration_files/unused_private_method.feature +0 -68
  112. data/features/configuration_loading.feature +0 -91
  113. data/features/configuration_via_source_comments/erroneous_source_comments.feature +0 -68
  114. data/features/configuration_via_source_comments/well_formed_source_comments.feature +0 -116
  115. data/features/locales.feature +0 -32
  116. data/features/programmatic_access.feature +0 -41
  117. data/features/rake_task/rake_task.feature +0 -138
  118. data/features/reports/codeclimate.feature +0 -59
  119. data/features/reports/json.feature +0 -59
  120. data/features/reports/reports.feature +0 -219
  121. data/features/reports/yaml.feature +0 -52
  122. data/features/rspec_matcher.feature +0 -41
  123. data/features/samples.feature +0 -305
  124. data/features/step_definitions/.rubocop.yml +0 -5
  125. data/features/step_definitions/reek_steps.rb +0 -102
  126. data/features/step_definitions/sample_file_steps.rb +0 -63
  127. data/features/support/env.rb +0 -33
  128. data/features/todo_list.feature +0 -108
  129. data/samples/checkstyle.xml +0 -7
  130. data/samples/clean_source/clean.rb +0 -6
  131. data/samples/configuration/accepts_rejects_and_excludes_for_detectors.reek.yml +0 -29
  132. data/samples/configuration/accepts_rejects_and_excludes_for_directory_directives.reek.yml +0 -30
  133. data/samples/configuration/corrupt.reek +0 -1
  134. data/samples/configuration/empty.reek +0 -0
  135. data/samples/configuration/full_configuration.reek +0 -13
  136. data/samples/configuration/full_mask.reek +0 -6
  137. data/samples/configuration/home/home.reek.yml +0 -4
  138. data/samples/configuration/partial_mask.reek +0 -4
  139. data/samples/configuration/regular_configuration/.reek.yml +0 -4
  140. data/samples/configuration/regular_configuration/empty_sub_directory/.gitignore +0 -0
  141. data/samples/configuration/with_excluded_paths.reek +0 -5
  142. data/samples/no_config_file/.keep +0 -0
  143. data/samples/paths.rb +0 -5
  144. data/samples/smelly_source/inline.rb +0 -704
  145. data/samples/smelly_source/optparse.rb +0 -1788
  146. data/samples/smelly_source/redcloth.rb +0 -1130
  147. data/samples/smelly_source/ruby.rb +0 -368
  148. data/samples/smelly_source/smelly.rb +0 -7
  149. data/samples/source_with_exclude_paths/ignore_me/uncommunicative_method_name.rb +0 -5
  150. data/samples/source_with_exclude_paths/nested/ignore_me_as_well/irresponsible_module.rb +0 -2
  151. data/samples/source_with_exclude_paths/nested/uncommunicative_parameter_name.rb +0 -6
  152. data/samples/source_with_exclude_paths/nested/uncommunicative_variable_name.rb +0 -6
  153. data/samples/source_with_hidden_directories/.hidden/hidden.rb +0 -1
  154. data/samples/source_with_hidden_directories/not_hidden.rb +0 -1
  155. data/samples/source_with_non_ruby_files/gibberish +0 -1
  156. data/samples/source_with_non_ruby_files/python_source.py +0 -1
  157. data/samples/source_with_non_ruby_files/ruby.rb +0 -6
  158. data/spec/performance/reek/smell_detectors/runtime_speed_spec.rb +0 -15
  159. data/spec/quality/documentation_spec.rb +0 -41
  160. data/spec/quality/reek_source_spec.rb +0 -11
  161. data/spec/reek/ast/node_spec.rb +0 -211
  162. data/spec/reek/ast/object_refs_spec.rb +0 -83
  163. data/spec/reek/ast/reference_collector_spec.rb +0 -47
  164. data/spec/reek/ast/sexp_extensions_spec.rb +0 -498
  165. data/spec/reek/cli/application_spec.rb +0 -168
  166. data/spec/reek/cli/command/report_command_spec.rb +0 -44
  167. data/spec/reek/cli/command/todo_list_command_spec.rb +0 -86
  168. data/spec/reek/cli/options_spec.rb +0 -51
  169. data/spec/reek/cli/silencer_spec.rb +0 -28
  170. data/spec/reek/code_comment_spec.rb +0 -184
  171. data/spec/reek/configuration/app_configuration_spec.rb +0 -195
  172. data/spec/reek/configuration/configuration_file_finder_spec.rb +0 -230
  173. data/spec/reek/configuration/default_directive_spec.rb +0 -13
  174. data/spec/reek/configuration/directory_directives_spec.rb +0 -122
  175. data/spec/reek/configuration/excluded_paths_spec.rb +0 -16
  176. data/spec/reek/configuration/rake_task_converter_spec.rb +0 -33
  177. data/spec/reek/configuration/schema_validator_spec.rb +0 -165
  178. data/spec/reek/context/code_context_spec.rb +0 -192
  179. data/spec/reek/context/ghost_context_spec.rb +0 -60
  180. data/spec/reek/context/method_context_spec.rb +0 -72
  181. data/spec/reek/context/module_context_spec.rb +0 -55
  182. data/spec/reek/context/root_context_spec.rb +0 -12
  183. data/spec/reek/context/statement_counter_spec.rb +0 -24
  184. data/spec/reek/context_builder_spec.rb +0 -457
  185. data/spec/reek/detector_repository_spec.rb +0 -22
  186. data/spec/reek/documentation_link_spec.rb +0 -20
  187. data/spec/reek/errors/base_error_spec.rb +0 -13
  188. data/spec/reek/examiner_spec.rb +0 -309
  189. data/spec/reek/logging_error_handler_spec.rb +0 -24
  190. data/spec/reek/rake/task_spec.rb +0 -56
  191. data/spec/reek/report/code_climate/code_climate_configuration_spec.rb +0 -22
  192. data/spec/reek/report/code_climate/code_climate_fingerprint_spec.rb +0 -126
  193. data/spec/reek/report/code_climate/code_climate_formatter_spec.rb +0 -51
  194. data/spec/reek/report/code_climate/code_climate_report_spec.rb +0 -56
  195. data/spec/reek/report/html_report_spec.rb +0 -19
  196. data/spec/reek/report/json_report_spec.rb +0 -58
  197. data/spec/reek/report/location_formatter_spec.rb +0 -32
  198. data/spec/reek/report/progress_formatter_spec.rb +0 -68
  199. data/spec/reek/report/text_report_spec.rb +0 -89
  200. data/spec/reek/report/xml_report_spec.rb +0 -24
  201. data/spec/reek/report/yaml_report_spec.rb +0 -55
  202. data/spec/reek/report_spec.rb +0 -28
  203. data/spec/reek/smell_configuration_spec.rb +0 -56
  204. data/spec/reek/smell_detectors/attribute_spec.rb +0 -197
  205. data/spec/reek/smell_detectors/base_detector_spec.rb +0 -50
  206. data/spec/reek/smell_detectors/boolean_parameter_spec.rb +0 -93
  207. data/spec/reek/smell_detectors/class_variable_spec.rb +0 -106
  208. data/spec/reek/smell_detectors/control_parameter_spec.rb +0 -300
  209. data/spec/reek/smell_detectors/data_clump_spec.rb +0 -134
  210. data/spec/reek/smell_detectors/duplicate_method_call_spec.rb +0 -211
  211. data/spec/reek/smell_detectors/feature_envy_spec.rb +0 -295
  212. data/spec/reek/smell_detectors/instance_variable_assumption_spec.rb +0 -96
  213. data/spec/reek/smell_detectors/irresponsible_module_spec.rb +0 -226
  214. data/spec/reek/smell_detectors/long_parameter_list_spec.rb +0 -61
  215. data/spec/reek/smell_detectors/long_yield_list_spec.rb +0 -49
  216. data/spec/reek/smell_detectors/manual_dispatch_spec.rb +0 -75
  217. data/spec/reek/smell_detectors/missing_safe_method_spec.rb +0 -68
  218. data/spec/reek/smell_detectors/module_initialize_spec.rb +0 -77
  219. data/spec/reek/smell_detectors/nested_iterators_spec.rb +0 -333
  220. data/spec/reek/smell_detectors/nil_check_spec.rb +0 -100
  221. data/spec/reek/smell_detectors/repeated_conditional_spec.rb +0 -100
  222. data/spec/reek/smell_detectors/subclassed_from_core_class_spec.rb +0 -77
  223. data/spec/reek/smell_detectors/too_many_constants_spec.rb +0 -144
  224. data/spec/reek/smell_detectors/too_many_instance_variables_spec.rb +0 -132
  225. data/spec/reek/smell_detectors/too_many_methods_spec.rb +0 -54
  226. data/spec/reek/smell_detectors/too_many_statements_spec.rb +0 -90
  227. data/spec/reek/smell_detectors/uncommunicative_method_name_spec.rb +0 -78
  228. data/spec/reek/smell_detectors/uncommunicative_module_name_spec.rb +0 -78
  229. data/spec/reek/smell_detectors/uncommunicative_parameter_name_spec.rb +0 -147
  230. data/spec/reek/smell_detectors/uncommunicative_variable_name_spec.rb +0 -201
  231. data/spec/reek/smell_detectors/unused_parameters_spec.rb +0 -114
  232. data/spec/reek/smell_detectors/unused_private_method_spec.rb +0 -205
  233. data/spec/reek/smell_detectors/utility_function_spec.rb +0 -293
  234. data/spec/reek/smell_warning_spec.rb +0 -137
  235. data/spec/reek/source/source_code_spec.rb +0 -79
  236. data/spec/reek/source/source_locator_spec.rb +0 -166
  237. data/spec/reek/spec/should_reek_of_spec.rb +0 -153
  238. data/spec/reek/spec/should_reek_only_of_spec.rb +0 -91
  239. data/spec/reek/spec/should_reek_spec.rb +0 -52
  240. data/spec/reek/spec/smell_matcher_spec.rb +0 -87
  241. data/spec/reek/tree_dresser_spec.rb +0 -46
  242. data/spec/spec_helper.rb +0 -110
  243. data/tasks/configuration.rake +0 -18
  244. data/tasks/console.rake +0 -5
  245. data/tasks/reek.rake +0 -6
  246. data/tasks/rubocop.rake +0 -11
  247. data/tasks/test.rake +0 -32
@@ -1,305 +0,0 @@
1
- Feature: Basic smell detection
2
- In order to write better software
3
- As a developer
4
- I want to detect the smells in my Ruby code
5
-
6
- Scenario: Correct smells from inline.rb
7
- Given the smelly file 'inline.rb'
8
- And the smelly file 'optparse.rb'
9
- And the smelly file 'redcloth.rb'
10
- When I run reek --no-line-numbers inline.rb optparse.rb redcloth.rb
11
- Then the exit status indicates smells
12
- And it reports:
13
- """
14
- inline.rb -- 51 warnings:
15
- BooleanParameter: Inline::C#parse_signature has boolean parameter 'raw'
16
- ClassVariable: Inline declares the class variable '@@directory'
17
- ClassVariable: Inline declares the class variable '@@rootdir'
18
- ClassVariable: Inline::C declares the class variable '@@type_map'
19
- ControlParameter: Inline::C#parse_signature is controlled by argument 'raw'
20
- DataClump: Inline::C takes parameters ['options', 'src'] to 5 methods
21
- DuplicateMethodCall: Inline#self.rootdir calls 'env.nil?' 2 times
22
- DuplicateMethodCall: Inline::C#build calls '$? != 0' 2 times
23
- DuplicateMethodCall: Inline::C#build calls 'Inline.directory' 5 times
24
- DuplicateMethodCall: Inline::C#build calls 'io.puts "#endif"' 2 times
25
- DuplicateMethodCall: Inline::C#build calls 'io.puts "#ifdef __cplusplus"' 2 times
26
- DuplicateMethodCall: Inline::C#build calls 'io.puts' 6 times
27
- DuplicateMethodCall: Inline::C#build calls 'warn "Output:\n#{result}"' 2 times
28
- DuplicateMethodCall: Inline::C#crap_for_windoze calls 'Config::CONFIG['libdir']' 2 times
29
- DuplicateMethodCall: Inline::C#generate calls 'result.sub!(/\A\n/, '')' 2 times
30
- DuplicateMethodCall: Inline::C#generate calls 'signature['args']' 2 times
31
- DuplicateMethodCall: Inline::C#generate calls 'signature['args'].map' 2 times
32
- DuplicateMethodCall: Inline::C#initialize calls 'stack.empty?' 2 times
33
- DuplicateMethodCall: Module#inline calls 'Inline.const_get(lang)' 2 times
34
- DuplicateMethodCall: Module#inline calls 'options[:testing]' 2 times
35
- InstanceVariableAssumption: Inline::C assumes too much for instance variable '@module_name'
36
- InstanceVariableAssumption: Inline::C assumes too much for instance variable '@so_name'
37
- InstanceVariableAssumption: Inline::C assumes too much for instance variable '@types'
38
- IrresponsibleModule: CompilationError has no descriptive comment
39
- IrresponsibleModule: Dir has no descriptive comment
40
- IrresponsibleModule: File has no descriptive comment
41
- IrresponsibleModule: Module has no descriptive comment
42
- NestedIterators: Inline::C#build contains iterators nested 2 deep
43
- NilCheck: Inline#self.rootdir performs a nil-check
44
- RepeatedConditional: Inline::C tests '$DEBUG' at least 7 times
45
- RepeatedConditional: Inline::C tests '$TESTING' at least 4 times
46
- RepeatedConditional: Inline::C tests '@@type_map.has_key? type' at least 3 times
47
- TooManyConstants: Inline has 6 constants
48
- TooManyInstanceVariables: Inline::C has at least 13 instance variables
49
- TooManyMethods: Inline::C has at least 25 methods
50
- TooManyStatements: File#self.write_with_backup has approx 6 statements
51
- TooManyStatements: Inline#self.rootdir has approx 8 statements
52
- TooManyStatements: Inline::C#build has approx 63 statements
53
- TooManyStatements: Inline::C#generate has approx 35 statements
54
- TooManyStatements: Inline::C#module_name has approx 7 statements
55
- TooManyStatements: Inline::C#parse_signature has approx 16 statements
56
- TooManyStatements: Module#inline has approx 12 statements
57
- UncommunicativeMethodName: Inline::C#c has the name 'c'
58
- UncommunicativeModuleName: Inline::C has the name 'C'
59
- UncommunicativeVariableName: Inline::C#build has the variable name 'n'
60
- UncommunicativeVariableName: Inline::C#build has the variable name 't'
61
- UncommunicativeVariableName: Inline::C#module_name has the variable name 'm'
62
- UncommunicativeVariableName: Inline::C#module_name has the variable name 'md5'
63
- UncommunicativeVariableName: Inline::C#module_name has the variable name 'x'
64
- UncommunicativeVariableName: Inline::C#parse_signature has the variable name 'x'
65
- UtilityFunction: Inline::C#strip_comments doesn't depend on instance state (maybe move it to another class?)
66
- optparse.rb -- 126 warnings:
67
- Attribute: OptionParser#banner is a writable attribute
68
- Attribute: OptionParser#default_argv is a writable attribute
69
- Attribute: OptionParser#program_name is a writable attribute
70
- Attribute: OptionParser#release is a writable attribute
71
- Attribute: OptionParser#summary_indent is a writable attribute
72
- Attribute: OptionParser#summary_width is a writable attribute
73
- Attribute: OptionParser#version is a writable attribute
74
- Attribute: OptionParser::ParseError#reason is a writable attribute
75
- BooleanParameter: OptionParser#complete has boolean parameter 'icase'
76
- BooleanParameter: OptionParser::Completion#complete has boolean parameter 'icase'
77
- BooleanParameter: OptionParser::List#complete has boolean parameter 'icase'
78
- ControlParameter: OptionParser#summarize is controlled by argument 'blk'
79
- ControlParameter: OptionParser::Arguable#options= is controlled by argument 'opt'
80
- ControlParameter: OptionParser::ParseError#set_option is controlled by argument 'eq'
81
- DuplicateMethodCall: OptionParser#getopts calls 'result[opt] = false' 2 times
82
- DuplicateMethodCall: OptionParser#make_switch calls 'default_style.guess(arg = a)' 4 times
83
- DuplicateMethodCall: OptionParser#make_switch calls 'long << (o = q.downcase)' 2 times
84
- DuplicateMethodCall: OptionParser#make_switch calls 'notwice(NilClass, klass, 'type')' 2 times
85
- DuplicateMethodCall: OptionParser#make_switch calls 'notwice(a ? Object : TrueClass, klass, 'type')' 2 times
86
- DuplicateMethodCall: OptionParser#make_switch calls 'pattern.method(:convert)' 2 times
87
- DuplicateMethodCall: OptionParser#make_switch calls 'pattern.method(:convert).to_proc' 2 times
88
- DuplicateMethodCall: OptionParser#make_switch calls 'pattern.respond_to?(:convert)' 2 times
89
- DuplicateMethodCall: OptionParser#make_switch calls 'q.downcase' 3 times
90
- DuplicateMethodCall: OptionParser#make_switch calls 'sdesc << "-#{q}"' 2 times
91
- DuplicateMethodCall: OptionParser#make_switch calls 'search(:atype, FalseClass)' 2 times
92
- DuplicateMethodCall: OptionParser#make_switch calls 'search(:atype, o)' 6 times
93
- DuplicateMethodCall: OptionParser#order calls 'argv[0]' 2 times
94
- DuplicateMethodCall: OptionParser#parse calls 'argv[0]' 2 times
95
- DuplicateMethodCall: OptionParser#parse_in_order calls '$!.set_option(arg, true)' 2 times
96
- DuplicateMethodCall: OptionParser#parse_in_order calls 'cb.call(val)' 2 times
97
- DuplicateMethodCall: OptionParser#parse_in_order calls 'raise $!.set_option(arg, true)' 2 times
98
- DuplicateMethodCall: OptionParser#parse_in_order calls 'raise(*exc)' 2 times
99
- DuplicateMethodCall: OptionParser#parse_in_order calls 'setter.call(sw.switch_name, val)' 2 times
100
- DuplicateMethodCall: OptionParser#parse_in_order calls 'sw.block' 2 times
101
- DuplicateMethodCall: OptionParser#parse_in_order calls 'sw.switch_name' 2 times
102
- DuplicateMethodCall: OptionParser#permute calls 'argv[0]' 2 times
103
- DuplicateMethodCall: OptionParser::Completion#complete calls 'candidates.size' 2 times
104
- DuplicateMethodCall: OptionParser::Completion#complete calls 'k.id2name' 2 times
105
- DuplicateMethodCall: OptionParser::Switch#parse_arg calls 's.length' 2 times
106
- DuplicateMethodCall: OptionParser::Switch#summarize calls 'indent + l' 2 times
107
- DuplicateMethodCall: OptionParser::Switch#summarize calls 'left.collect {|s| s.length}' 2 times
108
- DuplicateMethodCall: OptionParser::Switch#summarize calls 'left.collect {|s| s.length}.max' 2 times
109
- DuplicateMethodCall: OptionParser::Switch#summarize calls 'left.collect {|s| s.length}.max.to_i' 2 times
110
- DuplicateMethodCall: OptionParser::Switch#summarize calls 'left.collect' 2 times
111
- DuplicateMethodCall: OptionParser::Switch#summarize calls 'left.shift' 2 times
112
- DuplicateMethodCall: OptionParser::Switch#summarize calls 'left[-1]' 3 times
113
- DuplicateMethodCall: OptionParser::Switch#summarize calls 's.length' 3 times
114
- FeatureEnvy: OptionParser#order refers to 'argv' more than self (maybe move it to another class?)
115
- FeatureEnvy: OptionParser#parse refers to 'argv' more than self (maybe move it to another class?)
116
- FeatureEnvy: OptionParser#permute refers to 'argv' more than self (maybe move it to another class?)
117
- FeatureEnvy: OptionParser::Completion#complete refers to 'candidates' more than self (maybe move it to another class?)
118
- FeatureEnvy: OptionParser::List#accept refers to 'pat' more than self (maybe move it to another class?)
119
- FeatureEnvy: OptionParser::List#add_banner refers to 'opt' more than self (maybe move it to another class?)
120
- FeatureEnvy: OptionParser::List#summarize refers to 'opt' more than self (maybe move it to another class?)
121
- InstanceVariableAssumption: OptionParser assumes too much for instance variable '@release'
122
- InstanceVariableAssumption: OptionParser assumes too much for instance variable '@version'
123
- LongParameterList: OptionParser#complete has 4 parameters
124
- LongParameterList: OptionParser#summarize has 4 parameters
125
- LongParameterList: OptionParser::List#complete has 4 parameters
126
- LongParameterList: OptionParser::List#update has 5 parameters
127
- LongParameterList: OptionParser::Switch#initialize has 7 parameters
128
- LongParameterList: OptionParser::Switch#summarize has 5 parameters
129
- ManualDispatch: OptionParser#make_switch manually dispatches method call
130
- ManualDispatch: OptionParser::List#accept manually dispatches method call
131
- ManualDispatch: OptionParser::List#add_banner manually dispatches method call
132
- ManualDispatch: OptionParser::List#summarize manually dispatches method call
133
- ModuleInitialize: OptionParser::Arguable has initialize method
134
- NestedIterators: OptionParser#make_switch contains iterators nested 2 deep
135
- NilCheck: OptionParser#make_switch performs a nil-check
136
- NilCheck: OptionParser#self.inc performs a nil-check
137
- RepeatedConditional: OptionParser tests 'a' at least 7 times
138
- RepeatedConditional: OptionParser tests 'argv.size == 1 and Array === argv[0]' at least 3 times
139
- RepeatedConditional: OptionParser tests 'default_pattern' at least 7 times
140
- RepeatedConditional: OptionParser tests 'not_style' at least 3 times
141
- RepeatedConditional: OptionParser tests 's' at least 7 times
142
- SubclassedFromCoreClass: OptionParser::CompletingHash inherits from core class 'Hash'
143
- SubclassedFromCoreClass: OptionParser::OptionMap inherits from core class 'Hash'
144
- TooManyConstants: OptionParser has 16 constants
145
- TooManyInstanceVariables: OptionParser has at least 6 instance variables
146
- TooManyInstanceVariables: OptionParser::Switch has at least 7 instance variables
147
- TooManyMethods: OptionParser has at least 42 methods
148
- TooManyStatements: OptionParser#complete has approx 6 statements
149
- TooManyStatements: OptionParser#getopts has approx 18 statements
150
- TooManyStatements: OptionParser#load has approx 6 statements
151
- TooManyStatements: OptionParser#make_switch has approx 72 statements
152
- TooManyStatements: OptionParser#parse_in_order has approx 35 statements
153
- TooManyStatements: OptionParser#permute! has approx 6 statements
154
- TooManyStatements: OptionParser::Arguable#options has approx 6 statements
155
- TooManyStatements: OptionParser::Completion#complete has approx 23 statements
156
- TooManyStatements: OptionParser::List#update has approx 10 statements
157
- TooManyStatements: OptionParser::Switch#parse_arg has approx 11 statements
158
- TooManyStatements: OptionParser::Switch#self.guess has approx 6 statements
159
- TooManyStatements: OptionParser::Switch#summarize has approx 28 statements
160
- TooManyStatements: OptionParser::Switch::PlacedArgument#parse has approx 6 statements
161
- UncommunicativeParameterName: OptionParser::List#accept has the parameter name 't'
162
- UncommunicativeParameterName: OptionParser::List#reject has the parameter name 't'
163
- UncommunicativeParameterName: OptionParser::Switch#self.incompatible_argument_styles has the parameter name 't'
164
- UncommunicativeVariableName: OptionParser has the variable name 'f'
165
- UncommunicativeVariableName: OptionParser has the variable name 'k'
166
- UncommunicativeVariableName: OptionParser has the variable name 'o'
167
- UncommunicativeVariableName: OptionParser has the variable name 's'
168
- UncommunicativeVariableName: OptionParser has the variable name 'v'
169
- UncommunicativeVariableName: OptionParser#load has the variable name 's'
170
- UncommunicativeVariableName: OptionParser#make_switch has the variable name 'a'
171
- UncommunicativeVariableName: OptionParser#make_switch has the variable name 'c'
172
- UncommunicativeVariableName: OptionParser#make_switch has the variable name 'n'
173
- UncommunicativeVariableName: OptionParser#make_switch has the variable name 'o'
174
- UncommunicativeVariableName: OptionParser#make_switch has the variable name 'q'
175
- UncommunicativeVariableName: OptionParser#make_switch has the variable name 's'
176
- UncommunicativeVariableName: OptionParser#make_switch has the variable name 'v'
177
- UncommunicativeVariableName: OptionParser#search has the variable name 'k'
178
- UncommunicativeVariableName: OptionParser#summarize has the variable name 'l'
179
- UncommunicativeVariableName: OptionParser#ver has the variable name 'v'
180
- UncommunicativeVariableName: OptionParser::Completion#complete has the variable name 'k'
181
- UncommunicativeVariableName: OptionParser::Completion#complete has the variable name 'v'
182
- UncommunicativeVariableName: OptionParser::List#update has the variable name 'o'
183
- UncommunicativeVariableName: OptionParser::Switch#add_banner has the variable name 's'
184
- UncommunicativeVariableName: OptionParser::Switch#parse_arg has the variable name 'm'
185
- UncommunicativeVariableName: OptionParser::Switch#parse_arg has the variable name 's'
186
- UncommunicativeVariableName: OptionParser::Switch#self.guess has the variable name 't'
187
- UncommunicativeVariableName: OptionParser::Switch#summarize has the variable name 'l'
188
- UncommunicativeVariableName: OptionParser::Switch#summarize has the variable name 'r'
189
- UncommunicativeVariableName: OptionParser::Switch#summarize has the variable name 's'
190
- UnusedParameters: OptionParser::Completion#convert has unused parameter 'opt'
191
- UnusedParameters: OptionParser::Switch::NoArgument#parse has unused parameter 'argv'
192
- UnusedParameters: OptionParser::Switch::OptionalArgument#parse has unused parameter 'argv'
193
- redcloth.rb -- 110 warnings:
194
- Attribute: RedCloth#filter_html is a writable attribute
195
- Attribute: RedCloth#filter_styles is a writable attribute
196
- Attribute: RedCloth#hard_breaks is a writable attribute
197
- Attribute: RedCloth#lite_mode is a writable attribute
198
- Attribute: RedCloth#no_span_caps is a writable attribute
199
- Attribute: RedCloth#rules is a writable attribute
200
- BooleanParameter: RedCloth#blocks has boolean parameter 'deep_code'
201
- ControlParameter: RedCloth#blocks is controlled by argument 'deep_code'
202
- ControlParameter: RedCloth#htmlesc is controlled by argument 'mode'
203
- ControlParameter: RedCloth#lT is controlled by argument 'text'
204
- ControlParameter: RedCloth#pba is controlled by argument 'element'
205
- DataClump: RedCloth takes parameters ['atts', 'cite', 'content', 'tag'] to 3 methods
206
- DuplicateMethodCall: RedCloth#block_textile_lists calls 'depth.last' 5 times
207
- DuplicateMethodCall: RedCloth#block_textile_lists calls 'depth.last.length' 2 times
208
- DuplicateMethodCall: RedCloth#block_textile_lists calls 'depth[i]' 2 times
209
- DuplicateMethodCall: RedCloth#block_textile_lists calls 'line_id - 1' 2 times
210
- DuplicateMethodCall: RedCloth#block_textile_lists calls 'lines[line_id - 1]' 2 times
211
- DuplicateMethodCall: RedCloth#block_textile_lists calls 'tl.length' 3 times
212
- DuplicateMethodCall: RedCloth#clean_html calls 'tags[tag]' 2 times
213
- DuplicateMethodCall: RedCloth#pba calls '$1.length' 2 times
214
- DuplicateMethodCall: RedCloth#rip_offtags calls '@pre_list.last << line' 2 times
215
- DuplicateMethodCall: RedCloth#rip_offtags calls '@pre_list.last' 2 times
216
- DuplicateMethodCall: RedCloth#rip_offtags calls 'codepre - used_offtags.length > 0' 2 times
217
- DuplicateMethodCall: RedCloth#rip_offtags calls 'codepre - used_offtags.length' 2 times
218
- DuplicateMethodCall: RedCloth#rip_offtags calls 'codepre.zero?' 2 times
219
- DuplicateMethodCall: RedCloth#rip_offtags calls 'htmlesc( line, :NoQuotes )' 2 times
220
- DuplicateMethodCall: RedCloth#rip_offtags calls 'used_offtags.length' 2 times
221
- DuplicateMethodCall: RedCloth#rip_offtags calls 'used_offtags['notextile']' 3 times
222
- FeatureEnvy: RedCloth#block_markdown_atx refers to 'text' more than self (maybe move it to another class?)
223
- FeatureEnvy: RedCloth#block_markdown_setext refers to 'text' more than self (maybe move it to another class?)
224
- FeatureEnvy: RedCloth#block_textile_lists refers to 'depth' more than self (maybe move it to another class?)
225
- FeatureEnvy: RedCloth#blocks refers to 'blk' more than self (maybe move it to another class?)
226
- FeatureEnvy: RedCloth#clean_white_space refers to 'text' more than self (maybe move it to another class?)
227
- FeatureEnvy: RedCloth#pba refers to 'text' more than self (maybe move it to another class?)
228
- InstanceVariableAssumption: RedCloth assumes too much for instance variable '@lite_mode'
229
- InstanceVariableAssumption: RedCloth assumes too much for instance variable '@pre_list'
230
- InstanceVariableAssumption: RedCloth assumes too much for instance variable '@rules'
231
- InstanceVariableAssumption: RedCloth assumes too much for instance variable '@shelf'
232
- InstanceVariableAssumption: RedCloth assumes too much for instance variable '@urlrefs'
233
- LongParameterList: RedCloth#textile_bq has 4 parameters
234
- LongParameterList: RedCloth#textile_fn_ has 5 parameters
235
- LongParameterList: RedCloth#textile_p has 4 parameters
236
- ManualDispatch: RedCloth#block_textile_prefix manually dispatches method call
237
- NestedIterators: RedCloth#block_textile_lists contains iterators nested 3 deep
238
- NestedIterators: RedCloth#block_textile_table contains iterators nested 2 deep
239
- NestedIterators: RedCloth#block_textile_table contains iterators nested 3 deep
240
- NestedIterators: RedCloth#blocks contains iterators nested 2 deep
241
- NestedIterators: RedCloth#clean_html contains iterators nested 2 deep
242
- NestedIterators: RedCloth#inline contains iterators nested 2 deep
243
- NestedIterators: RedCloth#inline_textile_span contains iterators nested 2 deep
244
- RepeatedConditional: RedCloth tests 'atts' at least 6 times
245
- RepeatedConditional: RedCloth tests 'codepre.zero?' at least 3 times
246
- RepeatedConditional: RedCloth tests 'href' at least 3 times
247
- RepeatedConditional: RedCloth tests 'title' at least 4 times
248
- SubclassedFromCoreClass: RedCloth inherits from core class 'String'
249
- TooManyConstants: RedCloth has 45 constants
250
- TooManyMethods: RedCloth has at least 44 methods
251
- TooManyStatements: RedCloth#block_markdown_bq has approx 6 statements
252
- TooManyStatements: RedCloth#block_textile_lists has approx 21 statements
253
- TooManyStatements: RedCloth#block_textile_table has approx 19 statements
254
- TooManyStatements: RedCloth#blocks has approx 19 statements
255
- TooManyStatements: RedCloth#clean_html has approx 15 statements
256
- TooManyStatements: RedCloth#clean_white_space has approx 7 statements
257
- TooManyStatements: RedCloth#glyphs_textile has approx 10 statements
258
- TooManyStatements: RedCloth#inline_markdown_link has approx 6 statements
259
- TooManyStatements: RedCloth#inline_markdown_reflink has approx 8 statements
260
- TooManyStatements: RedCloth#inline_textile_image has approx 17 statements
261
- TooManyStatements: RedCloth#inline_textile_link has approx 9 statements
262
- TooManyStatements: RedCloth#inline_textile_span has approx 9 statements
263
- TooManyStatements: RedCloth#pba has approx 21 statements
264
- TooManyStatements: RedCloth#rip_offtags has approx 18 statements
265
- TooManyStatements: RedCloth#to_html has approx 26 statements
266
- UncommunicativeMethodName: RedCloth#lT has the name 'lT'
267
- UncommunicativeParameterName: RedCloth#textile_popup_help has the parameter name 'windowH'
268
- UncommunicativeParameterName: RedCloth#textile_popup_help has the parameter name 'windowW'
269
- UncommunicativeVariableName: RedCloth has the variable name 'a'
270
- UncommunicativeVariableName: RedCloth has the variable name 'b'
271
- UncommunicativeVariableName: RedCloth#block_textile_lists has the variable name 'i'
272
- UncommunicativeVariableName: RedCloth#block_textile_lists has the variable name 'v'
273
- UncommunicativeVariableName: RedCloth#block_textile_table has the variable name 'x'
274
- UncommunicativeVariableName: RedCloth#clean_html has the variable name 'q'
275
- UncommunicativeVariableName: RedCloth#clean_html has the variable name 'q2'
276
- UncommunicativeVariableName: RedCloth#initialize has the variable name 'r'
277
- UncommunicativeVariableName: RedCloth#inline_markdown_link has the variable name 'm'
278
- UncommunicativeVariableName: RedCloth#inline_markdown_reflink has the variable name 'm'
279
- UncommunicativeVariableName: RedCloth#inline_textile_code has the variable name 'm'
280
- UncommunicativeVariableName: RedCloth#inline_textile_image has the variable name 'href_a1'
281
- UncommunicativeVariableName: RedCloth#inline_textile_image has the variable name 'href_a2'
282
- UncommunicativeVariableName: RedCloth#inline_textile_image has the variable name 'm'
283
- UncommunicativeVariableName: RedCloth#inline_textile_link has the variable name 'm'
284
- UncommunicativeVariableName: RedCloth#inline_textile_span has the variable name 'm'
285
- UncommunicativeVariableName: RedCloth#refs_markdown has the variable name 'm'
286
- UncommunicativeVariableName: RedCloth#refs_textile has the variable name 'm'
287
- UncommunicativeVariableName: RedCloth#retrieve has the variable name 'i'
288
- UncommunicativeVariableName: RedCloth#retrieve has the variable name 'r'
289
- UnusedParameters: RedCloth#block_markdown_lists has unused parameter 'text'
290
- UnusedParameters: RedCloth#textile_bq has unused parameter 'tag'
291
- UnusedParameters: RedCloth#textile_fn_ has unused parameter 'cite'
292
- UnusedParameters: RedCloth#textile_fn_ has unused parameter 'tag'
293
- UnusedParameters: RedCloth#textile_p has unused parameter 'cite'
294
- UtilityFunction: RedCloth#block_markdown_rule doesn't depend on instance state (maybe move it to another class?)
295
- UtilityFunction: RedCloth#clean_html doesn't depend on instance state (maybe move it to another class?)
296
- UtilityFunction: RedCloth#flush_left doesn't depend on instance state (maybe move it to another class?)
297
- UtilityFunction: RedCloth#footnote_ref doesn't depend on instance state (maybe move it to another class?)
298
- UtilityFunction: RedCloth#h_align doesn't depend on instance state (maybe move it to another class?)
299
- UtilityFunction: RedCloth#htmlesc doesn't depend on instance state (maybe move it to another class?)
300
- UtilityFunction: RedCloth#incoming_entities doesn't depend on instance state (maybe move it to another class?)
301
- UtilityFunction: RedCloth#lT doesn't depend on instance state (maybe move it to another class?)
302
- UtilityFunction: RedCloth#no_textile doesn't depend on instance state (maybe move it to another class?)
303
- UtilityFunction: RedCloth#v_align doesn't depend on instance state (maybe move it to another class?)
304
- 287 total warnings
305
- """
@@ -1,5 +0,0 @@
1
- inherit_from: ../../.rubocop.yml
2
-
3
- # Allow common When <regexp> syntax
4
- Lint/AmbiguousRegexpLiteral:
5
- Enabled: false
@@ -1,102 +0,0 @@
1
- When /^I run reek (.*)$/ do |args|
2
- reek(args)
3
- end
4
-
5
- When 'I run the code climate reek runner' do
6
- run_command_and_stop 'code_climate_reek'
7
- end
8
-
9
- When /^I pass "([^"]*)" to reek *(.*)$/ do |stdin, args|
10
- reek_with_pipe(stdin, args)
11
- end
12
-
13
- When /^I pass a stdin to reek *(.*) with:$/ do |args, stdin|
14
- reek_with_pipe(stdin, args)
15
- end
16
-
17
- Then /^it reports nothing$/ do
18
- expect(last_command_started).to have_output_on_stdout('')
19
- end
20
-
21
- Then /^there is no output on stdout$/ do
22
- expect(last_command_started).to have_output_on_stdout('')
23
- end
24
-
25
- Then /^stdout includes "(.*)"$/ do |text|
26
- expect(last_command_started).to have_output_on_stdout(/#{Regexp.escape(text)}/)
27
- end
28
-
29
- Then /^it succeeds$/ do
30
- success = Reek::CLI::Status::DEFAULT_SUCCESS_EXIT_CODE
31
- expect(last_command_started).to have_exit_status(success)
32
- end
33
-
34
- Then /^the exit status indicates an error$/ do
35
- error = Reek::CLI::Status::DEFAULT_ERROR_EXIT_CODE
36
- expect(last_command_started).to have_exit_status(error)
37
- end
38
-
39
- Then /^the exit status indicates smells$/ do
40
- smells = Reek::CLI::Status::DEFAULT_FAILURE_EXIT_CODE
41
- expect(last_command_started).to have_exit_status(smells)
42
- end
43
-
44
- Then(/^the exit status is (\d+)$/) do |status|
45
- expect(last_command_started).to have_exit_status(status.to_i)
46
- end
47
-
48
- Then /^it reports:$/ do |report|
49
- expect(last_command_started).to have_output_on_stdout(report.gsub('\n', "\n"))
50
- end
51
-
52
- Then /^it reports this yaml:$/ do |expected_yaml|
53
- expected_warnings = YAML.safe_load(expected_yaml.chomp)
54
- actual_warnings = YAML.safe_load(last_command_started.stdout)
55
- expect(actual_warnings).to eq expected_warnings
56
- end
57
-
58
- Then /^it reports this JSON:$/ do |expected_json|
59
- expected_warnings = JSON.parse(expected_json.chomp)
60
- actual_warnings = JSON.parse(last_command_started.stdout)
61
- expect(actual_warnings).to eq expected_warnings
62
- end
63
-
64
- Then /^stderr reports:$/ do |report|
65
- expect(last_command_started).to have_output_on_stderr(report.chomp)
66
- end
67
-
68
- Then /^it reports no errors$/ do
69
- expect(last_command_started).to have_output_on_stderr('')
70
- end
71
-
72
- Then /^it reports an error$/ do
73
- expect(last_command_started.stderr).to_not be_empty
74
- end
75
-
76
- Then /^it reports the error ['"](.*)['"]$/ do |string|
77
- expect(last_command_started).to have_output_on_stderr(/#{Regexp.escape(string)}/)
78
- end
79
-
80
- Then /^it reports a parsing error$/ do
81
- expect(last_command_started).to have_output_on_stderr(/Parser::SyntaxError/)
82
- end
83
-
84
- Then /^it should indicate the line numbers of those smells$/ do
85
- expect(last_command_started).to have_output(/\[.*\]:/)
86
- end
87
-
88
- Then /^it reports the current version$/ do
89
- expect(last_command_started).to have_output("reek #{Reek::Version::STRING}")
90
- end
91
-
92
- Then /^it reports this Code Climate output:$/ do |expected_output|
93
- expected_issues = expected_output.split('NULL_BYTE_CHARACTER').map do |issue|
94
- JSON.parse(issue)
95
- end
96
-
97
- actual_issues = last_command_started.stdout.split("\0").map do |issue|
98
- JSON.parse(issue)
99
- end
100
-
101
- expect(actual_issues).to eq(expected_issues)
102
- end
@@ -1,63 +0,0 @@
1
- require_relative '../../samples/paths'
2
-
3
- Given(/^the smelly file '(.+)'$/) do |filename|
4
- write_file(filename, SAMPLES_DIR.join('smelly_source').join(filename).read)
5
- end
6
-
7
- Given(/^the smelly file "(.+)" in the directory "(.+)"$/) do |filename, directory|
8
- FileUtils.mkdir_p directory
9
- write_file Pathname(directory).join(filename).to_s,
10
- SAMPLES_DIR.join('smelly_source').join(filename).read
11
- end
12
-
13
- Given(/^the clean file "(.*)"$/) do |filename|
14
- write_file(filename, CLEAN_FILE.read)
15
- end
16
-
17
- Given(/^a directory called 'clean' containing two clean files$/) do
18
- contents = CLEAN_FILE.read
19
-
20
- write_file('clean/clean_one.rb', contents)
21
- write_file('clean/clean_two.rb', contents)
22
- end
23
-
24
- Given(/^a directory called 'mixed_files' containing some clean and smelly files$/) do
25
- write_file('mixed_files/clean.rb', CLEAN_FILE.read)
26
- write_file('mixed_files/dirty.rb', SMELLY_FILE.read)
27
- end
28
-
29
- Given(/^a directory called 'smelly' containing two smelly files$/) do
30
- contents = SMELLY_FILE.read
31
-
32
- write_file('smelly/dirty_one.rb', contents)
33
- write_file('smelly/dirty_two.rb', contents)
34
- end
35
-
36
- Given(/^the smelly file '(.+)' in a subdirectory$/) do |filename|
37
- contents = SAMPLES_DIR.join('smelly_source').join(filename).read
38
-
39
- write_file("subdir/#{filename}", contents)
40
- end
41
-
42
- Given(/^a configuration file '(.+)'$/) do |filename|
43
- write_file(filename, CONFIGURATION_DIR.join(filename).read)
44
- end
45
-
46
- Given(/^our default configuration file$/) do
47
- default_configuration = File.read Reek::DEFAULT_SMELL_CONFIGURATION
48
- write_file('defaults.reek.yml', default_configuration)
49
- end
50
-
51
- When(/^I run "reek (.*?)" in a subdirectory$/) do |args|
52
- cd 'subdir'
53
-
54
- reek(args)
55
- end
56
-
57
- Then(/^it does not report private or protected methods$/) do
58
- # Pseudo step for feature clarity.
59
- end
60
-
61
- Given('with a configuration file that is further up in the directory tree') do
62
- # Pseudo step for feature clarity. We have an empty .reek.yml in our root directory already.
63
- end
@@ -1,33 +0,0 @@
1
- require_relative '../../lib/reek'
2
- require_relative '../../lib/reek/cli/application'
3
- require 'aruba/cucumber'
4
-
5
- begin
6
- require 'pry-byebug'
7
- rescue LoadError # rubocop:disable Lint/SuppressedException
8
- end
9
-
10
- #
11
- # Provides runner methods used in the cucumber steps.
12
- #
13
- class ReekWorld
14
- def reek(args)
15
- run_command_and_stop("reek --no-color --no-documentation #{args}", fail_on_error: false)
16
- end
17
-
18
- def reek_with_pipe(stdin, args)
19
- run_command "reek --no-color --no-documentation #{args}"
20
- type(stdin)
21
- close_input
22
- end
23
- end
24
-
25
- World do
26
- ReekWorld.new
27
- end
28
-
29
- Before do
30
- Aruba.configure do |config|
31
- config.exit_timeout = 30
32
- end
33
- end
@@ -1,108 +0,0 @@
1
- Feature: Auto-generate a todo file
2
- Write a Reek configuration as a kind of todo list that will prevent Reek
3
- from reporting smells on the current code. This can then be worked on later on.
4
- The main goal here would be to ease the Reek adoption by allowing developers to
5
- introduce Reek right away (e.g. for CI), exclude the "old" smells from getting reported
6
- and then fix them step by step.
7
-
8
- Scenario: Generate the default configuration file that disables all found smells
9
- Given the smelly file 'smelly.rb'
10
- When I run reek smelly.rb
11
- Then the exit status indicates smells
12
- And it reports:
13
- """
14
- smelly.rb -- 2 warnings:
15
- [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
16
- [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
17
- """
18
- When I run reek --todo smelly.rb
19
- Then it succeeds
20
- And it reports:
21
- """
22
-
23
- '.reek.yml' generated! You can now use this as a starting point.
24
- """
25
- And a file named ".reek.yml" should exist
26
- And the file ".reek.yml" should contain:
27
- """
28
- ---
29
- detectors:
30
- UncommunicativeMethodName:
31
- exclude:
32
- - Smelly#x
33
- UncommunicativeVariableName:
34
- exclude:
35
- - Smelly#x
36
- """
37
- When I run reek smelly.rb
38
- Then it succeeds
39
-
40
- Scenario: Reacts appropiately when there are no smells
41
- Given the clean file "clean.rb"
42
- When I run reek --todo clean.rb
43
- Then a file named ".reek.yml" should not exist
44
- And it reports:
45
- """
46
-
47
- No smells found - nothing to do, exiting.
48
- """
49
-
50
- Scenario: Don't overwrite existing .reek.yml files
51
- Given the smelly file 'smelly.rb'
52
- And a file named ".reek.yml" with:
53
- """
54
- ---
55
- detectors:
56
- UncommunicativeMethodName:
57
- enabled: false
58
- """
59
- When I run reek smelly.rb
60
- Then it reports:
61
- """
62
- smelly.rb -- 1 warning:
63
- [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
64
- """
65
- When I run reek --todo smelly.rb
66
- Then it reports:
67
- """
68
-
69
- Existing '.reek.yml' detected - aborting.
70
- """
71
- When I run reek smelly.rb
72
- Then it reports:
73
- """
74
- smelly.rb -- 1 warning:
75
- [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
76
- """
77
-
78
- Scenario: Ignore existing other configuration files that are passed explicitly
79
- Given the smelly file 'smelly.rb'
80
- And a file named "config.reek" with:
81
- """
82
- ---
83
- detectors:
84
- UncommunicativeMethodName:
85
- enabled: false
86
- """
87
- When I run reek -c config.reek smelly.rb
88
- Then it reports:
89
- """
90
- smelly.rb -- 1 warning:
91
- [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
92
- """
93
- When I run reek -c config.reek --todo smelly.rb
94
- Then it succeeds
95
- And a file named ".reek.yml" should exist
96
- And the file ".reek.yml" should contain:
97
- """
98
- ---
99
- detectors:
100
- UncommunicativeMethodName:
101
- exclude:
102
- - Smelly#x
103
- UncommunicativeVariableName:
104
- exclude:
105
- - Smelly#x
106
- """
107
- When I run reek smelly.rb
108
- Then it reports nothing
@@ -1,7 +0,0 @@
1
- <?xml version='1.0'?>
2
- <checkstyle>
3
- <file name='samples/smelly_source/smelly.rb'>
4
- <error column='0' line='4' message='has the name &apos;x&apos;' severity='warning' source='UncommunicativeMethodName'/>
5
- <error column='0' line='5' message='has the variable name &apos;y&apos;' severity='warning' source='UncommunicativeVariableName'/>
6
- </file>
7
- </checkstyle>
@@ -1,6 +0,0 @@
1
- # Well documented Clean class.
2
- class Clean
3
- def hello(argument)
4
- say argument
5
- end
6
- end