rails_best_practices 0.4.6 → 0.5.0

data/README.textile

@@ -89,6 +89,7 @@ MoveCodeIntoHelperCheck: { array_count: 3 }
 ReplaceInstanceVariableWithLocalVariableCheck: { }
 DryBundlerInCapistranoCheck: { }
 UseSayWithTimeInMigrationsCheck: { }
+UseQueryAttributeCheck: { }
 </code></pre>
 
 *************************************************
@@ -112,6 +113,7 @@ h2. Implementation
 ## Keep Finders on Their Own Model (rails2 only)
 ## the Law of Demeter
 ## Use Observer
+## Use Query Attribute
 
 * Migration
 ## Isolating Seed Data

data/lib/rails_best_practices/checks/add_model_virtual_attribute_check.rb

@@ -50,7 +50,7 @@ module RailsBestPractices
       def call_assignment(node)
         if node.message == :save
           variable = node.subject
-          add_error "add model virtual attribute (for #{node.subject.to_ruby})" if params_dup?(@variables[variable].collect {|h| h[:arguments]})
+          add_error "add model virtual attribute (for #{variable})" if params_dup?(@variables[variable].collect {|h| h[:arguments]})
         end
       end
       

data/lib/rails_best_practices/checks/always_add_db_index_check.rb

@@ -27,9 +27,9 @@ module RailsBestPractices
         elsif :call == node.node_type
           case node.message
           when :create_table
-            @table_name = node.arguments[1].to_ruby_string
+            @table_name = node.arguments[1].to_s
           when :integer
-            column_name = node.arguments[1].to_ruby_string
+            column_name = node.arguments[1].to_s
             if column_name =~ /_id$/ and !indexed?(@table_name, column_name)
               add_error "always add db index (#@table_name => #{column_name})", node.file, node.line
             end
@@ -40,8 +40,8 @@ module RailsBestPractices
       private
         def find_index_columns(node)
           node.grep_nodes({:node_type => :call, :message => :add_index}).each do |index_node|
-            table_name = index_node.arguments[1].to_ruby_string
-            reference_column = eval(index_node.arguments[2].to_ruby)
+            table_name = index_node.arguments[1].to_s
+            reference_column = eval(index_node.arguments[2].to_s)
             @index_columns << [table_name, reference_column]
           end
         end

data/lib/rails_best_practices/checks/check.rb

@@ -4,7 +4,7 @@ require 'rails_best_practices/core/error'
 module RailsBestPractices
   module Checks
     class Check
-      NODE_TYPES = [:call, :defn, :defs, :if, :unless, :class, :lasgn, :ivar, :block, :iter]
+      NODE_TYPES = [:call, :defn, :defs, :if, :unless, :class, :lasgn, :iasgn, :ivar, :lvar, :block, :iter]
       
       CONTROLLER_FILES = /_controller\.rb$/
       MIGRATION_FILES = /db\/migrate\/.*\.rb$/
@@ -60,6 +60,10 @@ module RailsBestPractices
         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
     end
   end
 end

data/lib/rails_best_practices/checks/dry_bundler_in_capistrano_check.rb

@@ -18,7 +18,7 @@ module RailsBestPractices
       end
 
       def evaluate_start(node)
-        if :namespace == node.message and "bundler" == node.arguments.to_ruby_string
+        if :namespace == node.message and equal?(node.arguments[1], "bundler")
           add_error "dry bundler in capistrano"
         end
       end

data/lib/rails_best_practices/checks/isolate_seed_data_check.rb

@@ -9,7 +9,7 @@ module RailsBestPractices
     class IsolateSeedDataCheck < Check
 
       def interesting_nodes
-        [:call, :lasgn]
+        [:call, :lasgn, :iasgn]
       end
 
       def interesting_files
@@ -24,7 +24,7 @@ module RailsBestPractices
       def evaluate_start(node)
         if [:create, :create!].include? node.message
           add_error("isolate seed data")
-        elsif :lasgn == node.node_type
+        elsif [:lasgn, :iasgn].include? node.node_type
           remember_new_variable(node)
         elsif [:save, :save!].include? node.message
           add_error("isolate seed data") if new_record?(node)
@@ -35,12 +35,12 @@ module RailsBestPractices
 
       def remember_new_variable(node)
         unless node.grep_nodes({:node_type => :call, :message => :new}).empty?
-          @new_variables << node.subject.to_s
+          @new_variables << node.left_value.to_s
         end
       end
 
       def new_record?(node)
-        @new_variables.include? node.subject.to_ruby
+        @new_variables.include? node.subject.to_s
       end
     end
   end

data/lib/rails_best_practices/checks/law_of_demeter_check.rb

@@ -22,7 +22,7 @@ module RailsBestPractices
       def evaluate_start(node)
         if node.node_type == :class
           remember_association(node)
-        elsif [:lvar, :ivar].include?(node.subject.node_type) and node.subject != s(:lvar, :_erbout)
+        elsif [:lvar, :ivar].include?(node.subject.subject.node_type) and node.subject != s(:lvar, :_erbout)
           add_error "law of demeter" if need_delegate?(node)
         end
       end
@@ -34,13 +34,13 @@ module RailsBestPractices
         (node.body.grep_nodes(:message => :belongs_to) + node.body.grep_nodes(:message => :has_one)).collect do |body_node|
           class_name = node.subject.to_s.underscore
           @associations[class_name] ||= []
-          @associations[class_name] << body_node.arguments[1].to_ruby_string
+          @associations[class_name] << body_node.arguments[1].to_s
         end
       end
 
       def need_delegate?(node)
         @associations.each do |class_name, associations|
-          return true if node.subject.to_ruby =~ /#{class_name}$/ and associations.include? node.message.to_s
+          return true if node.subject.subject.to_s =~ /#{class_name}$/ and associations.find { |association| equal?(association, node.subject.message) }
         end
         false
       end

data/lib/rails_best_practices/checks/move_code_into_model_check.rb

@@ -26,7 +26,7 @@ module RailsBestPractices
 
       def check_errors
         @variables.each do |node, count|
-          add_error "move code into model (#{node.to_ruby})" if count > 2
+          add_error "move code into model (#{node})" if count > 2
         end
       end
 

data/lib/rails_best_practices/checks/move_model_logic_into_model_check.rb

@@ -32,7 +32,7 @@ module RailsBestPractices
         end
         
         @variables.each do |variable, count|
-          add_error "move model logic into model (#{variable.to_ruby} called_count > #{@called_count})" if count > @called_count
+          add_error "move model logic into model (#{variable} called_count > #{@called_count})" if count > @called_count
         end
         @variables = nil
       end

data/lib/rails_best_practices/checks/overuse_route_customizations_check.rb

@@ -47,7 +47,7 @@ module RailsBestPractices
           return 0 if hash_nodes.empty?
           hash_key_node = hash_nodes.first[1]
           if :lit == hash_key_node.node_type and [:member, :collection].include? hash_key_node[1]
-            customize_hash = eval(hash_nodes.first.to_ruby)
+            customize_hash = eval(hash_nodes.first.to_s)
             (customize_hash[:member].size || 0) + (customize_hash[:collection].size || 0)
           end
         end

data/lib/rails_best_practices/checks/replace_complex_creation_with_factory_method_check.rb

@@ -48,7 +48,7 @@ module RailsBestPractices
       def call_assignment(node)
         if node.message == :save
           variable = node.subject
-          add_error "replace complex creation with factory method (#{variable.to_ruby} attribute_assignment_count > #{@attrasgn_count})" if @variables[variable] > @attrasgn_count
+          add_error "replace complex creation with factory method (#{variable} attribute_assignment_count > #{@attrasgn_count})" if @variables[variable] > @attrasgn_count
         end
       end
     end

data/lib/rails_best_practices/checks/use_model_association_check.rb

@@ -40,7 +40,7 @@ module RailsBestPractices
       def call_assignment(node)
         if node.message == :save
           variable = node.subject[1]
-          add_error "use model association (for #{node.subject.to_ruby})" if @variables[variable]
+          add_error "use model association (for #{node.subject})" if @variables[variable]
         end
       end
     end

data/lib/rails_best_practices/checks/use_observer_check.rb

@@ -26,7 +26,7 @@ module RailsBestPractices
       def evaluate_start(node)
         if :after_create == node.message
           remember_callbacks(node)
-        elsif :defn == node.node_type and @callbacks.include?(node.message_name.to_s)
+        elsif :defn == node.node_type and @callbacks.find { |callback| equal?(callback, node.message_name) }
           add_error "use observer" if use_observer?(node)
         end
       end
@@ -37,7 +37,7 @@ module RailsBestPractices
         node.arguments[1..-1].each do |argument|
           # ignore callback like after_create Comment.new
           if :lit == argument.node_type
-            @callbacks << argument.to_ruby_string
+            @callbacks << argument.to_s
           end
         end
       end

data/lib/rails_best_practices/checks/use_query_attribute_check.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    # Check to make sure use query attribute instead of nil?, blank? and present?.
+    # 
+    # Implementation: 
+    # 1. check all models to save model names and association names.
+    #    model names are used for detecting
+    #    association name should not be detected as query attribute
+    # 2. check all method calls, if their subjects are model names and their messages are one of nil?,
+    #    blank?, present? or == "", not pluralize and not in the association names, 
+    #    then they need to use query attribute.
+    class UseQueryAttributeCheck < Check
+      
+      QUERY_METHODS = [:nil?, :blank?, :present?]
+      ASSOCIATION_METHODS = [:belongs_to, :has_one, :has_many, :has_and_belongs_to_many]
+      
+      def interesting_nodes
+        [:if, :class, :call]
+      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
+          add_error "use query attribute", node.file, node.line if need_query_attribute?(node.conditional_statement)
+        else
+        end
+      end
+
+      private
+
+      def remember_klazz(class_node)
+        if class_node.file =~ MODLE_FILES
+          @klazzes << class_node.subject
+        end
+      end
+      
+      def remember_association(association_node)
+        @associations[@klazzes.last] ||= []
+        @associations[@klazzes.last] << association_node.arguments[1].to_s
+      end
+
+      def need_query_attribute?(conditional_statement_node)
+        case conditional_statement_node.node_type
+        when :and, :or
+          return need_query_attribute?(conditional_statement_node[1]) || need_query_attribute?(conditional_statement_node[2])
+        when :not
+          return need_query_attribute?(conditional_statement_node[1])
+        when :call
+          return true if query_method?(conditional_statement_node) or compare_with_empty_string?(conditional_statement_node)
+        end
+        false
+      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
+        
+        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 compare_with_empty_string?(node)
+        :== == node.message and [:arglist, [:str, ""]] == node.arguments
+      end
+    end
+  end
+end

data/lib/rails_best_practices/checks.rb

@@ -20,3 +20,4 @@ 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/core/core_ext.rb

@@ -5,17 +5,6 @@ module Enumerable
   end
 end
 
-class String
-  # copy from rails
-  def underscore
-    self.gsub(/::/, '/').
-    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-    gsub(/([a-z\d])([A-Z])/,'\1_\2').
-    tr("-", "_").
-    downcase
-  end
-end
-
 class NilClass
   def method_missing(method_sym, *arguments, &block)
     return nil

data/lib/rails_best_practices/core/runner.rb

@@ -3,6 +3,7 @@ require 'rubygems'
 require 'ruby_parser'
 require 'erb'
 require 'yaml'
+require 'active_support/inflector'
 
 module RailsBestPractices
   module Core
@@ -30,10 +31,13 @@ module RailsBestPractices
           content.gsub!(/#coding:US-ASCII\n/, '')
         end
         if filename =~ /.*\.haml$/
-          require 'haml'
-          content = Haml::Engine.new(content).precompiled
-          # remove \xxx characters
-          content.gsub!(/\\\d{3}/, '')
+          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)
         node.accept(@checker) if node

data/lib/rails_best_practices/core/visitable_sexp.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 require 'rubygems'
 require 'sexp'
-require 'ruby2ruby'
 
 class Sexp
   def accept(visitor)
@@ -48,7 +47,13 @@ class Sexp
   end
   
   def subject
-    if [:attrasgn, :call, :iasgn, :lasgn, :class, :iter].include? node_type
+    if [:attrasgn, :call, :class, :iter].include? node_type
+      self[1]
+    end
+  end
+
+  def left_value
+    if [:lasgn, :iasgn].include? node_type
       self[1]
     end
   end
@@ -106,13 +111,34 @@ class Sexp
       self[4][1]
     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
+  def to_s
+    if [:lvar, :ivar].include? node_type
+      self[1].to_s
+    elsif :str == node_type
+      self[1]
+    elsif :lit == node_type
+      ":#{self[1]}"
+    elsif :array == node_type
+      "[\"#{self.children.collect(&:to_s).join('", "')}\"]"
+    elsif :hash == node_type
+      key_value = false # false is key, true is value
+      result = "{"
+      children.each do |child|
+        result += "#{child.to_s}#{key_value ? ', ' : ' => '}"
+        key_value = !key_value
+      end
+      result.sub!(/, $/, '')
+      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
+  #end
 end

data/lib/rails_best_practices/version.rb

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

data/rails_best_practices.yml

@@ -19,3 +19,4 @@ MoveCodeIntoHelperCheck: { array_count: 3 }
 ReplaceInstanceVariableWithLocalVariableCheck: { }
 DryBundlerInCapistranoCheck: { }
 UseSayWithTimeInMigrationsCheck: { }
+UseQueryAttributeCheck: { }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rails_best_practices
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 6
-  version: 0.4.6
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Richard Huang
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-15 00:00:00 +08:00
+date: 2010-11-06 00:00:00 +08:00
 default_executable: rails_best_practices
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -36,22 +36,6 @@ dependencies:
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 2
-        - 4
-        version: 1.2.4
-  name: ruby2ruby
-  prerelease: false
-  type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -65,9 +49,9 @@ dependencies:
   name: progressbar
   prerelease: false
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -80,21 +64,33 @@ dependencies:
   name: colored
   prerelease: false
   type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: activesupport
+  prerelease: false
+  type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 62196431
+        hash: 13
         segments: 
         - 2
         - 0
-        - 0
-        - beta
-        - 22
-        version: 2.0.0.beta.22
+        - 1
+        version: 2.0.1
   name: rspec
   prerelease: false
   type: :development
@@ -103,7 +99,7 @@ dependencies:
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 35
         segments: 
@@ -119,7 +115,7 @@ dependencies:
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 7
         segments: 
@@ -163,6 +159,7 @@ files:
 - lib/rails_best_practices/checks/use_observer_check.rb
 - lib/rails_best_practices/checks/check.rb
 - lib/rails_best_practices/checks/overuse_route_customizations_check.rb
+- lib/rails_best_practices/checks/use_query_attribute_check.rb
 - lib/rails_best_practices/checks/use_before_filter_check.rb
 - lib/rails_best_practices/checks/move_code_into_model_check.rb
 - lib/rails_best_practices/core.rb