lint_fu 0.5.0 → 0.5.3

data/lib/lint_fu/eidos.rb

@@ -0,0 +1,35 @@
+module LintFu
+  # An eidos (plural: eide) holds information about a Ruby class, module or other
+  # relevant piece of code. The name comes from Plato's theory of forms; the
+  # eidos is the universal abstraction of an entire class of objects.
+  #
+  # Eide are built during the first pass of static analysis by parsing all source
+  # files in the project. On the second pass, the checkers parse selected bits of
+  # code, using the eide to better understand the code they are parsing. 
+  module Eidos
+    attr_accessor :parent_eidos
+    attr_reader   :modeled_class_name, :modeled_class_superclass_name, :parse_tree
+
+    VALID_SEXPS = Set.new([:class, :module])
+
+    #sexp:: [:class, <classname>, <superclass|nil>, <CLASS DEFS>]
+    #namespace:: Array of enclosing module names for this class 
+    def initialize(sexp, namespace=nil)
+      unless VALID_SEXPS.include?(sexp[0])
+        raise ArgumentError, "Must be constructed from a class-definition Sexp"
+      end
+
+      @sexp = sexp
+      if namespace
+        @modeled_class_name = namespace.join('::') + (namespace.empty? ? '' : '::') + sexp[1].to_s
+      else
+        @modeled_class_name = sexp[1]
+      end
+    end
+
+    #Have a pretty string representation
+    def to_s
+      "<<model of #{self.modeled_class_name}>>"
+    end
+  end
+end

data/lib/lint_fu/{model_element_builder.rb → eidos_builder.rb}

@@ -1,10 +1,11 @@
 module LintFu
-  class ModelElementBuilder < SexpProcessor
-    attr_reader :model_elements, :namespace
+  class EidosBuilder < SexpProcessor
+    attr_reader   :namespace, :eide
+    attr_accessor :current_model_element
     
     def initialize(namespace=nil)
       super()
-      @model_elements = []
+      @eide = []
       @namespace = namespace || []
       self.require_empty   = false
       self.auto_shift_type = false      
@@ -25,5 +26,9 @@ module LintFu
       @namespace.pop
       return sexp
     end
+
+    def build
+      raise NotImplemented      
+    end
   end
 end

data/lib/lint_fu/eidos_container.rb

@@ -0,0 +1,25 @@
+module LintFu
+  # An element of a static analysis model that contains, or consists of, eide. For instance,
+  # an Application might consists of Models, Controllers and Views.
+  module EidosContainer
+    def eide
+      return [].freeze unless @eide
+      @eide.dup.freeze
+    end
+
+    def each_eidos(&block)
+      @eide ||= Set.new()
+      @eide.each(&block)
+    end
+
+    def add_eidos(sub)
+      @eide ||= Set.new()
+      @eide << sub
+    end
+
+    def remove_eidos(sub)
+      @eide ||= Set.new()
+      @eide.delete sub
+    end
+  end
+end

data/lib/lint_fu/file_range.rb

@@ -0,0 +1,43 @@
+module LintFu
+  class FileRange
+    attr_reader :filename, :min_line, :max_line
+
+    def initialize(filename, min_line, max_line=nil, content=nil)
+      @filename = File.expand_path(filename)
+      @min_line = min_line
+      @max_line = max_line || min_line
+      @content = content
+    end
+
+    def line
+      min_line
+    end
+
+    def content
+      unless @content
+        #TODO optimize
+        all_content = File.readlines(self.file)
+
+        min_line = [self.min_line - 1, 0].max
+        max_line = [self.max_line - 1, all_content.size - 1].max
+        @content = all_content[min_line..max_line]
+      end
+
+      return @content
+    end
+
+    def ==(other)
+      (self.filename == other.filename) &&
+      (self.min_line == other.min_line) &&
+      (self.max_line == other.max_line)
+    end
+
+    def include?(range)
+      (self.filename == range.filename) &&
+      (self.min_line <= range.min_line) &&
+      (self.max_line >= range.max_line)
+    end
+
+    NONE = FileRange.new('/dev/null', 0)
+  end
+end

data/lib/lint_fu/mixins/sexp_instance_methods.rb

@@ -1,25 +1,32 @@
 module LintFu
+  class TranslationFailure < Exception
+
+  end
+
   module Mixins
     module SexpInstanceMethods
+      WHOLE_LINE_COMMENT = /^\s*#/
+
       def deep_clone
         Marshal.load(Marshal.dump(self))
       end
 
-      #Return a version of this Sexp that preserves the structure of the original, but with
-      #any specific names, quantities or other values replaced with nil. The fingerprint of
-      #a given chunk of code will tend to remain the same over time, even if variable names
-      #or other inconsequential details are changed.
-      #TODO actually implement this method
+      # Return a version of this Sexp that preserves the structure of the original, but with
+      # any specific names, quantities or other values replaced with nil. The fingerprint of
+      # a given chunk of code will tend to remain the same over time, even if variable names
+      # or other inconsequential details are changed.
       def fingerprint
+        #TODO actually implement this method
         self
       end
 
-      #Generate a human-readable description for this sexp that is similar to source code.
+      # Generate a human-readable description for this sexp that is similar to source code.
       def to_ruby_string
         Ruby2Ruby.new.process(self.deep_clone)
       end
 
-      # Translate a sexp containing a Ruby data literal (string, int, array, hash, etc) into the equivalent Ruby object.
+      # Translate a sexp containing a Ruby data literal (string, int, array, hash, etc) into
+      # the equivalent Ruby object.
       def to_ruby(options={})
         typ = self[0]
 
@@ -48,7 +55,7 @@ module LintFu
             return result
           else
             return options[:partial] if options.has_key?(:partial)
-            raise StandardError.new("Cannot convert Sexp to Ruby object: " + self.to_s)
+            raise TranslationFailure.new("Cannot convert Sexp to Ruby object (expression at #{self.file}:#{self.line}): " + self.to_s)
         end
       end
 
@@ -59,7 +66,9 @@ module LintFu
           when :true, :false, :lit, :str
             return true
           when :array, :arglist
-            self[1..-1].each { |sexp| return false unless sexp.constant? }
+            contents = self[1..-1]
+            return false if contents.empty?
+            contents.each { |sexp| return false unless sexp.constant? }
             return true
           when :hash
             result = {}
@@ -102,6 +111,45 @@ module LintFu
         return nil if results.empty?
         return results
       end
+
+      def preceding_comment_range
+        unless @preceding_comment_range
+          cont = File.readlines(self.file)
+
+          comments = ''
+
+          max_line = self.line - 1 - 1
+          max_line = 0 if max_line < 0
+          min_line = max_line
+
+          while cont[min_line] =~ WHOLE_LINE_COMMENT && min_line >= 0
+            min_line -= 1
+          end
+
+          if cont[max_line] =~ WHOLE_LINE_COMMENT
+            min_line +=1 unless min_line == max_line
+            @preceding_comment_range = FileRange.new(self.file, min_line+1, max_line+1, cont[min_line..max_line])
+          else
+            @preceding_comment_range = FileRange::NONE
+          end
+        end
+
+        if @preceding_comment_range == FileRange::NONE
+          return nil
+        else
+          return @preceding_comment_range
+        end
+      end
+      
+      def preceding_comments
+        range = preceding_comment_range
+        return [] unless range
+        return range.content
+      end
+
+      def blessings
+        @blessings ||= Blessing.parse(self.preceding_comments, self)
+      end
     end
   end
 end

data/lib/lint_fu/parser.rb

@@ -2,8 +2,7 @@ module LintFu
   module Parser
     def self.parse_ruby(filename)
       contents = File.read(filename)
-      sexp = RubyParser.new.parse(contents)
-      sexp.file = filename
+      sexp = RubyParser.new.parse(contents, filename)
       return sexp
     rescue SyntaxError => e
       e2 = SyntaxError.new "In #{filename}: #{e.message}"

data/lib/lint_fu/plugins/action_pack/controller_eidos.rb

@@ -0,0 +1,7 @@
+module LintFu::Plugins
+  module ActionPack
+    class ControllerEidos
+      include LintFu::Eidos
+    end
+  end
+end

data/lib/lint_fu/{action_pack/model_controller_builder.rb → plugins/action_pack/controller_eidos_builder.rb}

@@ -1,22 +1,22 @@
-module LintFu
+module LintFu::Plugins
   module ActionPack
-    class ModelControllerBuilder < ModelElementBuilder
+    class ControllerEidosBuilder < LintFu::EidosBuilder
       SIGNATURE_SEXP = s(:colon2, s(:const, :ActionController), :Base)
 
       #sexp:: [:class, <classname>, <superclass|nil>, <CLASS DEFS>]
       def process_class(sexp)
         return super(sexp) unless sexp[2] && sexp[2] == SIGNATURE_SEXP
         
-        unless @current_model_element
-          @current_model_element = ModelController.new(sexp, self.namespace)
+        unless self.current_model_element
+          self.current_model_element = ControllerEidos.new(sexp, self.namespace)
           did_element = true
         end
 
         ret = super(sexp)
 
         if did_element
-          self.model_elements.push @current_model_element
-          @current_model_element = nil
+          self.eide.push self.current_model_element
+          self.current_model_element = nil
         end
 
         return ret

data/lib/lint_fu/plugins/action_pack.rb

@@ -0,0 +1,2 @@
+require 'lint_fu/plugins/action_pack/controller_eidos'
+require 'lint_fu/plugins/action_pack/controller_eidos_builder'

data/lib/lint_fu/{active_record/model_model.rb → plugins/active_record/model_eidos.rb}

@@ -1,7 +1,7 @@
-module LintFu
+module LintFu::Plugins
   module ActiveRecord
-    class ModelModel
-      include LintFu::ModelElement
+    class ModelEidos
+      include LintFu::Eidos
       
       attr_reader :associations
       attr_reader :named_scopes

data/lib/lint_fu/{active_record/model_model_builder.rb → plugins/active_record/model_eidos_builder.rb}

@@ -1,6 +1,6 @@
-module LintFu
+module LintFu::Plugins
   module ActiveRecord
-    class ModelModelBuilder < ModelElementBuilder
+    class ModelEidosBuilder < LintFu::EidosBuilder
       SIGNATURE_SEXP = s(:colon2, s(:const, :ActiveRecord), :Base)      
 
       SINGULAR_ASSOCS = Set.new([:belongs_to, :has_one])
@@ -9,18 +9,20 @@ module LintFu
 
       #sexp:: [:class, <classname>, <superclass|nil>, <CLASS DEFS>]
       def process_class(sexp)
-        return super(sexp) unless sexp[2] && sexp[2] == SIGNATURE_SEXP
+        #always assume everything we see is a model
+        #cheap way to deal with model class hierarchy!
+        #return super(sexp) unless sexp[2] && sexp[2] == SIGNATURE_SEXP
 
-        unless @current_model_element
-          @current_model_element = ModelModel.new(sexp, self.namespace)
+        unless self.current_model_element
+          self.current_model_element = ModelEidos.new(sexp, self.namespace)
           did_element = true
         end
 
         ret = super(sexp)
 
         if did_element
-          self.model_elements.push @current_model_element
-          @current_model_element = nil
+          self.eide.push self.current_model_element
+          self.current_model_element = nil
         end
 
         return ret
@@ -28,7 +30,7 @@ module LintFu
 
       #s(:call, nil, :belongs_to, s(:arglist, s(:lit, :relation_name)))
       def process_call(sexp)
-        return sexp unless @current_model_element
+        return sexp unless self.current_model_element
 
         callee, method, arglist = sexp[1], sexp[2], sexp[3]
         arglist = nil unless arglist[0] == :arglist
@@ -51,8 +53,10 @@ module LintFu
             assoc_class_name = assoc_name.to_s.singularize.camelize
           end
 
-          @current_model_element.associations[assoc_name] = assoc_class_name
+          self.current_model_element.associations[assoc_name] = assoc_class_name
         end        
+      rescue LintFu::TranslationFailure => e
+        # TODO: log a warning
       end
 
       def discover_named_scopes(callee, method, arglist)
@@ -60,12 +64,14 @@ module LintFu
         if (callee == nil && method == :named_scope) && arglist
           scope_name = arglist[1].to_ruby
           scope_args = arglist[2..-1].to_ruby(:partial=>nil)
-          @current_model_element.named_scopes[scope_name] = scope_args
+          self.current_model_element.named_scopes[scope_name] = scope_args
         end
+      rescue LintFu::TranslationFailure => e
+        # TODO: log a warning
       end
 
       def discover_paranoia(callee, method, arglist)
-        @current_model_element.paranoid = true if (method == :acts_as_paranoid)
+        self.current_model_element.paranoid = true if (method == :acts_as_paranoid)
       end
     end
   end

data/lib/lint_fu/plugins/active_record.rb

@@ -0,0 +1,2 @@
+require 'lint_fu/plugins/active_record/model_eidos'
+require 'lint_fu/plugins/active_record/model_eidos_builder'

data/lib/lint_fu/{rails → plugins/rails}/buggy_eager_load_checker.rb

@@ -1,6 +1,6 @@
-module LintFu
+module LintFu::Plugins
   module Rails
-    class BuggyEagerLoad < Issue
+    class BuggyEagerLoad < LintFu::Issue
       def initialize(scan, file, sexp, subject)
         super(scan, file, sexp)
         @subject = subject
@@ -16,7 +16,7 @@ h4. What is it?
 
 A buggy eager load happens when an ActiveRecord finder performs eager loading of a @:has_many@ association and the "target" of the association acts as paranoid.
 
-The acts_as_paranoid plugin does not correctly eager loads that use a @JOIN@ strategy. If a paranoid model is eager loaded in this way, _all_ models -- even deleted ones -- will be loaded.
+The acts_as_paranoid plugin does not correctly handle eager loads that use a @JOIN@ strategy. If a paranoid model is eager loaded in this way, _all_ models -- even deleted ones -- will be loaded.
 
 h4. When does it happen?
 
@@ -39,13 +39,14 @@ EOF
     end
     
     # Visit a Rails controller looking for troublesome stuff
-    class BuggyEagerLoadChecker < Checker
+    class BuggyEagerLoadChecker < LintFu::Checker
       FINDER_REGEXP  = /^(find|first|all)(_or_initialize)?(_by_.*)?/
 
       #sexp:: s(:call, <target>, <method_name>, s(:arglist))
       def observe_call(sexp)
+        super(sexp)
         return unless finder?(sexp)
-        if finder?(sexp) && (si = spotty_includes(sexp[3]))
+        if finder?(sexp) && (si = spotty_includes(sexp[3])) && !suppressed?(UnsafeFind)
           scan.issues << BuggyEagerLoad.new(scan, self.file, sexp, si.modeled_class_name)
         end
       end

data/lib/lint_fu/{rails/scan_builder.rb → plugins/rails/issue_builder.rb}

@@ -1,24 +1,20 @@
-module LintFu
+module LintFu::Plugins
   module Rails
-    class ScanBuilder
+    class IssueBuilder
       attr_reader :fs_root
 
       def initialize(fs_root)
         @fs_root = fs_root
       end
 
-      def scan(context)
-        scan    = LintFu::Scan.new(@fs_root)
-
-        models_dir      = File.join(@fs_root, 'app', 'models')
-        controllers_dir = File.join(@fs_root, 'app', 'controllers')
-        views_dir       = File.join(@fs_root, 'app', 'views')
+      def build(context, scan)
+        models_dir      = File.join(scan.fs_root, 'app', 'models')
+        controllers_dir = File.join(scan.fs_root, 'app', 'controllers')
+        views_dir       = File.join(scan.fs_root, 'app', 'views')
 
         #Scan controllers
         Dir.glob(File.join(controllers_dir, '**', '*.rb')).each do |filename|
-          contents = File.read(filename)
-          parser = RubyParser.new
-          sexp = parser.parse(contents, filename)
+          sexp = LintFu::Parser.parse_ruby(filename)
           visitor = LintFu::Visitor.new
           visitor.observers << BuggyEagerLoadChecker.new(scan, context, filename)
           visitor.observers << SqlInjectionChecker.new(scan, context, filename)
@@ -28,15 +24,12 @@ module LintFu
 
         #Scan models
         Dir.glob(File.join(models_dir, '**', '*.rb')).each do |filename|
-          contents = File.read(filename)
-          parser = RubyParser.new
-          sexp = parser.parse(contents, filename)
+          sexp = LintFu::Parser.parse_ruby(filename)
           visitor = LintFu::Visitor.new
           visitor.observers << SqlInjectionChecker.new(scan, context, filename, 0.2)
+          visitor.observers << UnsafeFindChecker.new(scan, context, filename)
           visitor.process(sexp)          
         end
-
-        return scan
       end
     end
   end