dcov 0.1.0

data/spec/dcov_spec.rb

@@ -0,0 +1,101 @@
+# TODO: Make these platform independent (they're UNIX only right now)
+
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require File.dirname(__FILE__) + '/../lib/dcov.rb'
+
+describe "A new Dcov::Coverage object" do
+  before(:each) do
+    @myopts = OptionsMock.new
+  end
+  
+  before(:all) do
+    @myopts = OptionsMock.new
+    
+    @analyzer = Dcov::Analyzer.new(@myopts)
+  end
+  
+  it "should be of class Dcov::Coverage." do
+    @analyzer.class.should == Dcov::Analyzer
+  end
+  
+  it "should have the given hierarchy in an attribute." do
+    puts @analyzer.hierarchy
+  end
+  
+  it "should give correct coverage information on classes." do
+    @analyzer.stats.coverage_rating(:class).should == 20
+  end
+  
+  it "should give correct coverage information on modules." do
+    @analyzer.stats.coverage_rating(:module).should == 33
+  end
+  
+  it "should give correct coverage information on methods." do
+    @analyzer.stats.coverage_rating(:method).should == 50
+  end
+  
+  it "should properly process a class." do
+    @myopts[:files] = 'spec/just_a_class.rb'
+    coverage_is_zero = Dcov::Analyzer.new(@myopts)
+    
+    coverage_is_zero.stats.coverage_rating(:class).should == 50
+  end
+  
+  it "should properly process a module." do
+    @myopts[:files] = 'spec/just_a_module.rb'
+    coverage_is_zero = Dcov::Analyzer.new(@myopts)
+    
+    coverage_is_zero.stats.coverage_rating(:module).should == 50
+  end
+  
+  it "should properly process a method." do
+    @myopts[:files] = 'spec/just_a_method.rb'
+    coverage_is_zero = Dcov::Analyzer.new(@myopts)
+    
+    coverage_is_zero.stats.coverage_rating(:method).should == 50
+  end
+  
+  it "should generate HTML." do
+    File.exists?('coverage.html').should == true
+  end
+  
+  it "should go through the whole process without breaking!" do
+    lambda { Dcov::Analyzer.new(@myopts) }.should_not raise_error(Exception)
+  end
+  
+  it "should give an exception if no files are given." do
+    @myopts[:files] = ''
+    lambda { Dcov::Analyzer.new(@myopts) }.should raise_error(RuntimeError)
+    
+    @myopts[:files] = nil
+    lambda { Dcov::Analyzer.new(@myopts) }.should raise_error(RuntimeError)
+  end
+  
+  it "should raise an exception if told to process the wrong object." do
+    # TODO: make a mock object
+  end
+  
+  it "should raise a (sane, readable) exception if the HTML file isn't writable." do
+    `touch coverage.html; chmod 000 coverage.html`
+    lambda { Dcov::Analyzer.new(@myopts) }.should raise_error(RuntimeError)
+    `chmod 744 coverage.html`
+  end
+  
+  it "should still analyze if the structure is invalid." do
+    # TODO: Make a mock structure
+  end
+  
+  it "should return zero for coverage if the structure is empty." do
+    @myopts[:files] = 'spec/blank_code.rb'
+    coverage_is_zero = Dcov::Analyzer.new(@myopts)
+    
+    coverage_is_zero.stats.coverage_rating(:class).should == 0
+    coverage_is_zero.stats.coverage_rating(:module).should == 0
+    coverage_is_zero.stats.coverage_rating(:method).should == 0
+  end
+  
+  after(:all) do
+    `chmod 744 coverage.html; rm coverage.html`
+  end
+  
+end

data/spec/just_a_class.rb

@@ -0,0 +1,6 @@
+class Undocumented
+end
+
+# I am documented.
+class Documented
+end

data/spec/just_a_method.rb

@@ -0,0 +1,7 @@
+class CoverMe
+  def undocumented
+  end
+  
+  # I am documented.
+  def documented
+  end

data/spec/just_a_module.rb

@@ -0,0 +1,6 @@
+module Undocumented
+end
+
+# I am documented.
+module Documented
+end

data/spec/mock_code.rb

@@ -0,0 +1,35 @@
+# Hello.
+class Paragraph
+  class Sentence
+  end
+  
+  # Hey, hi!
+  def initialize
+  end
+end
+
+module Document
+  module HTML
+    class HTMLElement
+      
+    end
+  end
+  
+  class Element
+    def initialize
+    end
+    
+    def parse
+    end
+    
+    # The main method
+    def elementize
+    end
+  end
+end
+
+# Module to hold all our math functions
+module Math
+  class Sin
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+class OptionsMock < Hash  
+  def initialize
+    self[:files] = "spec/mock_code.rb"
+    self[:output_format] = "html"
+    self[:path] = Dir.getwd
+  end
+  
+  def method_missing(*args)
+    false
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: dcov
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2007-07-07 00:00:00 -04:00
+summary: A documentation analysis tool for Ruby.
+require_paths: 
+- lib
+email: jeremymcanally@gmail.com
+homepage: http://dcov.rubyforge.org
+rubyforge_project: dcov
+description: A documentation analysis tool for Ruby.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Jeremy McAnally
+files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/dcov
+- lib/dcov.rb
+- lib/dcov/analyzer.rb
+- lib/dcov/version.rb
+- lib/dcov/stats.rb
+- lib/dcov/analyzed_token.rb
+- lib/dcov/generators/html/generator.rb
+- lib/dcov/analyzers/coverage_analyzer.rb
+- setup.rb
+- spec/dcov_spec.rb
+- spec/spec_helper.rb
+- spec/blank_code.rb
+- spec/just_a_class.rb
+- spec/just_a_method.rb
+- spec/just_a_module.rb
+- spec/mock_code.rb
+test_files: []
+
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
+executables: 
+- dcov
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruport
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.1
+    version: