metric_fu-roodi 2.2.0

data/spec/roodi/checks/method_line_count_check_spec.rb

@@ -0,0 +1,56 @@
+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.make({'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
+
+  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

@@ -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.make)
+  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/missing_foreign_key_index_check_spec.rb

@@ -0,0 +1,33 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::MissingForeignKeyIndexCheck do
+  before(:each) do
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::MissingForeignKeyIndexCheck.make)
+  end
+
+  it "should warn about a missing foreign key" do
+    content = <<-END
+ActiveRecord::Schema.define(:version => 20091215233604) do
+  create_table "projects", :force => true do |t|
+    t.string   "name"
+  end
+
+  create_table "revisions", :force => true do |t|
+    t.integer  "project_id"
+    t.string   "key"
+  end
+
+  add_index "revisions", ["project_id"], :name => "index_revisions_on_project_id"
+
+  create_table "source_files", :force => true do |t|
+    t.integer "revision_id"
+    t.string  "filename"
+  end
+end
+    END
+    @roodi.check_content(content, "schema.rb")
+    errors = @roodi.errors
+    errors.should_not be_empty
+    errors[0].to_s.should eql("schema.rb:1 - Table 'source_files' is missing an index on the foreign key 'revision_id'")
+  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.make({'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.make)
+  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/npath_complexity_method_check_spec.rb

@@ -0,0 +1,53 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Checks::NpathComplexityMethodCheck do
+  before(:each) do
+    @roodi = Roodi::Core::Runner.new(Roodi::Checks::NpathComplexityMethodCheck.make({'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:1 - Method name \"method_name\" n-path complexity is #{complexity}.  It should be 0 or less.")
+  end
+  
+  it "should default to 1" do
+    content = <<-END
+    def method_name
+    end
+    END
+    verify_content_complexity(content, 1)
+  end
+  
+  it "should find an if block" do
+    content = <<-END
+    def method_name
+      call_foo if some_condition
+    end
+    END
+    verify_content_complexity(content, 2)
+  end
+  
+  it "should find nested if block" do
+    pending "NPath Complexity implementation that can support 'else' blocks"
+    content = <<-END
+    def method_name
+      if (value1)
+        foo
+      else
+        bar
+      end
+      if (value2)
+        bam
+      else
+        baz
+      end
+      if (value3)
+        one
+      end
+    end
+    END
+    verify_content_complexity(content, 8)
+  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.make({'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/roodi/core/runner_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Roodi::Core::Runner do
+  
+  describe "given a custom config file" do
+    before do
+      @runner = Roodi::Core::Runner.new
+      @runner.config= File.expand_path(File.dirname(__FILE__) + '/../roodi.yml')
+    end
+    
+    it "uses check from it" do
+      # @runner.check_file(File.expand_path(File.dirname(__FILE__) + '/../fixtures/test_class.rb'))
+      content = <<-RUBY
+        class TestClass
+
+          def METHOD
+
+          end
+        end
+      RUBY
+      @runner.check_content(content)
+      @runner.errors.should be_empty
+    end
+  end
+end

data/spec/roodi/roodi.yml

@@ -0,0 +1,2 @@
+MethodNameCheck:
+  pattern: !ruby/regexp /^[A-Z]+$/

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: metric_fu-roodi
+version: !ruby/object:Gem::Version
+  version: 2.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Marty Andrews
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby_parser
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Roodi stands for Ruby Object Oriented Design Inferometer
+email: marty@cogent.co
+executables:
+- metric_fu-roodi
+- metric_fu-roodi-describe
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/metric_fu-roodi
+- bin/metric_fu-roodi-describe
+- lib/roodi.rb
+- lib/roodi/checks.rb
+- 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/missing_foreign_key_index_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/npath_complexity_check.rb
+- lib/roodi/checks/npath_complexity_method_check.rb
+- lib/roodi/checks/parameter_number_check.rb
+- lib/roodi/core.rb
+- lib/roodi/core/checking_visitor.rb
+- lib/roodi/core/error.rb
+- lib/roodi/core/parser.rb
+- lib/roodi/core/runner.rb
+- lib/roodi/core/visitable_sexp.rb
+- lib/roodi/version.rb
+- lib/roodi_task.rb
+- roodi.gemspec
+- roodi.yml
+- 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/missing_foreign_key_index_check_spec.rb
+- spec/roodi/checks/module_line_count_check_spec.rb
+- spec/roodi/checks/module_name_check_spec.rb
+- spec/roodi/checks/npath_complexity_method_check_spec.rb
+- spec/roodi/checks/parameter_number_check_spec.rb
+- spec/roodi/core/runner_spec.rb
+- spec/roodi/roodi.yml
+- spec/spec_helper.rb
+homepage: http://github.com/metricfu/roodi
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Roodi stands for Ruby Object Oriented Design Inferometer
+test_files:
+- 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/missing_foreign_key_index_check_spec.rb
+- spec/roodi/checks/module_line_count_check_spec.rb
+- spec/roodi/checks/module_name_check_spec.rb
+- spec/roodi/checks/npath_complexity_method_check_spec.rb
+- spec/roodi/checks/parameter_number_check_spec.rb
+- spec/roodi/core/runner_spec.rb
+- spec/roodi/roodi.yml
+- spec/spec_helper.rb