rails_best_practices 1.19.0 → 1.19.1

data/lib/rails_best_practices/reviews/use_say_with_time_in_migrations_review.rb

@@ -16,7 +16,7 @@ module RailsBestPractices
     class UseSayWithTimeInMigrationsReview < Review
       interesting_nodes :defs
       interesting_files MIGRATION_FILES
-      url "https://rails-bestpractices.com/posts/2010/08/19/use-say-and-say_with_time-in-migrations-to-make-a-useful-migration-log/"
+      url 'https://rails-bestpractices.com/posts/2010/08/19/use-say-and-say_with_time-in-migrations-to-make-a-useful-migration-log/'
 
       WITH_SAY_METHODS = %w(say say_with_time)
 
@@ -38,7 +38,7 @@ module RailsBestPractices
                            child_node
                          end
           if :call == receiver_node.sexp_type
-            add_error("use say with time in migrations", node.file, child_node.line_number)
+            add_error('use say with time in migrations', node.file, child_node.line_number)
           end
         end
       end

data/lib/rails_best_practices/reviews/use_scope_access_review.rb

@@ -16,7 +16,7 @@ module RailsBestPractices
     class UseScopeAccessReview < Review
       interesting_nodes :if, :unless, :elsif, :ifop, :if_mod, :unless_mod
       interesting_files CONTROLLER_FILES
-      url "https://rails-bestpractices.com/posts/2010/07/20/use-scope-access/"
+      url 'https://rails-bestpractices.com/posts/2010/07/20/use-scope-access/'
 
       # check if node.
       #
@@ -24,7 +24,7 @@ module RailsBestPractices
       # and there is a redirect_to method call in the block body,
       # then it should be replaced by using scope access.
       add_callback :start_if, :start_unless, :start_elsif, :start_ifop, :start_if_mod, :start_unless_mod do |node|
-        add_error "use scope access" if current_user_redirect?(node)
+        add_error 'use scope access' if current_user_redirect?(node)
       end
 
       private
@@ -41,15 +41,15 @@ module RailsBestPractices
             node.conditional_statement.all_conditions
           end
           results = all_conditions.map do |condition_node|
-            ["==", "!="].include?(condition_node.message.to_s) &&
+            ['==', '!='].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")
+          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)
+          'current_user' == node.to_s || ('current_user' == node.receiver.to_s && 'id' == node.message.to_s)
         end
     end
   end

data/lib/rails_best_practices/reviews/use_turbo_sprockets_rails3_review.rb

@@ -12,13 +12,13 @@ module RailsBestPractices
     class UseTurboSprocketsRails3Review < Review
       interesting_nodes :command
       interesting_files CAPFILE
-      url "https://rails-bestpractices.com/posts/2012/11/23/speed-up-assets-precompile-with-turbo-sprockets-rails3/"
+      url 'https://rails-bestpractices.com/posts/2012/11/23/speed-up-assets-precompile-with-turbo-sprockets-rails3/'
 
       # 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
-            add_error "speed up assets precompile with turbo-sprockets-rails3"
+        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
+            add_error 'speed up assets precompile with turbo-sprockets-rails3'
           end
         end
       end

data/lib/rails_best_practices/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module RailsBestPractices
-  VERSION = "1.19.0"
+  VERSION = '1.19.1'
 end

data/rails_best_practices.gemspec

@@ -1,40 +1,40 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path("../lib/rails_best_practices/version", __FILE__)
+require File.expand_path('../lib/rails_best_practices/version', __FILE__)
 
 Gem::Specification.new do |s|
-  s.name        = "rails_best_practices"
+  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.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.required_ruby_version = '>= 1.9.0'
+  s.required_rubygems_version = '>= 1.3.6'
 
-  s.add_dependency("activesupport")
+  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("require_all")
-  s.add_dependency("ruby-progressbar")
-  s.add_dependency("json")
-
-  s.add_development_dependency("rake", '< 11.0')
-  s.add_development_dependency("rspec")
-  s.add_development_dependency("haml")
-  s.add_development_dependency("slim")
-  s.add_development_dependency("bundler")
-  s.add_development_dependency("awesome_print")
+  s.add_dependency('code_analyzer', '>= 0.4.8')
+  s.add_dependency('erubis')
+  s.add_dependency('i18n')
+  s.add_dependency('require_all', '~> 1.5.0')
+  s.add_dependency('ruby-progressbar')
+  s.add_dependency('json')
+
+  s.add_development_dependency('rake', '< 11.0')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('haml')
+  s.add_development_dependency('slim')
+  s.add_development_dependency('bundler')
+  s.add_development_dependency('awesome_print')
 
   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 = ["lib", "assets"]
+  s.require_paths = ['lib', 'assets']
 
   s.post_install_message = <<-POST_INSTALL_MESSAGE
 #{"*" * 80}

data/spec/rails_best_practices/analyzer_spec.rb

@@ -3,7 +3,7 @@ require 'tmpdir'
 
 module RailsBestPractices
   describe Analyzer do
-    subject { Analyzer.new(".") }
+    subject { Analyzer.new('.') }
 
     describe '::new' do
       it 'should expand a relative path to an absolute' do
@@ -11,37 +11,37 @@ module RailsBestPractices
       end
     end
 
-    describe "expand_dirs_to_files" do
-      it "should expand all files in spec directory" do
+    describe 'expand_dirs_to_files' do
+      it 'should expand 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"])
+    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'])
       end
     end
 
-    describe "file_ignore" do
+    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"]
+        @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
+      it 'should ignore lib' do
         expect(subject.file_ignore(@all, 'lib/')).to eq(@filtered)
       end
 
-      it "should ignore regexp patterns" do
+      it 'should ignore regexp patterns' do
         expect(subject.file_ignore(@all, /lib/)).to eq(@filtered)
       end
     end
 
-    describe "output" do
-      subject { described_class.new(".", "format" => format) }
+    describe 'output' do
+      subject { described_class.new('.', 'format' => format) }
 
       before do
         subject.stub(:output_terminal_errors)
@@ -52,49 +52,49 @@ module RailsBestPractices
         subject.output
       end
 
-      context "when format is not set" do
+      context 'when format is not set' do
         let(:format) { nil }
 
-        it "runs text output" do
+        it 'runs text output' do
           expect(subject).to have_received(:output_terminal_errors)
         end
       end
 
-      context "when format is yaml" do
-        let(:format) { "yaml" }
+      context 'when format is yaml' do
+        let(:format) { 'yaml' }
 
-        it "runs yaml output" do
+        it 'runs yaml output' do
           expect(subject).to have_received(:output_yaml_errors)
         end
       end
 
-      context "when format is html" do
-        let(:format) { "html" }
+      context 'when format is html' do
+        let(:format) { 'html' }
 
-        it "runs html output" do
+        it 'runs html output' do
           expect(subject).to have_received(:output_html_errors)
         end
       end
 
-      context "when format is xml" do
-        let(:format) { "xml" }
+      context 'when format is xml' do
+        let(:format) { 'xml' }
 
-        it "runs xml output" do
+        it 'runs xml output' do
           expect(subject).to have_received(:output_xml_errors)
         end
       end
 
     end
 
-    describe "output_terminal_errors" do
-      it "should output errors in terminal" do
+    describe 'output_terminal_errors' do
+      it 'should output errors in terminal' do
         check1 = Reviews::LawOfDemeterReview.new
         check2 = Reviews::UseQueryAttributeReview.new
         runner = Core::Runner.new(reviews: [check1, check2])
-        check1.add_error "law of demeter", "app/models/user.rb", 10
-        check2.add_error "use query attribute", "app/models/post.rb", 100
+        check1.add_error 'law of demeter', 'app/models/user.rb', 10
+        check2.add_error 'use query attribute', 'app/models/post.rb', 100
         subject.runner = runner
-        subject.instance_variable_set("@options", {"without-color" => false})
+        subject.instance_variable_set('@options', {'without-color' => false})
 
         $origin_stdout = $stdout
         $stdout = StringIO.new
@@ -109,13 +109,13 @@ module RailsBestPractices
       end
     end
 
-    describe "output_json_errors" do
-      let(:output_file) { "rails_best_practices_output.json" }
+    describe 'output_json_errors' do
+      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
 
@@ -125,8 +125,8 @@ module RailsBestPractices
       let(:result) { File.read(output_file) }
 
       before do
-        check1.add_error("law of demeter", "app/models/user.rb", 10)
-        check2.add_error("use query attribute", "app/models/post.rb", 100)
+        check1.add_error('law of demeter', 'app/models/user.rb', 10)
+        check2.add_error('use query attribute', 'app/models/post.rb', 100)
         subject.runner = runner
         subject.output
       end
@@ -135,7 +135,7 @@ module RailsBestPractices
         File.delete(output_file) if File.exists?(output_file)
       end
 
-      it "saves output as json into output file" do
+      it 'saves output as json into output file' do
         expect(result).to eq '[{"filename":"app/models/user.rb","line_number":"10","message":"law of demeter"},{"filename":"app/models/post.rb","line_number":"100","message":"use query attribute"}]'
       end
     end
@@ -146,7 +146,7 @@ module RailsBestPractices
         Dir.mktmpdir { |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' }
+          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'))
           expect(analyzer.parse_files).to be_include File.join(random_dir, 'vendor', 'my_project', 'my_file.rb')
         }
@@ -156,7 +156,7 @@ module RailsBestPractices
         Dir.mktmpdir { |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' }
+          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'))
           expect(analyzer.parse_files).to be_include File.join(random_dir, 'spec', 'my_project', 'my_file.rb')
         }
@@ -166,7 +166,7 @@ module RailsBestPractices
         Dir.mktmpdir { |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' }
+          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'))
           expect(analyzer.parse_files).to be_include File.join(random_dir, 'test', 'my_project', 'my_file.rb')
         }
@@ -176,7 +176,7 @@ module RailsBestPractices
         Dir.mktmpdir { |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' }
+          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'))
           expect(analyzer.parse_files).to be_include File.join(random_dir, 'test', 'my_project', 'my_file.rb')
         }
@@ -186,7 +186,7 @@ module RailsBestPractices
         Dir.mktmpdir { |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' }
+          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'))
           expect(analyzer.parse_files).to be_include File.join(random_dir, 'tmp', 'my_project', 'my_file.rb')
         }

data/spec/rails_best_practices/core/check_spec.rb

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

data/spec/rails_best_practices/core/checks_loader_spec.rb

@@ -4,15 +4,15 @@ module RailsBestPractices::Core
   describe ChecksLoader do
     let(:checks_loader) { ChecksLoader.new(RailsBestPractices::Analyzer::DEFAULT_CONFIG) }
 
-    describe "load_lexicals" do
-      it "should load lexical checks from the default configuration" do
+    describe 'load_lexicals' do
+      it 'should load 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
+    describe 'load_reviews' do
+      it 'should load 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/error_spec.rb

@@ -2,29 +2,29 @@ require 'spec_helper'
 
 module RailsBestPractices::Core
   describe Error do
-    it "should return error with filename, line number and message" do
+    it 'should return error with filename, line number and message' do
       expect(Error.new(
-        filename: "app/models/user.rb",
-        line_number: "100",
-        message: "not good",
-        type: "BogusReview").to_s).to eq("app/models/user.rb:100 - not good")
+        filename: 'app/models/user.rb',
+        line_number: '100',
+        message: 'not good',
+        type: 'BogusReview').to_s).to eq('app/models/user.rb:100 - not good')
     end
 
-    it "should return short filename" do
-      Runner.base_path = "../rails-bestpractices.com"
+    it 'should return short filename' do
+      Runner.base_path = '../rails-bestpractices.com'
       expect(Error.new(
-        filename: "../rails-bestpractices.com/app/models/user.rb",
-        line_number: "100",
-        message: "not good",
-        type: "BogusReview").short_filename).to eq("app/models/user.rb")
+        filename: '../rails-bestpractices.com/app/models/user.rb',
+        line_number: '100',
+        message: 'not good',
+        type: 'BogusReview').short_filename).to eq('app/models/user.rb')
     end
 
-    it "should return first line number" do
+    it 'should return first line number' do
       expect(Error.new(
-        filename: "app/models/user.rb",
-        line_number: "50,70,100",
-        message: "not good",
-        type: "BogusReview").first_line_number).to eq("50")
+        filename: 'app/models/user.rb',
+        line_number: '50,70,100',
+        message: 'not good',
+        type: 'BogusReview').first_line_number).to eq('50')
     end
   end
 end

data/spec/rails_best_practices/core/except_methods_spec.rb

@@ -2,60 +2,60 @@ require 'spec_helper'
 
 module RailsBestPractices::Core
   describe Check::Exceptable do
-    let(:method) { Method.new "BlogPost", "approve", "public", {} }
+    let(:method) { Method.new 'BlogPost', 'approve', 'public', {} }
 
-    context "wildcard class and method" do
+    context 'wildcard class and method' do
       let(:except_method) { '*#*' }
 
-      it "matches" do
+      it 'matches' do
         expect(Check::Exceptable.matches(method, except_method)).to eql true
       end
     end
 
-    context "wildcard class and matching explicit method" do
+    context 'wildcard class and matching explicit method' do
       let(:except_method) { '*#approve' }
 
-      it "matches" do
+      it 'matches' do
         expect(Check::Exceptable.matches(method, except_method)).to eql true
       end
     end
 
-    context "wildcard class and non-matching explicit method" do
+    context 'wildcard class and non-matching explicit method' do
       let(:except_method) { '*#disapprove' }
 
-      it "matches" do
+      it 'matches' do
         expect(Check::Exceptable.matches(method, except_method)).to eql false
       end
     end
 
-    context "matching class and wildcard method" do
+    context 'matching class and wildcard method' do
       let(:except_method) { 'BlogPost#*' }
 
-      it "matches" do
+      it 'matches' do
         expect(Check::Exceptable.matches(method, except_method)).to eql true
       end
     end
 
-    context "non-matching class and wildcard method" do
+    context 'non-matching class and wildcard method' do
       let(:except_method) { 'User#*' }
 
-      it "matches" do
+      it 'matches' do
         expect(Check::Exceptable.matches(method, except_method)).to eql false
       end
     end
 
-    context "matching class and matching method" do
+    context 'matching class and matching method' do
       let(:except_method) { 'BlogPost#approve' }
 
-      it "matches" do
+      it 'matches' do
         expect(Check::Exceptable.matches(method, except_method)).to eql true
       end
     end
 
-    context "non-matching class and non-matching method" do
+    context 'non-matching class and non-matching method' do
       let(:except_method) { 'User#disapprove' }
 
-      it "matches" do
+      it 'matches' do
         expect(Check::Exceptable.matches(method, except_method)).to eql false
       end
     end