rails_best_practices 1.9.0 → 1.9.1

data/lib/rails_best_practices/reviews/protect_mass_assignment_review.rb

@@ -19,16 +19,24 @@ module RailsBestPractices
         "http://rails-bestpractices.com/posts/148-protect-mass-assignment"
       end
 
-      # check class node, grep all command nodes, if none of them is with message attr_accessible or attr_protected,
+      # check class node, grep all command nodes,
+      # if config.active_record.whitelist_attributes is not set true,
+      # and if none of them is with message attr_accessible or attr_protected,
+      # and if not use devise or authlogic,
       # then it should add attr_accessible or attr_protected to protect mass assignment.
       def start_class(node)
-        if !rails_builtin?(node) && !devise?(node) && !authlogic?(node)
+        if !whitelist_attributes_config? && !rails_builtin?(node) && !devise?(node) && !authlogic?(node)
           add_error "protect mass assignment"
         end
       end
 
       private
+        def whitelist_attributes_config?
+          Prepares.configs["config.active_record.whitelist_attributes"] == "true"
+        end
+
         def rails_builtin?(node)
+          node.grep_node(:sexp_type => [:vcall, :var_ref], :to_s => "attr_accessible").present? ||
           node.grep_node(:sexp_type => :command, :message => %w(attr_accessible attr_protected)).present?
         end
 
@@ -37,7 +45,7 @@ module RailsBestPractices
         end
 
         def authlogic?(node)
-         node.grep_node(:sexp_type => :vcall, :to_s => "acts_as_authentic").present? ||
+         node.grep_node(:sexp_type => [:vcall, :var_ref], :to_s => "acts_as_authentic").present? ||
          node.grep_node(:sexp_type => :fcall, :message => "acts_as_authentic").present?
         end
     end

data/lib/rails_best_practices/reviews/remove_unused_methods_in_models_review.rb

@@ -94,9 +94,13 @@ module RailsBestPractices
 
         def internal_except_methods
           %w(
-            initialize validate validate_each to_xml to_json assign_attributes after_find after_initialize
-            before_save before_create before_update before_destroy after_save after_create after_update after_destroy
-            to_param method_missing
+            initialize
+            validate validate_each validate_on_create validate_on_update
+            human_attribute_name
+            assign_attributes
+            to_xml to_json to_param
+            before_save before_create before_update before_destroy after_save after_create after_update after_destroy after_find after_initialize
+            method_missing
           ).map { |method_name| "*\##{method_name}" }
         end
     end

data/lib/rails_best_practices/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module RailsBestPractices
-  VERSION = "1.9.0"
+  VERSION = "1.9.1"
 end

data/rails_best_practices.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.add_dependency("erubis")
   s.add_dependency("i18n")
   s.add_dependency("activesupport")
+  s.add_dependency("awesome_print")
 
   s.add_development_dependency("rake")
   s.add_development_dependency("rspec")

data/spec/rails_best_practices/analyzer_spec.rb

@@ -1,45 +1,65 @@
 require 'spec_helper'
 
-describe RailsBestPractices::Analyzer do
-  subject { RailsBestPractices::Analyzer.new(".") }
+module RailsBestPractices
+  describe Analyzer do
+    subject { Analyzer.new(".") }
 
-  describe "expand_dirs_to_files" do
-    it "should expand all files in spec directory" do
-      dir = File.dirname(__FILE__)
-      subject.expand_dirs_to_files(dir).should be_include(dir + '/analyzer_spec.rb')
+    describe "expand_dirs_to_files" do
+      it "should expand all files in spec directory" do
+        dir = File.dirname(__FILE__)
+        subject.expand_dirs_to_files(dir).should be_include(dir + '/analyzer_spec.rb')
+      end
     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"]
-      subject.file_sort(files).should == ["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"]
+        subject.file_sort(files).should == ["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
-  end
 
-  describe "file_ignore" do
-    it "should ignore lib" do
-      files = ["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"]
-      subject.file_ignore(files, 'lib/').should == ["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"]
+    describe "file_ignore" do
+      it "should ignore lib" do
+        files = ["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"]
+        subject.file_ignore(files, 'lib/').should == ["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
     end
-  end
 
-  describe "output_terminal_errors" do
-    it "should output errors in terminal" do
-      check1 = RailsBestPractices::Reviews::LawOfDemeterReview.new
-      check2 = RailsBestPractices::Reviews::UseQueryAttributeReview.new
-      runner = RailsBestPractices::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
-      subject.runner = runner
-      subject.instance_variable_set("@options", {"without-color" => false})
+    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
+        subject.runner = runner
+        subject.instance_variable_set("@options", {"without-color" => false})
+
+        $origin_stdout = $stdout
+        $stdout = StringIO.new
+        subject.output_terminal_errors
+        result = $stdout.string
+        $stdout = $origin_stdout
+        result.should == ["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"
+      end
+    end
 
-      $origin_stdout = $stdout
-      $stdout = StringIO.new
-      subject.output_terminal_errors
-      result = $stdout.string
-      $stdout = $origin_stdout
-      result.should == ["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"
+    describe "errors_filter_block" do
+      it "should call errors_filter_block after analyze" do
+        analyzer = Analyzer.new("path", "silent" => true)
+        analyzer.errors_filter_block = lambda { |errors| errors.each { |error| error.highlight = true } }
+        analyzer.stub(:expand_dirs_to_files).and_return([])
+        analyzer.stub(:file_sort).and_return([])
+        analyzer.stub(:file_ignore).and_return([])
+        analyzer.stub(:process)
+        runner = stub
+        runner.stub(:color=)
+        errors = [Core::Error.new, Core::Error.new]
+        Core::Runner.stub(:new).and_return(runner)
+        runner.stub(:errors).and_return(errors)
+        analyzer.analyze
+        analyzer.send(:errors).should be_all(&:highlight)
+      end
     end
   end
 end

data/spec/rails_best_practices/core/check_spec.rb

@@ -1,63 +1,82 @@
 require 'spec_helper'
 
-describe RailsBestPractices::Core::Check do
-  let(:check) { RailsBestPractices::Core::Check.new }
+module RailsBestPractices::Core
+  describe Check do
+    let(:check) { Check.new }
 
-  it "should get empty interesting nodes" do
-    check.interesting_nodes.should == []
-  end
-
-  it "should match none of interesting files" do
-    check.interesting_files.should == []
-  end
-
-  context "node_start" do
-    it "should call start_if" do
-      node = stub(:sexp_type => :if)
-      check.should_receive(:send).with("start_if", node)
-      check.node_start(node)
+    it "should get empty interesting nodes" do
+      check.interesting_nodes.should == []
     end
 
-    it "should call start_call" do
-      node = stub(:sexp_type => :call)
-      check.should_receive(:send).with("start_call", node)
-      check.node_start(node)
+    it "should match none of interesting files" do
+      check.interesting_files.should == []
     end
-  end
 
-  context "node_end" do
-    it "should call end_if" do
-      node = stub(:sexp_type => :if)
-      check.should_receive(:send).with("end_if", node)
-      check.node_end(node)
+    context "node_start" do
+      it "should call start_if" do
+        node = stub(:sexp_type => :if)
+        check.should_receive(:send).with("start_if", node)
+        check.node_start(node)
+      end
+
+      it "should call start_call" do
+        node = stub(:sexp_type => :call)
+        check.should_receive(:send).with("start_call", node)
+        check.node_start(node)
+      end
+
+      it "should print node if debug mode" do
+        node = stub(:sexp_type => :call)
+        Check.class_eval { debug }
+        check.should_receive(:send).with("start_call", node)
+        check.should_receive(:ap).with(node)
+        check.node_start(node)
+        Check.class_eval { @debug = false }
+      end
     end
 
-    it "should call end_call" do
-      node = stub(:sexp_type => :call)
-      check.should_receive(:send).with("end_call", node)
-      check.node_end(node)
+    context "node_end" do
+      it "should call end_if" do
+        node = stub(:sexp_type => :if)
+        check.should_receive(:send).with("end_if", node)
+        check.node_end(node)
+      end
+
+      it "should call end_call" do
+        node = stub(:sexp_type => :call)
+        check.should_receive(:send).with("end_call", node)
+        check.node_end(node)
+      end
     end
-  end
 
-  context "callback" do
-    it "should add callback to start_call" do
-      execute = false
-      check.class.add_callback "start_call" do
-        execute = true
+    context "callback" do
+      it "should add callback to start_call" do
+        execute = false
+        check.class.add_callback "start_call" do
+          execute = true
+        end
+        node = stub(:sexp_type => :call)
+        check.node_start(node)
+        execute.should be_true
+      end
+
+      it "should ad callbacks to end_call" do
+        execute = false
+        check.class.add_callback "end_call" do
+          execute = true
+        end
+        node = stub(:sexp_type => :call)
+        check.node_end(node)
+        execute.should be_true
       end
-      node = stub(:sexp_type => :call)
-      check.node_start(node)
-      execute.should be_true
     end
 
-    it "should ad callbacks to end_call" do
-      execute = false
-      check.class.add_callback "end_call" do
-        execute = true
+    context "debug" do
+      it "should be debug mode" do
+        Check.debug
+        Check.should be_debug
+        Check.class_eval { @debug = false }
       end
-      node = stub(:sexp_type => :call)
-      check.node_end(node)
-      execute.should be_true
     end
   end
 end

data/spec/rails_best_practices/core/checking_visitor_spec.rb

@@ -1,78 +1,79 @@
 # encoding: utf-8
 require 'spec_helper'
 
-class TestLexical1
-end
-class TestLexical2
-end
-class TestPrepare1 < RailsBestPractices::Core::Check
-  interesting_nodes :call
-  interesting_files MODEL_FILES
-end
-
-class TestPrepare2 < RailsBestPractices::Core::Check
-  interesting_nodes :class
-  interesting_files MAILER_FILES
-end
-
-class TestReview1 < RailsBestPractices::Core::Check
-  interesting_nodes :defn
-  interesting_files CONTROLLER_FILES
-end
+module RailsBestPractices::Core
 
-class TestReview2 < RailsBestPractices::Core::Check
-  interesting_nodes :call
-  interesting_files VIEW_FILES
-end
-
-describe RailsBestPractices::Core::CheckingVisitor do
-  let(:lexical1) { TestLexical1.new }
-  let(:lexical2) { TestLexical2.new }
-  let(:prepare1) { TestPrepare1.new }
-  let(:prepare2) { TestPrepare2.new }
-  let(:review1) { TestReview1.new }
-  let(:review2) { TestReview2.new }
-  let(:visitor) {
-    RailsBestPractices::Core::CheckingVisitor.new(
-      :lexicals => [lexical1, lexical2],
-      :prepares => [prepare1, prepare2],
-      :reviews => [review1, review2]
-    )
-  }
-
-  it "should lexical check" do
-    filename = "app/models/user.rb"
-    content = "class User; end"
-    lexical1.should_receive(:check).with(filename, content)
-    lexical2.should_receive(:check).with(filename, content)
-    visitor.lexical(filename, content)
+  class TestLexical1; end
+  class TestLexical2; end
+  class TestPrepare1 < Check
+    interesting_nodes :call
+    interesting_files MODEL_FILES
   end
 
-  it "should prepare model associations" do
-    node = stub(:sexp_type => :call, :children => [], :file => "app/models/user.rb")
-    prepare1.should_receive(:node_start).with(node)
-    prepare1.should_receive(:node_end).with(node)
-    visitor.prepare(node)
+  class TestPrepare2 < Check
+    interesting_nodes :class
+    interesting_files MAILER_FILES
   end
 
-  it "should prepare mailer names" do
-    node = stub(:sexp_type => :class, :children => [], :file => "app/mailers/user_mailer.rb")
-    prepare2.should_receive(:node_start).with(node)
-    prepare2.should_receive(:node_end).with(node)
-    visitor.prepare(node)
+  class TestReview1 < Check
+    interesting_nodes :defn
+    interesting_files CONTROLLER_FILES
   end
 
-  it "should review controller method definitions" do
-    node = stub(:sexp_type => :defn, :children => [], :file => "app/controllers/users_controller.rb")
-    review1.should_receive(:node_start).with(node)
-    review1.should_receive(:node_end).with(node)
-    visitor.review(node)
+  class TestReview2 < Check
+    interesting_nodes :call
+    interesting_files VIEW_FILES
   end
 
-  it "should review view calls" do
-    node = stub(:sexp_type => :call, :children => [], :file => "app/views/users/new.html.erb")
-    review2.should_receive(:node_start).with(node)
-    review2.should_receive(:node_end).with(node)
-    visitor.review(node)
+  describe CheckingVisitor do
+    let(:lexical1) { TestLexical1.new }
+    let(:lexical2) { TestLexical2.new }
+    let(:prepare1) { TestPrepare1.new }
+    let(:prepare2) { TestPrepare2.new }
+    let(:review1) { TestReview1.new }
+    let(:review2) { TestReview2.new }
+    let(:visitor) {
+      CheckingVisitor.new(
+        :lexicals => [lexical1, lexical2],
+        :prepares => [prepare1, prepare2],
+        :reviews => [review1, review2]
+      )
+    }
+
+    it "should lexical check" do
+      filename = "app/models/user.rb"
+      content = "class User; end"
+      lexical1.should_receive(:check).with(filename, content)
+      lexical2.should_receive(:check).with(filename, content)
+      visitor.lexical(filename, content)
+    end
+
+    it "should prepare model associations" do
+      node = stub(:sexp_type => :call, :children => [], :file => "app/models/user.rb")
+      prepare1.should_receive(:node_start).with(node)
+      prepare1.should_receive(:node_end).with(node)
+      visitor.prepare(node)
+    end
+
+    it "should prepare mailer names" do
+      node = stub(:sexp_type => :class, :children => [], :file => "app/mailers/user_mailer.rb")
+      prepare2.should_receive(:node_start).with(node)
+      prepare2.should_receive(:node_end).with(node)
+      visitor.prepare(node)
+    end
+
+    it "should review controller method definitions" do
+      node = stub(:sexp_type => :defn, :children => [], :file => "app/controllers/users_controller.rb")
+      review1.should_receive(:node_start).with(node)
+      review1.should_receive(:node_end).with(node)
+      visitor.review(node)
+    end
+
+    it "should review view calls" do
+      node = stub(:sexp_type => :call, :children => [], :file => "app/views/users/new.html.erb")
+      review2.should_receive(:node_start).with(node)
+      review2.should_receive(:node_end).with(node)
+      visitor.review(node)
+    end
   end
 end

data/spec/rails_best_practices/core/configs_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+module RailsBestPractices::Core
+  describe Configs do
+    it { should be_a_kind_of Hash }
+  end
+end

data/spec/rails_best_practices/core/controllers_spec.rb

@@ -1,5 +1,7 @@
 require 'spec_helper'
 
-describe RailsBestPractices::Core::Controllers do
-  it { should be_a_kind_of RailsBestPractices::Core::Klasses }
+module RailsBestPractices::Core
+  describe Controllers do
+    it { should be_a_kind_of Klasses }
+  end
 end