rails_best_practices 1.19.3 → 1.21.0

data/lib/rails_best_practices/reviews/use_say_with_time_in_migrations_review.rb

@@ -31,14 +31,15 @@ module RailsBestPractices
         node.body.statements.each do |child_node|
           next if child_node.grep_nodes_count(sexp_type: %i[fcall command], message: WITH_SAY_METHODS) > 0
 
-          receiver_node = if :method_add_block == child_node.sexp_type
-                           child_node[1]
-                         elsif :method_add_arg == child_node.sexp_type
-                           child_node[1]
-                         else
-                           child_node
-                         end
-          if :call == receiver_node.sexp_type
+          receiver_node =
+            if child_node.sexp_type == :method_add_block
+              child_node[1]
+            elsif child_node.sexp_type == :method_add_arg
+              child_node[1]
+            else
+              child_node
+            end
+          if receiver_node.sexp_type == :call
             add_error('use say with time in migrations', node.file, child_node.line_number)
           end
         end

data/lib/rails_best_practices/reviews/use_scope_access_review.rb

@@ -30,28 +30,30 @@ module RailsBestPractices
 
       private
 
-        # check a if node to see
-        #
-        # if the conditional statement is compared with current_user or current_user.id,
-        # and there is a redirect_to method call in the block body,
-        # then it should be replaced by using scope access.
-        def current_user_redirect?(node)
-          all_conditions = if node.conditional_statement == node.conditional_statement.all_conditions
+      # check a if node to see
+      #
+      # if the conditional statement is compared with current_user or current_user.id,
+      # and there is a redirect_to method call in the block body,
+      # then it should be replaced by using scope access.
+      def current_user_redirect?(node)
+        all_conditions =
+          if node.conditional_statement == node.conditional_statement.all_conditions
             [node.conditional_statement]
           else
             node.conditional_statement.all_conditions
           end
-          results = all_conditions.map do |condition_node|
+        results =
+          all_conditions.map do |condition_node|
             ['==', '!='].include?(condition_node.message.to_s) &&
               (current_user?(condition_node.argument) || current_user?(condition_node.receiver))
           end
-          results.any? { |result| result == true } && node.body.grep_node(message: 'redirect_to')
-        end
+        results.any? { |result| result == true } && node.body.grep_node(message: 'redirect_to')
+      end
 
-        # check a call node to see if it uses current_user, or current_user.id.
-        def current_user?(node)
-          'current_user' == node.to_s || ('current_user' == node.receiver.to_s && 'id' == node.message.to_s)
-        end
+      # check a call node to see if it uses current_user, or current_user.id.
+      def current_user?(node)
+        node.to_s == 'current_user' || (node.receiver.to_s == 'current_user' && node.message.to_s == 'id')
+      end
     end
   end
 end

data/lib/rails_best_practices/reviews/use_turbo_sprockets_rails3_review.rb

@@ -18,7 +18,8 @@ module RailsBestPractices
       # check command node to see if load 'deploy/assets'
       add_callback :start_command do |node|
         if Prepares.gems.gem_version('rails').to_i == 3
-          if !Prepares.gems.has_gem?('turbo-sprockets-rails3') && 'load' == node.message.to_s && 'deploy/assets' == node.arguments.to_s
+          if !Prepares.gems.has_gem?('turbo-sprockets-rails3') && node.message.to_s == 'load' &&
+               node.arguments.to_s == 'deploy/assets'
             add_error 'speed up assets precompile with turbo-sprockets-rails3'
           end
         end

data/lib/rails_best_practices/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsBestPractices
-  VERSION = '1.19.3'.freeze
+  VERSION = '1.21.0'
 end

data/rails_best_practices.gemspec

@@ -2,54 +2,53 @@
 
 require File.expand_path('lib/rails_best_practices/version', __dir__)
 
-Gem::Specification.new do |s|
-  s.name        = 'rails_best_practices'
-  s.version     = RailsBestPractices::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Richard Huang']
-  s.email       = ['flyerhzm@gmail.com']
-  s.homepage    = 'http://rails-bestpractices.com'
-  s.summary     = 'a code metric tool for rails codes.'
-  s.description = 'a code metric tool for rails codes, written in Ruby.'
-  s.license     = 'MIT'
-
-  s.required_ruby_version = '>= 1.9.0'
-  s.required_rubygems_version = '>= 1.3.6'
-
-  s.add_dependency('activesupport')
-  # TODO: add a dependency for Rails >= 3 ?
-  s.add_dependency('code_analyzer', '>= 0.4.8')
-  s.add_dependency('erubis')
-  s.add_dependency('i18n')
-  s.add_dependency('json')
-  s.add_dependency('require_all', '~> 2.0')
-  s.add_dependency('ruby-progressbar')
-
-  s.add_development_dependency('awesome_print')
-  s.add_development_dependency('bundler')
-  s.add_development_dependency('haml')
-  s.add_development_dependency('rake', '< 11.0')
-  s.add_development_dependency('rspec')
-  s.add_development_dependency('slim')
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
-  s.require_paths = %w[lib assets]
-
-  s.post_install_message = <<-POST_INSTALL_MESSAGE
-#{'*' * 80}
-
-  rails_best_practices is a code metric tool to check the quality of rails codes.
-
-  I highly recommend you browse the Rails Best Practices website first.
-
-      http://rails-bestpractices.com
-
-  Enjoy!
-
-      Richard Huang (flyerhzm@gmail.com)
-
-#{'*' * 80}
+Gem::Specification.new do |spec|
+  spec.name        = 'rails_best_practices'
+  spec.version     = RailsBestPractices::VERSION
+  spec.platform    = Gem::Platform::RUBY
+  spec.authors     = ['Richard Huang']
+  spec.email       = ['flyerhzm@gmail.com']
+  spec.homepage    = 'http://rails-bestpractices.com'
+  spec.summary     = 'a code metric tool for rails codes.'
+  spec.description = 'a code metric tool for rails codes, written in Ruby.'
+  spec.license     = 'MIT'
+
+  spec.required_ruby_version = '>= 1.9.0'
+  spec.required_rubygems_version = '>= 1.3.6'
+
+  spec.add_dependency('activesupport')
+  spec.add_dependency('code_analyzer', '>= 0.5.2')
+  spec.add_dependency('erubis')
+  spec.add_dependency('i18n')
+  spec.add_dependency('json')
+  spec.add_dependency('require_all', '~> 3.0')
+  spec.add_dependency('ruby-progressbar')
+
+  spec.add_development_dependency('awesome_print')
+  spec.add_development_dependency('bundler')
+  spec.add_development_dependency('haml')
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('rspec')
+  spec.add_development_dependency('slim')
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w[lib assets]
+
+  spec.post_install_message = <<~POST_INSTALL_MESSAGE
+    #{'*' * 80}
+
+      rails_best_practices is a code metric tool to check the quality of rails codes.
+
+      I highly recommend you browse the Rails Best Practices website first.
+
+          http://rails-bestpractices.com
+
+      Enjoy!
+
+          Richard Huang (flyerhzm@gmail.com)
+
+    #{'*' * 80}
   POST_INSTALL_MESSAGE
 end

data/spec/fixtures/lib/rails_best_practices/plugins/reviews/not_use_rails_root_review.rb

@@ -5,8 +5,7 @@ require 'rails_best_practices/reviews/review'
 module RailsBestPractices
   module Plugins
     module Reviews
-      class NotUseRailsRootReview < RailsBestPractices::Reviews::Review
-      end
+      class NotUseRailsRootReview < RailsBestPractices::Reviews::Review; end
     end
   end
 end

data/spec/rails_best_practices/analyzer_spec.rb

@@ -5,39 +5,70 @@ require 'tmpdir'
 
 module RailsBestPractices
   describe Analyzer do
-    subject { Analyzer.new('.') }
+    subject { described_class.new('.') }
 
     describe '::new' do
-      it 'should expand a relative path to an absolute' do
+      it 'expands a relative path to an absolute' do
         expect(subject.path).to eq File.expand_path('.')
       end
     end
 
     describe 'expand_dirs_to_files' do
-      it 'should expand all files in spec directory' do
+      it 'expands all files in spec directory' do
         dir = File.dirname(__FILE__)
         expect(subject.expand_dirs_to_files(dir)).to be_include(dir + '/analyzer_spec.rb')
       end
     end
 
     describe 'file_sort' do
-      it 'should get models first, mailers, helpers and then others' do
-        files = ['app/controllers/users_controller.rb', 'app/mailers/user_mailer.rb', 'app/helpers/users_helper.rb', 'app/models/user.rb', 'app/views/users/index.html.haml', 'app/views/users/show.html.slim', 'lib/user.rb']
-        expect(subject.file_sort(files)).to eq(['app/models/user.rb', 'app/mailers/user_mailer.rb', 'app/helpers/users_helper.rb', 'app/controllers/users_controller.rb', 'app/views/users/index.html.haml', 'app/views/users/show.html.slim', 'lib/user.rb'])
+      it 'gets models first, mailers, helpers and then others' do
+        files = [
+          'app/controllers/users_controller.rb',
+          'app/mailers/user_mailer.rb',
+          'app/helpers/users_helper.rb',
+          'app/models/user.rb',
+          'app/views/users/index.html.haml',
+          'app/views/users/show.html.slim',
+          'lib/user.rb'
+        ]
+        expect(subject.file_sort(files)).to eq(
+          [
+            'app/models/user.rb',
+            'app/mailers/user_mailer.rb',
+            'app/helpers/users_helper.rb',
+            'app/controllers/users_controller.rb',
+            'app/views/users/index.html.haml',
+            'app/views/users/show.html.slim',
+            'lib/user.rb'
+          ]
+        )
       end
     end
 
     describe 'file_ignore' do
       before do
-        @all = ['app/controllers/users_controller.rb', 'app/mailers/user_mailer.rb', 'app/models/user.rb', 'app/views/users/index.html.haml', 'app/views/users/show.html.slim', 'lib/user.rb']
-        @filtered = ['app/controllers/users_controller.rb', 'app/mailers/user_mailer.rb', 'app/models/user.rb', 'app/views/users/index.html.haml', 'app/views/users/show.html.slim']
-      end
-
-      it 'should ignore lib' do
+        @all = [
+          'app/controllers/users_controller.rb',
+          'app/mailers/user_mailer.rb',
+          'app/models/user.rb',
+          'app/views/users/index.html.haml',
+          'app/views/users/show.html.slim',
+          'lib/user.rb'
+        ]
+        @filtered = [
+          'app/controllers/users_controller.rb',
+          'app/mailers/user_mailer.rb',
+          'app/models/user.rb',
+          'app/views/users/index.html.haml',
+          'app/views/users/show.html.slim'
+        ]
+      end
+
+      it 'ignores lib' do
         expect(subject.file_ignore(@all, 'lib/')).to eq(@filtered)
       end
 
-      it 'should ignore regexp patterns' do
+      it 'ignores regexp patterns' do
         expect(subject.file_ignore(@all, /lib/)).to eq(@filtered)
       end
     end
@@ -88,7 +119,7 @@ module RailsBestPractices
     end
 
     describe 'output_terminal_errors' do
-      it 'should output errors in terminal' do
+      it 'outputs errors in terminal' do
         check1 = Reviews::LawOfDemeterReview.new
         check2 = Reviews::UseQueryAttributeReview.new
         runner = Core::Runner.new(reviews: [check1, check2])
@@ -102,11 +133,14 @@ module RailsBestPractices
         subject.output_terminal_errors
         result = $stdout.string
         $stdout = $origin_stdout
-        expect(result).to eq([
-          "\e[31mapp/models/user.rb:10 - law of demeter\e[0m",
-          "\e[31mapp/models/post.rb:100 - use query attribute\e[0m",
-          "\e[32m\nPlease go to https://rails-bestpractices.com to see more useful Rails Best Practices.\e[0m",
-          "\e[31m\nFound 2 warnings.\e[0m"].join("\n") + "\n")
+        expect(result).to eq(
+          [
+            "\e[31mapp/models/user.rb:10 - law of demeter\e[0m",
+            "\e[31mapp/models/post.rb:100 - use query attribute\e[0m",
+            "\e[32m\nPlease go to https://rails-bestpractices.com to see more useful Rails Best Practices.\e[0m",
+            "\e[31m\nFound 2 warnings.\e[0m"
+          ].join("\n") + "\n"
+        )
       end
     end
 
@@ -114,10 +148,7 @@ module RailsBestPractices
       let(:output_file) { 'rails_best_practices_output.json' }
 
       subject do
-        described_class.new('.',
-          'format' => 'json',
-          'output-file' => output_file
-        )
+        described_class.new('.', 'format' => 'json', 'output-file' => output_file)
       end
 
       let(:check1) { Reviews::LawOfDemeterReview.new }
@@ -142,54 +173,54 @@ module RailsBestPractices
     end
 
     describe 'parse_files' do
-      it 'should not filter out all files when the path contains "vendor"' do
-        Dir.mktmpdir { |random_dir|
+      it 'does not filter out all files when the path contains "vendor"' do
+        Dir.mktmpdir do |random_dir|
           Dir.mkdir(File.join(random_dir, 'vendor'))
           Dir.mkdir(File.join(random_dir, 'vendor', 'my_project'))
           File.open(File.join(random_dir, 'vendor', 'my_project', 'my_file.rb'), 'w') { |file| file << 'woot' }
-          analyzer = Analyzer.new(File.join(random_dir, 'vendor', 'my_project'))
+          analyzer = described_class.new(File.join(random_dir, 'vendor', 'my_project'))
           expect(analyzer.parse_files).to be_include File.join(random_dir, 'vendor', 'my_project', 'my_file.rb')
-        }
+        end
       end
 
-      it 'should not filter out all files when the path contains "spec"' do
-        Dir.mktmpdir { |random_dir|
+      it 'does not filter out all files when the path contains "spec"' do
+        Dir.mktmpdir do |random_dir|
           Dir.mkdir(File.join(random_dir, 'spec'))
           Dir.mkdir(File.join(random_dir, 'spec', 'my_project'))
           File.open(File.join(random_dir, 'spec', 'my_project', 'my_file.rb'), 'w') { |file| file << 'woot' }
-          analyzer = Analyzer.new(File.join(random_dir, 'spec', 'my_project'))
+          analyzer = described_class.new(File.join(random_dir, 'spec', 'my_project'))
           expect(analyzer.parse_files).to be_include File.join(random_dir, 'spec', 'my_project', 'my_file.rb')
-        }
+        end
       end
 
-      it 'should not filter out all files when the path contains "test"' do
-        Dir.mktmpdir { |random_dir|
+      it 'does not filter out all files when the path contains "test"' do
+        Dir.mktmpdir do |random_dir|
           Dir.mkdir(File.join(random_dir, 'test'))
           Dir.mkdir(File.join(random_dir, 'test', 'my_project'))
           File.open(File.join(random_dir, 'test', 'my_project', 'my_file.rb'), 'w') { |file| file << 'woot' }
-          analyzer = Analyzer.new(File.join(random_dir, 'test', 'my_project'))
+          analyzer = described_class.new(File.join(random_dir, 'test', 'my_project'))
           expect(analyzer.parse_files).to be_include File.join(random_dir, 'test', 'my_project', 'my_file.rb')
-        }
+        end
       end
 
-      it 'should not filter out all files when the path contains "features"' do
-        Dir.mktmpdir { |random_dir|
+      it 'does not filter out all files when the path contains "features"' do
+        Dir.mktmpdir do |random_dir|
           Dir.mkdir(File.join(random_dir, 'test'))
           Dir.mkdir(File.join(random_dir, 'test', 'my_project'))
           File.open(File.join(random_dir, 'test', 'my_project', 'my_file.rb'), 'w') { |file| file << 'woot' }
-          analyzer = Analyzer.new(File.join(random_dir, 'test', 'my_project'))
+          analyzer = described_class.new(File.join(random_dir, 'test', 'my_project'))
           expect(analyzer.parse_files).to be_include File.join(random_dir, 'test', 'my_project', 'my_file.rb')
-        }
+        end
       end
 
-      it 'should not filter out all files when the path contains "tmp"' do
-        Dir.mktmpdir { |random_dir|
+      it 'does not filter out all files when the path contains "tmp"' do
+        Dir.mktmpdir do |random_dir|
           Dir.mkdir(File.join(random_dir, 'tmp'))
           Dir.mkdir(File.join(random_dir, 'tmp', 'my_project'))
           File.open(File.join(random_dir, 'tmp', 'my_project', 'my_file.rb'), 'w') { |file| file << 'woot' }
-          analyzer = Analyzer.new(File.join(random_dir, 'tmp', 'my_project'))
+          analyzer = described_class.new(File.join(random_dir, 'tmp', 'my_project'))
           expect(analyzer.parse_files).to be_include File.join(random_dir, 'tmp', 'my_project', 'my_file.rb')
-        }
+        end
       end
     end
   end

data/spec/rails_best_practices/core/check_spec.rb

@@ -4,13 +4,13 @@ require 'spec_helper'
 
 module RailsBestPractices::Core
   describe Check do
-    let(:check) { Check.new }
+    let(:check) { described_class.new }
 
     context 'debug' do
-      it 'should be debug mode' do
-        Check.debug
-        expect(Check).to be_debug
-        Check.class_eval { @debug = false }
+      it 'is debug mode' do
+        described_class.debug
+        expect(described_class).to be_debug
+        described_class.class_eval { @debug = false }
       end
     end
   end

data/spec/rails_best_practices/core/checks_loader_spec.rb

@@ -4,17 +4,17 @@ require 'spec_helper'
 
 module RailsBestPractices::Core
   describe ChecksLoader do
-    let(:checks_loader) { ChecksLoader.new(RailsBestPractices::Analyzer::DEFAULT_CONFIG) }
+    let(:checks_loader) { described_class.new(RailsBestPractices::Analyzer::DEFAULT_CONFIG) }
 
     describe 'load_lexicals' do
-      it 'should load lexical checks from the default configuration' do
+      it 'loads lexical checks from the default configuration' do
         lexicals = checks_loader.load_lexicals
         expect(lexicals.map(&:class)).to include(RailsBestPractices::Lexicals::RemoveTrailingWhitespaceCheck)
       end
     end
 
     describe 'load_reviews' do
-      it 'should load the reviews from the default the configuration' do
+      it 'loads the reviews from the default the configuration' do
         reviews = checks_loader.load_reviews
         expect(reviews.map(&:class)).to include(RailsBestPractices::Reviews::AlwaysAddDbIndexReview)
       end

data/spec/rails_best_practices/core/configs_spec.rb

@@ -4,6 +4,6 @@ require 'spec_helper'
 
 module RailsBestPractices::Core
   describe Configs do
-    it { should be_a_kind_of Hash }
+    it { is_expected.to be_a_kind_of Hash }
   end
 end