rails_best_practices 0.2.15 → 0.2.16

data/README.textile

@@ -58,6 +58,7 @@ AlwaysAddDbIndexCheck: { }
 UseFilterCheck: { }
 MoveCodeIntoControllerCheck: { }
 MoveCodeIntoHelperCheck: { }
+ReplaceInstanceVariableWithLocalVariableCheck: { }
 </code></pre>
 
 *************************************************
@@ -102,7 +103,7 @@ h2. Progress
 ## [-Move code into controller-]
 ## Move code into model
 ## [-Move code into helper-]
-## Replace instance variable with local variable
+## [-Replace instance variable with local variable-]
 ## Use Form Builder
 ## Organize Helper files
 

data/VERSION

@@ -1 +1 @@
-0.2.15
+0.2.16

data/lib/rails_best_practices/checks.rb

@@ -18,3 +18,4 @@ require 'rails_best_practices/checks/always_add_db_index_check'
 require 'rails_best_practices/checks/use_filter_check'
 require 'rails_best_practices/checks/move_code_into_controller_check'
 require 'rails_best_practices/checks/move_code_into_helper_check'
+require 'rails_best_practices/checks/replace_instance_variable_with_local_variable_check'

data/lib/rails_best_practices/checks/check.rb

@@ -3,12 +3,13 @@ require 'rails_best_practices/core/error'
 module RailsBestPractices
   module Checks
     class Check
-      NODE_TYPES = [:call, :defn, :defs, :if, :unless, :class, :lasgn]
+      NODE_TYPES = [:call, :defn, :defs, :if, :unless, :class, :lasgn, :ivar]
       
       CONTROLLER_FILES = /_controller.rb$/
       MIGRATION_FILES = /db\/migrate\/.*rb/
       MODLE_FILES = /models\/.*rb/
       VIEW_FILES = /views\/.*erb/
+      PARTIAL_VIEW_FILES = /views\/.*\/_.*erb/
 
       def initialize
         @errors = []

data/lib/rails_best_practices/checks/replace_instance_variable_with_local_variable_check.rb

@@ -0,0 +1,23 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # Check a partail view file to make sure there is no instance variable.
+    #
+    # Implementation: Check all instance variable, if exists, then it should be replaced with local variable
+    class ReplaceInstanceVariableWithLocalVariableCheck < Check
+      
+      def interesting_nodes
+        [:ivar]
+      end
+      
+      def interesting_files
+        PARTIAL_VIEW_FILES
+      end
+      
+      def evaluate_start(node)
+        add_error "replace instance variable with local variable"
+      end
+    end
+  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.15"
+  s.version = "0.2.16"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Huang"]
@@ -43,6 +43,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/replace_instance_variable_with_local_variable_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",
@@ -72,6 +73,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/replace_instance_variable_with_local_variable_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",
@@ -101,6 +103,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/replace_instance_variable_with_local_variable_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",

data/rails_best_practices.yml

@@ -18,3 +18,4 @@ AlwaysAddDbIndexCheck: { }
 UseFilterCheck: { }
 MoveCodeIntoControllerCheck: { }
 MoveCodeIntoHelperCheck: { }
+ReplaceInstanceVariableWithLocalVariableCheck: { }

data/spec/rails_best_practices/checks/move_code_into_helper_check_spec.rb

@@ -15,6 +15,7 @@ describe RailsBestPractices::Checks::MoveCodeIntoHelperCheck do
     @runner.check('app/views/posts/show.html.erb', content)
     errors = @runner.errors
     errors.should_not be_empty
+    errors[0].to_s.should == "app/views/posts/show.html.erb:3 - move code into helper"
   end
 
   it "should not move code into helper with simple arguments" do

data/spec/rails_best_practices/checks/replace_instance_variable_with_local_variable_check_spec.rb

@@ -0,0 +1,26 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe RailsBestPractices::Checks::ReplaceInstanceVariableWithLocalVariableCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::ReplaceInstanceVariableWithLocalVariableCheck.new)
+  end
+
+  it "should replace instance variable with local varialbe" do
+    content = <<-EOF
+    <%= @post.title %>
+    EOF
+    @runner.check('app/views/posts/_post.html.erb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/views/posts/_post.html.erb:1 - replace instance variable with local variable"
+  end
+
+  it "should not replace instance variable with local varialbe" do
+    content = <<-EOF
+    <%= post.title %>
+    EOF
+    @runner.check('app/views/posts/_post.html.erb', 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.15
+  version: 0.2.16
 platform: ruby
 authors: 
 - Richard Huang
@@ -66,6 +66,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/replace_instance_variable_with_local_variable_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
@@ -95,6 +96,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/replace_instance_variable_with_local_variable_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
@@ -146,6 +148,7 @@ test_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/replace_instance_variable_with_local_variable_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