rails_best_practices 1.19.5 → 1.22.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.travis.yml +1 -0
- data/CHANGELOG.md +10 -16
- data/Gemfile +2 -1
- data/Gemfile.lock +51 -45
- data/Guardfile +2 -0
- data/Rakefile +2 -17
- data/assets/result.html.erb +2 -0
- data/lib/rails_best_practices/analyzer.rb +59 -48
- data/lib/rails_best_practices/core/check.rb +39 -32
- data/lib/rails_best_practices/core/checks_loader.rb +8 -6
- data/lib/rails_best_practices/core/configs.rb +1 -2
- data/lib/rails_best_practices/core/controllers.rb +1 -2
- data/lib/rails_best_practices/core/error.rb +1 -1
- data/lib/rails_best_practices/core/helpers.rb +1 -2
- data/lib/rails_best_practices/core/mailers.rb +1 -2
- data/lib/rails_best_practices/core/methods.rb +21 -16
- data/lib/rails_best_practices/core/model_associations.rb +9 -4
- data/lib/rails_best_practices/core/models.rb +1 -2
- data/lib/rails_best_practices/core/modules.rb +1 -1
- data/lib/rails_best_practices/core/routes.rb +2 -2
- data/lib/rails_best_practices/core/runner.rb +49 -34
- data/lib/rails_best_practices/inline_disables/comment_ripper.rb +19 -0
- data/lib/rails_best_practices/inline_disables/inline_disable.rb +50 -0
- data/lib/rails_best_practices/inline_disables.rb +3 -0
- data/lib/rails_best_practices/lexicals/long_line_check.rb +7 -3
- data/lib/rails_best_practices/option_parser.rb +22 -6
- data/lib/rails_best_practices/prepares/controller_prepare.rb +15 -3
- data/lib/rails_best_practices/prepares/gemfile_prepare.rb +1 -1
- data/lib/rails_best_practices/prepares/helper_prepare.rb +6 -1
- data/lib/rails_best_practices/prepares/initializer_prepare.rb +2 -2
- data/lib/rails_best_practices/prepares/mailer_prepare.rb +1 -0
- data/lib/rails_best_practices/prepares/model_prepare.rb +52 -12
- data/lib/rails_best_practices/prepares/route_prepare.rb +16 -10
- data/lib/rails_best_practices/prepares.rb +1 -1
- data/lib/rails_best_practices/reviews/add_model_virtual_attribute_review.rb +15 -13
- data/lib/rails_best_practices/reviews/always_add_db_index_review.rb +36 -31
- data/lib/rails_best_practices/reviews/check_destroy_return_value_review.rb +14 -5
- data/lib/rails_best_practices/reviews/check_save_return_value_review.rb +19 -8
- data/lib/rails_best_practices/reviews/hash_syntax_review.rb +5 -5
- data/lib/rails_best_practices/reviews/isolate_seed_data_review.rb +4 -4
- data/lib/rails_best_practices/reviews/keep_finders_on_their_own_model_review.rb +7 -8
- data/lib/rails_best_practices/reviews/law_of_demeter_review.rb +6 -6
- data/lib/rails_best_practices/reviews/move_code_into_controller_review.rb +1 -1
- data/lib/rails_best_practices/reviews/move_code_into_helper_review.rb +6 -7
- data/lib/rails_best_practices/reviews/move_finder_to_named_scope_review.rb +7 -8
- data/lib/rails_best_practices/reviews/needless_deep_nesting_review.rb +12 -10
- data/lib/rails_best_practices/reviews/not_use_default_route_review.rb +1 -2
- data/lib/rails_best_practices/reviews/overuse_route_customizations_review.rb +5 -5
- data/lib/rails_best_practices/reviews/protect_mass_assignment_review.rb +5 -2
- data/lib/rails_best_practices/reviews/remove_unused_methods_in_controllers_review.rb +6 -3
- data/lib/rails_best_practices/reviews/remove_unused_methods_in_helpers_review.rb +6 -4
- data/lib/rails_best_practices/reviews/remove_unused_methods_in_models_review.rb +29 -9
- data/lib/rails_best_practices/reviews/replace_complex_creation_with_factory_method_review.rb +3 -3
- data/lib/rails_best_practices/reviews/restrict_auto_generated_routes_review.rb +17 -15
- data/lib/rails_best_practices/reviews/simplify_render_in_controllers_review.rb +1 -2
- data/lib/rails_best_practices/reviews/simplify_render_in_views_review.rb +3 -3
- data/lib/rails_best_practices/reviews/use_before_filter_review.rb +2 -1
- data/lib/rails_best_practices/reviews/use_model_association_review.rb +6 -6
- data/lib/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review.rb +9 -8
- data/lib/rails_best_practices/reviews/use_observer_review.rb +9 -9
- data/lib/rails_best_practices/reviews/use_query_attribute_review.rb +26 -26
- data/lib/rails_best_practices/reviews/use_say_with_time_in_migrations_review.rb +8 -7
- data/lib/rails_best_practices/reviews/use_scope_access_review.rb +17 -15
- data/lib/rails_best_practices/reviews/use_turbo_sprockets_rails3_review.rb +2 -1
- data/lib/rails_best_practices/version.rb +1 -1
- data/lib/rails_best_practices.rb +2 -2
- data/rails_best_practices.gemspec +35 -36
- data/spec/fixtures/lib/rails_best_practices/plugins/reviews/not_use_rails_root_review.rb +1 -2
- data/spec/rails_best_practices/analyzer_spec.rb +73 -42
- data/spec/rails_best_practices/core/check_spec.rb +5 -5
- data/spec/rails_best_practices/core/checks_loader_spec.rb +3 -3
- data/spec/rails_best_practices/core/configs_spec.rb +1 -1
- data/spec/rails_best_practices/core/controllers_spec.rb +1 -1
- data/spec/rails_best_practices/core/error_spec.rb +21 -21
- data/spec/rails_best_practices/core/except_methods_spec.rb +7 -7
- data/spec/rails_best_practices/core/gems_spec.rb +4 -4
- data/spec/rails_best_practices/core/helpers_spec.rb +1 -1
- data/spec/rails_best_practices/core/klasses_spec.rb +3 -3
- data/spec/rails_best_practices/core/mailers_spec.rb +1 -1
- data/spec/rails_best_practices/core/methods_spec.rb +6 -6
- data/spec/rails_best_practices/core/model_associations_spec.rb +10 -6
- data/spec/rails_best_practices/core/model_attributes_spec.rb +4 -4
- data/spec/rails_best_practices/core/models_spec.rb +1 -1
- data/spec/rails_best_practices/core/modules_spec.rb +5 -5
- data/spec/rails_best_practices/core/routes_spec.rb +5 -5
- data/spec/rails_best_practices/core/runner_spec.rb +9 -7
- data/spec/rails_best_practices/core_ext/erubis_spec.rb +10 -10
- data/spec/rails_best_practices/inline_disables/inline_disable_spec.rb +62 -0
- data/spec/rails_best_practices/lexicals/long_line_check_spec.rb +11 -10
- data/spec/rails_best_practices/lexicals/remove_tab_check_spec.rb +6 -6
- data/spec/rails_best_practices/lexicals/remove_trailing_whitespace_check_spec.rb +6 -6
- data/spec/rails_best_practices/prepares/config_prepare_spec.rb +2 -2
- data/spec/rails_best_practices/prepares/controller_prepare_spec.rb +18 -10
- data/spec/rails_best_practices/prepares/gemfile_prepare_spec.rb +2 -2
- data/spec/rails_best_practices/prepares/helper_prepare_spec.rb +3 -3
- data/spec/rails_best_practices/prepares/initializer_prepare_spec.rb +3 -3
- data/spec/rails_best_practices/prepares/mailer_prepare_spec.rb +2 -2
- data/spec/rails_best_practices/prepares/model_prepare_spec.rb +79 -43
- data/spec/rails_best_practices/prepares/route_prepare_spec.rb +138 -77
- data/spec/rails_best_practices/prepares/schema_prepare_spec.rb +2 -2
- data/spec/rails_best_practices/reviews/add_model_virtual_attribute_review_spec.rb +18 -12
- data/spec/rails_best_practices/reviews/always_add_db_index_review_spec.rb +28 -22
- data/spec/rails_best_practices/reviews/check_destroy_return_value_review_spec.rb +15 -13
- data/spec/rails_best_practices/reviews/check_save_return_value_review_spec.rb +31 -21
- data/spec/rails_best_practices/reviews/default_scope_is_evil_review_spec.rb +6 -6
- data/spec/rails_best_practices/reviews/dry_bundler_in_capistrano_review_spec.rb +5 -5
- data/spec/rails_best_practices/reviews/hash_syntax_review_spec.rb +9 -9
- data/spec/rails_best_practices/reviews/isolate_seed_data_review_spec.rb +7 -7
- data/spec/rails_best_practices/reviews/keep_finders_on_their_own_model_review_spec.rb +9 -9
- data/spec/rails_best_practices/reviews/law_of_demeter_review_spec.rb +21 -14
- data/spec/rails_best_practices/reviews/move_code_into_controller_review_spec.rb +6 -6
- data/spec/rails_best_practices/reviews/move_code_into_helper_review_spec.rb +11 -6
- data/spec/rails_best_practices/reviews/move_code_into_model_review_spec.rb +26 -16
- data/spec/rails_best_practices/reviews/move_finder_to_named_scope_review_spec.rb +7 -7
- data/spec/rails_best_practices/reviews/move_model_logic_into_model_review_spec.rb +9 -7
- data/spec/rails_best_practices/reviews/needless_deep_nesting_review_spec.rb +9 -9
- data/spec/rails_best_practices/reviews/not_rescue_exception_review_spec.rb +9 -9
- data/spec/rails_best_practices/reviews/not_use_default_route_review_spec.rb +5 -5
- data/spec/rails_best_practices/reviews/not_use_time_ago_in_words_review_spec.rb +7 -7
- data/spec/rails_best_practices/reviews/overuse_route_customizations_review_spec.rb +7 -7
- data/spec/rails_best_practices/reviews/protect_mass_assignment_review_spec.rb +24 -19
- data/spec/rails_best_practices/reviews/remove_empty_helpers_review_spec.rb +6 -6
- data/spec/rails_best_practices/reviews/remove_unused_methods_in_controllers_review_spec.rb +44 -31
- data/spec/rails_best_practices/reviews/remove_unused_methods_in_helpers_review_spec.rb +17 -12
- data/spec/rails_best_practices/reviews/remove_unused_methods_in_models_review_spec.rb +46 -44
- data/spec/rails_best_practices/reviews/replace_complex_creation_with_factory_method_review_spec.rb +10 -8
- data/spec/rails_best_practices/reviews/replace_instance_variable_with_local_variable_review_spec.rb +16 -10
- data/spec/rails_best_practices/reviews/restrict_auto_generated_routes_review_spec.rb +54 -31
- data/spec/rails_best_practices/reviews/simplify_render_in_controllers_review_spec.rb +9 -9
- data/spec/rails_best_practices/reviews/simplify_render_in_views_review_spec.rb +13 -13
- data/spec/rails_best_practices/reviews/use_before_filter_review_spec.rb +11 -9
- data/spec/rails_best_practices/reviews/use_model_association_review_spec.rb +7 -7
- data/spec/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review_spec.rb +21 -17
- data/spec/rails_best_practices/reviews/use_observer_review_spec.rb +6 -6
- data/spec/rails_best_practices/reviews/use_parentheses_in_method_def_review_spec.rb +9 -7
- data/spec/rails_best_practices/reviews/use_query_attribute_review_spec.rb +31 -24
- data/spec/rails_best_practices/reviews/use_say_with_time_in_migrations_review_spec.rb +15 -11
- data/spec/rails_best_practices/reviews/use_scope_access_review_spec.rb +14 -14
- data/spec/rails_best_practices/reviews/use_turbo_sprockets_rails3_review_spec.rb +10 -8
- metadata +16 -11
@@ -2,42 +2,41 @@
|
|
2
2
|
|
3
3
|
require File.expand_path('lib/rails_best_practices/version', __dir__)
|
4
4
|
|
5
|
-
Gem::Specification.new do |
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
s.post_install_message = <<~POST_INSTALL_MESSAGE
|
5
|
+
Gem::Specification.new do |spec|
|
6
|
+
spec.name = 'rails_best_practices'
|
7
|
+
spec.version = RailsBestPractices::VERSION
|
8
|
+
spec.platform = Gem::Platform::RUBY
|
9
|
+
spec.authors = ['Richard Huang']
|
10
|
+
spec.email = ['flyerhzm@gmail.com']
|
11
|
+
spec.homepage = 'http://rails-bestpractices.com'
|
12
|
+
spec.summary = 'a code metric tool for rails codes.'
|
13
|
+
spec.description = 'a code metric tool for rails codes, written in Ruby.'
|
14
|
+
spec.license = 'MIT'
|
15
|
+
|
16
|
+
spec.required_ruby_version = '>= 1.9.0'
|
17
|
+
spec.required_rubygems_version = '>= 1.3.6'
|
18
|
+
|
19
|
+
spec.add_dependency('activesupport')
|
20
|
+
spec.add_dependency('code_analyzer', '>= 0.5.2')
|
21
|
+
spec.add_dependency('erubis')
|
22
|
+
spec.add_dependency('i18n')
|
23
|
+
spec.add_dependency('json')
|
24
|
+
spec.add_dependency('require_all', '~> 3.0')
|
25
|
+
spec.add_dependency('ruby-progressbar')
|
26
|
+
|
27
|
+
spec.add_development_dependency('awesome_print')
|
28
|
+
spec.add_development_dependency('bundler')
|
29
|
+
spec.add_development_dependency('haml')
|
30
|
+
spec.add_development_dependency('rake')
|
31
|
+
spec.add_development_dependency('rspec')
|
32
|
+
spec.add_development_dependency('slim')
|
33
|
+
|
34
|
+
spec.files = `git ls-files`.split($/)
|
35
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
36
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
37
|
+
spec.require_paths = %w[lib assets]
|
38
|
+
|
39
|
+
spec.post_install_message = <<~POST_INSTALL_MESSAGE
|
41
40
|
#{'*' * 80}
|
42
41
|
|
43
42
|
rails_best_practices is a code metric tool to check the quality of rails codes.
|
@@ -5,8 +5,7 @@ require 'rails_best_practices/reviews/review'
|
|
5
5
|
module RailsBestPractices
|
6
6
|
module Plugins
|
7
7
|
module Reviews
|
8
|
-
class NotUseRailsRootReview < RailsBestPractices::Reviews::Review
|
9
|
-
end
|
8
|
+
class NotUseRailsRootReview < RailsBestPractices::Reviews::Review; end
|
10
9
|
end
|
11
10
|
end
|
12
11
|
end
|
@@ -5,39 +5,70 @@ require 'tmpdir'
|
|
5
5
|
|
6
6
|
module RailsBestPractices
|
7
7
|
describe Analyzer do
|
8
|
-
subject {
|
8
|
+
subject { described_class.new('.') }
|
9
9
|
|
10
10
|
describe '::new' do
|
11
|
-
it '
|
11
|
+
it 'expands a relative path to an absolute' do
|
12
12
|
expect(subject.path).to eq File.expand_path('.')
|
13
13
|
end
|
14
14
|
end
|
15
15
|
|
16
16
|
describe 'expand_dirs_to_files' do
|
17
|
-
it '
|
17
|
+
it 'expands all files in spec directory' do
|
18
18
|
dir = File.dirname(__FILE__)
|
19
19
|
expect(subject.expand_dirs_to_files(dir)).to be_include(dir + '/analyzer_spec.rb')
|
20
20
|
end
|
21
21
|
end
|
22
22
|
|
23
23
|
describe 'file_sort' do
|
24
|
-
it '
|
25
|
-
files = [
|
26
|
-
|
24
|
+
it 'gets models first, mailers, helpers and then others' do
|
25
|
+
files = [
|
26
|
+
'app/controllers/users_controller.rb',
|
27
|
+
'app/mailers/user_mailer.rb',
|
28
|
+
'app/helpers/users_helper.rb',
|
29
|
+
'app/models/user.rb',
|
30
|
+
'app/views/users/index.html.haml',
|
31
|
+
'app/views/users/show.html.slim',
|
32
|
+
'lib/user.rb'
|
33
|
+
]
|
34
|
+
expect(subject.file_sort(files)).to eq(
|
35
|
+
[
|
36
|
+
'app/models/user.rb',
|
37
|
+
'app/mailers/user_mailer.rb',
|
38
|
+
'app/helpers/users_helper.rb',
|
39
|
+
'app/controllers/users_controller.rb',
|
40
|
+
'app/views/users/index.html.haml',
|
41
|
+
'app/views/users/show.html.slim',
|
42
|
+
'lib/user.rb'
|
43
|
+
]
|
44
|
+
)
|
27
45
|
end
|
28
46
|
end
|
29
47
|
|
30
48
|
describe 'file_ignore' do
|
31
49
|
before do
|
32
|
-
@all = [
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
50
|
+
@all = [
|
51
|
+
'app/controllers/users_controller.rb',
|
52
|
+
'app/mailers/user_mailer.rb',
|
53
|
+
'app/models/user.rb',
|
54
|
+
'app/views/users/index.html.haml',
|
55
|
+
'app/views/users/show.html.slim',
|
56
|
+
'lib/user.rb'
|
57
|
+
]
|
58
|
+
@filtered = [
|
59
|
+
'app/controllers/users_controller.rb',
|
60
|
+
'app/mailers/user_mailer.rb',
|
61
|
+
'app/models/user.rb',
|
62
|
+
'app/views/users/index.html.haml',
|
63
|
+
'app/views/users/show.html.slim'
|
64
|
+
]
|
65
|
+
end
|
66
|
+
|
67
|
+
it 'ignores lib' do
|
37
68
|
expect(subject.file_ignore(@all, 'lib/')).to eq(@filtered)
|
38
69
|
end
|
39
70
|
|
40
|
-
it '
|
71
|
+
it 'ignores regexp patterns' do
|
41
72
|
expect(subject.file_ignore(@all, /lib/)).to eq(@filtered)
|
42
73
|
end
|
43
74
|
end
|
@@ -88,7 +119,7 @@ module RailsBestPractices
|
|
88
119
|
end
|
89
120
|
|
90
121
|
describe 'output_terminal_errors' do
|
91
|
-
it '
|
122
|
+
it 'outputs errors in terminal' do
|
92
123
|
check1 = Reviews::LawOfDemeterReview.new
|
93
124
|
check2 = Reviews::UseQueryAttributeReview.new
|
94
125
|
runner = Core::Runner.new(reviews: [check1, check2])
|
@@ -102,12 +133,14 @@ module RailsBestPractices
|
|
102
133
|
subject.output_terminal_errors
|
103
134
|
result = $stdout.string
|
104
135
|
$stdout = $origin_stdout
|
105
|
-
expect(result).to eq(
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
136
|
+
expect(result).to eq(
|
137
|
+
[
|
138
|
+
"\e[31mapp/models/user.rb:10 - law of demeter\e[0m",
|
139
|
+
"\e[31mapp/models/post.rb:100 - use query attribute\e[0m",
|
140
|
+
"\e[32m\nPlease go to https://rails-bestpractices.com to see more useful Rails Best Practices.\e[0m",
|
141
|
+
"\e[31m\nFound 2 warnings.\e[0m"
|
142
|
+
].join("\n") + "\n"
|
143
|
+
)
|
111
144
|
end
|
112
145
|
end
|
113
146
|
|
@@ -115,9 +148,7 @@ module RailsBestPractices
|
|
115
148
|
let(:output_file) { 'rails_best_practices_output.json' }
|
116
149
|
|
117
150
|
subject do
|
118
|
-
described_class.new('.',
|
119
|
-
'format' => 'json',
|
120
|
-
'output-file' => output_file)
|
151
|
+
described_class.new('.', 'format' => 'json', 'output-file' => output_file)
|
121
152
|
end
|
122
153
|
|
123
154
|
let(:check1) { Reviews::LawOfDemeterReview.new }
|
@@ -142,54 +173,54 @@ module RailsBestPractices
|
|
142
173
|
end
|
143
174
|
|
144
175
|
describe 'parse_files' do
|
145
|
-
it '
|
146
|
-
Dir.mktmpdir
|
176
|
+
it 'does not filter out all files when the path contains "vendor"' do
|
177
|
+
Dir.mktmpdir do |random_dir|
|
147
178
|
Dir.mkdir(File.join(random_dir, 'vendor'))
|
148
179
|
Dir.mkdir(File.join(random_dir, 'vendor', 'my_project'))
|
149
180
|
File.open(File.join(random_dir, 'vendor', 'my_project', 'my_file.rb'), 'w') { |file| file << 'woot' }
|
150
|
-
analyzer =
|
181
|
+
analyzer = described_class.new(File.join(random_dir, 'vendor', 'my_project'))
|
151
182
|
expect(analyzer.parse_files).to be_include File.join(random_dir, 'vendor', 'my_project', 'my_file.rb')
|
152
|
-
|
183
|
+
end
|
153
184
|
end
|
154
185
|
|
155
|
-
it '
|
156
|
-
Dir.mktmpdir
|
186
|
+
it 'does not filter out all files when the path contains "spec"' do
|
187
|
+
Dir.mktmpdir do |random_dir|
|
157
188
|
Dir.mkdir(File.join(random_dir, 'spec'))
|
158
189
|
Dir.mkdir(File.join(random_dir, 'spec', 'my_project'))
|
159
190
|
File.open(File.join(random_dir, 'spec', 'my_project', 'my_file.rb'), 'w') { |file| file << 'woot' }
|
160
|
-
analyzer =
|
191
|
+
analyzer = described_class.new(File.join(random_dir, 'spec', 'my_project'))
|
161
192
|
expect(analyzer.parse_files).to be_include File.join(random_dir, 'spec', 'my_project', 'my_file.rb')
|
162
|
-
|
193
|
+
end
|
163
194
|
end
|
164
195
|
|
165
|
-
it '
|
166
|
-
Dir.mktmpdir
|
196
|
+
it 'does not filter out all files when the path contains "test"' do
|
197
|
+
Dir.mktmpdir do |random_dir|
|
167
198
|
Dir.mkdir(File.join(random_dir, 'test'))
|
168
199
|
Dir.mkdir(File.join(random_dir, 'test', 'my_project'))
|
169
200
|
File.open(File.join(random_dir, 'test', 'my_project', 'my_file.rb'), 'w') { |file| file << 'woot' }
|
170
|
-
analyzer =
|
201
|
+
analyzer = described_class.new(File.join(random_dir, 'test', 'my_project'))
|
171
202
|
expect(analyzer.parse_files).to be_include File.join(random_dir, 'test', 'my_project', 'my_file.rb')
|
172
|
-
|
203
|
+
end
|
173
204
|
end
|
174
205
|
|
175
|
-
it '
|
176
|
-
Dir.mktmpdir
|
206
|
+
it 'does not filter out all files when the path contains "features"' do
|
207
|
+
Dir.mktmpdir do |random_dir|
|
177
208
|
Dir.mkdir(File.join(random_dir, 'test'))
|
178
209
|
Dir.mkdir(File.join(random_dir, 'test', 'my_project'))
|
179
210
|
File.open(File.join(random_dir, 'test', 'my_project', 'my_file.rb'), 'w') { |file| file << 'woot' }
|
180
|
-
analyzer =
|
211
|
+
analyzer = described_class.new(File.join(random_dir, 'test', 'my_project'))
|
181
212
|
expect(analyzer.parse_files).to be_include File.join(random_dir, 'test', 'my_project', 'my_file.rb')
|
182
|
-
|
213
|
+
end
|
183
214
|
end
|
184
215
|
|
185
|
-
it '
|
186
|
-
Dir.mktmpdir
|
216
|
+
it 'does not filter out all files when the path contains "tmp"' do
|
217
|
+
Dir.mktmpdir do |random_dir|
|
187
218
|
Dir.mkdir(File.join(random_dir, 'tmp'))
|
188
219
|
Dir.mkdir(File.join(random_dir, 'tmp', 'my_project'))
|
189
220
|
File.open(File.join(random_dir, 'tmp', 'my_project', 'my_file.rb'), 'w') { |file| file << 'woot' }
|
190
|
-
analyzer =
|
221
|
+
analyzer = described_class.new(File.join(random_dir, 'tmp', 'my_project'))
|
191
222
|
expect(analyzer.parse_files).to be_include File.join(random_dir, 'tmp', 'my_project', 'my_file.rb')
|
192
|
-
|
223
|
+
end
|
193
224
|
end
|
194
225
|
end
|
195
226
|
end
|
@@ -4,13 +4,13 @@ require 'spec_helper'
|
|
4
4
|
|
5
5
|
module RailsBestPractices::Core
|
6
6
|
describe Check do
|
7
|
-
let(:check) {
|
7
|
+
let(:check) { described_class.new }
|
8
8
|
|
9
9
|
context 'debug' do
|
10
|
-
it '
|
11
|
-
|
12
|
-
expect(
|
13
|
-
|
10
|
+
it 'is debug mode' do
|
11
|
+
described_class.debug
|
12
|
+
expect(described_class).to be_debug
|
13
|
+
described_class.class_eval { @debug = false }
|
14
14
|
end
|
15
15
|
end
|
16
16
|
end
|
@@ -4,17 +4,17 @@ require 'spec_helper'
|
|
4
4
|
|
5
5
|
module RailsBestPractices::Core
|
6
6
|
describe ChecksLoader do
|
7
|
-
let(:checks_loader) {
|
7
|
+
let(:checks_loader) { described_class.new(RailsBestPractices::Analyzer::DEFAULT_CONFIG) }
|
8
8
|
|
9
9
|
describe 'load_lexicals' do
|
10
|
-
it '
|
10
|
+
it 'loads lexical checks from the default configuration' do
|
11
11
|
lexicals = checks_loader.load_lexicals
|
12
12
|
expect(lexicals.map(&:class)).to include(RailsBestPractices::Lexicals::RemoveTrailingWhitespaceCheck)
|
13
13
|
end
|
14
14
|
end
|
15
15
|
|
16
16
|
describe 'load_reviews' do
|
17
|
-
it '
|
17
|
+
it 'loads the reviews from the default the configuration' do
|
18
18
|
reviews = checks_loader.load_reviews
|
19
19
|
expect(reviews.map(&:class)).to include(RailsBestPractices::Reviews::AlwaysAddDbIndexReview)
|
20
20
|
end
|
@@ -4,32 +4,32 @@ require 'spec_helper'
|
|
4
4
|
|
5
5
|
module RailsBestPractices::Core
|
6
6
|
describe Error do
|
7
|
-
it '
|
8
|
-
expect(
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
).to_s).to eq('app/models/user.rb:100 - not good')
|
7
|
+
it 'returns error with filename, line number and message' do
|
8
|
+
expect(
|
9
|
+
described_class.new(
|
10
|
+
filename: 'app/models/user.rb', line_number: '100', message: 'not good', type: 'BogusReview'
|
11
|
+
).to_s
|
12
|
+
).to eq('app/models/user.rb:100 - not good')
|
14
13
|
end
|
15
14
|
|
16
|
-
it '
|
15
|
+
it 'returns short filename' do
|
17
16
|
Runner.base_path = '../rails-bestpractices.com'
|
18
|
-
expect(
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
17
|
+
expect(
|
18
|
+
described_class.new(
|
19
|
+
filename: '../rails-bestpractices.com/app/models/user.rb',
|
20
|
+
line_number: '100',
|
21
|
+
message: 'not good',
|
22
|
+
type: 'BogusReview'
|
23
|
+
).short_filename
|
24
|
+
).to eq('app/models/user.rb')
|
24
25
|
end
|
25
26
|
|
26
|
-
it '
|
27
|
-
expect(
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
).first_line_number).to eq('50')
|
27
|
+
it 'returns first line number' do
|
28
|
+
expect(
|
29
|
+
described_class.new(
|
30
|
+
filename: 'app/models/user.rb', line_number: '50,70,100', message: 'not good', type: 'BogusReview'
|
31
|
+
).first_line_number
|
32
|
+
).to eq('50')
|
33
33
|
end
|
34
34
|
end
|
35
35
|
end
|
@@ -10,7 +10,7 @@ module RailsBestPractices::Core
|
|
10
10
|
let(:except_method) { '*#*' }
|
11
11
|
|
12
12
|
it 'matches' do
|
13
|
-
expect(
|
13
|
+
expect(described_class.matches(method, except_method)).to eql true
|
14
14
|
end
|
15
15
|
end
|
16
16
|
|
@@ -18,7 +18,7 @@ module RailsBestPractices::Core
|
|
18
18
|
let(:except_method) { '*#approve' }
|
19
19
|
|
20
20
|
it 'matches' do
|
21
|
-
expect(
|
21
|
+
expect(described_class.matches(method, except_method)).to eql true
|
22
22
|
end
|
23
23
|
end
|
24
24
|
|
@@ -26,7 +26,7 @@ module RailsBestPractices::Core
|
|
26
26
|
let(:except_method) { '*#disapprove' }
|
27
27
|
|
28
28
|
it 'matches' do
|
29
|
-
expect(
|
29
|
+
expect(described_class.matches(method, except_method)).to eql false
|
30
30
|
end
|
31
31
|
end
|
32
32
|
|
@@ -34,7 +34,7 @@ module RailsBestPractices::Core
|
|
34
34
|
let(:except_method) { 'BlogPost#*' }
|
35
35
|
|
36
36
|
it 'matches' do
|
37
|
-
expect(
|
37
|
+
expect(described_class.matches(method, except_method)).to eql true
|
38
38
|
end
|
39
39
|
end
|
40
40
|
|
@@ -42,7 +42,7 @@ module RailsBestPractices::Core
|
|
42
42
|
let(:except_method) { 'User#*' }
|
43
43
|
|
44
44
|
it 'matches' do
|
45
|
-
expect(
|
45
|
+
expect(described_class.matches(method, except_method)).to eql false
|
46
46
|
end
|
47
47
|
end
|
48
48
|
|
@@ -50,7 +50,7 @@ module RailsBestPractices::Core
|
|
50
50
|
let(:except_method) { 'BlogPost#approve' }
|
51
51
|
|
52
52
|
it 'matches' do
|
53
|
-
expect(
|
53
|
+
expect(described_class.matches(method, except_method)).to eql true
|
54
54
|
end
|
55
55
|
end
|
56
56
|
|
@@ -58,7 +58,7 @@ module RailsBestPractices::Core
|
|
58
58
|
let(:except_method) { 'User#disapprove' }
|
59
59
|
|
60
60
|
it 'matches' do
|
61
|
-
expect(
|
61
|
+
expect(described_class.matches(method, except_method)).to eql false
|
62
62
|
end
|
63
63
|
end
|
64
64
|
end
|
@@ -4,15 +4,15 @@ require 'spec_helper'
|
|
4
4
|
|
5
5
|
module RailsBestPractices::Core
|
6
6
|
describe Gems do
|
7
|
-
it {
|
7
|
+
it { is_expected.to be_a_kind_of Array }
|
8
8
|
|
9
|
-
let(:gems) {
|
9
|
+
let(:gems) { described_class.new }
|
10
10
|
before do
|
11
11
|
gems << Gem.new('rails', '4.0.0')
|
12
12
|
gems << Gem.new('mysql2', '0.2.0')
|
13
13
|
end
|
14
14
|
|
15
|
-
|
15
|
+
describe '#has_gem?' do
|
16
16
|
it 'has rails gem' do
|
17
17
|
expect(gems).to be_has_gem 'rails'
|
18
18
|
end
|
@@ -22,7 +22,7 @@ module RailsBestPractices::Core
|
|
22
22
|
end
|
23
23
|
end
|
24
24
|
|
25
|
-
|
25
|
+
describe '#gem_version' do
|
26
26
|
it 'gets rails version' do
|
27
27
|
expect(gems.gem_version('rails')).to eq '4.0.0'
|
28
28
|
end
|
@@ -4,10 +4,10 @@ require 'spec_helper'
|
|
4
4
|
|
5
5
|
module RailsBestPractices::Core
|
6
6
|
describe Klasses do
|
7
|
-
it {
|
7
|
+
it { is_expected.to be_a_kind_of Array }
|
8
8
|
|
9
9
|
context 'Klass' do
|
10
|
-
|
10
|
+
describe '#class_name' do
|
11
11
|
it 'gets class name without module' do
|
12
12
|
klass = Klass.new('BlogPost', 'Post', [])
|
13
13
|
expect(klass.class_name).to eq('BlogPost')
|
@@ -19,7 +19,7 @@ module RailsBestPractices::Core
|
|
19
19
|
end
|
20
20
|
end
|
21
21
|
|
22
|
-
|
22
|
+
describe '#extend_class_name' do
|
23
23
|
it 'gets extend class name without module' do
|
24
24
|
klass = Klass.new('BlogPost', 'Post', [])
|
25
25
|
expect(klass.extend_class_name).to eq('Post')
|
@@ -4,9 +4,9 @@ require 'spec_helper'
|
|
4
4
|
|
5
5
|
module RailsBestPractices::Core
|
6
6
|
describe Methods do
|
7
|
-
let(:methods) {
|
7
|
+
let(:methods) { described_class.new }
|
8
8
|
|
9
|
-
before
|
9
|
+
before do
|
10
10
|
methods.add_method('Post', 'create')
|
11
11
|
methods.add_method('Post', 'destroy')
|
12
12
|
methods.add_method('Post', 'save_or_update', {}, 'protected')
|
@@ -14,7 +14,7 @@ module RailsBestPractices::Core
|
|
14
14
|
methods.add_method('Comment', 'create')
|
15
15
|
end
|
16
16
|
|
17
|
-
it '
|
17
|
+
it 'get_methodses' do
|
18
18
|
expect(methods.get_methods('Post').map(&:method_name)).to eq(%w[create destroy save_or_update find_by_sql])
|
19
19
|
expect(methods.get_methods('Post', 'public').map(&:method_name)).to eq(%w[create destroy])
|
20
20
|
expect(methods.get_methods('Post', 'protected').map(&:method_name)).to eq(['save_or_update'])
|
@@ -22,7 +22,7 @@ module RailsBestPractices::Core
|
|
22
22
|
expect(methods.get_methods('Comment').map(&:method_name)).to eq(['create'])
|
23
23
|
end
|
24
24
|
|
25
|
-
it '
|
25
|
+
it 'has_method?s' do
|
26
26
|
expect(methods).to be_has_method('Post', 'create', 'public')
|
27
27
|
expect(methods).to be_has_method('Post', 'destroy', 'public')
|
28
28
|
expect(methods).not_to be_has_method('Post', 'save_or_update', 'public')
|
@@ -32,12 +32,12 @@ module RailsBestPractices::Core
|
|
32
32
|
expect(methods).not_to be_has_method('Comment', 'destroy')
|
33
33
|
end
|
34
34
|
|
35
|
-
it '
|
35
|
+
it 'get_methods' do
|
36
36
|
expect(methods.get_method('Post', 'create', 'public')).not_to be_nil
|
37
37
|
expect(methods.get_method('Post', 'create', 'protected')).to be_nil
|
38
38
|
end
|
39
39
|
|
40
|
-
it '
|
40
|
+
it 'get_all_unused_methodses' do
|
41
41
|
methods.get_method('Comment', 'create').mark_used
|
42
42
|
expect(methods.get_all_unused_methods('public').map(&:method_name)).to eq(%w[create destroy])
|
43
43
|
expect(methods.get_all_unused_methods('protected').map(&:method_name)).to eq(['save_or_update'])
|
@@ -4,20 +4,24 @@ require 'spec_helper'
|
|
4
4
|
|
5
5
|
module RailsBestPractices::Core
|
6
6
|
describe ModelAssociations do
|
7
|
-
let(:model_associations) {
|
7
|
+
let(:model_associations) { described_class.new }
|
8
8
|
|
9
|
-
before
|
9
|
+
before do
|
10
10
|
model_associations.add_association('Project', 'project_manager', 'belongs_to')
|
11
11
|
model_associations.add_association('Project', 'people', 'has_many', 'Person')
|
12
12
|
end
|
13
13
|
|
14
|
-
it '
|
15
|
-
expect(model_associations.get_association('Project', 'project_manager')).to eq(
|
16
|
-
|
14
|
+
it 'gets model associations' do
|
15
|
+
expect(model_associations.get_association('Project', 'project_manager')).to eq(
|
16
|
+
'meta' => 'belongs_to', 'class_name' => 'ProjectManager'
|
17
|
+
)
|
18
|
+
expect(model_associations.get_association('Project', 'people')).to eq(
|
19
|
+
'meta' => 'has_many', 'class_name' => 'Person'
|
20
|
+
)
|
17
21
|
expect(model_associations.get_association('Project', 'unknown')).to be_nil
|
18
22
|
end
|
19
23
|
|
20
|
-
it '
|
24
|
+
it 'checks is model associatiosn' do
|
21
25
|
expect(model_associations.is_association?('Project', 'project_manager')).to eq true
|
22
26
|
expect(model_associations.is_association?('Project', 'people')).to eq true
|
23
27
|
expect(model_associations.is_association?('Project', 'unknown')).to eq false
|
@@ -4,20 +4,20 @@ require 'spec_helper'
|
|
4
4
|
|
5
5
|
module RailsBestPractices::Core
|
6
6
|
describe ModelAttributes do
|
7
|
-
let(:model_attributes) {
|
7
|
+
let(:model_attributes) { described_class.new }
|
8
8
|
|
9
|
-
before
|
9
|
+
before do
|
10
10
|
model_attributes.add_attribute('Post', 'title', :string)
|
11
11
|
model_attributes.add_attribute('Post', 'user_id', :integer)
|
12
12
|
end
|
13
13
|
|
14
|
-
it '
|
14
|
+
it 'gets model attributes' do
|
15
15
|
expect(model_attributes.get_attribute_type('Post', 'title')).to eq(:string)
|
16
16
|
expect(model_attributes.get_attribute_type('Post', 'user_id')).to eq(:integer)
|
17
17
|
expect(model_attributes.get_attribute_type('Post', 'unknonw')).to be_nil
|
18
18
|
end
|
19
19
|
|
20
|
-
it '
|
20
|
+
it 'checks is model attributes' do
|
21
21
|
expect(model_attributes.is_attribute?('Post', 'title')).to be true
|
22
22
|
expect(model_attributes.is_attribute?('Post', 'user_id')).to be true
|
23
23
|
expect(model_attributes.is_attribute?('Post', 'unknonw')).to be false
|