rails_best_practices 0.2.1 → 0.2.2

data/README.textile

@@ -42,6 +42,7 @@ OveruseRouteCustomizationsCheck: { customize_count: 3 }
 NeedlessDeepNestingCheck: { nested_count: 2 }
 NotUseDefaultRouteCheck: {  }
 KeepFindersOnTheirOwnModelCheck: { }
+LawOfDemeterCheck: { }
 </code></pre>
 
 *************************************************
@@ -67,8 +68,8 @@ h2. Progress
 
 * Lesson 3. Model
 ## [-Keep Finders on Their Own Model-]
-## Love named_scope
-## the Law of Demeter
+## [-Love named_scope-] # same as Move finder to named_scope
+## [-the Law of Demeter-]
 ## DRY: metaprogramming
 ## Extract into Module
 ## Extract to composed class

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/lib/rails_best_practices/checks.rb

@@ -11,3 +11,4 @@ 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'

data/lib/rails_best_practices/checks/check.rb

@@ -3,7 +3,7 @@ require 'rails_best_practices/core/error'
 module RailsBestPractices
   module Checks
     class Check
-      NODE_TYPES = [:call, :defn, :if, :unless]
+      NODE_TYPES = [:call, :defn, :if, :unless, :class]
 
       def initialize
         @errors = []

data/lib/rails_best_practices/checks/keep_finders_on_their_own_model_check.rb

@@ -2,6 +2,9 @@ require 'rails_best_practices/checks/check'
 
 module RailsBestPractices
   module Checks
+    # Check a model to make sure finders are on their own model.
+    #
+    # Implementation: check if :find is called by other model.
     class KeepFindersOnTheirOwnModelCheck < Check
       
       def interesting_nodes

data/lib/rails_best_practices/checks/law_of_demeter_check.rb

@@ -0,0 +1,42 @@
+require 'rails_best_practices/checks/check'
+
+module RailsBestPractices
+  module Checks
+    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.class_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

data/lib/rails_best_practices/command.rb

@@ -1,11 +1,11 @@
 require 'optparse'
 
 def expand_dirs_to_files *dirs
-  extensions = ['rb']
+  extensions = ['rb', 'builder']
 
   dirs.flatten.map { |p|
     if File.directory? p
-      Dir[File.join(p, '**', "*.{#{extensions.join(',')}}")]
+      Dir[File.join(p, '**', "*{#{extensions.join(',')}}")]
     else
       p
     end
@@ -29,4 +29,4 @@ expand_dirs_to_files(ARGV).each.each { |file| runner.check_file(file) }
 runner.errors.each {|error| puts error}
 puts "\nFound #{runner.errors.size} errors."
 
-exit runner.errors.size
+exit runner.errors.size

data/lib/rails_best_practices/core/core_ext.rb

@@ -4,8 +4,19 @@ 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
   end
-end
+end

data/lib/rails_best_practices/core/runner.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'ruby_parser'
+require 'erb'
 require 'yaml'
 
 module RailsBestPractices
@@ -21,6 +22,9 @@ module RailsBestPractices
       end
 
       def check(filename, content)
+        if filename =~ /.*erb/
+          content = ERB.new(content).src
+        end
         node = parse(filename, content)
         node.accept(@checker) if node
       end

data/lib/rails_best_practices/core/visitable_sexp.rb

@@ -47,7 +47,7 @@ class Sexp
   end
   
   def subject
-    if [:attrasgn, :call, :iasgn, :lasgn].include? node_type
+    if [:attrasgn, :call, :iasgn, :lasgn, :class].include? node_type
       self[1]
     end
   end
@@ -85,11 +85,16 @@ class Sexp
   def method_body
     if :block == node_type
       self[1..-1]
-    else
+    end
+  end
+
+  def class_body
+    if :class == node_type
+      self[3]
     end
   end
 
   def to_ruby
-    Ruby2Ruby.new.process(self)
+    Ruby2Ruby.new.process(self) unless self.empty?
   end
 end

data/rails_best_practices.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rails_best_practices}
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Huang"]
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
      "lib/rails_best_practices/checks/add_model_virtual_attribute_check.rb",
      "lib/rails_best_practices/checks/check.rb",
      "lib/rails_best_practices/checks/keep_finders_on_their_own_model_check.rb",
+     "lib/rails_best_practices/checks/law_of_demeter_check.rb",
      "lib/rails_best_practices/checks/many_to_many_collection_check.rb",
      "lib/rails_best_practices/checks/move_finder_to_named_scope_check.rb",
      "lib/rails_best_practices/checks/move_model_logic_into_model_check.rb",
@@ -52,6 +53,7 @@ Gem::Specification.new do |s|
      "rails_best_practices.yml",
      "spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb",
      "spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb",
+     "spec/rails_best_practices/checks/law_of_demeter_check_spec.rb",
      "spec/rails_best_practices/checks/many_to_many_collection_check_spec.rb",
      "spec/rails_best_practices/checks/move_finder_to_named_scope_check_spec.rb",
      "spec/rails_best_practices/checks/move_model_logic_into_model_check_spec.rb",
@@ -80,6 +82,7 @@ Gem::Specification.new do |s|
      "spec/rails_best_practices/checks/many_to_many_collection_check_spec.rb",
      "spec/rails_best_practices/checks/use_model_association_check_spec.rb",
      "spec/rails_best_practices/checks/move_model_logic_into_model_check_spec.rb",
+     "spec/rails_best_practices/checks/law_of_demeter_check_spec.rb",
      "spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb",
      "spec/rails_best_practices/checks/nested_model_forms_check_spec.rb",
      "spec/rails_best_practices/checks/move_finder_to_named_scope_check_spec.rb",

data/rails_best_practices.yml

@@ -11,3 +11,4 @@ OveruseRouteCustomizationsCheck: { customize_count: 3 }
 NeedlessDeepNestingCheck: { nested_count: 2 }
 NotUseDefaultRouteCheck: {  }
 KeepFindersOnTheirOwnModelCheck: { }
+LawOfDemeterCheck: { }

data/spec/rails_best_practices/checks/law_of_demeter_check_spec.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe RailsBestPractices::Checks::LawOfDemeterCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::LawOfDemeterCheck.new)
+
+    content = <<-EOF
+    class Invoice < ActiveRecord::Base
+      belongs_to :user
+    end
+    EOF
+    @runner.check('app/models/invoice.rb', content)
+  end
+
+  it "should law of demeter" do
+    content = <<-EOF
+    <%= @invoice.user.name %>
+    <%= @invoice.user.address %>
+    <%= @invoice.user.cellphone %>
+    EOF
+    @runner.check('app/views/invoices/show.html.erb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/views/invoices/show.html.erb:1 - law of demeter"
+  end
+
+  it "should no law of demeter" do
+    content = <<-EOF
+    <%= @invoice.user_name %>
+    <%= @invoice.user_address %>
+    <%= @invoice.user_cellphone %>
+    EOF
+    @runner.check('app/views/invoices/show.html.erb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rails_best_practices
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - Richard Huang
@@ -53,6 +53,7 @@ files:
 - lib/rails_best_practices/checks/add_model_virtual_attribute_check.rb
 - lib/rails_best_practices/checks/check.rb
 - lib/rails_best_practices/checks/keep_finders_on_their_own_model_check.rb
+- lib/rails_best_practices/checks/law_of_demeter_check.rb
 - lib/rails_best_practices/checks/many_to_many_collection_check.rb
 - lib/rails_best_practices/checks/move_finder_to_named_scope_check.rb
 - lib/rails_best_practices/checks/move_model_logic_into_model_check.rb
@@ -75,6 +76,7 @@ files:
 - rails_best_practices.yml
 - spec/rails_best_practices/checks/add_model_virtual_attribute_check_spec.rb
 - spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb
+- spec/rails_best_practices/checks/law_of_demeter_check_spec.rb
 - spec/rails_best_practices/checks/many_to_many_collection_check_spec.rb
 - spec/rails_best_practices/checks/move_finder_to_named_scope_check_spec.rb
 - spec/rails_best_practices/checks/move_model_logic_into_model_check_spec.rb
@@ -125,6 +127,7 @@ test_files:
 - spec/rails_best_practices/checks/many_to_many_collection_check_spec.rb
 - spec/rails_best_practices/checks/use_model_association_check_spec.rb
 - spec/rails_best_practices/checks/move_model_logic_into_model_check_spec.rb
+- spec/rails_best_practices/checks/law_of_demeter_check_spec.rb
 - spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb
 - spec/rails_best_practices/checks/nested_model_forms_check_spec.rb
 - spec/rails_best_practices/checks/move_finder_to_named_scope_check_spec.rb