rails_best_practices 0.2.11 → 0.2.12

data/README.textile

@@ -1,5 +1,4 @@
 h1. rails_best_practices
-
 rails_best_practices is a gem to check quality of rails app files according to ihower's presentation Rails Best Practices.
 rails_best_practices is a code static parser tool based on ruby_parser.
 
@@ -53,6 +52,7 @@ LawOfDemeterCheck: { }
 UseObserverCheck: { }
 IsolateSeedDataCheck: { }
 AlwaysAddDbIndexCheck: { }
+UseFilterCheck: { }
 </code></pre>
 
 *************************************************
@@ -90,7 +90,7 @@ h2. Progress
 ## [-Always add DB index-]
 
 * Lesson 5. Controller
-## Use before_filter
+## [-Use before_filter-]
 ## DRY Controller
 
 * Lesson 6. View

data/VERSION

@@ -1 +1 @@
-0.2.11
+0.2.12

data/lib/rails_best_practices/checks.rb

@@ -15,3 +15,4 @@ require 'rails_best_practices/checks/law_of_demeter_check'
 require 'rails_best_practices/checks/use_observer_check'
 require 'rails_best_practices/checks/isolate_seed_data_check'
 require 'rails_best_practices/checks/always_add_db_index_check'
+require 'rails_best_practices/checks/use_filter_check'

data/lib/rails_best_practices/checks/use_filter_check.rb

@@ -0,0 +1,36 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # Check a controller file to make sure to use filter to remove duplicate call in different action.
+    #
+    # Implementation: Check all methods' first call, if they are duplicate, then should use filter.
+    class UseFilterCheck < Check
+
+      def interesting_nodes
+        [:class]
+      end
+
+      def interesting_files
+        /_controller.rb$/
+      end
+
+      def evaluate_start(node)
+        @methods = {}
+        node.grep_nodes({:node_type => :defn}).each { |method_node| remember_method(method_node) }
+        @methods.each do |first_call, method_names|
+          add_error "use filter for #{first_call.to_ruby} in #{method_names.join(',')}" if method_names.size > 1
+        end
+      end
+
+      private
+
+      def remember_method(method_node)
+        method_name = method_node.message_name
+        first_call = method_node.body[1]
+        @methods[first_call] ||= []
+        @methods[first_call] << method_name
+      end
+    end
+  end
+end

data/lib/rails_best_practices/core/visitable_sexp.rb

@@ -93,8 +93,10 @@ class Sexp
       self[1..-1]
     elsif :class == node_type
       self[3]
+    elsif :defn == node_type
+      self[3][1]
     elsif :defs == node_type
-      self[4]
+      self[4][1]
     end
   end
 

data/rails_best_practices.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rails_best_practices}
-  s.version = "0.2.11"
+  s.version = "0.2.12"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Huang"]
@@ -41,6 +41,7 @@ Gem::Specification.new do |s|
      "lib/rails_best_practices/checks/not_use_default_route_check.rb",
      "lib/rails_best_practices/checks/overuse_route_customizations_check.rb",
      "lib/rails_best_practices/checks/replace_complex_creation_with_factory_method_check.rb",
+     "lib/rails_best_practices/checks/use_filter_check.rb",
      "lib/rails_best_practices/checks/use_model_association_check.rb",
      "lib/rails_best_practices/checks/use_model_callback_check.rb",
      "lib/rails_best_practices/checks/use_observer_check.rb",
@@ -67,6 +68,7 @@ Gem::Specification.new do |s|
      "spec/rails_best_practices/checks/not_use_default_route_check_spec.rb",
      "spec/rails_best_practices/checks/overuse_route_customizations_check_spec.rb",
      "spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb",
+     "spec/rails_best_practices/checks/use_filter_check_spec.rb",
      "spec/rails_best_practices/checks/use_model_association_check_spec.rb",
      "spec/rails_best_practices/checks/use_model_callback_check_spec.rb",
      "spec/rails_best_practices/checks/use_observer_check_spec.rb",
@@ -82,6 +84,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/rails_best_practices/checks/use_scope_access_check_spec.rb",
      "spec/rails_best_practices/checks/not_use_default_route_check_spec.rb",
+     "spec/rails_best_practices/checks/use_filter_check_spec.rb",
      "spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb",
      "spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb",
      "spec/rails_best_practices/checks/use_model_callback_check_spec.rb",

data/rails_best_practices.yml

@@ -15,3 +15,4 @@ LawOfDemeterCheck: { }
 UseObserverCheck: { }
 IsolateSeedDataCheck: { }
 AlwaysAddDbIndexCheck: { }
+UseFilterCheck: { }

data/spec/rails_best_practices/checks/use_filter_check_spec.rb

@@ -0,0 +1,62 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe RailsBestPractices::Checks::UseFilterCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::UseFilterCheck.new)
+  end
+  
+  it "should use filter" do
+    content = <<-EOF
+    class PostsController < ApplicationController
+
+      def show
+        @post = current_user.posts.find(params[:id])
+      end
+
+      def edit
+        @post = current_user.posts.find(params[:id])
+      end
+
+      def update
+        @post = current_user.posts.find(params[:id])
+        @post.update_attributes(params[:post])
+      end
+
+      def destroy
+        @post = current_user.posts.find(params[:id])
+        @post.destroy
+      end
+
+    end
+    EOF
+    @runner.check('app/controllers/posts_controller.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/controllers/posts_controller.rb:1 - use filter for @post = current_user.posts.find(params[:id]) in show,edit,update,destroy"
+  end
+  
+  it "should not use filter" do
+    content = <<-EOF
+    class PostsController < ApplicationController
+      before_filter :find_post, :only => [:show, :edit, :update, :destroy]
+
+      def update
+        @post.update_attributes(params[:post])
+      end
+
+      def destroy
+        @post.destroy
+      end
+
+      protected
+
+      def find_post
+        @post = current_user.posts.find(params[:id])
+      end
+    end
+    EOF
+    @runner.check('app/controllers/posts_controller.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rails_best_practices
 version: !ruby/object:Gem::Version 
-  version: 0.2.11
+  version: 0.2.12
 platform: ruby
 authors: 
 - Richard Huang
@@ -64,6 +64,7 @@ files:
 - lib/rails_best_practices/checks/not_use_default_route_check.rb
 - lib/rails_best_practices/checks/overuse_route_customizations_check.rb
 - lib/rails_best_practices/checks/replace_complex_creation_with_factory_method_check.rb
+- lib/rails_best_practices/checks/use_filter_check.rb
 - lib/rails_best_practices/checks/use_model_association_check.rb
 - lib/rails_best_practices/checks/use_model_callback_check.rb
 - lib/rails_best_practices/checks/use_observer_check.rb
@@ -90,6 +91,7 @@ files:
 - spec/rails_best_practices/checks/not_use_default_route_check_spec.rb
 - spec/rails_best_practices/checks/overuse_route_customizations_check_spec.rb
 - spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb
+- spec/rails_best_practices/checks/use_filter_check_spec.rb
 - spec/rails_best_practices/checks/use_model_association_check_spec.rb
 - spec/rails_best_practices/checks/use_model_callback_check_spec.rb
 - spec/rails_best_practices/checks/use_observer_check_spec.rb
@@ -127,6 +129,7 @@ summary: check rails files according to ihower's presentation 'rails best practi
 test_files: 
 - spec/rails_best_practices/checks/use_scope_access_check_spec.rb
 - spec/rails_best_practices/checks/not_use_default_route_check_spec.rb
+- spec/rails_best_practices/checks/use_filter_check_spec.rb
 - spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb
 - spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb
 - spec/rails_best_practices/checks/use_model_callback_check_spec.rb