Contents

require 'rails_best_practices/checks/check'

module RailsBestPractices
  module Checks
    # Check to make sure not avoid the law of demeter.
    # 
    # Implementation: 
    # 1. check all models to record belongs_to associations
    # 2. check if calling belongs_to association's method or attribute
    class LawOfDemeterCheck < Check
      
      def interesting_nodes
        [:call, :class]
      end

      def initialize
        super
        @associations = {}
      end

      def evaluate_start(node)
        if node.node_type == :class
          remember_belongs_to(node)
        elsif [:lvar, :ivar].include?(node.subject.node_type) and node.subject != s(:lvar, :_erbout)
          add_error "law of demeter" if need_delegate?(node)
        end
      end

      private

      def remember_belongs_to(node)
        node.body.grep_nodes(:message => :belongs_to).collect do |body_node|
          class_name = node.subject.to_s.underscore
          @associations[class_name] ||= []
          @associations[class_name] << eval(body_node.arguments[1].to_ruby).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
        end
        false
      end
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
rails_best_practices-0.2.8	lib/rails_best_practices/checks/law_of_demeter_check.rb
rails_best_practices-0.2.6	lib/rails_best_practices/checks/law_of_demeter_check.rb
rails_best_practices-0.2.5	lib/rails_best_practices/checks/law_of_demeter_check.rb