rails_best_practices 0.7.5 → 0.8.0

data/README.md

@@ -108,6 +108,8 @@ Now you can customize this configuration file, the default configuration is as f
     UseQueryAttributeCheck: { }
     RemoveTrailingWhitespaceCheck: { }
     UseMultipartAlternativeAsContentTypeOfEmailCheck: {}
+    SimplifyRenderInViewsCheck: {}
+    SimplifyRenderInControllersCheck: {}
 
 You can remove or comment one review to disable it, and you can change the options.
 
@@ -156,6 +158,7 @@ View
 2. Move code into model
 3. Move code into helper
 4. Replace instance variable with local variable
+5. Simplify render in views
 
 Deployment
 

data/lib/rails_best_practices/core/runner.rb

@@ -126,7 +126,8 @@ module RailsBestPractices
               content = Haml::Engine.new(content).precompiled
               # remove \xxx characters
               content.gsub!(/\\\d{3}/, '')
-            rescue Haml::SyntaxError
+            rescue Haml::Error
+              # do nothing, just ignore the wrong haml files.
             end
           end
           content

data/lib/rails_best_practices/prepares.rb

@@ -6,7 +6,15 @@ require 'rails_best_practices/prepares/schema_prepare'
 module RailsBestPractices
   module Prepares
     class <<self
-      attr_accessor :models, :model_associations, :model_attributes, :mailer_names
+      attr_writer :models, :model_associations, :model_attributes, :mailer_names
+
+      [:models, :model_associations, :model_attributes, :mailer_names].each do |method_name|
+        class_eval <<-EOS
+        def #{method_name}
+          @#{method_name} ||= []
+        end
+        EOS
+      end
     end
   end
 end

data/lib/rails_best_practices/reviews.rb

@@ -22,3 +22,5 @@ require 'rails_best_practices/reviews/dry_bundler_in_capistrano_review'
 require 'rails_best_practices/reviews/use_say_with_time_in_migrations_review'
 require 'rails_best_practices/reviews/use_query_attribute_review'
 require 'rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review'
+require 'rails_best_practices/reviews/simplify_render_in_views_review'
+require 'rails_best_practices/reviews/simplify_render_in_controllers_review'

data/lib/rails_best_practices/reviews/always_add_db_index_review.rb

@@ -201,8 +201,8 @@ module RailsBestPractices
 
         # remove the non foreign keys with only _type column.
         def remove_only_type_foreign_keys
-          @foreign_keys.delete_if { |table, foreign_key|
-            foreign_key.size == 1 && foreign_key[0] =~ /_type$/
+          @foreign_keys.each { |table, foreign_keys|
+            foreign_keys.delete_if { |key| key =~ /_type$/ }
           }
         end
 

data/lib/rails_best_practices/reviews/simplify_render_in_controllers_review.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+require 'rails_best_practices/reviews/review'
+
+module RailsBestPractices
+  module Reviews
+    # Review a controller file to make sure using simplified syntax for render.
+    #
+    # See the best practice details here http://rails-bestpractices.com/posts/62-simplify-render-in-controllers.
+    #
+    # Implementation:
+    #
+    # Review process:
+    #   check all render method calls in controller files,
+    #   if there is a key 'action', 'template' or 'file' in the argument,
+    #   then they should be replaced by simplified syntax.
+    class SimplifyRenderInControllersReview < Review
+      def url
+        "http://rails-bestpractices.com/posts/62-simplify-render-in-controllers"
+      end
+
+      def interesting_nodes
+        [:call]
+      end
+
+      def interesting_files
+        CONTROLLER_FILES
+      end
+
+      # check call node in the controller file,
+      # if its message is render and the arguments contain a key action, template or file,
+      # then it should be replaced by simplified syntax.
+      def start_call(call_node)
+        if :render == call_node.message && call_node.arguments[1].to_s =~ /"(action|template|file)" =>/
+          add_error 'simplify render in controllers'
+        end
+      end
+    end
+  end
+end

data/lib/rails_best_practices/reviews/simplify_render_in_views_review.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+require 'rails_best_practices/reviews/review'
+
+module RailsBestPractices
+  module Reviews
+    # Review a view file to make sure using simplified syntax for render.
+    #
+    # See the best practice details here http://rails-bestpractices.com/posts/61-simplify-render-in-views.
+    #
+    # Implementation:
+    #
+    # Review process:
+    #   check all render method calls in view files,
+    #   if there is a key 'partial' in the argument, then they should be replaced by simplified syntax.
+    class SimplifyRenderInViewsReview < Review
+      def url
+        "http://rails-bestpractices.com/posts/61-simplify-render-in-views"
+      end
+
+      def interesting_nodes
+        [:call]
+      end
+
+      def interesting_files
+        VIEW_FILES
+      end
+
+      # check call node in view file,
+      # if its message is render and the arguments contain a key partial,
+      # then it should be replaced by simplified syntax.
+      def start_call(call_node)
+        if :render == call_node.message && call_node.arguments[1].to_s =~ /"partial" =>/
+          add_error 'simplify render in views'
+        end
+      end
+    end
+  end
+end

data/lib/rails_best_practices/version.rb

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

data/rails_best_practices.yml

@@ -22,3 +22,5 @@ UseSayWithTimeInMigrationsCheck: { }
 UseQueryAttributeCheck: { }
 RemoveTrailingWhitespaceCheck: { }
 UseMultipartAlternativeAsContentTypeOfEmailCheck: {}
+SimplifyRenderInViewsCheck: {}
+SimplifyRenderInControllersCheck: {}

data/spec/rails_best_practices/reviews/always_add_db_index_review_spec.rb

@@ -83,6 +83,22 @@ describe RailsBestPractices::Reviews::AlwaysAddDbIndexReview do
     runner.errors[0].to_s.should == "db/schema.rb:2 - always add db index (taggings => [tag_id])"
   end
 
+  it "should always add db index only _id without non related _type column" do
+    content = <<-EOF
+    ActiveRecord::Schema.define(:version => 20100603080629) do
+      create_table "websites", :force => true do |t|
+        t.integer  "user_id"
+        t.string   "icon_file_name"
+        t.integer  "icon_file_size"
+        t.string   "icon_content_type"
+      end
+    end
+    EOF
+    runner.review('db/schema.rb', content)
+    runner.should have(1).errors
+    runner.errors[0].to_s.should == "db/schema.rb:2 - always add db index (websites => [user_id])"
+  end
+
   it "should not always add db index with column has no id" do
     content = <<-EOF
     ActiveRecord::Schema.define(:version => 20100603080629) do

data/spec/rails_best_practices/reviews/simplify_render_in_controllers_review_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Reviews::SimplifyRenderInControllersReview do
+  let(:runner) { RailsBestPractices::Core::Runner.new(:reviews => RailsBestPractices::Reviews::SimplifyRenderInControllersReview.new) }
+
+  it "should simplify render action view" do
+    content =<<-EOF
+    def edit
+      render :action => :edit
+    end
+    EOF
+    runner.review("app/controllers/posts_controller.rb", content)
+    runner.should have(1).errors
+    runner.errors[0].to_s.should == "app/controllers/posts_controller.rb:3 - simplify render in controllers"
+  end
+
+  it "should simplify render actions's template" do
+    content =<<-EOF
+    def edit
+      render :template => 'books/edit'
+    end
+    EOF
+    runner.review("app/controllers/posts_controller.rb", content)
+    runner.should have(1).errors
+    runner.errors[0].to_s.should == "app/controllers/posts_controller.rb:3 - simplify render in controllers"
+  end
+
+  it "should simplify render an arbitrary file" do
+    content =<<-EOF
+    def edit
+      render :file => '/path/to/rails/app/views/books/edit'
+    end
+    EOF
+    runner.review("app/controllers/posts_controller.rb", content)
+    runner.should have(1).errors
+    runner.errors[0].to_s.should == "app/controllers/posts_controller.rb:3 - simplify render in controllers"
+  end
+
+  it "should not simplify render action view" do
+    content =<<-EOF
+    render :edit
+    EOF
+    runner.review("app/controllers/posts_controller", content)
+    runner.should have(0).errors
+  end
+
+  it "should not simplify render actions's template" do
+    content =<<-EOF
+    def edit
+      render 'books/edit'
+    end
+    EOF
+    runner.review("app/controllers/posts_controller.rb", content)
+    runner.should have(0).errors
+  end
+
+  it "should not simplify render an arbitrary file" do
+    content =<<-EOF
+    def edit
+      render '/path/to/rails/app/views/books/edit'
+    end
+    EOF
+    runner.review("app/controllers/posts_controller.rb", content)
+    runner.should have(0).errors
+  end
+end

data/spec/rails_best_practices/reviews/simplify_render_in_views_review_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Reviews::SimplifyRenderInViewsReview do
+  let(:runner) { RailsBestPractices::Core::Runner.new(:reviews => RailsBestPractices::Reviews::SimplifyRenderInViewsReview.new) }
+
+  it "should simplify render simple partial" do
+    content =<<-EOF
+    <%= render :partial => 'sidebar' %>
+    EOF
+    runner.review('app/views/posts/index.html.erb', content)
+    runner.should have(1).errors
+    runner.errors[0].to_s.should == "app/views/posts/index.html.erb:1 - simplify render in views"
+  end
+
+  it "should simplify render partial with object" do
+    content =<<-EOF
+    <%= render :partial => 'posts/post', :object => @post %>
+    EOF
+    runner.review('app/views/posts/index.html.erb', content)
+    runner.should have(1).errors
+    runner.errors[0].to_s.should == "app/views/posts/index.html.erb:1 - simplify render in views"
+  end
+
+  it "should simplify render partial with collection" do
+    content =<<-EOF
+    <%= render :partial => 'posts', :collection => @posts %>
+    EOF
+    runner.review('app/views/posts/index.html.erb', content)
+    runner.should have(1).errors
+    runner.errors[0].to_s.should == "app/views/posts/index.html.erb:1 - simplify render in views"
+  end
+
+  it "should simplify render partial with local variables" do
+    content =<<-EOF
+    <%= render :partial => 'comments/comment', :locals => { :parent => post } %>
+    EOF
+    runner.review('app/views/posts/index.html.erb', content)
+    runner.should have(1).errors
+    runner.errors[0].to_s.should == "app/views/posts/index.html.erb:1 - simplify render in views"
+  end
+
+  it "should not simplify render simple partial" do
+    content =<<-EOF
+    <%= render 'sidebar' %>
+    <%= render 'shared/sidebar' %>
+    EOF
+    runner.review('app/views/posts/index.html.erb', content)
+    runner.should have(0).errors
+  end
+
+  it "should not simplify render partial with object" do
+    content =<<-EOF
+    <%= render @post %>
+    EOF
+    runner.review('app/views/posts/index.html.erb', content)
+    runner.should have(0).errors
+  end
+
+  it "should not simplify render partial with collection" do
+    content =<<-EOF
+    <%= render @posts %>
+    EOF
+    runner.review('app/views/posts/index.html.erb', content)
+    runner.should have(0).errors
+  end
+
+  it "should not simplify render partial with local variables" do
+    content =<<-EOF
+    <%= render 'comments/comment', :parent => post %>
+    EOF
+    runner.review('app/views/posts/index.html.erb', content)
+    runner.should have(0).errors
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rails_best_practices
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 63
   prerelease: 
   segments: 
   - 0
-  - 7
-  - 5
-  version: 0.7.5
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Richard Huang
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-28 00:00:00 +08:00
+date: 2011-04-23 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -247,6 +247,8 @@ files:
 - lib/rails_best_practices/reviews/replace_complex_creation_with_factory_method_review.rb
 - lib/rails_best_practices/reviews/replace_instance_variable_with_local_variable_review.rb
 - lib/rails_best_practices/reviews/review.rb
+- lib/rails_best_practices/reviews/simplify_render_in_controllers_review.rb
+- lib/rails_best_practices/reviews/simplify_render_in_views_review.rb
 - lib/rails_best_practices/reviews/use_before_filter_review.rb
 - lib/rails_best_practices/reviews/use_model_association_review.rb
 - lib/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review.rb
@@ -288,6 +290,8 @@ files:
 - spec/rails_best_practices/reviews/replace_complex_creation_with_factory_method_review_spec.rb
 - spec/rails_best_practices/reviews/replace_instance_variable_with_local_variable_review_spec.rb
 - spec/rails_best_practices/reviews/review_spec.rb
+- spec/rails_best_practices/reviews/simplify_render_in_controllers_review_spec.rb
+- spec/rails_best_practices/reviews/simplify_render_in_views_review_spec.rb
 - spec/rails_best_practices/reviews/use_before_filter_review_spec.rb
 - spec/rails_best_practices/reviews/use_model_association_review_spec.rb
 - spec/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review_spec.rb
@@ -378,6 +382,8 @@ test_files:
 - spec/rails_best_practices/reviews/replace_complex_creation_with_factory_method_review_spec.rb
 - spec/rails_best_practices/reviews/replace_instance_variable_with_local_variable_review_spec.rb
 - spec/rails_best_practices/reviews/review_spec.rb
+- spec/rails_best_practices/reviews/simplify_render_in_controllers_review_spec.rb
+- spec/rails_best_practices/reviews/simplify_render_in_views_review_spec.rb
 - spec/rails_best_practices/reviews/use_before_filter_review_spec.rb
 - spec/rails_best_practices/reviews/use_model_association_review_spec.rb
 - spec/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review_spec.rb