rails_best_practices 0.6.6 → 0.6.7

data/Gemfile

@@ -1,3 +1,2 @@
 source "http://rubygems.org"
-gem 'rake'
 gemspec

data/README.md

@@ -62,6 +62,10 @@ Install
 Issue
 -----
 
+If you install the rails_best_practices with bundler-installed github-sourced gem, please use the following command instead.
+
+    bundle exec rails_best_practices .
+
 If you got NoMethodError or any syntax error, you should use debug mode to detect which file rails_best_practices is parsing and getting the error.
 
     rails_best_practices -d .
@@ -79,30 +83,30 @@ to generate `rails_best_practices.yml` file.
 
 Now you can customize this configuration file, the default configuration is as follows:
 
-    MoveFinderToNamedScopeCheck: { }
-    UseModelAssociationCheck: { }
-    UseScopeAccessCheck: { }
-    AddModelVirtualAttributeCheck: { }
-    ReplaceComplexCreationWithFactoryMethodCheck: { attribute_assignment_count: 2 }
-    MoveModelLogicIntoModelCheck: { use_count: 4 }
-    OveruseRouteCustomizationsCheck: { customize_count: 3 }
-    NeedlessDeepNestingCheck: { nested_count: 2 }
-    NotUseDefaultRouteCheck: {  }
-    KeepFindersOnTheirOwnModelCheck: { }
-    LawOfDemeterCheck: { }
-    UseObserverCheck: { }
-    IsolateSeedDataCheck: { }
-    AlwaysAddDbIndexCheck: { }
-    UseBeforeFilterCheck: { }
-    MoveCodeIntoControllerCheck: { }
-    MoveCodeIntoModelCheck: { use_count: 2 }
-    MoveCodeIntoHelperCheck: { array_count: 3 }
-    ReplaceInstanceVariableWithLocalVariableCheck: { }
-    DryBundlerInCapistranoCheck: { }
-    UseSayWithTimeInMigrationsCheck: { }
-    UseQueryAttributeCheck: { }
-
-You can remove or comment one check to disable it, and you can change the options.
+    MoveFinderToNamedScopeReview: { }
+    UseModelAssociationReview: { }
+    UseScopeAccessReview: { }
+    AddModelVirtualAttributeReview: { }
+    ReplaceComplexCreationWithFactoryMethodReview: { attribute_assignment_count: 2 }
+    MoveModelLogicIntoModelReview: { use_count: 4 }
+    OveruseRouteCustomizationsReview: { customize_count: 3 }
+    NeedlessDeepNestingReview: { nested_count: 2 }
+    NotUseDefaultRouteReview: {  }
+    KeepFindersOnTheirOwnModelReview: { }
+    LawOfDemeterReview: { }
+    UseObserverReview: { }
+    IsolateSeedDataReview: { }
+    AlwaysAddDbIndexReview: { }
+    UseBeforeFilterReview: { }
+    MoveCodeIntoControllerReview: { }
+    MoveCodeIntoModelReview: { use_count: 2 }
+    MoveCodeIntoHelperReview: { array_count: 3 }
+    ReplaceInstanceVariableWithLocalVariableReview: { }
+    DryBundlerInCapistranoReview: { }
+    UseSayWithTimeInMigrationsReview: { }
+    UseQueryAttributeReview: { }
+
+You can remove or comment one review to disable it, and you can change the options.
 
 Implementation
 --------------

data/Rakefile

@@ -2,7 +2,6 @@ require "bundler"
 Bundler.setup
 
 require "rake"
-require "rake/rdoctask"
 require "rspec"
 require "rspec/core/rake_task"
 
@@ -35,11 +34,4 @@ Rspec::Core::RakeTask.new('spec:progress') do |spec|
   spec.pattern = "spec/**/*_spec.rb"
 end
 
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = "rdoc"
-  rdoc.title = "rails_best_practices #{RailsBestPractices::VERSION}"
-  rdoc.rdoc_files.include("README*")
-  rdoc.rdoc_files.include("lib/**/*.rb")
-end
-
 task :default => :spec

data/install_supported_rubies.sh

@@ -2,7 +2,6 @@
 rubies=( 1.8.7 1.9.2 ree )
 for x in ${rubies[*]}
 do
-  rvm install $x || exit $?
-  rvm $x && rvm gemset use global && gem install bundler || exit $?
-  bundle install || exit $?
+  rvm install $x
+  rvm $x && rvm gemset use global && gem install bundler
 done

data/lib/rails_best_practices.rb

@@ -26,7 +26,8 @@ require 'rubygems'
 require 'progressbar'
 require 'colored'
 require 'haml'
-require 'rails_best_practices/checks'
+require 'rails_best_practices/prepares'
+require 'rails_best_practices/reviews'
 require 'rails_best_practices/core'
 require 'fileutils'
 
@@ -73,9 +74,9 @@ module RailsBestPractices
       @runner.debug = true if @options['debug']
       @runner.color = !options['without-color']
 
-      if @runner.checks.find { |check| check.is_a? Checks::AlwaysAddDbIndexCheck } &&
+      if @runner.checks.find { |check| check.is_a? Reviews::AlwaysAddDbIndexReview } &&
          !review_files.find { |file| file.index "db\/schema.rb" }
-        plain_output("AlwaysAddDbIndexCheck is disabled as there is no db/schema.rb file in your rails project.", 'blue')
+        plain_output("AlwaysAddDbIndexReview is disabled as there is no db/schema.rb file in your rails project.", 'blue')
       end
 
       @bar = ProgressBar.new('Analyzing', prepare_files.size + review_files.size)
@@ -162,13 +163,13 @@ module RailsBestPractices
     # @return [Array] sorted files
     def file_sort files
       files.sort { |a, b|
-        if a =~ Checks::Check::MODEL_FILES
+        if a =~ Core::Check::MODEL_FILES
           -1
-        elsif b =~ Checks::Check::MODEL_FILES
+        elsif b =~ Core::Check::MODEL_FILES
           1
-        elsif a =~ Checks::Check::MAILER_FILES
+        elsif a =~ Core::Check::MAILER_FILES
           -1
-        elsif b =~ Checks::Check::MAILER_FILES
+        elsif b =~ Core::Check::MAILER_FILES
           1
         else
           a <=> b

data/lib/rails_best_practices/core.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+require 'rails_best_practices/core/check'
 require 'rails_best_practices/core/runner'
 require 'rails_best_practices/core/checking_visitor'
 require 'rails_best_practices/core/error'

data/lib/rails_best_practices/core/check.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+module RailsBestPractices
+  module Core
+    # A Check class that takes charge of checking the sexp.
+    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/
+
+      # default interesting nodes.
+      def interesting_nodes
+        []
+      end
+
+      # default interesting files.
+      def interesting_files
+        /.*/
+      end
+
+      # delegate to start_### according to the node_type, like
+      #
+      #     start_call
+      #     start_defn
+      #
+      # @param [Sexp] node
+      def node_start(node)
+        @node = node
+        self.send("start_#{node.node_type}", node)
+      end
+
+      # delegate to end_### according to the node_type, like
+      #
+      #     end_call
+      #     end_defn
+      #
+      # @param [Sexp] node
+      def node_end(node)
+        @node = node
+        self.send("end_#{node.node_type}", node)
+      end
+
+      # method_missing to catch all start and end process for each node type, like
+      #
+      #     start_defn
+      #     end_defn
+      #     start_call
+      #     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 =~ /^start_/
+          p args if respond_to?(:debug)
+        elsif method_name.to_s =~ /^end_/
+          # nothing to do
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/rails_best_practices/core/checking_visitor.rb

@@ -14,26 +14,29 @@ module RailsBestPractices
     # if the node_type and the node filename match the interesting_review_nodes and interesting_review_files,
     # then run the reivew for that node.
     class CheckingVisitor
-      # remember all the checks for prepare and review processes according to interesting_prepare_nodes and interesting_review_nodes,
-      def initialize(checks)
+      # remember all the checks for prepare and review processes according to interesting_nodes.
+      #
+      # @param [Array] prepares
+      # @param [Array] reviews
+      def initialize(prepares, reviews)
         [:prepare, :review].each do |process|
           instance_variable_set("@#{process}_checks", {})                  # @review_checks = {}
-          checks.each do |check|                                           # checks.each do |check|
-            check.send("interesting_#{process}_nodes").each do |node|      # check.interesting_review_nodes.each do |node|
-              instance_variable_get("@#{process}_checks")[node] ||= []     #   @review_checks[node] ||= []
-              instance_variable_get("@#{process}_checks")[node] << check   #   @review_checks[node] << check
-              instance_variable_get("@#{process}_checks")[node].uniq!      #   @review_checks[node].uniq!
-            end                                                            # end
-          end
+          eval("#{process}s").each do |check|                              # reviews.each do |check|
+            check.send("interesting_nodes").each do |node|                 #   check.interesting_nodes.each do |node|
+              instance_variable_get("@#{process}_checks")[node] ||= []     #     @review_checks[node] ||= []
+              instance_variable_get("@#{process}_checks")[node] << check   #     @review_checks[node] << check
+              instance_variable_get("@#{process}_checks")[node].uniq!      #     @review_checks[node].uniq!
+            end                                                            #   end
+          end                                                              # end
         end
       end
 
       # for prepare process
-      # if the node_type and the node filename match the interesting_prepare_nodes and interesting_prepare_files,
+      # if the node_type and the node filename match the interesting_nodes and interesting_files,
       # then run the prepare for that node.
       #
       # for review process
-      # if the node_type and the node filename match the interesting_review_nodes and interesting_review_files,
+      # if the node_type and the node filename match the interesting_nodes and interesting_files,
       # then run the reivew for that node.
       [:prepare, :review].each do |process|
         class_eval <<-EOS
@@ -41,16 +44,16 @@ module RailsBestPractices
             checks = @#{process}_checks[node.node_type]                #   checks = @review_checks[node.node_type]
             if checks                                                  #   if checks
               checks.each { |check|                                    #     checks.each { |check|
-                if node.file =~ check.interesting_#{process}_files     #      if node.file =~ check.interesting_review_files
-                  check.#{process}_node_start(node)                    #         check.review_node_start(node)
+                if node.file =~ check.interesting_files                #      if node.file =~ check.interesting_files
+                  check.node_start(node)                               #         check.node_start(node)
                 end                                                    #       end
               }                                                        #     }
             end                                                        #   end
             node.children.each {|sexp| sexp.#{process}(self)}          #   node.children.each {|sexp| sexp.review(self)}
             if checks                                                  #   if checks
               checks.each { |check|                                    #     checks.each { |check|
-                if node.file =~ check.interesting_#{process}_files     #       if node.file =~ check.interesting_review_files
-                  check.#{process}_node_end(node)                      #         check.review_node_end(node)
+                if node.file =~ check.interesting_files                #       if node.file =~ check.interesting_files
+                  check.node_end(node)                                 #         check.node_end(node)
                 end                                                    #       end
               }                                                        #     }
             end                                                        #   end

data/lib/rails_best_practices/core/runner.rb

@@ -31,12 +31,19 @@ module RailsBestPractices
         @base_path || "."
       end
 
-      def initialize(*checks)
+      # initialize the runner.
+      #
+      # @param [Hash] options pass the prepares and reviews.
+      def initialize(options={})
         custom_config = File.join(Runner.base_path, 'config/rails_best_practices.yml')
         @config = File.exists?(custom_config) ? custom_config : RailsBestPractices::DEFAULT_CONFIG
-        @checks = checks unless checks.empty?
-        @checks ||= load_checks
-        @checker ||= CheckingVisitor.new(@checks)
+
+        prepares = Array(options[:prepares])
+        reviews = Array(options[:reviews])
+        @prepares = prepares.empty? ? load_prepares : prepares
+        @reviews = reviews.empty? ? load_reviews : reviews
+
+        @checker ||= CheckingVisitor.new(@prepares, @reviews)
         @debug = false
       end
 
@@ -60,13 +67,11 @@ module RailsBestPractices
         EOS
       end
 
-      # get all errors from checks.
+      # get all errors from reviews.
       #
-      # @return [Array] all errors from checks
+      # @return [Array] all errors from reviews
       def errors
-        @checks ||= []
-        all_errors = @checks.collect {|check| check.errors}
-        all_errors.flatten
+        @reviews.collect {|review| review.errors}.flatten
       end
 
       private
@@ -106,12 +111,17 @@ module RailsBestPractices
           content
         end
 
-        # load all checks according to configuration.
-        def load_checks
+        # load all prepares.
+        def load_prepares
+          [RailsBestPractices::Prepares::ModelPrepare.new, RailsBestPractices::Prepares::MailerPrepare.new]
+        end
+
+        # load all reviews according to configuration.
+        def load_reviews
           check_objects = []
           checks = YAML.load_file @config
           checks.each do |check|
-            klass = RailsBestPractices::Checks.const_get(check[0])
+            klass = RailsBestPractices::Reviews.const_get(check[0].gsub(/Check/, 'Review'))
             check_objects << (check[1].empty? ? klass.new : klass.new(check[1]))
           end
           check_objects

data/lib/rails_best_practices/core/visitable_sexp.rb

@@ -395,10 +395,14 @@ class Sexp
 
   # to_s for lvar, ivar, lit, const, array, hash, and colon2 node.
   #
+  # @param [Hash] options
+  #   :remove_at remove the @ symbol for ivar.
   # @return [String] to_s
-  def to_s
+  def to_s(options={})
     case node_type
-    when :lvar, :ivar, :str, :lit, :const
+    when :ivar
+      options[:remove_at] ? self[1].to_s[1..-1] : self[1].to_s
+    when :lvar, :str, :lit, :const
       self[1].to_s
     when :array
       "[\"#{self.children.collect(&:to_s).join('", "')}\"]"

data/lib/rails_best_practices/prepares.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require 'rails_best_practices/prepares/model_prepare'
+require 'rails_best_practices/prepares/mailer_prepare'
+
+module RailsBestPractices
+  module Prepares
+    class <<self
+      attr_accessor :model_associations, :mailer_names
+    end
+  end
+end

data/lib/rails_best_practices/prepares/mailer_prepare.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+require 'rails_best_practices/core/check'
+
+module RailsBestPractices
+  module Prepares
+    # Remember the mailer names.
+    class MailerPrepare < Core::Check
+
+      def interesting_nodes
+        [:class]
+      end
+
+      def interesting_files
+        /#{MAILER_FILES}|#{MODEL_FILES}/
+      end
+
+      def initialize
+        @mailer_names = []
+      end
+
+      # check class node.
+      #
+      # if it is a subclass of ActionMailer::Base,
+      # then remember its class name.
+      def start_class(class_node)
+        if s(:colon2, s(:const, :ActionMailer), :Base) == class_node.base_class
+          @mailer_names << class_node.class_name
+          Prepares.mailer_names = @mailer_names
+        end
+      end
+    end
+  end
+end

data/lib/rails_best_practices/prepares/model_prepare.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+require 'rails_best_practices/core/check'
+
+module RailsBestPractices
+  module Prepares
+    # Remember the model associations.
+    class ModelPrepare < Core::Check
+
+      def interesting_nodes
+        [:class, :call]
+      end
+
+      def interesting_files
+        MODEL_FILES
+      end
+
+      def initialize
+        @associations = {}
+      end
+
+      # check class node to remember the last class name.
+      def start_class(class_node)
+        @last_klazz = class_node.class_name.to_s
+      end
+
+      # assign @associations to Prepare.model_associations.
+      def end_class(class_node)
+        Prepares.model_associations = @associations
+      end
+
+      # check call node to remember all assoications.
+      #
+      # the remembered association names (@associations) are like
+      #     {
+      #       :Project=>{
+      #         "categories"=>:has_and_belongs_to_many,
+      #         "project_manager"=>:has_one,
+      #         "portfolio"=>:belongs_to,
+      #         "milestones=>:has_many"
+      #       }
+      #     }
+      def start_call(node)
+        remember_association(node) if association_methods.include? node.message
+      end
+
+      # remember associations, with class to association names.
+      def remember_association(association_node)
+        association_meta = association_node.message
+        association_name = association_node.arguments[1].to_s
+        @associations[@last_klazz] ||= {}
+        @associations[@last_klazz][association_name] = association_meta
+      end
+
+      # default rails association methods.
+      def association_methods
+        [:belongs_to, :has_one, :has_many, :has_and_belongs_to_many]
+      end
+    end
+  end
+end