threedaymonk-roodi 1.3.8

data/spec/roodi/checks/empty_rescue_body_check_spec.rb

@@ -0,0 +1,114 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::EmptyRescueBodyCheck do
+  before(:each) do
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::EmptyRescueBodyCheck.new)
+  end
+  
+  it "should accept a rescue body with content and no parameter" do
+    content = <<-END
+    begin
+      call_method
+    rescue
+      puts "Recover from the call"
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept a rescue body with a return" do
+    content = <<-END
+    begin
+      call_method
+    rescue
+      return true
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept a method call that Ruby won't tell apart from a variable (a vcall)" do
+    content = <<-END
+    begin
+      call_method
+    rescue
+      show_error
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept a rescue body with content and a parameter" do
+    content = <<-END
+    begin
+      call_method
+    rescue Exception => e
+      puts "Recover from the call"
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept a rescue body with an assignment" do
+    content = <<-END
+    begin
+      call_method
+    rescue Exception => e
+      my_var = 1
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept a rescue body with an attribute assignment" do
+    content = <<-END
+    begin
+      call_method
+    rescue Exception => e
+      self.var = 1
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should reject an empty rescue block with no parameter" do
+    content = <<-END
+    begin
+      call_method
+    rescue
+    end
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.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
+    content = <<-END
+    call_method rescue nil
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should be_empty
+  end
+
+  it "should reject an empty rescue block with a parameter" do
+    content = <<-END
+    begin
+      call_method
+    rescue Exception => e
+    end
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.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

@@ -0,0 +1,18 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::ForLoopCheck do
+  before(:each) do
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::ForLoopCheck.new)
+  end
+  
+  it "should reject for loops" do
+    content = <<-END
+    for i in 1..2
+    end
+    END
+    @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 'for' loops. Use Enumerable.each instead.")
+  end
+end

data/spec/roodi/checks/method_line_count_check_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::MethodLineCountCheck do
+  before(:each) do
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::MethodLineCountCheck.new({'line_count' => 1}))
+  end
+  
+  it "should accept methods with less lines than the threshold" do
+    content = <<-END
+    def zero_line_method
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept methods with the same number of lines as the threshold" do
+    content = <<-END
+    def one_line_method
+      1
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should reject methods with more lines than the threshold" do
+    content = <<-END
+    def two_line_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:1 - Method \"two_line_method\" has 2 lines.  It should have 1 or less.")
+  end
+end

data/spec/roodi/checks/method_name_check_spec.rb

@@ -0,0 +1,76 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::MethodNameCheck do
+  before(:each) do
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::MethodNameCheck.new)
+  end
+  
+  it "should accept method names with underscores" do
+    content = <<-END
+    def good_method_name
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept method names with numbers" do
+    content = <<-END
+    def good_method_1_name
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept method names ending a question mark" do
+    content = <<-END
+    def good_method_name?
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept method names ending an exclamation mark" do
+    content = <<-END
+    def good_method_name!
+    end
+    END
+    @roodi.check_content(content)
+    @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
+
+  describe "when processing non-text based method names" do
+    ['<<', '>>', '==', '=', '<', '<=', '>', '>=', '[]', '[]='].each do |each|
+      it "should accept #{each} as a method name" do
+        content = <<-END
+        def #{each}
+        end
+        END
+        @roodi.check_content(content)
+        @roodi.errors.should be_empty
+      end
+    end
+  end
+
+  it "should reject camel case method names" do
+    content = <<-END
+    def badMethodName
+    end
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].to_s.should eql("dummy-file.rb:1 - Method name \"badMethodName\" should match pattern /^[_a-z<>=\\[|+-\\/\\*`]+[_a-z0-9_<>=~@\\[\\]]*[=!\\?]?$/")
+  end
+end

data/spec/roodi/checks/module_line_count_check_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::ModuleLineCountCheck do
+  before(:each) do
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::ModuleLineCountCheck.new({'line_count' => 1}))
+  end
+  
+  it "should accept modules with less lines than the threshold" do
+    content = <<-END
+    module ZeroLineModule
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept modules with the same number of lines as the threshold" do
+    content = <<-END
+    module OneLineModule
+      @foo = 1
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should reject modules with more lines than the threshold" do
+    content = <<-END
+    module TwoLineModule
+      @foo = 1
+      @bar = 2
+    end
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].to_s.should eql("dummy-file.rb:1 - Module \"TwoLineModule\" has 2 lines.  It should have 1 or less.")
+  end
+end

data/spec/roodi/checks/module_name_check_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::ModuleNameCheck do
+  before(:each) do
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::ModuleNameCheck.new)
+  end
+  
+  it "should accept camel case module names starting in capitals" do
+    content = <<-END
+    module GoodModuleName 
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should reject module names with underscores" do
+    content = <<-END
+    module Bad_ModuleName 
+    end
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].to_s.should eql("dummy-file.rb:1 - Module name \"Bad_ModuleName\" should match pattern /^[A-Z][a-zA-Z0-9]*$/")
+  end
+end

data/spec/roodi/checks/parameter_number_check_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::ParameterNumberCheck do
+  before(:each) do
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::ParameterNumberCheck.new({'parameter_count' => 1}))
+  end
+  
+  it "should accept methods with less lines than the threshold" do
+    content = <<-END
+    def zero_parameter_method
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should accept methods with the same number of parameters as the threshold" do
+    content = <<-END
+    def one_parameter_method(first_parameter)
+    end
+    END
+    @roodi.check_content(content)
+    @roodi.errors.should be_empty
+  end
+
+  it "should reject methods with more parameters than the threshold" do
+    content = <<-END
+    def two_parameter_method(first_parameter, second_parameter)
+    end
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].to_s.should eql("dummy-file.rb:1 - Method name \"two_parameter_method\" has 2 parameters.  It should have 1 or less.")
+  end
+
+  it "should cope with default values on parameters" do
+    content = <<-END
+    def two_parameter_method(first_parameter = 1, second_parameter = 2)
+    end
+    END
+    @roodi.check_content(content)
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].to_s.should eql("dummy-file.rb:1 - Method name \"two_parameter_method\" has 2 parameters.  It should have 1 or less.")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'roodi'
+require 'spec'

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: threedaymonk-roodi
+version: !ruby/object:Gem::Version 
+  version: 1.3.8
+platform: ruby
+authors: 
+- Marty Andrews
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-01 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby_parser
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: marty@cogentconsulting.com.au
+executables: 
+- roodi
+- roodi-describe
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- README.txt
+- roodi.yml
+- bin/roodi
+- bin/roodi-describe
+- spec/roodi
+- spec/roodi/checks
+- spec/roodi/checks/abc_metric_method_check_spec.rb
+- spec/roodi/checks/assignment_in_conditional_check_spec.rb
+- spec/roodi/checks/case_missing_else_check_spec.rb
+- spec/roodi/checks/class_line_count_check_spec.rb
+- spec/roodi/checks/class_name_check_spec.rb
+- spec/roodi/checks/class_variable_check_spec.rb
+- spec/roodi/checks/control_coupling_check_spec.rb
+- spec/roodi/checks/cyclomatic_complexity_block_check_spec.rb
+- spec/roodi/checks/cyclomatic_complexity_method_check_spec.rb
+- spec/roodi/checks/empty_rescue_body_check_spec.rb
+- spec/roodi/checks/for_loop_check_spec.rb
+- spec/roodi/checks/method_line_count_check_spec.rb
+- spec/roodi/checks/method_name_check_spec.rb
+- spec/roodi/checks/module_line_count_check_spec.rb
+- spec/roodi/checks/module_name_check_spec.rb
+- spec/roodi/checks/parameter_number_check_spec.rb
+- spec/spec_helper.rb
+- lib/roodi
+- lib/roodi/checks
+- lib/roodi/checks/abc_metric_method_check.rb
+- lib/roodi/checks/assignment_in_conditional_check.rb
+- lib/roodi/checks/case_missing_else_check.rb
+- lib/roodi/checks/check.rb
+- lib/roodi/checks/class_line_count_check.rb
+- lib/roodi/checks/class_name_check.rb
+- lib/roodi/checks/class_variable_check.rb
+- lib/roodi/checks/control_coupling_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/line_count_check.rb
+- lib/roodi/checks/method_line_count_check.rb
+- lib/roodi/checks/method_name_check.rb
+- lib/roodi/checks/module_line_count_check.rb
+- lib/roodi/checks/module_name_check.rb
+- lib/roodi/checks/name_check.rb
+- lib/roodi/checks/parameter_number_check.rb
+- lib/roodi/checks.rb
+- lib/roodi/core
+- lib/roodi/core/checking_visitor.rb
+- lib/roodi/core/error.rb
+- lib/roodi/core/iterator_visitor.rb
+- lib/roodi/core/parser.rb
+- lib/roodi/core/runner.rb
+- lib/roodi/core/visitable_sexp.rb
+- lib/roodi/core.rb
+- lib/roodi.rb
+- lib/roodi_task.rb
+has_rdoc: true
+homepage: http://github.com/threedaymonk/roodi
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: roodi
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Roodi parses your Ruby code and warns you about design issues you have based on the checks that is has configured.
+test_files: []
+