rails_best_practices 0.9.0 → 0.10.0

data/README.md

@@ -111,6 +111,7 @@ Now you can customize this configuration file, the default configuration is as f
     SimplifyRenderInViewsCheck: {}
     SimplifyRenderInControllersCheck: {}
     RemoveEmptyHelpersCheck: {}
+    RemoveTabCheck: {}
 
 You can remove or comment one review to disable it, and you can change the options.
 
@@ -173,6 +174,7 @@ Deployment
 Other
 
 1. Remove Trailing Whitespace
+2. Remove Tab
 
 Write Your Own Check List
 -------------------------

data/lib/rails_best_practices/lexicals/remove_tab_check.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+require 'rails_best_practices/core/check'
+
+module RailsBestPractices
+  module Lexicals
+    # Make sure there are no tabs in files.
+    #
+    # See the best practice details here http://rails-bestpractices.com/posts/81-remove-tab
+    class RemoveTabCheck < Core::Check
+      def url
+        "http://rails-bestpractices.com/posts/81-remove-tab"
+      end
+
+      # check if the content of file contains a tab.
+      #
+      # @param [String] filename name of the file
+      # @param [String] content content of the file
+      def check(filename, content)
+        if content =~ /\t/m
+          line_no = $`.count("\n") + 1
+          add_error("remove tab, use spaces instead", filename, line_no)
+        end
+      end
+    end
+  end
+end

data/lib/rails_best_practices/lexicals.rb

@@ -1,2 +1,3 @@
 # encoding: utf-8
 require 'rails_best_practices/lexicals/remove_trailing_whitespace_check'
+require 'rails_best_practices/lexicals/remove_tab_check'

data/lib/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review.rb

@@ -54,8 +54,8 @@ module RailsBestPractices
         #
         # @param [String] name method name in action_mailer
         def rails3_canonical_mailer_views?(name)
-          (exist?("#{name}.html.erb") && !exist?("#{name}.text.erb")) ||
-          (exist?("#{name}.html.haml") && !exist?("#{name}.text.haml"))
+          (exist?("#{name}.html.erb") && !haml_or_erb_exists?("#{name}.text")) ||
+          (exist?("#{name}.html.haml") && !haml_or_erb_exists?("#{name}.text") )
         end
 
         # check if the filename existed in the mailer directory.
@@ -63,6 +63,11 @@ module RailsBestPractices
           File.exist? File.join(mailer_directory, filename)
         end
 
+        # check if haml or erb exists
+        def haml_or_erb_exists?(filename)
+          exist?("#{filename}.erb") || exist?("#{filename}.haml")
+        end
+
         # check if the method is a deliver_method.
         #
         # @param [String] name the name of the method

data/lib/rails_best_practices/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 module RailsBestPractices
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end
 

data/lib/rails_best_practices.rb

@@ -166,19 +166,30 @@ module RailsBestPractices
     # @param [Array] files
     # @return [Array] sorted files
     def file_sort files
-      files.sort { |a, b|
-        if a =~ Core::Check::MODEL_FILES
-          -1
-        elsif b =~ Core::Check::MODEL_FILES
-          1
-        elsif a =~ Core::Check::MAILER_FILES
-          -1
-        elsif b =~ Core::Check::MAILER_FILES
-          1
-        else
-          a <=> b
-        end
-      }
+      models = []
+      mailers = []
+      files.each do |a| 
+          if a =~ Core::Check::MODEL_FILES
+            models << a
+          end
+      end
+      files.each do |a| 
+          if a =~ Core::Check::MAILER_FILES
+            mailers << a
+          end
+      end
+      files.collect! do |a| 
+          if a =~ Core::Check::MAILER_FILES || a =~ Core::Check::MODEL_FILES
+            #nil
+          else
+            a
+          end
+      end
+      files.compact!
+      models.sort
+      mailers.sort
+      files.sort
+      return models + mailers + files
     end
 
     # ignore specific files.

data/rails_best_practices.yml

@@ -6,7 +6,7 @@ ReplaceComplexCreationWithFactoryMethodCheck: { attribute_assignment_count: 2 }
 MoveModelLogicIntoModelCheck: { use_count: 4 }
 OveruseRouteCustomizationsCheck: { customize_count: 3 }
 NeedlessDeepNestingCheck: { nested_count: 2 }
-NotUseDefaultRouteCheck: {  }
+NotUseDefaultRouteCheck: { }
 KeepFindersOnTheirOwnModelCheck: { }
 LawOfDemeterCheck: { }
 UseObserverCheck: { }
@@ -21,7 +21,8 @@ DryBundlerInCapistranoCheck: { }
 UseSayWithTimeInMigrationsCheck: { }
 UseQueryAttributeCheck: { }
 RemoveTrailingWhitespaceCheck: { }
-UseMultipartAlternativeAsContentTypeOfEmailCheck: {}
-SimplifyRenderInViewsCheck: {}
-SimplifyRenderInControllersCheck: {}
-RemoveEmptyHelpersCheck: {}
+UseMultipartAlternativeAsContentTypeOfEmailCheck: { }
+SimplifyRenderInViewsCheck: { }
+SimplifyRenderInControllersCheck: { }
+RemoveEmptyHelpersCheck: { }
+RemoveTabCheck: { }

data/spec/rails_best_practices/lexicals/remove_tab_check_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Lexicals::RemoveTabCheck do
+  let(:runner) { RailsBestPractices::Core::Runner.new(:lexicals => RailsBestPractices::Lexicals::RemoveTabCheck.new) }
+
+  it "should remove tab" do
+    content =<<-EOF
+    class User < ActiveRecord::Base
+      has_many :projects
+    end
+    EOF
+    content.gsub!("\n", "\t\n")
+    runner.lexical('app/models/user.rb', content)
+    runner.should have(1).errors
+    runner.errors[0].to_s.should == "app/models/user.rb:1 - remove tab, use spaces instead"
+  end
+
+  it "should remove tab with third line" do
+    content =<<-EOF
+    class User < ActiveRecord::Base
+      has_many :projects
+\t
+    end
+    EOF
+    runner.lexical('app/models/user.rb', content)
+    runner.should have(1).errors
+    runner.errors[0].to_s.should == "app/models/user.rb:3 - remove tab, use spaces instead"
+  end
+
+  it "should not remove trailing whitespace" do
+    content =<<-EOF
+    class User < ActiveRecord::Base
+      has_many :projects
+    end
+    EOF
+    runner.lexical('app/models/user.rb', content)
+    runner.should have(0).errors
+  end
+end

data/spec/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review_spec.rb

@@ -160,7 +160,7 @@ describe RailsBestPractices::Reviews::UseMultipartAlternativeAsContentTypeOfEmai
         end
 
         it "should not use multipart/alternative as content_type of email" do
-          mock_email_files(["send_email.html.haml"], "text.haml" => true, "html.haml" => true)
+          mock_email_files(["send_email.html.haml", "send_email.text.haml"], "html.haml" => true, "text.haml" => true)
           runner.review('app/mailers/project_mailer.rb', content)
           runner.should have(0).errors
         end
@@ -171,6 +171,18 @@ describe RailsBestPractices::Reviews::UseMultipartAlternativeAsContentTypeOfEmai
           runner.should have(0).errors
         end
       end
+
+      context "haml/erb mix" do
+        it "should not suggest using multipart/alternative when mixing html.haml and text.erb" do
+          mock_email_files(["send_email.html.haml", "send_email.text.erb"], "html.haml" => true, "text.erb" => true)
+          runner.review('app/mailers/project_mailer.rb', content)
+          runner.should have(0).errors
+
+          mock_email_files(["send_email.html.erb", "send_email.text.haml"], "html.erb" => true, "text.haml" => true)
+          runner.review('app/mailers/project_mailer.rb', content)
+          runner.should have(0).errors
+        end
+      end
     end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: rails_best_practices
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors: 
 - Richard Huang
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-15 00:00:00 +08:00
+date: 2011-07-04 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -173,6 +173,7 @@ files:
 - lib/rails_best_practices/core/visitable_sexp.rb
 - lib/rails_best_practices/core_ext/enumerable.rb
 - lib/rails_best_practices/lexicals.rb
+- lib/rails_best_practices/lexicals/remove_tab_check.rb
 - lib/rails_best_practices/lexicals/remove_trailing_whitespace_check.rb
 - lib/rails_best_practices/prepares.rb
 - lib/rails_best_practices/prepares/mailer_prepare.rb
@@ -219,6 +220,7 @@ files:
 - spec/rails_best_practices/core/nil_spec.rb
 - spec/rails_best_practices/core/visitable_sexp_spec.rb
 - spec/rails_best_practices/core_ext/enumerable_spec.rb
+- spec/rails_best_practices/lexicals/remove_tab_check_spec.rb
 - spec/rails_best_practices/lexicals/remove_trailing_whitespace_check_spec.rb
 - spec/rails_best_practices/prepares/mailer_prepare_spec.rb
 - spec/rails_best_practices/prepares/model_prepare_spec.rb
@@ -280,7 +282,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 251922047825024421
+      hash: 25522351918325657
       segments: 
       - 0
       version: "0"
@@ -307,6 +309,7 @@ test_files:
 - spec/rails_best_practices/core/nil_spec.rb
 - spec/rails_best_practices/core/visitable_sexp_spec.rb
 - spec/rails_best_practices/core_ext/enumerable_spec.rb
+- spec/rails_best_practices/lexicals/remove_tab_check_spec.rb
 - spec/rails_best_practices/lexicals/remove_trailing_whitespace_check_spec.rb
 - spec/rails_best_practices/prepares/mailer_prepare_spec.rb
 - spec/rails_best_practices/prepares/model_prepare_spec.rb