code_analyzer 0.1.1 → 0.2.0

data/README.md

@@ -19,7 +19,7 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: I will write instructions later.
+<http://flyerhzm.github.com/code_analyzer/>
 
 ## Contributing
 

data/lib/code_analyzer.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require "ripper"
 require "code_analyzer/version"
 require "code_analyzer/nil"

data/lib/code_analyzer/analyzer_exception.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module CodeAnalyzer
   class AnalyzerException < Exception; end
 end

data/lib/code_analyzer/checker.rb

@@ -55,6 +55,7 @@ module CodeAnalyzer
       warnings << Warning.new(filename: filename, line_number: line_number, message: message)
     end
 
+    # all warnings.
     def warnings
       @warnings ||= []
     end

data/lib/code_analyzer/checking_visitor.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 module CodeAnalyzer
   module CheckingVisitor
+    autoload :Base, "code_analyzer/checking_visitor/base"
     autoload :Plain, "code_analyzer/checking_visitor/plain"
     autoload :Default, "code_analyzer/checking_visitor/default"
   end

data/lib/code_analyzer/checking_visitor/base.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+module CodeAnalyzer::CheckingVisitor
+  # Base class for checking visitor.
+  class Base
+    def initialize(options={})
+      @checkers = options[:checkers]
+    end
+
+    def after_check; end
+
+    def warnings
+      @warnings ||= @checkers.map(&:warnings).flatten
+    end
+  end
+end

data/lib/code_analyzer/checking_visitor/default.rb

@@ -1,9 +1,10 @@
 # encoding: utf-8
 module CodeAnalyzer::CheckingVisitor
-  class Default
+  # This is the default checking visitor to check ruby sexp nodes.
+  class Default < Base
     def initialize(options={})
+      super
       @checks = {}
-      @checkers = options[:checkers]
       @checkers.each do |checker|
         checker.interesting_nodes.each do |node|
           @checks[node] ||= []
@@ -11,14 +12,19 @@ module CodeAnalyzer::CheckingVisitor
           @checks[node].uniq!
         end
       end
-    end
+   end
 
+    # check the ruby sexp nodes for the ruby file.
+    #
+    # @param [String] filename is the filename of ruby code.
+    # @param [String] content is the content of ruby file.
     def check(filename, content)
       node = parse(filename, content)
       node.file = filename
       check_node(node)
     end
 
+    # trigger all after_check callbacks defined in all checkers.
     def after_check
       @checkers.each do |checker|
         after_check_callbacks = checker.class.get_callbacks(:after_check)
@@ -30,14 +36,19 @@ module CodeAnalyzer::CheckingVisitor
 
     # parse ruby code.
     #
-    # @param [String] filename is the filename of ruby file.
-    # @param [String] content is the source code of ruby file.
+    # @param [String] filename is the filename of ruby code.
+    # @param [String] content is the content of ruby file.
     def parse(filename, content)
       Sexp.from_array(Ripper::SexpBuilder.new(content).parse)
     rescue Exception
       raise AnalyzerException.new("#{filename} looks like it's not a valid Ruby file.  Skipping...")
     end
 
+    # recursively check ruby sexp node.
+    #
+    # 1. it triggers the interesting checkers' start callbacks.
+    # 2. recursively check the sexp children.
+    # 3. it triggers the interesting checkers' end callbacks.
     def check_node(node)
       checkers = @checks[node.sexp_type]
       if checkers

data/lib/code_analyzer/checking_visitor/plain.rb

@@ -1,17 +1,15 @@
 # encoding: utf-8
 module CodeAnalyzer::CheckingVisitor
-  class Plain
-    def initialize(options={})
-      @checkers = options[:checkers]
-    end
-
+  # This is the checking visitor to check ruby plain code.
+  class Plain < Base
+    # check the ruby plain code.
+    #
+    # @param [String] filename is the filename of ruby code.
+    # @param [String] content is the content of ruby file.
     def check(filename, content)
       @checkers.each do |checker|
         checker.check(filename, content)
       end
     end
-
-    def after_check
-    end
   end
 end

data/lib/code_analyzer/version.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module CodeAnalyzer
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/spec/code_analyzer/checking_visitor/base_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+module CodeAnalyzer
+  module CheckingVisitor
+    describe Base do
+      it "should return all checkers' warnings" do
+        warning1 = Warning.new
+        checker1 = mock(:checker, warnings: [warning1])
+        warning2 = Warning.new
+        checker2 = mock(:checker, warnings: [warning2])
+        visitor = Base.new(checkers: [checker1, checker2])
+        visitor.warnings.should == [warning1, warning2]
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: code_analyzer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-17 00:00:00.000000000 Z
+date: 2012-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sexp_processor
-  requirement: &70274611483180 !ruby/object:Gem::Requirement
+  requirement: &70129984050860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70274611483180
+  version_requirements: *70129984050860
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70274611482560 !ruby/object:Gem::Requirement
+  requirement: &70129984046400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70274611482560
+  version_requirements: *70129984046400
 description: a code analyzer tool which extracted from rails_best_practices, it helps
   you easily build your own code analyzer tool.
 email:
@@ -53,6 +53,7 @@ files:
 - lib/code_analyzer/analyzer_exception.rb
 - lib/code_analyzer/checker.rb
 - lib/code_analyzer/checking_visitor.rb
+- lib/code_analyzer/checking_visitor/base.rb
 - lib/code_analyzer/checking_visitor/default.rb
 - lib/code_analyzer/checking_visitor/plain.rb
 - lib/code_analyzer/nil.rb
@@ -60,6 +61,7 @@ files:
 - lib/code_analyzer/version.rb
 - lib/code_analyzer/warning.rb
 - spec/code_analyzer/checker_spec.rb
+- spec/code_analyzer/checking_visitor/base_spec.rb
 - spec/code_analyzer/checking_visitor/default_spec.rb
 - spec/code_analyzer/checking_visitor/plain_spec.rb
 - spec/code_analyzer/nil_spec.rb
@@ -92,6 +94,7 @@ specification_version: 3
 summary: a code analyzer helps you build your own code analyzer tool.
 test_files:
 - spec/code_analyzer/checker_spec.rb
+- spec/code_analyzer/checking_visitor/base_spec.rb
 - spec/code_analyzer/checking_visitor/default_spec.rb
 - spec/code_analyzer/checking_visitor/plain_spec.rb
 - spec/code_analyzer/nil_spec.rb