reek 6.0.3 → 6.0.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +6 -1
- data/CONTRIBUTING.md +3 -0
- data/Dockerfile +1 -1
- data/Gemfile +6 -6
- data/lib/reek/ast/ast_node_class_map.rb +1 -1
- data/lib/reek/report/code_climate/code_climate_formatter.rb +1 -3
- data/lib/reek/smell_detectors/base_detector.rb +1 -1
- data/lib/reek/smell_warning.rb +1 -1
- data/lib/reek/source/source_locator.rb +1 -3
- data/lib/reek/version.rb +1 -1
- data/reek.gemspec +4 -1
- metadata +3 -208
- data/docs/API.md +0 -174
- data/docs/Attribute.md +0 -39
- data/docs/Basic-Smell-Options.md +0 -85
- data/docs/Boolean-Parameter.md +0 -54
- data/docs/Class-Variable.md +0 -40
- data/docs/Code-Smells.md +0 -39
- data/docs/Command-Line-Options.md +0 -119
- data/docs/Control-Couple.md +0 -26
- data/docs/Control-Parameter.md +0 -32
- data/docs/Data-Clump.md +0 -46
- data/docs/Duplicate-Method-Call.md +0 -264
- data/docs/Feature-Envy.md +0 -93
- data/docs/How-To-Write-New-Detectors.md +0 -132
- data/docs/How-reek-works-internally.md +0 -114
- data/docs/Instance-Variable-Assumption.md +0 -163
- data/docs/Irresponsible-Module.md +0 -47
- data/docs/Large-Class.md +0 -16
- data/docs/Long-Parameter-List.md +0 -39
- data/docs/Long-Yield-List.md +0 -37
- data/docs/Manual-Dispatch.md +0 -30
- data/docs/Missing-Safe-Method.md +0 -92
- data/docs/Module-Initialize.md +0 -62
- data/docs/Nested-Iterators.md +0 -59
- data/docs/Nil-Check.md +0 -47
- data/docs/RSpec-matchers.md +0 -129
- data/docs/Rake-Task.md +0 -66
- data/docs/Reek-4-to-Reek-5-migration.md +0 -188
- data/docs/Reek-Driven-Development.md +0 -46
- data/docs/Repeated-Conditional.md +0 -47
- data/docs/Simulated-Polymorphism.md +0 -16
- data/docs/Smell-Suppression.md +0 -96
- data/docs/Style-Guide.md +0 -19
- data/docs/Subclassed-From-Core-Class.md +0 -79
- data/docs/Too-Many-Constants.md +0 -37
- data/docs/Too-Many-Instance-Variables.md +0 -43
- data/docs/Too-Many-Methods.md +0 -56
- data/docs/Too-Many-Statements.md +0 -54
- data/docs/Uncommunicative-Method-Name.md +0 -94
- data/docs/Uncommunicative-Module-Name.md +0 -92
- data/docs/Uncommunicative-Name.md +0 -18
- data/docs/Uncommunicative-Parameter-Name.md +0 -90
- data/docs/Uncommunicative-Variable-Name.md +0 -96
- data/docs/Unused-Parameters.md +0 -28
- data/docs/Unused-Private-Method.md +0 -101
- data/docs/Utility-Function.md +0 -56
- data/docs/Versioning-Policy.md +0 -7
- data/docs/YAML-Reports.md +0 -93
- data/docs/defaults.reek.yml +0 -129
- data/docs/templates/default/docstring/html/public_api_marker.erb +0 -3
- data/docs/templates/default/docstring/setup.rb +0 -35
- data/docs/templates/default/fulldoc/html/css/common.css +0 -1
- data/docs/yard_plugin.rb +0 -17
- data/features/command_line_interface/basic_usage.feature +0 -15
- data/features/command_line_interface/options.feature +0 -123
- data/features/command_line_interface/show_progress.feature +0 -33
- data/features/command_line_interface/smell_selection.feature +0 -15
- data/features/command_line_interface/smells_count.feature +0 -38
- data/features/command_line_interface/stdin.feature +0 -65
- data/features/configuration_files/accept_setting.feature +0 -87
- data/features/configuration_files/directory_specific_directives.feature +0 -274
- data/features/configuration_files/exclude_directives.feature +0 -35
- data/features/configuration_files/exclude_paths_directives.feature +0 -42
- data/features/configuration_files/masking_smells.feature +0 -94
- data/features/configuration_files/mix_accept_reject_setting.feature +0 -84
- data/features/configuration_files/reject_setting.feature +0 -89
- data/features/configuration_files/schema_validation.feature +0 -59
- data/features/configuration_files/show_configuration_file.feature +0 -44
- data/features/configuration_files/unused_private_method.feature +0 -68
- data/features/configuration_loading.feature +0 -91
- data/features/configuration_via_source_comments/erroneous_source_comments.feature +0 -68
- data/features/configuration_via_source_comments/well_formed_source_comments.feature +0 -116
- data/features/locales.feature +0 -32
- data/features/programmatic_access.feature +0 -41
- data/features/rake_task/rake_task.feature +0 -138
- data/features/reports/codeclimate.feature +0 -59
- data/features/reports/json.feature +0 -59
- data/features/reports/reports.feature +0 -219
- data/features/reports/yaml.feature +0 -52
- data/features/rspec_matcher.feature +0 -41
- data/features/samples.feature +0 -305
- data/features/step_definitions/.rubocop.yml +0 -5
- data/features/step_definitions/reek_steps.rb +0 -102
- data/features/step_definitions/sample_file_steps.rb +0 -63
- data/features/support/env.rb +0 -33
- data/features/todo_list.feature +0 -108
- data/samples/checkstyle.xml +0 -7
- data/samples/clean_source/clean.rb +0 -6
- data/samples/configuration/accepts_rejects_and_excludes_for_detectors.reek.yml +0 -29
- data/samples/configuration/accepts_rejects_and_excludes_for_directory_directives.reek.yml +0 -30
- data/samples/configuration/corrupt.reek +0 -1
- data/samples/configuration/empty.reek +0 -0
- data/samples/configuration/full_configuration.reek +0 -13
- data/samples/configuration/full_mask.reek +0 -6
- data/samples/configuration/home/home.reek.yml +0 -4
- data/samples/configuration/partial_mask.reek +0 -4
- data/samples/configuration/regular_configuration/.reek.yml +0 -4
- data/samples/configuration/regular_configuration/empty_sub_directory/.gitignore +0 -0
- data/samples/configuration/with_excluded_paths.reek +0 -5
- data/samples/no_config_file/.keep +0 -0
- data/samples/paths.rb +0 -5
- data/samples/smelly_source/inline.rb +0 -704
- data/samples/smelly_source/optparse.rb +0 -1788
- data/samples/smelly_source/redcloth.rb +0 -1130
- data/samples/smelly_source/ruby.rb +0 -368
- data/samples/smelly_source/smelly.rb +0 -7
- data/samples/source_with_exclude_paths/ignore_me/uncommunicative_method_name.rb +0 -5
- data/samples/source_with_exclude_paths/nested/ignore_me_as_well/irresponsible_module.rb +0 -2
- data/samples/source_with_exclude_paths/nested/uncommunicative_parameter_name.rb +0 -6
- data/samples/source_with_exclude_paths/nested/uncommunicative_variable_name.rb +0 -6
- data/samples/source_with_hidden_directories/.hidden/hidden.rb +0 -1
- data/samples/source_with_hidden_directories/not_hidden.rb +0 -1
- data/samples/source_with_non_ruby_files/gibberish +0 -1
- data/samples/source_with_non_ruby_files/python_source.py +0 -1
- data/samples/source_with_non_ruby_files/ruby.rb +0 -6
- data/spec/performance/reek/smell_detectors/runtime_speed_spec.rb +0 -15
- data/spec/quality/documentation_spec.rb +0 -41
- data/spec/quality/reek_source_spec.rb +0 -11
- data/spec/reek/ast/node_spec.rb +0 -211
- data/spec/reek/ast/object_refs_spec.rb +0 -83
- data/spec/reek/ast/reference_collector_spec.rb +0 -47
- data/spec/reek/ast/sexp_extensions_spec.rb +0 -498
- data/spec/reek/cli/application_spec.rb +0 -168
- data/spec/reek/cli/command/report_command_spec.rb +0 -44
- data/spec/reek/cli/command/todo_list_command_spec.rb +0 -86
- data/spec/reek/cli/options_spec.rb +0 -51
- data/spec/reek/cli/silencer_spec.rb +0 -28
- data/spec/reek/code_comment_spec.rb +0 -184
- data/spec/reek/configuration/app_configuration_spec.rb +0 -195
- data/spec/reek/configuration/configuration_file_finder_spec.rb +0 -230
- data/spec/reek/configuration/default_directive_spec.rb +0 -13
- data/spec/reek/configuration/directory_directives_spec.rb +0 -122
- data/spec/reek/configuration/excluded_paths_spec.rb +0 -25
- data/spec/reek/configuration/rake_task_converter_spec.rb +0 -33
- data/spec/reek/configuration/schema_validator_spec.rb +0 -165
- data/spec/reek/context/code_context_spec.rb +0 -192
- data/spec/reek/context/ghost_context_spec.rb +0 -60
- data/spec/reek/context/method_context_spec.rb +0 -72
- data/spec/reek/context/module_context_spec.rb +0 -55
- data/spec/reek/context/root_context_spec.rb +0 -12
- data/spec/reek/context/statement_counter_spec.rb +0 -24
- data/spec/reek/context_builder_spec.rb +0 -457
- data/spec/reek/detector_repository_spec.rb +0 -22
- data/spec/reek/documentation_link_spec.rb +0 -20
- data/spec/reek/errors/base_error_spec.rb +0 -13
- data/spec/reek/examiner_spec.rb +0 -309
- data/spec/reek/logging_error_handler_spec.rb +0 -24
- data/spec/reek/rake/task_spec.rb +0 -56
- data/spec/reek/report/code_climate/code_climate_configuration_spec.rb +0 -22
- data/spec/reek/report/code_climate/code_climate_fingerprint_spec.rb +0 -126
- data/spec/reek/report/code_climate/code_climate_formatter_spec.rb +0 -51
- data/spec/reek/report/code_climate/code_climate_report_spec.rb +0 -56
- data/spec/reek/report/html_report_spec.rb +0 -19
- data/spec/reek/report/json_report_spec.rb +0 -58
- data/spec/reek/report/location_formatter_spec.rb +0 -32
- data/spec/reek/report/progress_formatter_spec.rb +0 -68
- data/spec/reek/report/text_report_spec.rb +0 -89
- data/spec/reek/report/xml_report_spec.rb +0 -24
- data/spec/reek/report/yaml_report_spec.rb +0 -55
- data/spec/reek/report_spec.rb +0 -28
- data/spec/reek/smell_configuration_spec.rb +0 -56
- data/spec/reek/smell_detectors/attribute_spec.rb +0 -197
- data/spec/reek/smell_detectors/base_detector_spec.rb +0 -50
- data/spec/reek/smell_detectors/boolean_parameter_spec.rb +0 -93
- data/spec/reek/smell_detectors/class_variable_spec.rb +0 -106
- data/spec/reek/smell_detectors/control_parameter_spec.rb +0 -300
- data/spec/reek/smell_detectors/data_clump_spec.rb +0 -134
- data/spec/reek/smell_detectors/duplicate_method_call_spec.rb +0 -211
- data/spec/reek/smell_detectors/feature_envy_spec.rb +0 -295
- data/spec/reek/smell_detectors/instance_variable_assumption_spec.rb +0 -96
- data/spec/reek/smell_detectors/irresponsible_module_spec.rb +0 -226
- data/spec/reek/smell_detectors/long_parameter_list_spec.rb +0 -61
- data/spec/reek/smell_detectors/long_yield_list_spec.rb +0 -49
- data/spec/reek/smell_detectors/manual_dispatch_spec.rb +0 -75
- data/spec/reek/smell_detectors/missing_safe_method_spec.rb +0 -68
- data/spec/reek/smell_detectors/module_initialize_spec.rb +0 -77
- data/spec/reek/smell_detectors/nested_iterators_spec.rb +0 -333
- data/spec/reek/smell_detectors/nil_check_spec.rb +0 -100
- data/spec/reek/smell_detectors/repeated_conditional_spec.rb +0 -100
- data/spec/reek/smell_detectors/subclassed_from_core_class_spec.rb +0 -77
- data/spec/reek/smell_detectors/too_many_constants_spec.rb +0 -144
- data/spec/reek/smell_detectors/too_many_instance_variables_spec.rb +0 -132
- data/spec/reek/smell_detectors/too_many_methods_spec.rb +0 -54
- data/spec/reek/smell_detectors/too_many_statements_spec.rb +0 -90
- data/spec/reek/smell_detectors/uncommunicative_method_name_spec.rb +0 -78
- data/spec/reek/smell_detectors/uncommunicative_module_name_spec.rb +0 -78
- data/spec/reek/smell_detectors/uncommunicative_parameter_name_spec.rb +0 -147
- data/spec/reek/smell_detectors/uncommunicative_variable_name_spec.rb +0 -201
- data/spec/reek/smell_detectors/unused_parameters_spec.rb +0 -114
- data/spec/reek/smell_detectors/unused_private_method_spec.rb +0 -205
- data/spec/reek/smell_detectors/utility_function_spec.rb +0 -309
- data/spec/reek/smell_warning_spec.rb +0 -137
- data/spec/reek/source/source_code_spec.rb +0 -79
- data/spec/reek/source/source_locator_spec.rb +0 -166
- data/spec/reek/spec/should_reek_of_spec.rb +0 -153
- data/spec/reek/spec/should_reek_only_of_spec.rb +0 -91
- data/spec/reek/spec/should_reek_spec.rb +0 -52
- data/spec/reek/spec/smell_matcher_spec.rb +0 -87
- data/spec/reek/tree_dresser_spec.rb +0 -46
- data/spec/spec_helper.rb +0 -110
- data/tasks/configuration.rake +0 -18
- data/tasks/console.rake +0 -5
- data/tasks/reek.rake +0 -6
- data/tasks/rubocop.rake +0 -11
- data/tasks/test.rake +0 -32
@@ -1,219 +0,0 @@
|
|
1
|
-
Feature: Correctly formatted reports
|
2
|
-
In order to get the most out of Reek
|
3
|
-
As a developer
|
4
|
-
I want to be able to parse Reek's output simply and consistently
|
5
|
-
|
6
|
-
Scenario Outline: two reports run together with indented smells
|
7
|
-
Given a directory called 'smelly' containing two smelly files
|
8
|
-
When I run reek <args>
|
9
|
-
Then the exit status indicates smells
|
10
|
-
And it reports:
|
11
|
-
"""
|
12
|
-
smelly/dirty_one.rb -- 2 warnings:
|
13
|
-
[4]:UncommunicativeMethodName: Smelly#x has the name 'x'
|
14
|
-
[5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
|
15
|
-
smelly/dirty_two.rb -- 2 warnings:
|
16
|
-
[4]:UncommunicativeMethodName: Smelly#x has the name 'x'
|
17
|
-
[5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
|
18
|
-
4 total warnings
|
19
|
-
"""
|
20
|
-
|
21
|
-
Examples:
|
22
|
-
| args |
|
23
|
-
| smelly/dirty_one.rb smelly/dirty_two.rb |
|
24
|
-
| smelly |
|
25
|
-
|
26
|
-
Scenario Outline: No sorting (which means report each file as it is read in)
|
27
|
-
Given a directory called 'smelly' containing two smelly files
|
28
|
-
When I run reek <option> smelly
|
29
|
-
Then the exit status indicates smells
|
30
|
-
And it reports:
|
31
|
-
"""
|
32
|
-
smelly/dirty_one.rb -- 2 warnings:
|
33
|
-
[4]:UncommunicativeMethodName: Smelly#x has the name 'x'
|
34
|
-
[5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
|
35
|
-
smelly/dirty_two.rb -- 2 warnings:
|
36
|
-
[4]:UncommunicativeMethodName: Smelly#x has the name 'x'
|
37
|
-
[5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
|
38
|
-
4 total warnings
|
39
|
-
"""
|
40
|
-
|
41
|
-
Examples:
|
42
|
-
| option |
|
43
|
-
| |
|
44
|
-
| --sort-by none |
|
45
|
-
| --sort-by n |
|
46
|
-
|
47
|
-
Scenario Outline: Sort by issue count
|
48
|
-
Given a directory called 'smelly' containing two smelly files
|
49
|
-
When I run reek <option> smelly
|
50
|
-
Then the exit status indicates smells
|
51
|
-
And it reports:
|
52
|
-
"""
|
53
|
-
smelly/dirty_two.rb -- 2 warnings:
|
54
|
-
[4]:UncommunicativeMethodName: Smelly#x has the name 'x'
|
55
|
-
[5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
|
56
|
-
smelly/dirty_one.rb -- 2 warnings:
|
57
|
-
[4]:UncommunicativeMethodName: Smelly#x has the name 'x'
|
58
|
-
[5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
|
59
|
-
4 total warnings
|
60
|
-
"""
|
61
|
-
|
62
|
-
Examples:
|
63
|
-
| option |
|
64
|
-
| --sort-by smelliness |
|
65
|
-
| --sort-by s |
|
66
|
-
|
67
|
-
Scenario: good files show no headings by default
|
68
|
-
Given a directory called 'clean' containing two clean files
|
69
|
-
When I run reek clean
|
70
|
-
Then it succeeds
|
71
|
-
And it reports:
|
72
|
-
"""
|
73
|
-
0 total warnings
|
74
|
-
"""
|
75
|
-
|
76
|
-
Scenario Outline: --empty-headings turns on headings for fragrant files
|
77
|
-
Given a directory called 'clean' containing two clean files
|
78
|
-
When I run reek <option> clean
|
79
|
-
Then it succeeds
|
80
|
-
And it reports:
|
81
|
-
"""
|
82
|
-
clean/clean_one.rb -- 0 warnings
|
83
|
-
clean/clean_two.rb -- 0 warnings
|
84
|
-
0 total warnings
|
85
|
-
"""
|
86
|
-
|
87
|
-
Examples:
|
88
|
-
| option |
|
89
|
-
| --empty-headings |
|
90
|
-
| -V |
|
91
|
-
|
92
|
-
Scenario Outline: --no-empty-headings turns off headings for fragrant files
|
93
|
-
Given a directory called 'clean' containing two clean files
|
94
|
-
When I run reek <option> clean
|
95
|
-
Then it succeeds
|
96
|
-
And it reports:
|
97
|
-
"""
|
98
|
-
0 total warnings
|
99
|
-
"""
|
100
|
-
|
101
|
-
Examples:
|
102
|
-
| option |
|
103
|
-
| --no-empty-headings |
|
104
|
-
| -V --no-empty-headings |
|
105
|
-
|
106
|
-
Scenario Outline: --no-line-numbers turns off line numbers
|
107
|
-
Given the smelly file 'smelly.rb'
|
108
|
-
When I run reek <option> smelly.rb
|
109
|
-
Then the exit status indicates smells
|
110
|
-
And it reports:
|
111
|
-
"""
|
112
|
-
smelly.rb -- 2 warnings:
|
113
|
-
UncommunicativeMethodName: Smelly#x has the name 'x'
|
114
|
-
UncommunicativeVariableName: Smelly#x has the variable name 'y'
|
115
|
-
"""
|
116
|
-
|
117
|
-
Examples:
|
118
|
-
| option |
|
119
|
-
| --no-line-numbers |
|
120
|
-
| --no-line-numbers -V |
|
121
|
-
| -V --no-line-numbers |
|
122
|
-
|
123
|
-
Scenario Outline: --line-numbers turns on line numbers
|
124
|
-
Given the smelly file 'smelly.rb'
|
125
|
-
When I run reek <option> smelly.rb
|
126
|
-
Then the exit status indicates smells
|
127
|
-
And it reports:
|
128
|
-
"""
|
129
|
-
smelly.rb -- 2 warnings:
|
130
|
-
[4]:UncommunicativeMethodName: Smelly#x has the name 'x'
|
131
|
-
[5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
|
132
|
-
"""
|
133
|
-
|
134
|
-
Examples:
|
135
|
-
| option |
|
136
|
-
| --line-numbers |
|
137
|
-
| --no-line-numbers --line-numbers |
|
138
|
-
| --no-line-numbers -n |
|
139
|
-
|
140
|
-
Scenario Outline: --single-line shows filename and one line number
|
141
|
-
Given the smelly file 'smelly.rb'
|
142
|
-
When I run reek <option> smelly.rb
|
143
|
-
Then the exit status indicates smells
|
144
|
-
And it reports:
|
145
|
-
"""
|
146
|
-
smelly.rb -- 2 warnings:
|
147
|
-
smelly.rb:4: UncommunicativeMethodName: Smelly#x has the name 'x'
|
148
|
-
smelly.rb:5: UncommunicativeVariableName: Smelly#x has the variable name 'y'
|
149
|
-
"""
|
150
|
-
|
151
|
-
Examples:
|
152
|
-
| option |
|
153
|
-
| -s |
|
154
|
-
| --single-line |
|
155
|
-
| -s -V |
|
156
|
-
| -V -s |
|
157
|
-
|
158
|
-
Scenario Outline: Extra slashes aren't added to directory names
|
159
|
-
Given a directory called 'smelly' containing two smelly files
|
160
|
-
When I run reek <args>
|
161
|
-
Then the exit status indicates smells
|
162
|
-
And it reports:
|
163
|
-
"""
|
164
|
-
smelly/dirty_one.rb -- 2 warnings:
|
165
|
-
[4]:UncommunicativeMethodName: Smelly#x has the name 'x'
|
166
|
-
[5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
|
167
|
-
smelly/dirty_two.rb -- 2 warnings:
|
168
|
-
[4]:UncommunicativeMethodName: Smelly#x has the name 'x'
|
169
|
-
[5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
|
170
|
-
4 total warnings
|
171
|
-
"""
|
172
|
-
|
173
|
-
Examples:
|
174
|
-
| args |
|
175
|
-
| smelly/ |
|
176
|
-
| smelly |
|
177
|
-
|
178
|
-
Scenario Outline: -U or --documentation adds helpful links to smell warnings
|
179
|
-
Given the smelly file 'smelly.rb'
|
180
|
-
When I run reek <option> smelly.rb
|
181
|
-
Then the exit status indicates smells
|
182
|
-
And it reports:
|
183
|
-
"""
|
184
|
-
smelly.rb -- 2 warnings:
|
185
|
-
[4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v6.0.3/docs/Uncommunicative-Method-Name.md]
|
186
|
-
[5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v6.0.3/docs/Uncommunicative-Variable-Name.md]
|
187
|
-
"""
|
188
|
-
|
189
|
-
Examples:
|
190
|
-
| option |
|
191
|
-
| -U |
|
192
|
-
| --documentation |
|
193
|
-
|
194
|
-
Scenario: --no-documentation drops links from smell warnings
|
195
|
-
Given the smelly file 'smelly.rb'
|
196
|
-
When I run reek --no-documentation smelly.rb
|
197
|
-
Then the exit status indicates smells
|
198
|
-
And it reports:
|
199
|
-
"""
|
200
|
-
smelly.rb -- 2 warnings:
|
201
|
-
[4]:UncommunicativeMethodName: Smelly#x has the name 'x'
|
202
|
-
[5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
|
203
|
-
"""
|
204
|
-
|
205
|
-
Scenario Outline: --documentation is independent of --line-numbers
|
206
|
-
Given the smelly file 'smelly.rb'
|
207
|
-
When I run reek <option> smelly.rb
|
208
|
-
Then the exit status indicates smells
|
209
|
-
And it reports:
|
210
|
-
"""
|
211
|
-
smelly.rb -- 2 warnings:
|
212
|
-
UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v6.0.3/docs/Uncommunicative-Method-Name.md]
|
213
|
-
UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v6.0.3/docs/Uncommunicative-Variable-Name.md]
|
214
|
-
"""
|
215
|
-
|
216
|
-
Examples:
|
217
|
-
| option |
|
218
|
-
| --no-line-numbers -U |
|
219
|
-
| --no-line-numbers --documentation |
|
@@ -1,52 +0,0 @@
|
|
1
|
-
Feature: Report smells using simple YAML layout
|
2
|
-
In order to parse Reek's output simply and consistently, simply
|
3
|
-
output a list of smells in Yaml.
|
4
|
-
|
5
|
-
Scenario: output is empty when there are no smells
|
6
|
-
Given a directory called 'clean' containing two clean files
|
7
|
-
When I run reek --format yaml clean
|
8
|
-
Then it succeeds
|
9
|
-
And it reports this yaml:
|
10
|
-
"""
|
11
|
-
--- []
|
12
|
-
"""
|
13
|
-
|
14
|
-
Scenario: Indicate smells and print them as yaml when using files
|
15
|
-
Given the smelly file 'smelly.rb'
|
16
|
-
When I run reek --format yaml smelly.rb
|
17
|
-
Then the exit status indicates smells
|
18
|
-
And it reports this yaml:
|
19
|
-
"""
|
20
|
-
---
|
21
|
-
- context: Smelly#x
|
22
|
-
lines:
|
23
|
-
- 4
|
24
|
-
message: has the name 'x'
|
25
|
-
smell_type: UncommunicativeMethodName
|
26
|
-
source: smelly.rb
|
27
|
-
name: x
|
28
|
-
documentation_link: https://github.com/troessner/reek/blob/v6.0.3/docs/Uncommunicative-Method-Name.md
|
29
|
-
- context: Smelly#x
|
30
|
-
lines:
|
31
|
-
- 5
|
32
|
-
message: has the variable name 'y'
|
33
|
-
smell_type: UncommunicativeVariableName
|
34
|
-
source: smelly.rb
|
35
|
-
name: y
|
36
|
-
documentation_link: https://github.com/troessner/reek/blob/v6.0.3/docs/Uncommunicative-Variable-Name.md
|
37
|
-
"""
|
38
|
-
|
39
|
-
Scenario: Indicate smells and print them as yaml when using STDIN
|
40
|
-
When I pass "class Turn; end" to reek --format yaml
|
41
|
-
Then the exit status indicates smells
|
42
|
-
And it reports this yaml:
|
43
|
-
"""
|
44
|
-
---
|
45
|
-
- smell_type: IrresponsibleModule
|
46
|
-
source: "STDIN"
|
47
|
-
context: Turn
|
48
|
-
lines:
|
49
|
-
- 1
|
50
|
-
message: has no descriptive comment
|
51
|
-
documentation_link: https://github.com/troessner/reek/blob/v6.0.3/docs/Irresponsible-Module.md
|
52
|
-
"""
|
@@ -1,41 +0,0 @@
|
|
1
|
-
Feature: Use reek_of matcher
|
2
|
-
As a developer
|
3
|
-
In order to check code quality as part of my spec suite
|
4
|
-
I want to assert that my code doesn't smell
|
5
|
-
|
6
|
-
Background:
|
7
|
-
Given the smelly file 'smelly.rb'
|
8
|
-
And a file "reek_spec.rb" with:
|
9
|
-
"""
|
10
|
-
require 'reek'
|
11
|
-
require 'reek/spec'
|
12
|
-
|
13
|
-
describe 'smelly.rb' do
|
14
|
-
it 'is clean' do
|
15
|
-
expect(Pathname.new('smelly.rb')).not_to reek
|
16
|
-
end
|
17
|
-
end
|
18
|
-
"""
|
19
|
-
|
20
|
-
Scenario: Failing on a smelly file
|
21
|
-
When I run `rspec reek_spec.rb`
|
22
|
-
Then stdout should contain:
|
23
|
-
"""
|
24
|
-
Failure/Error: expect(Pathname.new('smelly.rb')).not_to reek
|
25
|
-
"""
|
26
|
-
|
27
|
-
Scenario: Masking smells with a configuration file
|
28
|
-
Given a file named ".reek.yml" with:
|
29
|
-
"""
|
30
|
-
---
|
31
|
-
detectors:
|
32
|
-
UncommunicativeMethodName:
|
33
|
-
enabled: false
|
34
|
-
UncommunicativeVariableName:
|
35
|
-
enabled: false
|
36
|
-
"""
|
37
|
-
When I run `rspec reek_spec.rb`
|
38
|
-
Then stdout should contain:
|
39
|
-
"""
|
40
|
-
1 example, 0 failures
|
41
|
-
"""
|
data/features/samples.feature
DELETED
@@ -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
|
-
"""
|