roodi 1.1.0 → 1.1.1

data/History.txt

@@ -1,11 +1,24 @@
-= 1.1.0
+= 1.1.1
+
+* I'd initially published to Rubyforge under a 1.0.0 gem, and I've since tried to retrospectively fix up the version number system.  It turns out that Rubyforge caches old gems permanently, so I have to re-start at a larger number again.
+* class name check no longer gets confused about scoped class names like Module::Classname.
+
+= 0.5
+
+* expanded regex matching for method name check.
+* suppressed noisy output from ParseTree using facets API.
+* updated dependencies and version as a result of facets change.
+* made Roodi tolerant of being asked to parse files which aren't really Ruby files.
+* updated the documentation with usage examples.
+
+= 0.4
 
 * Added support back in for line numbers in error messages.
 * Re-enabled MethodLineCountCheck as part of the default check set.
 
-= 1.0.0
+= 0.3
 
-* First release of Roodi.
+* First version of Roodi to be published to Rubyforge.
 
 = 0.2
 

data/README.txt

@@ -1,11 +1,35 @@
 = roodi
 
-* http://www.rubyforge.org/
+* http://roodi.rubyforge.org
 
 == DESCRIPTION:
 
 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.
 
+== INSTALL:
+
+* sudo gem install roodi
+
+== SYNOPSIS:
+
+To check one or more files using the default configuration that comes with Roodi, use:
+    roodi [patterns]
+
+=== EXAMPLE USAGE
+
+Check all ruby files in a rails app:
+    roodi "rails_app/**/*.rb"
+
+Check one controller and one model file in a rails app:
+    roodi app/controller/sample_controller.rb app/models/sample.rb
+
+Check one controller and all model files in a rails app:
+    roodi app/controller/sample_controller.rb "app/models/*.rb"
+
+
+If you're writing a check, it is useful to see the structure of a file the way that Roodi tokenizes it (via ParesTree). Use:
+    roodi-describe [filename]
+
 == SUPPORTED CHECKS:
 
 * ClassNameCheck - Check that class names match convention.
@@ -16,14 +40,6 @@ Roodi stands for Ruby Object Oriented Design Inferometer.  It parses your Ruby c
 * MethodNameCheck - Check that method names match convention.
 * MethodLineCountCheck - Check that the number of lines in a method is below the threshold.
 
-== SYNOPSIS:
-
-* TBD.  See the Rakefile in this project for an example of how to get started if you're on the bleeding edge.
-
-== INSTALL:
-
-* sudo gem install roodi
-
 == LICENSE:
 
 (The MIT License)

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']
+  p.extra_deps = ['ParseTree', 'facets']
   p.remote_rdoc_dir = ''
 end
 

data/lib/roodi/checks/class_name_check.rb

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

data/lib/roodi/checks/method_name_check.rb

@@ -8,7 +8,7 @@ module Roodi
       end
 
       def evaluate(node)
-        pattern = /^[a-z<>=\[\]]+[a-z0-9_<>=\[\]]*[=!\?]?$/
+        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

data/lib/roodi/core/parse_tree_runner.rb

@@ -19,8 +19,13 @@ module Roodi
       
       def check(filename, content)
         @checks ||= load_checks
-        node = @parser.parse(content, filename)
-        node.accept(IteratorVisitor.new(CheckingVisitor.new(@checks)))
+        begin
+          node = @parser.parse(content, filename)
+          node.accept(IteratorVisitor.new(CheckingVisitor.new(@checks)))
+        rescue Exception => e
+          # puts e
+          puts "#{filename} looks like it's not a valid Ruby file.  Skipping..."
+        end
       end
 
       def check_content(content)

data/lib/roodi/core/parser.rb

@@ -1,10 +1,20 @@
 require 'rubygems'
 require 'parse_tree'
+require 'facets'
+
 
 module Roodi
   module Core
     class Parser
       def parse(content, filename)
+        silence_stream(STDERR) do 
+          return silent_parse(content, filename)
+        end
+      end
+      
+      private
+      
+      def silent_parse(content, filename)
         @parser ||= ParseTree.new(true)
         node = @parser.parse_tree_for_string(content, filename)
         sexp = VisitableSexp.from_array node

data/lib/roodi.rb

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

data/spec/checks/class_name_check_spec.rb

@@ -14,6 +14,18 @@ describe Roodi::Checks::ClassNameCheck do
     @roodi.errors.should be_empty
   end
 
+  it "should be able to parse scoped class names" do
+    content = <<-END
+    class MyScope::GoodClassName 
+      def method
+      end
+    end
+    END
+    # @roodi.print_content(content)
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
   it "should reject class names with underscores" do
     content = <<-END
     class Bad_ClassName 

data/spec/checks/method_name_check_spec.rb

@@ -147,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:1 - Method name \"badMethodName\" should match pattern /^[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.1.0
+  version: 1.1.1
 platform: ruby
 authors: 
 - Marty Andrews
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-09 00:00:00 +10:00
+date: 2008-09-11 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,6 +22,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: facets
+  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
@@ -78,7 +88,7 @@ files:
 - spec/checks/method_name_check_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://www.rubyforge.org/
+homepage: http://roodi.rubyforge.org
 post_install_message: 
 rdoc_options: 
 - --main