rails_best_practices 0.6.6 → 0.6.7

data/lib/rails_best_practices/checks.rb

@@ -1,23 +0,0 @@
-# encoding: utf-8
-require 'rails_best_practices/checks/move_finder_to_named_scope_check'
-require 'rails_best_practices/checks/use_model_association_check'
-require 'rails_best_practices/checks/use_scope_access_check'
-require 'rails_best_practices/checks/add_model_virtual_attribute_check'
-require 'rails_best_practices/checks/replace_complex_creation_with_factory_method_check'
-require 'rails_best_practices/checks/move_model_logic_into_model_check'
-require 'rails_best_practices/checks/overuse_route_customizations_check'
-require 'rails_best_practices/checks/needless_deep_nesting_check'
-require 'rails_best_practices/checks/not_use_default_route_check'
-require 'rails_best_practices/checks/keep_finders_on_their_own_model_check'
-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_before_filter_check'
-require 'rails_best_practices/checks/move_code_into_controller_check'
-require 'rails_best_practices/checks/move_code_into_model_check'
-require 'rails_best_practices/checks/move_code_into_helper_check'
-require 'rails_best_practices/checks/replace_instance_variable_with_local_variable_check'
-require 'rails_best_practices/checks/dry_bundler_in_capistrano_check'
-require 'rails_best_practices/checks/use_say_with_time_in_migrations_check'
-require 'rails_best_practices/checks/use_query_attribute_check'

data/lib/rails_best_practices/checks/check.rb

@@ -1,203 +0,0 @@
-# encoding: utf-8
-require 'rails_best_practices/core/error'
-
-module RailsBestPractices
-  module Checks
-    # A Check class that takes charge of reviewing one rails best practice.
-    # One check contains two process:
-    # 1. prepare process (optional), in this process, one check will do some preparation, such as analyzing the model associations.The check only does the preparation for the nodes (defined in interesting_prepare_nodes) in the files (defined in interesting_prepare_files).
-    # 2. review process, in this process, one check will really review your rails codes. The check only review the nodes (defined in interesting_review_nodes) in the files # (defined in interesting_review_files).
-    class Check
-      # only nodes whose node_type is in NODE_TYPE will be reviewed.
-      NODE_TYPES = [:call, :defn, :defs, :if, :class, :lasgn, :iasgn, :ivar, :lvar, :block, :iter, :const]
-
-      CONTROLLER_FILES = /_controller\.rb$/
-      MIGRATION_FILES = /db\/migrate\/.*\.rb$/
-      MODEL_FILES = /models\/.*\.rb$/
-      MAILER_FILES = /models\/.*\.rb$|mailers\/.*\.rb/
-      VIEW_FILES = /views\/.*\.(erb|haml)$/
-      PARTIAL_VIEW_FILES = /views\/.*\/_.*\.(erb|haml)$/
-      ROUTE_FILE = /config\/routes.rb/
-
-      attr_reader :errors
-
-      def initialize
-        @errors = []
-      end
-
-      # define default interesting_prepare_nodes, interesting_review_nodes, interesting_prepare_files and interesting_review_files.
-      [:prepare, :review].each do |process|
-        class_eval <<-EOS
-          def interesting_#{process}_nodes                        # def interesting_review_nodes
-            []                                                    #   []
-          end                                                     # end
-                                                                  #
-          def interesting_#{process}_files                        # def interesting_review_files
-            /.*/                                                  #   /.*/
-          end                                                     # end
-        EOS
-      end
-
-      # define method prepare_node_start, prepare_node_end, review_node_start and review_node_end.
-      #
-      # they delegate the node to special process method, like
-      #
-      #     review_node_start(call_node) => review_start_call(call_node)
-      #     review_node_end(defn_node) => review_end_defn(defn_node)
-      #     prepare_node_start(calss_node) => prepare_start_class(class_node)
-      #     prepare_node_end(if_node) => prepare_end_if(if_node)
-      [:prepare, :review].each do |process|
-        class_eval <<-EOS
-          def #{process}_node_start(node)                         # def review_node_start(node)
-            @node = node                                          #   @node = node
-            method = "#{process}_start_" + node.node_type.to_s    #   method = "review_start_" + node.node_type.to_s
-            self.send(method, node)                               #   self.send(method, node)
-          end                                                     # end
-                                                                  #
-          def #{process}_node_end(node)                           # def review_node_end(node)
-            @node = node                                          #   @node = node
-            method = "#{process}_end_" + node.node_type.to_s      #   method = "review_end_" + node.node_type.to_s
-            self.send(method, node)                               #   self.send(method, node)
-          end                                                     # end
-        EOS
-      end
-
-      # method_missing to catch all start and end process for each node type, like
-      #
-      #     prepare_start_defn
-      #     prepare_end_defn
-      #     review_start_call
-      #     review_end_call
-      #
-      # if there is a ""debug"" method defined in check, each node will be output.
-      def method_missing(method_name, *args)
-        if method_name.to_s =~ /^(prepare|review)_start_/
-          p args if respond_to?(:debug)
-        elsif method_name.to_s =~ /^(prepare|review)_end_/
-          # nothing to do
-        else
-          super
-        end
-      end
-
-      # remember the model names and model associations in prepare process.
-      def self.prepare_model_associations
-        class_eval <<-EOS
-          def initialize
-            super
-            @klazzes = []
-            @associations = {}
-          end
-
-          def interesting_prepare_nodes
-            [:class, :call]
-          end
-
-          def interesting_prepare_files
-            MODEL_FILES
-          end
-
-          # check class node to remember all class name in prepare process.
-          #
-          # the remembered class names (@klazzes) are like
-          #     [ :User, :Post ]
-          def prepare_start_class(node)
-            remember_klazz(node)
-          end
-
-          # check call node to remember all assoication names in prepare process.
-          #
-          # the remembered association names (@associations) are like
-          #     { :User => [":projects", ":location"], :Post => [":comments"] }
-          def prepare_start_call(node)
-            remember_association(node) if association_methods.include? node.message
-          end
-
-          # remember class models, just the subject of class node.
-          def remember_klazz(class_node)
-            @klazzes << class_node.class_name
-          end
-
-          # remember associations, with class to association names.
-          def remember_association(association_node)
-            @associations[@klazzes.last] ||= []
-            @associations[@klazzes.last] << association_node.arguments[1].to_s
-          end
-
-          # default rails association methods.
-          def association_methods
-            [:belongs_to, :has_one, :has_many, :has_and_belongs_to_many]
-          end
-
-        EOS
-      end
-
-      # add error if source code violates rails best practice.
-      #   error is the string message for violation of the rails best practice
-      #   file is the filename of source code
-      #   line is the line number of the source code which is reviewing
-      def add_error(error, file = @node.file, line = @node.line)
-        @errors << RailsBestPractices::Core::Error.new("#{file}", "#{line}", error, url)
-      end
-
-      # remember use count for the local or instance variable in the call or attrasgn node.
-      #
-      # find the local variable or instance variable in the call or attrasgn node,
-      # then save it to as key in @variable_use_count hash, and add the call count (hash value).
-      def remember_variable_use_count(node)
-        variable_node = variable(node)
-        if variable_node
-          variable_use_count[variable_node] ||= 0
-          variable_use_count[variable_node] += 1
-        end
-      end
-
-      # return @variable_use_count hash.
-      def variable_use_count
-        @variable_use_count ||= {}
-      end
-
-      # reset @variable_use_count hash.
-      def reset_variable_use_count
-        @variable_use_count = nil
-      end
-
-      # find local variable or instance variable in the most inner call node, e.g.
-      #
-      # if the call node is
-      #
-      #     s(:call, s(:ivar, :@post), :editors, s(:arglist)),
-      #
-      # or it is
-      #
-      #     s(:call,
-      #       s(:call, s(:ivar, :@post), :editors, s(:arglist)),
-      #       :include?,
-      #       s(:arglist, s(:call, nil, :current_user, s(:arglist)))
-      #     )
-      #
-      # then the variable both are s(:ivar, :@post).
-      #
-      def variable(node)
-        while node.subject.node_type == :call
-          node = node.subject
-        end
-        subject_node = node.subject
-        if [:ivar, :lvar].include?(subject_node.node_type) and subject_node[1] != :_erbout
-          subject_node
-        else
-          nil
-        end
-      end
-
-      # compare two sexp nodes' to_s.
-      #     equal?(":test", :test) => true
-      #     equai?("@test", :test) => true
-      def equal?(node, expected_node)
-        actual = node.to_s.downcase
-        expected = expected_node.to_s.downcase
-        actual == expected || actual == ':' + expected || actual == '@' + expected
-      end
-    end
-  end
-end

data/spec/rails_best_practices/checks/check_spec.rb

@@ -1,57 +0,0 @@
-require 'spec_helper'
-
-describe RailsBestPractices::Checks::Check do
-  before :each do
-    @check = RailsBestPractices::Checks::Check.new
-  end
-
-  it "should get empty interesting prepare nodes" do
-    @check.interesting_prepare_nodes.should == []
-  end
-
-  it "should get empty interesting review nodes" do
-    @check.interesting_review_nodes.should == []
-  end
-
-  it "should match all files of interesting prepare files" do
-    @check.interesting_prepare_files.should == /.*/
-  end
-
-  it "should match all files of interesting review files" do
-    @check.interesting_review_files.should == /.*/
-  end
-
-  context "review_node_start" do
-    it "should call review_start_if" do
-      node = stub(:node_type => :if)
-      @check.should_receive(:send).with("review_start_if", node)
-      @check.review_node_start(node)
-    end
-
-    it "should call review_start_call" do
-      node = stub(:node_type => :call)
-      @check.should_receive(:send).with("review_start_call", node)
-      @check.review_node_start(node)
-    end
-  end
-
-  context "review_node_end" do
-    it "should call review_end_if" do
-      node = stub(:node_type => :if)
-      @check.should_receive(:send).with("review_end_if", node)
-      @check.review_node_end(node)
-    end
-
-    it "should call review_end_call" do
-      node = stub(:node_type => :call)
-      @check.should_receive(:send).with("review_end_call", node)
-      @check.review_node_end(node)
-    end
-  end
-
-  context "equal?" do
-    it "should be true when compare symbol string with symbol" do
-      @check.equal?(":test", :test).should be_true
-    end
-  end
-end

data/spec/rails_best_practices/checks/move_code_into_controller_check_spec.rb

@@ -1,33 +0,0 @@
-require 'spec_helper'
-
-describe RailsBestPractices::Checks::MoveCodeIntoControllerCheck do
-  before(:each) do
-    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::MoveCodeIntoControllerCheck.new)
-  end
-
-  it "should move code into controller" do
-    content = <<-EOF
-    <% @posts = Post.find(:all) %>
-    <% @posts.each do |post| %>
-      <%=h post.title %>
-      <%=h post.content %>
-    <% end %>
-    EOF
-    @runner.review('app/views/posts/index.html.erb', content)
-    errors = @runner.errors
-    errors.should_not be_empty
-    errors[0].to_s.should == "app/views/posts/index.html.erb:1 - move code into controller"
-  end
-
-  it "should not move code into controller" do
-    content = <<-EOF
-    <% @posts.each do |post| %>
-      <%=h post.title %>
-      <%=h post.content %>
-    <% end %>
-    EOF
-    @runner.review('app/views/posts/index.html.erb', content)
-    errors = @runner.errors
-    errors.should be_empty
-  end
-end

data/spec/rails_best_practices/checks/move_code_into_helper_check_spec.rb

@@ -1,28 +0,0 @@
-require 'spec_helper'
-
-describe RailsBestPractices::Checks::MoveCodeIntoHelperCheck do
-  before(:each) do
-    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::MoveCodeIntoHelperCheck.new('array_count' => 2))
-  end
-
-  it "should move code into helper" do
-    content = <<-EOF
-    <%= select_tag :state, options_for_select( [[t(:draft), "draft"],
-                                                [t(:published), "published"]],
-                                               params[:default_state] ) %>
-    EOF
-    @runner.review('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 (array_count >= 2)"
-  end
-
-  it "should not move code into helper with simple arguments" do
-    content = <<-EOF
-    <%= select_tag :state, options_for_select( Post.STATES ) %>
-    EOF
-    @runner.review('app/views/posts/show.html.erb', content)
-    errors = @runner.errors
-    errors.should be_empty
-  end
-end

data/spec/rails_best_practices/checks/replace_instance_variable_with_local_variable_check_spec.rb

@@ -1,36 +0,0 @@
-require '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.review('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 replace instance variable with local varialbe in haml file" do
-    content = <<-EOF
-= @post.title
-    EOF
-    @runner.review('app/views/posts/_post.html.haml', content)
-    errors = @runner.errors
-    errors.should_not be_empty
-    errors[0].to_s.should == "app/views/posts/_post.html.haml:1 - replace instance variable with local variable"
-  end
-
-  it "should not replace instance variable with local varialbe" do
-    content = <<-EOF
-    <%= post.title %>
-    EOF
-    @runner.review('app/views/posts/_post.html.erb', content)
-    errors = @runner.errors
-    errors.should be_empty
-  end
-end

data/spec/rails_best_practices/checks/use_query_attribute_check_spec.rb

@@ -1,192 +0,0 @@
-require 'spec_helper'
-
-describe RailsBestPractices::Checks::UseQueryAttributeCheck do
-
-  before(:each) do
-    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::UseQueryAttributeCheck.new)
-
-    content = <<-EOF
-    class User < ActiveRecord::Base
-      has_many :projects
-      belongs_to :location
-      has_one :phone
-
-      belongs_to :category, :class_name => 'IssueCategory', :foreign_key => 'category_id'
-    end
-    EOF
-    @runner.prepare('app/models/user.rb', content)
-  end
-
-  it "should use query attribute by blank call" do
-    content = <<-EOF
-    <% if @user.login.blank? %>
-      <%= link_to 'login', new_session_path %>
-    <% end %>
-    EOF
-    @runner.review('app/views/users/show.html.erb', content)
-    errors = @runner.errors
-    errors.should_not be_empty
-    errors[0].to_s.should == "app/views/users/show.html.erb:1 - use query attribute (@user.login?)"
-  end
-
-  it "should use query attribute by comparing empty string" do
-    content = <<-EOF
-    <% if @user.login == "" %>
-      <%= link_to 'login', new_session_path %>
-    <% end %>
-    EOF
-    @runner.review('app/views/users/show.html.erb', content)
-    errors = @runner.errors
-    errors.should_not be_empty
-    errors[0].to_s.should == "app/views/users/show.html.erb:1 - use query attribute (@user.login?)"
-  end
-
-  it "should use query attribute by nil call" do
-    content = <<-EOF
-    <% if @user.login.nil? %>
-      <%= link_to 'login', new_session_path %>
-    <% end %>
-    EOF
-    @runner.review('app/views/users/show.html.erb', content)
-    errors = @runner.errors
-    errors.should_not be_empty
-    errors[0].to_s.should == "app/views/users/show.html.erb:1 - use query attribute (@user.login?)"
-  end
-
-  it "should use query attribute by present call" do
-    content = <<-EOF
-    <% if @user.login.present? %>
-      <%= @user.login %>
-    <% end %>
-    EOF
-    @runner.review('app/views/users/show.html.erb', content)
-    errors = @runner.errors
-    errors.should_not be_empty
-    errors[0].to_s.should == "app/views/users/show.html.erb:1 - use query attribute (@user.login?)"
-  end
-
-  it "should use query attribute within and conditions" do
-    content = <<-EOF
-    <% if @user.active? and @user.login.present? %>
-      <%= @user.login %>
-    <% end %>
-    EOF
-    @runner.review('app/views/users/show.html.erb', content)
-    errors = @runner.errors
-    errors.should_not be_empty
-    errors[0].to_s.should == "app/views/users/show.html.erb:1 - use query attribute (@user.login?)"
-  end
-
-  it "should use query attribute within or conditions" do
-    content = <<-EOF
-    <% if @user.active? or @user.login != "" %>
-      <%= @user.login %>
-    <% end %>
-    EOF
-    @runner.review('app/views/users/show.html.erb', content)
-    errors = @runner.errors
-    errors.should_not be_empty
-    errors[0].to_s.should == "app/views/users/show.html.erb:1 - use query attribute (@user.login?)"
-  end
-
-  it "should not use query attribute" do
-    content = <<-EOF
-    <% if @user.login? %>
-      <%= @user.login %>
-    <% end %>
-    EOF
-    @runner.review('app/views/users/show.html.erb', content)
-    errors = @runner.errors
-    errors.should be_empty
-  end
-
-  it "should not review for pluralize attribute" do
-    content = <<-EOF
-    <% if @user.roles.blank? %>
-      <%= @user.login %>
-    <% end %>
-    EOF
-    @runner.review('app/views/users/show.html.erb', content)
-    errors = @runner.errors
-    errors.should be_empty
-  end
-
-  it "should not review non model class" do
-    content = <<-EOF
-    <% if @person.login.present? %>
-      <%= @person.login %>
-    <% end %>
-    EOF
-    @runner.review('app/views/users/show.html.erb', content)
-    errors = @runner.errors
-    errors.should be_empty
-  end
-
-  context "association" do
-    it "should not review belongs_to association" do
-      content = <<-EOF
-      <% if @user.location.present? %>
-        <%= @user.location.name %>
-      <% end %>
-      EOF
-      @runner.review('app/views/users/show.html.erb', content)
-      errors = @runner.errors
-      errors.should be_empty
-    end
-
-      it "should not review belongs_to category" do
-        content = <<-EOF
-        <% if @user.category.present? %>
-          <%= @user.category.name %>
-        <% end %>
-        EOF
-        @runner.review('app/views/users/show.html.erb', content)
-        errors = @runner.errors
-        errors.should be_empty
-      end
-
-    it "should not review has_one association" do
-      content = <<-EOF
-      <% if @user.phone.present? %>
-        <%= @user.phone.number %>
-      <% end %>
-      EOF
-      @runner.review('app/views/users/show.html.erb', content)
-      errors = @runner.errors
-      errors.should be_empty
-    end
-
-    it "should not review has_many association" do
-      content = <<-EOF
-      <% if @user.projects.present? %>
-        <%= @user.projects.first.name %>
-      <% end %>
-      EOF
-      @runner.review('app/views/users/show.html.erb', content)
-      errors = @runner.errors
-      errors.should be_empty
-    end
-  end
-
-  it "should not review for class method" do
-    content = <<-EOF
-    <% if User.name.present? %>
-      <%= User.name %>
-    <% end %>
-    EOF
-    @runner.review('app/views/users/show.html.erb', content)
-    errors = @runner.errors
-    errors.should be_empty
-  end
-
-  it "should not review for non attribute call" do
-    content = <<-EOF
-    if @user.login(false).nil?
-      puts @user.login(false)
-    end
-    EOF
-    @runner.review('app/models/users_controller.rb', content)
-    errors = @runner.errors
-    errors.should be_empty
-  end
-end