roodi 1.3.7 → 1.4.0

data/History.txt

@@ -1,3 +1,7 @@
+= 1.4.0
+
+* Upgraded from ParseTree to ruby_parser.
+
 = 1.3.7
 
 * Fixed a bug in the rake task where it always failed even if no errors existed.

data/Manifest.txt

@@ -30,8 +30,8 @@ lib/roodi/core.rb
 lib/roodi/core/checking_visitor.rb
 lib/roodi/core/error.rb
 lib/roodi/core/iterator_visitor.rb
-lib/roodi/core/parse_tree_runner.rb
 lib/roodi/core/parser.rb
+lib/roodi/core/runner.rb
 lib/roodi/core/visitable_sexp.rb
 lib/roodi_task.rb
 roodi.yml

data/README.txt

@@ -29,7 +29,7 @@ Check one controller and all model files in a rails app:
 Check all ruby files in a rails app with a custom configuration file:
     roodi -config=my_roodi_config.yml "rails_app/**/*.rb"
 
-If you're writing a check, it is useful to see the structure of a file the way that Roodi tokenizes it (via ParseTree). Use:
+If you're writing a check, it is useful to see the structure of a file the way that Roodi tokenizes it (via ruby_parser). Use:
     roodi-describe [filename]
 
 == CUSTOM CONFIGURATION

data/Rakefile

@@ -8,7 +8,7 @@ require 'roodi'
 
 Hoe.new('roodi', Roodi::VERSION) do |p|
   p.developer('Marty Andrews', 'marty@cogentconsulting.com.au')
-  p.extra_deps = ['ParseTree', 'facets']
+  p.extra_deps = ['ruby_parser', 'facets']
   p.remote_rdoc_dir = ''
 end
 

data/bin/roodi

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
 
 require 'roodi'
 
-runner = Roodi::Core::ParseTreeRunner.new
+runner = Roodi::Core::Runner.new
 
 config_param = ARGV.detect {|arg| arg =~ /-config=.*/}
 runner.config = config_param.split("=")[1] if config_param

data/bin/roodi-describe

@@ -3,5 +3,5 @@
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
 require 'roodi'
 
-roodi = Roodi::Core::ParseTreeRunner.new
+roodi = Roodi::Core::Runner.new
 roodi.print_file(ARGV[0])

data/lib/roodi.rb

@@ -2,5 +2,5 @@ require 'roodi/checks'
 require 'roodi/core'
 
 module Roodi
-  VERSION = '1.3.7'
+  VERSION = '1.4.0'
 end

data/lib/roodi/checks/check.rb

@@ -10,16 +10,16 @@ module Roodi
       def position(offset = 0)
         "#{@line[2]}:#{@line[1] + offset}"
       end
-  
-      def evaluate_node_at_line(node, line)
-        @line = line
+
+      def evaluate_node(node)
+        @node = node
         eval_method = "evaluate_#{node.node_type}"
         self.send(eval_method, node) if self.respond_to? eval_method
         evaluate(node) if self.respond_to? :evaluate
       end
   
-      def add_error(error, offset = 0)
-        @errors << Roodi::Core::Error.new("#{@line[2]}", "#{@line[1] + offset}", error)
+      def add_error(error)
+        @errors << Roodi::Core::Error.new("#{@node.file}", "#{@node.line}", error)
       end
   
       def errors

data/lib/roodi/checks/control_coupling_check.rb

@@ -9,8 +9,7 @@ module Roodi
 
       def evaluate_defn(node)
         @method_name = node[1]
-        @arguments = node[2][1][1]
-        @arguments.delete_at 0
+        @arguments = node[2][1..-1]
       end
         
       def evaluate_lvar(node)

data/lib/roodi/checks/empty_rescue_body_check.rb

@@ -7,14 +7,14 @@ module Roodi
     # When the body of a rescue block is empty, exceptions can get caught and swallowed without
     # any feedback to the user.
     class EmptyRescueBodyCheck < Check
-      STATEMENT_NODES = [:fcall, :return, :attrasgn, :vcall, :nil]
+      STATEMENT_NODES = [:fcall, :return, :attrasgn, :vcall, :nil, :call]
       
       def interesting_nodes
         [:resbody]
       end
 
       def evaluate(node)
-        add_error("Rescue block should not be empty.", 1) unless has_statement?(node)
+        add_error("Rescue block should not be empty.") unless has_statement?(node)
       end
   
       private

data/lib/roodi/checks/line_count_check.rb

@@ -22,10 +22,7 @@ module Roodi
       protected
   
       def count_lines(node)
-        count = 0
-        count = count + 1 if node.node_type == :newline
-        node.children.each {|node| count += count_lines(node)}
-        count
+        node.last.line - node.line - 1
       end
     end
   end

data/lib/roodi/checks/parameter_number_check.rb

@@ -21,7 +21,7 @@ module Roodi
 
       def evaluate(node)
         method_name = node[1]
-        arguments = node[2][1][1]
+        arguments = node[2]
         parameter_count = arguments.inject(-1) { |count, each| count = count + (each.class == Symbol ? 1 : 0) }
         add_error "Method name \"#{method_name}\" has #{parameter_count} parameters.  It should have #{@parameter_count} or less." unless parameter_count <= @parameter_count
       end

data/lib/roodi/core.rb

@@ -1 +1 @@
-require 'roodi/core/parse_tree_runner'
+require 'roodi/core/runner'

data/lib/roodi/core/checking_visitor.rb

@@ -14,9 +14,8 @@ module Roodi
       end
 
       def visit(node)
-        @last_newline = node if node.node_type == :newline
         checks = @checks[node.node_type]
-        checks.each {|check| check.evaluate_node_at_line(node, @last_newline)} unless checks.nil?
+        checks.each {|check| check.evaluate_node(node)} unless checks.nil?
         nil
       end
     end

data/lib/roodi/core/iterator_visitor.rb

@@ -9,7 +9,7 @@ module Roodi
     		visited.accept(@payload)
     		visitable_nodes = visited.is_language_node? ? visited.sexp_body : visited
     		visitable_nodes.each do |child| 
-    		  if child.class == VisitableSexp then
+    		  if child.class == Sexp then
       		  child.accept(self)
     		  end
   		  end

data/lib/roodi/core/parser.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-require 'parse_tree'
+require 'ruby_parser'
 require 'facets'
 
 
@@ -15,11 +15,8 @@ module Roodi
       private
       
       def silent_parse(content, filename)
-        @parser ||= ParseTree.new(true)
-        node = @parser.parse_tree_for_string(content, filename)
-        sexp = VisitableSexp.from_array node
-        sexp.filename = filename
-        sexp
+        @parser ||= RubyParser.new
+        @parser.parse(content, filename)
       end
     end
   end

data/lib/roodi/core/{parse_tree_runner.rb → runner.rb}

@@ -8,7 +8,7 @@ require 'roodi/core/visitable_sexp'
 
 module Roodi
   module Core
-    class ParseTreeRunner
+    class Runner
       DEFAULT_CONFIG = File.join(File.dirname(__FILE__), "..", "..", "..", "roodi.yml")
       
       attr_writer :config
@@ -35,6 +35,7 @@ module Roodi
   
       def print(filename, content)
         node = @parser.parse(content, filename)
+        puts "Line: #{node.line}"
         pp node
       end
 

data/lib/roodi/core/visitable_sexp.rb

@@ -1,24 +1,20 @@
 require 'rubygems'
 require 'sexp'
 
-module Roodi
-  module Core
-    class VisitableSexp < Sexp
-      def accept(visitor)
-        visitor.visit(self)
-      end
-      
-      def node_type
-        first
-      end
-      
-      def children
-        sexp_body.select {|each| each.class == VisitableSexp }
-      end
-      
-      def is_language_node?
-        first.class == Symbol
-      end
-    end
+class Sexp
+  def accept(visitor)
+    visitor.visit(self)
+  end
+
+  def node_type
+    first
+  end
+
+  def children
+    find_all { | sexp | Sexp === sexp }
+  end
+
+  def is_language_node?
+    first.class == Symbol
   end
 end

data/lib/roodi_task.rb

@@ -18,7 +18,7 @@ class RoodiTask < Rake::TaskLib
   def define
     desc "Check for design issues in: #{patterns.join(', ')}"
     task name do
-      runner = Roodi::Core::ParseTreeRunner.new
+      runner = Roodi::Core::Runner.new
 
       runner.config = config if config
 

data/spec/roodi/checks/abc_metric_method_check_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Checks::AbcMetricMethodCheck do
   before(:each) do
-    @roodi = Roodi::Core::ParseTreeRunner.new(Roodi::Checks::AbcMetricMethodCheck.new({'score' => 0}))
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::AbcMetricMethodCheck.new({'score' => 0}))
   end
 
   def verify_content_score(content, a, b, c)

data/spec/roodi/checks/assignment_in_conditional_check_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Checks::AssignmentInConditionalCheck do
   before(:each) do
-    @roodi = Roodi::Core::ParseTreeRunner.new(Roodi::Checks::AssignmentInConditionalCheck.new)
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::AssignmentInConditionalCheck.new)
   end
   
   it "should accept an assignment before an if clause" do
@@ -55,9 +55,7 @@ describe Roodi::Checks::AssignmentInConditionalCheck do
   end
 
   it "should reject an assignment inside a a ternary operator check clause" do
-    content = <<-END
-    call_foo (bar = bam) ? baz : bad
-    END
+    content = 'call_foo (bar = bam) ? baz : bad'
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty

data/spec/roodi/checks/case_missing_else_check_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Checks::CaseMissingElseCheck do
   before(:each) do
-    @roodi = Roodi::Core::ParseTreeRunner.new(Roodi::Checks::CaseMissingElseCheck.new)
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::CaseMissingElseCheck.new)
   end
   
   it "should accept case statements that do have an else" do
@@ -27,6 +27,6 @@ describe Roodi::Checks::CaseMissingElseCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].to_s.should eql("dummy-file.rb:1 - Case statement is missing an else clause.")
+    errors[0].to_s.should match(/dummy-file.rb:[1-2] - Case statement is missing an else clause./)
   end
 end

data/spec/roodi/checks/class_line_count_check_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Checks::ClassLineCountCheck do
   before(:each) do
-    @roodi = Roodi::Core::ParseTreeRunner.new(Roodi::Checks::ClassLineCountCheck.new({'line_count' => 1}))
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::ClassLineCountCheck.new({'line_count' => 1}))
   end
   
   it "should accept classes with less lines than the threshold" do

data/spec/roodi/checks/class_name_check_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Checks::ClassNameCheck do
   before(:each) do
-    @roodi = Roodi::Core::ParseTreeRunner.new(Roodi::Checks::ClassNameCheck.new)
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::ClassNameCheck.new)
   end
   
   it "should accept camel case class names starting in capitals" do

data/spec/roodi/checks/class_variable_check_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Checks::ClassVariableCheck do
   before(:each) do
-    @roodi = Roodi::Core::ParseTreeRunner.new(Roodi::Checks::ClassVariableCheck.new)
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::ClassVariableCheck.new)
   end
   
   it "should reject class variables" do
@@ -12,6 +12,6 @@ describe Roodi::Checks::ClassVariableCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].to_s.should eql("dummy-file.rb:1 - Don't use class variables. You might want to try a different design.")
+    errors[0].to_s.should match(/dummy-file.rb:[1-2] - Don't use class variables. You might want to try a different design./)
   end
 end

data/spec/roodi/checks/control_coupling_check_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Checks::ControlCouplingCheck do
   before(:each) do
-    @roodi = Roodi::Core::ParseTreeRunner.new(Roodi::Checks::ControlCouplingCheck.new)
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::ControlCouplingCheck.new)
   end
   
   it "should reject methods with if checks using a parameter" do
@@ -18,6 +18,6 @@ describe Roodi::Checks::ControlCouplingCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].to_s.should eql("dummy-file.rb:2 - Method \"write\" uses the argument \"quoted\" for internal control.")
+    errors[0].to_s.should match(/dummy-file.rb:[2-3] - Method \"write\" uses the argument \"quoted\" for internal control./)
   end
 end

data/spec/roodi/checks/cyclomatic_complexity_block_check_spec.rb

@@ -2,14 +2,14 @@ require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Checks::CyclomaticComplexityBlockCheck do
   before(:each) do
-    @roodi = Roodi::Core::ParseTreeRunner.new(Roodi::Checks::CyclomaticComplexityBlockCheck.new({'complexity' => 0}))
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::CyclomaticComplexityBlockCheck.new({'complexity' => 0}))
   end
 
   def verify_content_complexity(content, complexity)
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].to_s.should eql("dummy-file.rb:2 - Block cyclomatic complexity is #{complexity}.  It should be 0 or less.")
+    errors[0].to_s.should match(/dummy-file.rb:[2-4] - Block cyclomatic complexity is #{complexity}.  It should be 0 or less./)
   end
   
   it "should find a simple block" do

data/spec/roodi/checks/cyclomatic_complexity_method_check_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Checks::CyclomaticComplexityMethodCheck do
   before(:each) do
-    @roodi = Roodi::Core::ParseTreeRunner.new(Roodi::Checks::CyclomaticComplexityMethodCheck.new({'complexity' => 0}))
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::CyclomaticComplexityMethodCheck.new({'complexity' => 0}))
   end
 
   def verify_content_complexity(content, complexity)

data/spec/roodi/checks/empty_rescue_body_check_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Checks::EmptyRescueBodyCheck do
   before(:each) do
-    @roodi = Roodi::Core::ParseTreeRunner.new(Roodi::Checks::EmptyRescueBodyCheck.new)
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::EmptyRescueBodyCheck.new)
   end
   
   it "should accept a rescue body with content and no parameter" do
@@ -87,7 +87,7 @@ describe Roodi::Checks::EmptyRescueBodyCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].to_s.should eql("dummy-file.rb:3 - Rescue block should not be empty.")
+    errors[0].to_s.should match(/dummy-file.rb:[3-4] - Rescue block should not be empty./)
   end
 
   it "should accept a rescue block with an explicit nil" do
@@ -109,6 +109,6 @@ describe Roodi::Checks::EmptyRescueBodyCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].to_s.should eql("dummy-file.rb:3 - Rescue block should not be empty.")
+    errors[0].to_s.should match(/dummy-file.rb:[3-4] - Rescue block should not be empty./)
   end
 end

data/spec/roodi/checks/for_loop_check_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Checks::ForLoopCheck do
   before(:each) do
-    @roodi = Roodi::Core::ParseTreeRunner.new(Roodi::Checks::ForLoopCheck.new)
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::ForLoopCheck.new)
   end
   
   it "should reject for loops" do

data/spec/roodi/checks/method_line_count_check_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Checks::MethodLineCountCheck do
   before(:each) do
-    @roodi = Roodi::Core::ParseTreeRunner.new(Roodi::Checks::MethodLineCountCheck.new({'line_count' => 1}))
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::MethodLineCountCheck.new({'line_count' => 1}))
   end
   
   it "should accept methods with less lines than the threshold" do
@@ -36,4 +36,21 @@ describe Roodi::Checks::MethodLineCountCheck do
     errors.should_not be_empty
     errors[0].to_s.should eql("dummy-file.rb:1 - Method \"two_line_method\" has 2 lines.  It should have 1 or less.")
   end
+
+  it "should count only lines from the method" do
+    content = <<-END
+    def first_method
+      puts 1
+    end
+
+    def second_method
+      puts 1
+      puts 2
+    end
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].to_s.should eql("dummy-file.rb:5 - Method \"second_method\" has 2 lines.  It should have 1 or less.")
+  end
 end

data/spec/roodi/checks/method_name_check_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Checks::MethodNameCheck do
   before(:each) do
-    @roodi = Roodi::Core::ParseTreeRunner.new(Roodi::Checks::MethodNameCheck.new)
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::MethodNameCheck.new)
   end
   
   it "should accept method names with underscores" do

data/spec/roodi/checks/module_line_count_check_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Checks::ModuleLineCountCheck do
   before(:each) do
-    @roodi = Roodi::Core::ParseTreeRunner.new(Roodi::Checks::ModuleLineCountCheck.new({'line_count' => 1}))
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::ModuleLineCountCheck.new({'line_count' => 1}))
   end
   
   it "should accept modules with less lines than the threshold" do

data/spec/roodi/checks/module_name_check_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Checks::ModuleNameCheck do
   before(:each) do
-    @roodi = Roodi::Core::ParseTreeRunner.new(Roodi::Checks::ModuleNameCheck.new)
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::ModuleNameCheck.new)
   end
   
   it "should accept camel case module names starting in capitals" do

data/spec/roodi/checks/parameter_number_check_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe Roodi::Checks::ParameterNumberCheck do
   before(:each) do
-    @roodi = Roodi::Core::ParseTreeRunner.new(Roodi::Checks::ParameterNumberCheck.new({'parameter_count' => 1}))
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::ParameterNumberCheck.new({'parameter_count' => 1}))
   end
   
   it "should accept methods with less lines than the threshold" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: roodi
 version: !ruby/object:Gem::Version 
-  version: 1.3.7
+  version: 1.4.0
 platform: ruby
 authors: 
 - Marty Andrews
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-06 00:00:00 +10:00
+date: 2009-05-08 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: ParseTree
+  name: ruby_parser
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -87,8 +87,8 @@ files:
 - lib/roodi/core/checking_visitor.rb
 - lib/roodi/core/error.rb
 - lib/roodi/core/iterator_visitor.rb
-- lib/roodi/core/parse_tree_runner.rb
 - lib/roodi/core/parser.rb
+- lib/roodi/core/runner.rb
 - lib/roodi/core/visitable_sexp.rb
 - lib/roodi_task.rb
 - roodi.yml