rails_best_practices 0.5.3 → 0.5.5

data/README.textile

@@ -14,7 +14,7 @@ rails_best_practices .
 
 notice the period at the end, it can be the relative or absolute path of your rails app.
 
-And default rails_best_practices will do parse codes in vendor, spec, test and stories directories. If you need, see the command options:
+And default rails_best_practices will do parse codes in vendor, spec, test and features directories. If you need, see the command options:
 
 <pre><code>
 $ rails_best_practices -h
@@ -23,7 +23,7 @@ Usage: rails_best_practices [options]
         --vendor                     include vendor files
         --spec                       include spec files
         --test                       include test files
-        --stories                    include stories files
+        --features                    include features files
     -x, --exclude PATTERNS           Don't analyze files matching a pattern
                                      (comma-separated regexp list)
     -v, --version                    Show this version
@@ -32,7 +32,7 @@ Usage: rails_best_practices [options]
 
 *************************************************
 
-h2. Helpful links
+h2. Resources
 
 Homepage: "http://rails-bestpractices.com":http://rails-bestpractices.com
 Repository: "http://github.com/flyerhzm/rails_best_practices":http://github.com/flyerhzm/rails_best_practices

data/lib/rails_best_practices.rb

@@ -3,23 +3,27 @@ require 'rails_best_practices/checks'
 require 'rails_best_practices/core'
 
 module RailsBestPractices
-  
+
   class <<self
+    def prepare_files
+      expand_dirs_to_files 'app/models'
+    end
+
     def analyze_files(dir = '.', options = {})
       files = expand_dirs_to_files(dir)
       files = model_first_sort(files)
       ['vendor', 'spec', 'test', 'stories', 'features'].each do |pattern|
         files = ignore_files(files, "#{pattern}/") unless options[pattern]
       end
-      
+
       # Exclude files based on exclude regexes if the option is set.
       for pattern in options[:exclude]
         files = ignore_files(files, pattern)
       end
-      
+
       files
     end
-  
+
     def expand_dirs_to_files *dirs
       extensions = ['rb', 'erb', 'haml', 'builder']
 

data/lib/rails_best_practices/checks/always_add_db_index_check.rb

@@ -40,6 +40,7 @@ module RailsBestPractices
 
       def evaluate_end(node)
         if :iter == node.node_type && :call == node.subject.node_type && s(:colon2, s(:const, :ActiveRecord), :Schema) == node.subject.subject
+          remove_only_type_foreign_keys
           @foreign_keys.each do |table, foreign_key|
             table_node = @table_nodes[table]
             foreign_key.each do |column|
@@ -67,16 +68,27 @@ module RailsBestPractices
 
         def add_foreign_key_column(table_name, foreign_key_column)
           @foreign_keys[table_name] ||= []
-          if foreign_key_column =~ /_id$/
-            unless @foreign_keys[table_name].find { |foreign_key| foreign_key.include? foreign_key_column }
+          if foreign_key_column =~ /(.*?)_id$/
+            if @foreign_keys[table_name].delete("#{$1}_type")
+              @foreign_keys[table_name] << ["#{$1}_id", "#{$1}_type"]
+            else
               @foreign_keys[table_name] << foreign_key_column
             end
           elsif foreign_key_column =~ /(.*?)_type$/
-            @foreign_keys[table_name].delete("#{$1}_id")
-            @foreign_keys[table_name] << ["#{$1}_id", foreign_key_column]
+            if @foreign_keys[table_name].delete("#{$1}_id")
+              @foreign_keys[table_name] << ["#{$1}_id", "#{$1}_type"]
+            else
+              @foreign_keys[table_name] << foreign_key_column
+            end
           end
         end
 
+        def remove_only_type_foreign_keys
+          @foreign_keys.delete_if { |table, foreign_key|
+            foreign_key.size == 1 && foreign_key[0] =~ /_type$/
+          }
+        end
+
         def indexed?(table, column)
           index_columns = @index_columns[table]
           !index_columns || !index_columns.any? { |e| greater_than(Array(e), Array(column)) }

data/lib/rails_best_practices/checks/check.rb

@@ -4,8 +4,8 @@ require 'rails_best_practices/core/error'
 module RailsBestPractices
   module Checks
     class Check
-      NODE_TYPES = [:call, :defn, :defs, :if, :unless, :class, :lasgn, :iasgn, :ivar, :lvar, :block, :iter]
-      
+      NODE_TYPES = [:call, :defn, :defs, :if, :unless, :class, :lasgn, :iasgn, :ivar, :lvar, :block, :iter, :const]
+
       CONTROLLER_FILES = /_controller\.rb$/
       MIGRATION_FILES = /db\/migrate\/.*\.rb$/
       MODLE_FILES = /models\/.*\.rb$/
@@ -17,50 +17,81 @@ module RailsBestPractices
       def initialize
         @errors = []
       end
-      
+
       def interesting_files
         /.*/
       end
-  
+
+      def interesting_prepare_files
+        /.*/
+      end
+
       NODE_TYPES.each do |node|
         start_node_method = "evaluate_start_#{node}"
         end_node_method = "evaluate_end_#{node}"
         define_method(start_node_method) { |node| } unless self.respond_to?(start_node_method)
         define_method(end_node_method) { |node| } unless self.respond_to?(end_node_method)
+
+        prepare_start_node_method = "prepare_start_#{node}"
+        prepare_end_node_method = "prepare_end_#{node}"
+        define_method(prepare_start_node_method) { |node| } unless self.respond_to?(prepare_start_node_method)
+        define_method(prepare_end_node_method) { |node| } unless self.respond_to?(prepare_end_node_method)
       end
 
       def position(offset = 0)
         "#{@line[2]}:#{@line[1] + offset}"
       end
-      
+
+      def prepare_start(node)
+      end
+
+      def prepare_end(node)
+      end
+
       def evaluate_start(node)
       end
 
       def evaluate_end(node)
       end
 
+      def prepare_node(position, node)
+        @node = node
+        prepare_method = "prepare_#{position}_#{node.node_type}"
+        self.send(prepare_method, node)
+      end
+
       def evaluate_node(position, node)
         @node = node
         eval_method = "evaluate_#{position}_#{node.node_type}"
         self.send(eval_method, node)
       end
 
+      def prepare_node_start(node)
+        prepare_node(:start, node)
+        prepare_start(node)
+      end
+
+      def prepare_node_end(node)
+        prepare_node(:end, node)
+        prepare_end(node)
+      end
+
       def evaluate_node_start(node)
         evaluate_node(:start, node)
         evaluate_start(node)
       end
-  
+
       def evaluate_node_end(node)
         evaluate_node(:end, node)
         evaluate_end(node)
       end
-      
+
       def add_error(error, file = nil, line = nil)
         file ||= @node.file
         line ||= @node.line
         @errors << RailsBestPractices::Core::Error.new("#{file}", "#{line}", error)
       end
-      
+
       def equal?(node, expected)
         node.to_s == expected or node.to_s == ':' + expected.to_s
       end

data/lib/rails_best_practices/checks/use_query_attribute_check.rb

@@ -21,65 +21,70 @@ module RailsBestPractices
         [:if, :class, :call]
       end
 
+      def interesting_prepare_files
+        MODLE_FILES
+      end
+
       def initialize
         super
         @klazzes = []
         @associations = {}
       end
 
-      def evaluate_start(node)
-        case node.node_type
-        when :class
-          remember_klazz(node)
-        when :call
-          remember_association(node) if ASSOCIATION_METHODS.include? node.message
-        when :if
-          if node = query_attribute_node(node.conditional_statement)
-            add_error "use query attribute", node.file, node.line
-          end
-        else
-        end
+      def prepare_start_class(node)
+        remember_klazz(node)
       end
 
-      private
+      def prepare_start_call(node)
+        remember_association(node) if ASSOCIATION_METHODS.include? node.message
+      end
 
-      def remember_klazz(class_node)
-        if class_node.file =~ MODLE_FILES
-          @klazzes << class_node.subject
+      def evaluate_start_if(node)
+        if node = query_attribute_node(node.conditional_statement)
+          subject_node = node.subject
+          add_error "use query attribute (#{subject_node.subject}.#{subject_node.message}?)", node.file, node.line
         end
       end
 
-      def remember_association(association_node)
-        @associations[@klazzes.last] ||= []
-        @associations[@klazzes.last] << association_node.arguments[1].to_s
-      end
+      private
+        def remember_klazz(class_node)
+          if class_node.file =~ MODLE_FILES
+            @klazzes << class_node.subject
+          end
+        end
 
-      def query_attribute_node(conditional_statement_node)
-        case conditional_statement_node.node_type
-        when :and, :or
-          return query_attribute_node(conditional_statement_node[1]) || query_attribute_node(conditional_statement_node[2])
-        when :not
-          return query_attribute_node(conditional_statement_node[1])
-        when :call
-          return conditional_statement_node if query_method?(conditional_statement_node) or compare_with_empty_string?(conditional_statement_node)
+        def remember_association(association_node)
+          @associations[@klazzes.last] ||= []
+          @associations[@klazzes.last] << association_node.arguments[1].to_s
         end
-        nil
-      end
 
-      def query_method?(node)
-        return false unless :call == node.subject.node_type
-        subject = node.subject.subject
-        message = node.subject.message
-        subject_ruby = subject.to_s
+        def query_attribute_node(conditional_statement_node)
+          case conditional_statement_node.node_type
+          when :and, :or
+            return query_attribute_node(conditional_statement_node[1]) || query_attribute_node(conditional_statement_node[2])
+          when :not
+            return query_attribute_node(conditional_statement_node[1])
+          when :call
+            return conditional_statement_node if query_method?(conditional_statement_node) or compare_with_empty_string?(conditional_statement_node)
+          end
+          nil
+        end
 
-        subject_ruby && @klazzes.find { |klazz| subject_ruby =~ %r|#{klazz.to_s.underscore}| and !@associations[klazz].find { |association| equal?(association, message) } } &&
-        message && message.to_s.pluralize != message.to_s &&
-        QUERY_METHODS.include?(node.message)
-      end
+        def query_method?(node)
+          return false unless :call == node.subject.node_type
+          subject = node.subject.subject
+          message = node.subject.message
+          subject_ruby = subject.to_s
 
-      def compare_with_empty_string?(node)
-        :== == node.message and [:arglist, [:str, ""]] == node.arguments
-      end
+          subject_ruby && node.subject.arguments.size == 1 &&
+            @klazzes.find { |klazz| subject_ruby =~ %r|#{klazz.to_s.underscore}| and !@associations[klazz].find { |association| equal?(association, message) } } &&
+            message && message.to_s.pluralize != message.to_s &&
+          QUERY_METHODS.include?(node.message)
+        end
+
+        def compare_with_empty_string?(node)
+          :== == node.message and [:arglist, [:str, ""]] == node.arguments
+        end
     end
   end
 end

data/lib/rails_best_practices/command.rb

@@ -11,7 +11,7 @@ OptionParser.new do |opts|
     options['debug'] = true
   end
 
-  ['vendor', 'spec', 'test', 'stories'].each do |pattern|
+  ['vendor', 'spec', 'test', 'features'].each do |pattern|
     opts.on("--#{pattern}", "include #{pattern} files") do
       options[pattern] = true
     end
@@ -42,6 +42,7 @@ end
 runner = RailsBestPractices::Core::Runner.new
 runner.set_debug if options['debug']
 
+prepare_files = RailsBestPractices::prepare_files
 files = RailsBestPractices::analyze_files(ARGV, options)
 
 if runner.checks.find { |check| check.is_a? RailsBestPractices::Checks::AlwaysAddDbIndexCheck } &&
@@ -49,7 +50,13 @@ if runner.checks.find { |check| check.is_a? RailsBestPractices::Checks::AlwaysAd
   puts "AlwaysAddDbIndexCheck is disabled as there is no db/schema.rb file in your rails project.".blue
 end
 
-bar = ProgressBar.new('Analyzing', files.size)
+bar = ProgressBar.new('Analyzing', prepare_files.size + files.size)
+
+prepare_files.each do |file|
+  runner.prepare_file(file)
+  bar.inc unless options['debug']
+end
+
 files.each do |file|
   runner.check_file(file)
   bar.inc unless options['debug']

data/lib/rails_best_practices/core/checking_visitor.rb

@@ -14,12 +14,17 @@ module RailsBestPractices
         end
       end
 
+      def prepare(node)
+        checks = @checks[node.node_type]
+        checks.each {|check| check.prepare_node_start(node) if node.file =~ check.interesting_prepare_files} unless checks.nil?
+        node.visitable_children.each {|sexp| sexp.prepare(self)}
+        checks.each {|check| check.prepare_node_end(node) if node.file =~ check.interesting_prepare_files} unless checks.nil?
+      end
+
     	def visit(node)
         checks = @checks[node.node_type]
         checks.each {|check| check.evaluate_node_start(node) if node.file =~ check.interesting_files} unless checks.nil?
-
     		node.visitable_children.each {|sexp| sexp.accept(self)}
-
         checks.each {|check| check.evaluate_node_end(node) if node.file =~ check.interesting_files} unless checks.nil?
     	end
     end

data/lib/rails_best_practices/core/runner.rb

@@ -27,30 +27,25 @@ module RailsBestPractices
 
       def check(filename, content)
         puts filename if @debug
-        if filename =~ /.*\.erb$/
-          content = Erubis::Eruby.new(content).src
-        end
-        if filename =~ /.*\.haml$/
-          begin
-            require 'haml'
-            content = Haml::Engine.new(content).precompiled
-            # remove \xxx characters
-            content.gsub!(/\\\d{3}/, '')
-          rescue Haml::SyntaxError
-          end
-        end
-        node = parse(filename, content)
+        content = parse_erb_or_haml(filename, content)
+        node = parse_ruby(filename, content)
         node.accept(@checker) if node
       end
 
-      def check_content(content)
-        check("dummy-file.rb", content)
+      def prepare(filename, content)
+        puts filename if @debug
+        node = parse_ruby(filename, content)
+        node.prepare(@checker) if node
       end
 
       def check_file(filename)
         check(filename, File.read(filename))
       end
 
+      def prepare_file(filename)
+        prepare(filename, File.read(filename))
+      end
+
       def errors
         @checks ||= []
         all_errors = @checks.collect {|check| check.errors}
@@ -59,7 +54,7 @@ module RailsBestPractices
 
       private
 
-      def parse(filename, content)
+      def parse_ruby(filename, content)
         begin
           RubyParser.new.parse(content, filename)
         rescue Exception => e
@@ -68,6 +63,22 @@ module RailsBestPractices
         end
       end
 
+      def parse_erb_or_haml(filename, content)
+        if filename =~ /.*\.erb$/
+          content = Erubis::Eruby.new(content).src
+        end
+        if filename =~ /.*\.haml$/
+          begin
+            require 'haml'
+            content = Haml::Engine.new(content).precompiled
+            # remove \xxx characters
+            content.gsub!(/\\\d{3}/, '')
+          rescue Haml::SyntaxError
+          end
+        end
+        content
+      end
+
       def load_checks
         check_objects = []
         checks = YAML.load_file @config

data/lib/rails_best_practices/core/visitable_sexp.rb

@@ -3,6 +3,10 @@ require 'rubygems'
 require 'sexp'
 
 class Sexp
+  def prepare(visitor)
+    visitor.prepare(self)
+  end
+
   def accept(visitor)
     visitor.visit(self)
   end
@@ -14,23 +18,23 @@ class Sexp
   def children
     find_all { | sexp | Sexp === sexp }
   end
-  
+
   def is_language_node?
     first.class == Symbol
   end
-  
+
   def visitable_children
     parent = is_language_node? ? sexp_body : self
     parent.children
   end
-  
+
   def recursive_children(&handler)
     visitable_children.each do |child|
       handler.call child
       child.recursive_children(&handler)
     end
   end
-  
+
   def grep_nodes(options)
     return self if options.empty?
     node_type = options[:node_type]
@@ -45,7 +49,7 @@ class Sexp
     end
     nodes
   end
-  
+
   def subject
     if [:attrasgn, :call, :class, :iter].include? node_type
       self[1]
@@ -57,37 +61,37 @@ class Sexp
       self[1]
     end
   end
-  
+
   def message
     if [:attrasgn, :call, :defs, :iter].include? node_type
       self[2]
     end
   end
-  
+
   def arguments
     if [:attrasgn, :call].include? node_type
       self[3]
     end
   end
-  
+
   def call
     if [:if, :arglist].include? node_type
       self[1]
     end
   end
-  
+
   def conditional_statement
     if node_type == :if
       self[1]
     end
   end
-  
+
   def true_node
     if :if == node_type
       self[2]
     end
   end
-  
+
   def false_node
     if :if == node_type
       self[3]
@@ -99,7 +103,7 @@ class Sexp
       self[1]
     end
   end
-  
+
   def body
     if :block == node_type
       self[1..-1]
@@ -111,7 +115,7 @@ class Sexp
       self[4][1]
     end
   end
-  
+
   def to_s
     if [:lvar, :ivar].include? node_type
       self[1].to_s
@@ -119,6 +123,8 @@ class Sexp
       self[1]
     elsif :lit == node_type
       ":#{self[1]}"
+    elsif :const == node_type
+      self[1]
     elsif :array == node_type
       "[\"#{self.children.collect(&:to_s).join('", "')}\"]"
     elsif :hash == node_type
@@ -132,11 +138,11 @@ class Sexp
       result += "}"
     end
   end
-  
+
   #def to_ruby
     #Ruby2Ruby.new.process(self) unless self.empty?
   #end
-  
+
   #def to_ruby_string
     #return nil if self.empty?
     #eval(Ruby2Ruby.new.process(self)).to_s

data/lib/rails_best_practices/version.rb

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

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rails_best_practices
 version: !ruby/object:Gem::Version 
+  hash: 1
   prerelease: false
   segments: 
   - 0
   - 5
-  - 3
-  version: 0.5.3
+  - 5
+  version: 0.5.5
 platform: ruby
 authors: 
 - Richard Huang
@@ -14,138 +15,147 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-04 00:00:00 +08:00
+date: 2010-12-13 00:00:00 +08:00
 default_executable: rails_best_practices
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: ruby_parser
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 2
         - 0
         - 4
         version: 2.0.4
-  type: :runtime
+  requirement: *id001
+  name: ruby_parser
   prerelease: false
-  version_requirements: *id001
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  name: progressbar
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 59
         segments: 
         - 0
         - 9
         - 0
         version: 0.9.0
-  type: :runtime
+  requirement: *id002
+  name: progressbar
   prerelease: false
-  version_requirements: *id002
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  name: colored
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 11
         segments: 
         - 1
         - 2
         version: "1.2"
-  type: :runtime
+  requirement: *id003
+  name: colored
   prerelease: false
-  version_requirements: *id003
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  name: erubis
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 27
         segments: 
         - 2
         - 6
         - 6
         version: 2.6.6
-  type: :runtime
+  requirement: *id004
+  name: erubis
   prerelease: false
-  version_requirements: *id004
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  name: i18n
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  type: :runtime
+  requirement: *id005
+  name: i18n
   prerelease: false
-  version_requirements: *id005
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  name: activesupport
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
-  type: :runtime
+  requirement: *id006
+  name: activesupport
   prerelease: false
-  version_requirements: *id006
+  type: :runtime
 - !ruby/object:Gem::Dependency 
-  name: rspec
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 2
         - 0
         - 1
         version: 2.0.1
-  type: :development
+  requirement: *id007
+  name: rspec
   prerelease: false
-  version_requirements: *id007
+  type: :development
 - !ruby/object:Gem::Dependency 
-  name: haml
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 35
         segments: 
         - 3
         - 0
         - 18
         version: 3.0.18
-  type: :development
+  requirement: *id008
+  name: haml
   prerelease: false
-  version_requirements: *id008
+  type: :development
 - !ruby/object:Gem::Dependency 
-  name: watchr
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 0
         - 6
         version: "0.6"
-  type: :development
+  requirement: *id009
+  name: watchr
   prerelease: false
-  version_requirements: *id009
+  type: :development
 description: a code metric tool for rails codes, written in Ruby.
 email: 
 - flyerhzm@gmail.com
@@ -208,7 +218,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -3421555404989740069
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -217,6 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 23
       segments: 
       - 1
       - 3