roodi 1.0.0 → 1.1.0

data/History.txt

@@ -1,3 +1,8 @@
+= 1.1.0
+
+* Added support back in for line numbers in error messages.
+* Re-enabled MethodLineCountCheck as part of the default check set.
+
 = 1.0.0
 
 * First release of Roodi.

data/Manifest.txt

@@ -21,7 +21,6 @@ lib/roodi/core/iterator_visitor.rb
 lib/roodi/core/parse_tree_runner.rb
 lib/roodi/core/parser.rb
 lib/roodi/core/visitable_sexp.rb
-roodi.gemspec
 roodi.yml
 spec/checks/class_name_check_spec.rb
 spec/checks/cyclomatic_complexity_block_check_spec.rb

data/README.txt

@@ -6,7 +6,7 @@
 
 Roodi stands for Ruby Object Oriented Design Inferometer.  It parses your Ruby code and warns you about design issues you have based on the checks that is has configured.
 
-== SUPPORTED CHECKS
+== SUPPORTED CHECKS:
 
 * ClassNameCheck - Check that class names match convention.
 * CyclomaticComplexityBlockCheck - Check that the cyclomatic complexity of all blocks is below the threshold.
@@ -14,6 +14,7 @@ Roodi stands for Ruby Object Oriented Design Inferometer.  It parses your Ruby c
 * EmptyRescueBodyCheck - Check that there are no empty rescue blocks.
 * ForLoopCheck - Check that for loops aren't used (Use Enumerable.each instead)
 * MethodNameCheck - Check that method names match convention.
+* MethodLineCountCheck - Check that the number of lines in a method is below the threshold.
 
 == SYNOPSIS:
 
@@ -47,29 +48,3 @@ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-
-== Introduction
-
-Roodi is an acronym that stands for Ruby Object Oriented Design Inferometer.  It parses your Ruby code and warns you about design issues you have based on the checks that is has configured.
-
-== Usage
-
-TBD.  See the Rakefile in this project for an example of how to get started if you're on the bleeding edge.
-
-== Background
-
-Roodi is almost identical in design to the Java tool called Checkstyle (http://checkstyle.sf.net/), however it is named after the Java tool that I worked on called Joodi (http://joodi.checkstyle.net).  I think it's more appropriate to name it similarly to Joodi than Checkstyle, because the checks exist to warn you about design issues, not style issues.  Joodi has a different design, but a better name.  I used a combination of each.
-
-== Design
-
-Roodi builds an Abstract Syntax Tree (AST) of the Ruby source code, then uses the visitor patten to walk every node in the tree and see if the checks can infer any design issues with them.  Usually, the existence of an AST would mean running a grammar file through a parser to build it.  No such grammar file exists to build a complete representation of the source (including whitespace characters and comments) for the Ruby language, so I originally used the object model built by the JRuby team instead.  That design soon switched to use ParseTree instead, which makes Roodi more portable (it doesn't depend on JRuby anymore), but slightly less functional (mainly because ParseTree doesn't support line numbers).
-
-== Checks currently supported
-	ClassNameCheck					Check that class names match convention.
-	CyclomaticComplexityBlockCheck	Check that the cyclomatic complexity of all blocks is below the threshold.
-	CyclomaticComplexityMethodCheck	Check that the cyclomatic complexity of all methods is below the threshold.
-	EmptyRescueBodyCheck			Check that there are no empty rescue blocks.
-	ForLoopCheck					Check that for loops aren't used (Use Enumerable.each instead)
-	MethodNameCheck					Check that method names match convention.

data/Rakefile

@@ -6,6 +6,19 @@ require 'rake'
 require 'spec/rake/spectask'
 require 'roodi'
 
+Hoe.new('roodi', Roodi::VERSION) do |p|
+  p.developer('Marty Andrews', 'marty@cogentconsulting.com.au')
+  p.extra_deps = ['ParseTree']
+  p.remote_rdoc_dir = ''
+end
+
+def roodi(ruby_files)
+  roodi = Roodi::Core::ParseTreeRunner.new
+  ruby_files.each { |file| roodi.check_file(file) }
+  roodi.errors.each {|error| puts error}
+  puts "\nFound #{roodi.errors.size} errors."
+end
+
 desc "Run all specs"
 Spec::Rake::SpecTask.new('spec') do |t|
   t.spec_files = FileList['spec/**/*spec.rb']
@@ -17,19 +30,3 @@ task :roodi do
   roodi(Dir.glob(pattern))
 end
 
-task :roodi_runway do
-  pattern = File.join("/Users/marty/Data/runway", "**", "*.rb")
-  roodi(Dir.glob(pattern))
-end
-
-def roodi(ruby_files)
-  roodi = Roodi::Core::ParseTreeRunner.new
-  ruby_files.each { |file| roodi.check_file(file) }
-  roodi.errors.each {|error| puts error}
-  puts "\nFound #{roodi.errors.size} errors."
-end
-
-Hoe.new('roodi', Roodi::VERSION) do |p|
-  p.developer('Marty Andrews', 'marty@cogentconsulting.com.au')
-  p.remote_rdoc_dir = '' # Release to root
-end

data/lib/roodi.rb

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

data/lib/roodi/checks/check.rb

@@ -5,12 +5,17 @@ module Roodi
         @errors = []
       end
   
-      def position(node)
-        node.filename
+      def position(offset = 0)
+        "#{@line[2]}:#{@line[1] + offset}"
       end
   
-      def add_error(error)
-        @errors << error
+      def evaluate_node_at_line(node, line)
+        @line = line
+        evaluate(node)
+      end
+  
+      def add_error(error, offset = 0)
+        @errors << "#{position(offset)} - #{error}"
       end
   
       def errors

data/lib/roodi/checks/class_name_check.rb

@@ -9,7 +9,7 @@ module Roodi
   
       def evaluate(node)
         pattern = /^[A-Z][a-zA-Z0-9]*$/
-        add_error "#{position(node)} - Class name \"#{node[1]}\" should match pattern #{pattern}." unless node[1].to_s =~ pattern
+        add_error "Class name \"#{node[1]}\" should match pattern #{pattern.inspect}" unless node[1].to_s =~ pattern
       end
     end
   end

data/lib/roodi/checks/cyclomatic_complexity_block_check.rb

@@ -8,12 +8,12 @@ module Roodi
       end
       
       def interesting_nodes
-        [:block]
+        [:iter]
       end
 
       def evaluate(node)
         complexity = count_complexity(node)
-        add_error "#{position(node)} - Block cyclomatic complexity is #{complexity}.  It should be #{@complexity} or less." unless complexity <= @complexity
+        add_error "Block cyclomatic complexity is #{complexity}.  It should be #{@complexity} or less." unless complexity <= @complexity
       end
     end
   end

data/lib/roodi/checks/cyclomatic_complexity_method_check.rb

@@ -13,7 +13,7 @@ module Roodi
 
       def evaluate(node)
         complexity = count_complexity(node)
-        add_error "#{position(node)} - Method name \"#{node[1]}\" has a cyclomatic complexity is #{complexity}.  It should be #{@complexity} or less." unless complexity <= @complexity
+        add_error "Method name \"#{node[1]}\" has a cyclomatic complexity is #{complexity}.  It should be #{@complexity} or less." unless complexity <= @complexity
       end
     end
   end

data/lib/roodi/checks/empty_rescue_body_check.rb

@@ -8,7 +8,7 @@ module Roodi
       end
 
       def evaluate(node)
-        add_error "#{position(node)} - Rescue block should not be empty." unless has_statement?(node)
+        add_error("Rescue block should not be empty.", 1) unless has_statement?(node)
       end
   
       private

data/lib/roodi/checks/for_loop_check.rb

@@ -8,7 +8,7 @@ module Roodi
       end
 
       def evaluate(node)
-        add_error "#{position(node)} - Don't use 'for' loops. Use Enumerable.each instead."
+        add_error "Don't use 'for' loops. Use Enumerable.each instead."
       end
     end
   end

data/lib/roodi/checks/method_line_count_check.rb

@@ -14,7 +14,7 @@ module Roodi
 
       def evaluate(node)
         line_count = count_lines(node)
-        add_error "#{position(node)} - Method name \"#{node.getName}\" has #{line_count} lines.  It should have #{@line_count} or less." unless line_count <= @line_count
+        add_error "Method name \"#{node[1]}\" has #{line_count} lines.  It should have #{@line_count} or less." unless line_count <= @line_count
       end
   
       private
@@ -22,7 +22,7 @@ module Roodi
       def count_lines(node)
         count = 0
         count = count + 1 if node.node_type == :newline
-        node.childNodes.each {|node| count += count_lines(node)}
+        node.children.each {|node| count += count_lines(node)}
         count
       end
     end

data/lib/roodi/checks/method_name_check.rb

@@ -8,8 +8,8 @@ module Roodi
       end
 
       def evaluate(node)
-        pattern = /^[a-z]+[a-z0-9_]*[!\?]?$/
-        add_error "#{position(node)} - Method name \"#{node[1]}\" should match pattern #{pattern}." unless node[1].to_s =~ pattern
+        pattern = /^[a-z<>=\[\]]+[a-z0-9_<>=\[\]]*[=!\?]?$/
+        add_error "Method name \"#{node[1]}\" should match pattern #{pattern.inspect}" unless node[1].to_s =~ pattern
       end
     end
   end

data/lib/roodi/core/checking_visitor.rb

@@ -14,8 +14,9 @@ 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)} unless checks.nil?
+        checks.each {|check| check.evaluate_node_at_line(node, @last_newline)} unless checks.nil?
         nil
       end
     end

data/lib/roodi/core/iterator_visitor.rb

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

data/lib/roodi/core/parse_tree_runner.rb

@@ -45,6 +45,7 @@ module Roodi
       end
   
       def errors
+        @checks ||= []
         all_errors = @checks.collect {|check| check.errors}
         all_errors.flatten
       end

data/lib/roodi/core/parser.rb

@@ -5,7 +5,7 @@ module Roodi
   module Core
     class Parser
       def parse(content, filename)
-        @parser ||= ParseTree.new
+        @parser ||= ParseTree.new(true)
         node = @parser.parse_tree_for_string(content, filename)
         sexp = VisitableSexp.from_array node
         sexp.filename = filename

data/lib/roodi/core/visitable_sexp.rb

@@ -19,14 +19,6 @@ module Roodi
       def is_language_node?
         first.class == Symbol
       end
-      
-      def filename=(filename)
-        @filename = filename
-      end
-      
-      def filename
-        @filename
-      end
     end
   end
 end

data/roodi.yml

@@ -4,5 +4,6 @@ checks:
 - { name: CyclomaticComplexityMethodCheck, complexity: 5 }
 - { name: EmptyRescueBodyCheck }
 - { name: ForLoopCheck }
+- { name: MethodLineCountCheck }
 - { name: MethodNameCheck }
 

data/spec/checks/class_name_check_spec.rb

@@ -22,6 +22,6 @@ describe Roodi::Checks::ClassNameCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].should eql("dummy-file.rb - Class name \"Bad_ClassName\" should match pattern (?-mix:^[A-Z][a-zA-Z0-9]*$).")
+    errors[0].should eql("dummy-file.rb:1 - Class name \"Bad_ClassName\" should match pattern /^[A-Z][a-zA-Z0-9]*$/")
   end
 end

data/spec/checks/cyclomatic_complexity_block_check_spec.rb

@@ -9,13 +9,13 @@ describe Roodi::Checks::CyclomaticComplexityBlockCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].should eql("dummy-file.rb - Block cyclomatic complexity is #{complexity}.  It should be 0 or less.")
+    errors[0].should eql("dummy-file.rb:2 - Block cyclomatic complexity is #{complexity}.  It should be 0 or less.")
   end
   
   it "should find a simple block" do
     content = <<-END
     def method_name
-      it "should be a complex block" do
+      it "should be a simple block" do
         call_foo
       end
     end

data/spec/checks/cyclomatic_complexity_method_check_spec.rb

@@ -9,7 +9,7 @@ describe Roodi::Checks::CyclomaticComplexityMethodCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].should eql("dummy-file.rb - Method name \"method_name\" has a cyclomatic complexity is #{complexity}.  It should be 0 or less.")
+    errors[0].should eql("dummy-file.rb:1 - Method name \"method_name\" has a cyclomatic complexity is #{complexity}.  It should be 0 or less.")
   end
   
   it "should find an if block" do

data/spec/checks/empty_rescue_body_check_spec.rb

@@ -13,7 +13,6 @@ describe Roodi::Checks::EmptyRescueBodyCheck do
       puts "Recover from the call"
     end
     END
-    # @roodi.print_content(content)
     @roodi.check_content(content)
     @roodi.errors.should be_empty
   end
@@ -37,11 +36,10 @@ describe Roodi::Checks::EmptyRescueBodyCheck do
     rescue
     end
     END
-    # @roodi.print_content(content)
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].should eql("dummy-file.rb - Rescue block should not be empty.")
+    errors[0].should eql("dummy-file.rb:3 - Rescue block should not be empty.")
   end
 
   it "should reject an empty rescue block with a parameter" do
@@ -54,6 +52,6 @@ describe Roodi::Checks::EmptyRescueBodyCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].should eql("dummy-file.rb - Rescue block should not be empty.")
+    errors[0].should eql("dummy-file.rb:3 - Rescue block should not be empty.")
   end
 end

data/spec/checks/for_loop_check_spec.rb

@@ -13,6 +13,6 @@ describe Roodi::Checks::ForLoopCheck do
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].should eql("dummy-file.rb - Don't use 'for' loops. Use Enumerable.each instead.")
+    errors[0].should eql("dummy-file.rb:1 - Don't use 'for' loops. Use Enumerable.each instead.")
   end
 end

data/spec/checks/method_line_count_check_spec.rb

@@ -6,7 +6,6 @@ describe Roodi::Checks::MethodLineCountCheck do
   end
   
   it "should accept methods with less lines than the threshold" do
-    pending "Support from ParseTree for newlines in methods"
     content = <<-END
     def zero_line_method
     end
@@ -16,7 +15,6 @@ describe Roodi::Checks::MethodLineCountCheck do
   end
 
   it "should accept methods with the same number of lines as the threshold" do
-    pending "Support from ParseTree for newlines in methods"
     content = <<-END
     def one_line_method
       1
@@ -27,16 +25,15 @@ describe Roodi::Checks::MethodLineCountCheck do
   end
 
   it "should reject methods with more lines than the threshold" do
-    pending "Support from ParseTree for newlines in methods"
     content = <<-END
     def two_line_method
-      1
-      2
+      puts 1
+      puts 2
     end
     END
     @roodi.check_content(content)
     errors = @roodi.errors
     errors.should_not be_empty
-    errors[0].should eql("dummy-file.rb - Method name \"two_line_method\" has 2 lines.  It should have 1 or less.")
+    errors[0].should eql("dummy-file.rb:1 - Method name \"two_line_method\" has 2 lines.  It should have 1 or less.")
   end
 end

data/spec/checks/method_name_check_spec.rb

@@ -41,6 +41,105 @@ describe Roodi::Checks::MethodNameCheck do
     @roodi.errors.should be_empty
   end
 
+  it "should accept method names ending an equals sign" do
+    content = <<-END
+    def good_method_name=
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept << as a method name" do
+    content = <<-END
+    def <<
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept >> as a method name" do
+    content = <<-END
+    def >>
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept == as a method name" do
+    content = <<-END
+    def ==
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept === as a method name" do
+    content = <<-END
+    def ===
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept < as a method name" do
+    content = <<-END
+    def <
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept <= as a method name" do
+    content = <<-END
+    def <=
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept > as a method name" do
+    content = <<-END
+    def >
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept >= as a method name" do
+    content = <<-END
+    def >=
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept [] as a method name" do
+    content = <<-END
+    def []
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept []= as a method name" do
+    content = <<-END
+    def []=
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
   it "should reject camel case method names" do
     content = <<-END
     def badMethodName
@@ -48,7 +147,7 @@ describe Roodi::Checks::MethodNameCheck do
     END
     @roodi.check_content(content)
     errors = @roodi.errors
-    errors.should_not be_empty
-    errors[0].should eql("dummy-file.rb - Method name \"badMethodName\" should match pattern (?-mix:^[a-z]+[a-z0-9_]*[!\\?]?$).")
+    errors.should_not be_empty    
+    errors[0].should eql("dummy-file.rb:1 - Method name \"badMethodName\" should match pattern /^[a-z<>=\\[\\]]+[a-z0-9_<>=\\[\\]]*[=!\\?]?$/")
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: roodi
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Marty Andrews
@@ -9,9 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-08 00:00:00 +10:00
+date: 2008-09-09 00:00:00 +10:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ParseTree
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -58,7 +68,6 @@ files:
 - lib/roodi/core/parse_tree_runner.rb
 - lib/roodi/core/parser.rb
 - lib/roodi/core/visitable_sexp.rb
-- roodi.gemspec
 - roodi.yml
 - spec/checks/class_name_check_spec.rb
 - spec/checks/cyclomatic_complexity_block_check_spec.rb

data/roodi.gemspec

@@ -1,15 +0,0 @@
-Gem::Specification.new do |s|
-  s.name             = "roodi"
-  s.version          = "0.1.1"
-  s.platform         = "jruby"
-  s.summary          = "Ruby Object Oriented Design Inferometer"
-  s.email            = "marty@martyandrews.net"
-  s.homepage         = "https://github.com/martinjandrews/roodi"
-  s.description      = "Roodi parses your Ruby code and warns you about design issues you have based on the checks that is has configured."
-  s.has_rdoc         = true
-  s.author           = "Marty Andrews"
-  s.files            = ["CHANGELOG", "LICENSE", "README", "Rakefile", "bin/roodi", "bin/roodi-describe", "lib/roodi", "lib/roodi/checks", "lib/roodi/checks/check.rb", "lib/roodi/checks/class_name_check.rb", "lib/roodi/checks/cyclomatic_complexity_block_check.rb", "lib/roodi/checks/cyclomatic_complexity_check.rb", "lib/roodi/checks/cyclomatic_complexity_method_check.rb", "lib/roodi/checks/empty_rescue_body_check.rb", "lib/roodi/checks/for_loop_check.rb", "lib/roodi/checks/method_line_count_check.rb", "lib/roodi/checks/method_name_check.rb", "lib/roodi/checks.rb", "lib/roodi/core", "lib/roodi/core/checking_visitor.rb", "lib/roodi/core/iterator_visitor.rb", "lib/roodi/core/printing_visitor.rb", "lib/roodi/core/runner.rb", "lib/roodi/core/tree_walker.rb", "lib/roodi/core.rb", "lib/roodi/jruby", "lib/roodi/jruby/ast", "lib/roodi/jruby/ast/node.rb", "lib/roodi/jruby/ast/when_node.rb", "lib/roodi/jruby/ast.rb", "lib/roodi/jruby.rb", "lib/roodi.rb", "lib/tasks", "spec/checks", "spec/checks/class_name_check_spec.rb", "spec/checks/cyclomatic_complexity_block_check_spec.rb", "spec/checks/cyclomatic_complexity_method_check_spec.rb", "spec/checks/empty_rescue_body_check_spec.rb", "spec/checks/for_loop_check_spec.rb", "spec/checks/method_line_count_check_spec.rb", "spec/checks/method_name_check_spec.rb", "spec/spec_helper.rb"]
-  # s.test_files       = ["spec/checks", "spec/checks/class_name_check_spec.rb", "spec/checks/cyclomatic_complexity_block_check_spec.rb", "spec/checks/cyclomatic_complexity_method_check_spec.rb", "spec/checks/empty_rescue_body_check_spec.rb", "spec/checks/for_loop_check_spec.rb", "spec/checks/method_line_count_check_spec.rb", "spec/checks/method_name_check_spec.rb", "spec/spec_helper.rb"]
-  s.rdoc_options     = ['--quiet', '--title', 'The Roodi Reference', '--main', 'README', '--inline-source']
-  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README"]
-end