rails_best_practices 1.15.7 → 1.16.0

data/rails_best_practices.yml

@@ -1,6 +1,7 @@
 AddModelVirtualAttributeCheck: { }
 AlwaysAddDbIndexCheck: { }
 #CheckSaveReturnValueCheck: { }
+#CheckDestroyReturnValueCheck: { }
 DefaultScopeIsEvilCheck: { }
 DryBundlerInCapistranoCheck: { }
 #HashSyntaxCheck: { }

data/spec/rails_best_practices/analyzer_spec.rb

@@ -101,7 +101,11 @@ module RailsBestPractices
         subject.output_terminal_errors
         result = $stdout.string
         $stdout = $origin_stdout
-        expect(result).to eq(["app/models/user.rb:10 - law of demeter".red, "app/models/post.rb:100 - use query attribute".red, "\nPlease go to http://rails-bestpractices.com to see more useful Rails Best Practices.".green, "\nFound 2 warnings.".red].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 http://rails-bestpractices.com to see more useful Rails Best Practices.\e[0m",
+          "\e[31m\nFound 2 warnings.\e[0m"].join("\n") + "\n")
       end
     end
 

data/spec/rails_best_practices/core/modules_spec.rb

@@ -9,20 +9,20 @@ module RailsBestPractices::Core
         @mod = Mod.new("PostsHelper", [])
       end
       subject { Modules.new.tap { |modules| modules << @mod } }
-      it "should add decendant to the corresponding module" do
-        expect(@mod).to receive(:add_decendant).with("PostsController")
-        subject.add_module_decendant("PostsHelper", "PostsController")
+      it "should add descendant to the corresponding module" do
+        expect(@mod).to receive(:add_descendant).with("PostsController")
+        subject.add_module_descendant("PostsHelper", "PostsController")
       end
     end
 
     context "Mod" do
       subject {
         Mod.new("UsersHelper", ["Admin"]).tap do |mod|
-          mod.add_decendant("Admin::UsersController")
+          mod.add_descendant("Admin::UsersController")
         end
       }
       it { expect(subject.to_s).to eq("Admin::UsersHelper") }
-      it { expect(subject.decendants).to eq(["Admin::UsersController"]) }
+      it { expect(subject.descendants).to eq(["Admin::UsersController"]) }
     end
   end
 end

data/spec/rails_best_practices/prepares/controller_prepare_spec.rb

@@ -123,7 +123,7 @@ module RailsBestPractices
       end
 
       context "helpers" do
-        it "should add helper decendant" do
+        it "should add helper descendant" do
           content =<<-EOF
           module PostsHelper
           end
@@ -136,7 +136,7 @@ module RailsBestPractices
           EOF
           runner.prepare('app/controllers/posts_controller.rb', content)
           helpers = Prepares.helpers
-          expect(helpers.first.decendants).to eq(["PostsController"])
+          expect(helpers.first.descendants).to eq(["PostsController"])
         end
       end
     end

data/spec/rails_best_practices/reviews/check_destroy_return_value_spec.rb

@@ -0,0 +1,151 @@
+require 'spec_helper'
+
+module RailsBestPractices
+  module Reviews
+    describe CheckDestroyReturnValueReview do
+      let(:runner) { Core::Runner.new(reviews: CheckDestroyReturnValueReview.new) }
+
+      describe "check_destroy_return_value" do
+        it "should warn you if you fail to check the destroy return value" do
+          content =<<-EOF
+          def my_method
+            post = Posts.create do |p|
+              p.title = "foo"
+            end
+            post.destroy
+          end
+          EOF
+          runner.review('app/helpers/posts_helper.rb', content)
+          expect(runner.errors.size).to eq(1)
+          expect(runner.errors[0].to_s).to eq("app/helpers/posts_helper.rb:5 - check 'destroy' return value or use 'destroy!'")
+        end
+
+        it "should allow destroy return value if assigned to a var" do
+          content =<<-EOF
+          def my_method
+            post = Posts.create do |p|
+              p.title = "foo"
+            end
+            check_this_later = post.destroy
+          end
+          EOF
+          runner.review('app/helpers/posts_helper.rb', content)
+          expect(runner.errors.size).to eq(0)
+        end
+
+        it "should allow destroy return value used in if" do
+          content =<<-EOF
+          def my_method
+            post = Posts.create do |p|
+              p.title = "foo"
+            end
+            if post.destroy
+              "OK"
+            else
+              raise "could not delete"
+            end
+          end
+          EOF
+          runner.review('app/helpers/posts_helper.rb', content)
+          expect(runner.errors.size).to eq(0)
+        end
+
+        it "should allow destroy return value used in elsif" do
+          content =<<-EOF
+          def my_method
+            post = Posts.create do |p|
+              p.title = "foo"
+            end
+            if current_user
+              "YES"
+            elsif post.destroy
+              "OK"
+            else
+              raise "could not delete"
+            end
+          end
+          EOF
+          runner.review('app/helpers/posts_helper.rb', content)
+          expect(runner.errors.size).to eq(0)
+        end
+
+        it "should allow destroy return value used in unless" do
+          content =<<-EOF
+          def my_method
+            unless @post.destroy
+              raise "could not destroy"
+            end
+          end
+          EOF
+          runner.review('app/helpers/posts_helper.rb', content)
+          expect(runner.errors.size).to eq(0)
+        end
+
+        it "should allow destroy return value used in if_mod" do
+          content =<<-EOF
+          def my_method
+            post = Posts.create do |p|
+              p.title = "foo"
+            end
+            "OK" if post.destroy
+          end
+          EOF
+          runner.review('app/helpers/posts_helper.rb', content)
+          expect(runner.errors.size).to eq(0)
+        end
+
+        it "should allow destroy return value used in unless_mod" do
+          content =<<-EOF
+          def my_method
+            post = Posts.create do |p|
+              p.title = "foo"
+            end
+            "NO" unless post.destroy
+          end
+          EOF
+          runner.review('app/helpers/posts_helper.rb', content)
+          expect(runner.errors.size).to eq(0)
+        end
+
+        it "should allow destroy return value used in unless with &&" do
+          content =<<-EOF
+          def my_method
+            unless some_method(1) && other_method(2) && @post.destroy
+              raise "could not destroy"
+            end
+          end
+          EOF
+          runner.review('app/helpers/posts_helper.rb', content)
+          expect(runner.errors.size).to eq(0)
+        end
+
+        it "should allow destroy!" do
+          content =<<-EOF
+          def my_method
+            post = Posts.create do |p|
+              p.title = "foo"
+            end
+            post.destroy!
+          end
+          EOF
+          runner.review('app/helpers/posts_helper.rb', content)
+          expect(runner.errors.size).to eq(0)
+        end
+      end
+
+      it "should not check ignored files" do
+        runner = Core::Runner.new(reviews: CheckDestroyReturnValueReview.new(ignored_files: /helpers/))
+        content =<<-EOF
+          def my_method
+            post = Posts.create do |p|
+              p.title = "foo"
+            end
+            post.destroy
+          end
+        EOF
+        runner.review('app/helpers/posts_helper.rb', content)
+        expect(runner.errors.size).to eq(0)
+      end
+    end
+  end
+end

data/spec/rails_best_practices/reviews/remove_unused_methods_in_helpers_review_spec.rb

@@ -84,6 +84,36 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
+      it "should not remove unused methods if called in descendant controllers" do
+        application_helper_content =<<-EOF
+        module ApplicationHelper
+          def admin?; end
+        end
+        EOF
+        application_controller_content =<<-EOF
+        class ApplicationController
+          include ApplicationHelper
+        end
+        EOF
+        controller_content =<<-EOF
+        class PostsController < ApplicationController
+
+          def show
+            head(:forbidden) unless admin?
+          end
+        end
+        EOF
+        runner.prepare('app/helpers/application_helper.rb', application_helper_content)
+        runner.prepare('app/controllers/application_controller.rb', application_controller_content)
+        runner.prepare('app/controllers/posts_controller.rb', controller_content)
+        runner.after_prepare
+        runner.review('app/helpers/application_helper.rb', application_helper_content)
+        runner.review('app/controllers/application_controller.rb', application_controller_content)
+        runner.review('app/controllers/posts_controller.rb', controller_content)
+        runner.after_review
+        expect(runner.errors.size).to eq(0)
+      end
+
        it "should not check ignored files" do
         runner = Core::Runner.new(prepares: [Prepares::ControllerPrepare.new, Prepares::HelperPrepare.new],
                                   reviews: RemoveUnusedMethodsInHelpersReview.new(ignored_files: /posts_helper/, except_methods: []))

data/spec/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review_spec.rb

@@ -52,11 +52,10 @@ GEM
               expect(runner.errors[0].to_s).to eq("app/mailers/project_mailer.rb:2 - use multipart/alternative as content_type of email")
             end
 
-            it "should use multiple/alternative as content_type of email when only plain text" do
+            it "should not use multiple/alternative as content_type of email when only plain text" do
               mock_email_files(["send_email.text.plain.erb"])
               runner.review('app/mailers/project_mailer.rb', content)
-              expect(runner.errors.size).to eq(1)
-              expect(runner.errors[0].to_s).to eq("app/mailers/project_mailer.rb:2 - use multipart/alternative as content_type of email")
+              expect(runner.errors.size).to eq(0)
             end
 
             it "should not use multipart/alternative as content_type of email" do
@@ -74,11 +73,10 @@ GEM
               expect(runner.errors[0].to_s).to eq("app/mailers/project_mailer.rb:2 - use multipart/alternative as content_type of email")
             end
 
-            it "should use multiple/alternative as content_type of email when only plain text" do
+            it "should not use multiple/alternative as content_type of email when only plain text" do
               mock_email_files(["send_email.text.plain.haml"])
               runner.review('app/mailers/project_mailer.rb', content)
-              expect(runner.errors.size).to eq(1)
-              expect(runner.errors[0].to_s).to eq("app/mailers/project_mailer.rb:2 - use multipart/alternative as content_type of email")
+              expect(runner.errors.size).to eq(0)
             end
 
             it "should not use multipart/alternative as content_type of email" do
@@ -96,11 +94,10 @@ GEM
               expect(runner.errors[0].to_s).to eq("app/mailers/project_mailer.rb:2 - use multipart/alternative as content_type of email")
             end
 
-            it "should use multiple/alternative as content_type of email when only plain text" do
+            it "should not use multiple/alternative as content_type of email when only plain text" do
               mock_email_files(["send_email.text.plain.slim"])
               runner.review('app/mailers/project_mailer.rb', content)
-              expect(runner.errors.size).to eq(1)
-              expect(runner.errors[0].to_s).to eq("app/mailers/project_mailer.rb:2 - use multipart/alternative as content_type of email")
+              expect(runner.errors.size).to eq(0)
             end
 
             it "should not use multipart/alternative as content_type of email" do
@@ -118,11 +115,10 @@ GEM
               expect(runner.errors[0].to_s).to eq("app/mailers/project_mailer.rb:2 - use multipart/alternative as content_type of email")
             end
 
-            it "should use multiple/alternative as content_type of email when only plain text" do
+            it "should not use multiple/alternative as content_type of email when only plain text" do
               mock_email_files(["send_email.text.plain.rhtml"])
               runner.review('app/mailers/project_mailer.rb', content)
-              expect(runner.errors.size).to eq(1)
-              expect(runner.errors[0].to_s).to eq("app/mailers/project_mailer.rb:2 - use multipart/alternative as content_type of email")
+              expect(runner.errors.size).to eq(0)
             end
 
             it "should not use multipart/alternative as content_type of email" do
@@ -187,11 +183,10 @@ GEM
               expect(runner.errors[0].to_s).to eq("app/mailers/project_mailer.rb:2 - use multipart/alternative as content_type of email")
             end
 
-            it "should use multiple/alternative as content_type of email when only plain text" do
+            it "should not use multiple/alternative as content_type of email when only plain text" do
               mock_email_files(["send_email.text.erb"])
               runner.review('app/mailers/project_mailer.rb', content)
-              expect(runner.errors.size).to eq(1)
-              expect(runner.errors[0].to_s).to eq("app/mailers/project_mailer.rb:2 - use multipart/alternative as content_type of email")
+              expect(runner.errors.size).to eq(0)
             end
 
             it "should not use multipart/alternative as content_type of email" do
@@ -209,11 +204,10 @@ GEM
               expect(runner.errors[0].to_s).to eq("app/mailers/project_mailer.rb:2 - use multipart/alternative as content_type of email")
             end
 
-            it "should use multiple/alternative as content_type of email when only plain text" do
+            it "should not use multiple/alternative as content_type of email when only plain text" do
               mock_email_files(["send_email.text.haml"])
               runner.review('app/mailers/project_mailer.rb', content)
-              expect(runner.errors.size).to eq(1)
-              expect(runner.errors[0].to_s).to eq("app/mailers/project_mailer.rb:2 - use multipart/alternative as content_type of email")
+              expect(runner.errors.size).to eq(0)
             end
 
             it "should not use multipart/alternative as content_type of email" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_best_practices
 version: !ruby/object:Gem::Version
-  version: 1.15.7
+  version: 1.16.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-27 00:00:00.000000000 Z
+date: 2016-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.3
-- !ruby/object:Gem::Dependency
-  name: colored
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +192,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.30.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.30.1
 description: a code metric tool for rails codes, written in Ruby.
 email:
 - flyerhzm@gmail.com
@@ -216,7 +216,10 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - MIT_LICENSE
@@ -227,6 +230,7 @@ files:
 - install_supported_rubies.sh
 - lib/rails_best_practices.rb
 - lib/rails_best_practices/analyzer.rb
+- lib/rails_best_practices/colorize.rb
 - lib/rails_best_practices/command.rb
 - lib/rails_best_practices/core.rb
 - lib/rails_best_practices/core/check.rb
@@ -263,6 +267,7 @@ files:
 - lib/rails_best_practices/reviews.rb
 - lib/rails_best_practices/reviews/add_model_virtual_attribute_review.rb
 - lib/rails_best_practices/reviews/always_add_db_index_review.rb
+- lib/rails_best_practices/reviews/check_destroy_return_value_review.rb
 - lib/rails_best_practices/reviews/check_save_return_value_review.rb
 - lib/rails_best_practices/reviews/default_scope_is_evil_review.rb
 - lib/rails_best_practices/reviews/dry_bundler_in_capistrano_review.rb
@@ -338,6 +343,7 @@ files:
 - spec/rails_best_practices/prepares/schema_prepare_spec.rb
 - spec/rails_best_practices/reviews/add_model_virtual_attribute_review_spec.rb
 - spec/rails_best_practices/reviews/always_add_db_index_review_spec.rb
+- spec/rails_best_practices/reviews/check_destroy_return_value_spec.rb
 - spec/rails_best_practices/reviews/check_save_return_value_spec.rb
 - spec/rails_best_practices/reviews/default_scope_is_evil_review_spec.rb
 - spec/rails_best_practices/reviews/dry_bundler_in_capistrano_review_spec.rb
@@ -413,7 +419,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: a code metric tool for rails codes.
@@ -452,6 +458,7 @@ test_files:
 - spec/rails_best_practices/prepares/schema_prepare_spec.rb
 - spec/rails_best_practices/reviews/add_model_virtual_attribute_review_spec.rb
 - spec/rails_best_practices/reviews/always_add_db_index_review_spec.rb
+- spec/rails_best_practices/reviews/check_destroy_return_value_spec.rb
 - spec/rails_best_practices/reviews/check_save_return_value_spec.rb
 - spec/rails_best_practices/reviews/default_scope_is_evil_review_spec.rb
 - spec/rails_best_practices/reviews/dry_bundler_in_capistrano_review_spec.rb