dkubb-yardstick 0.0.1 → 0.1.0

data/spec/public/yardstick_spec.rb

@@ -2,5 +2,69 @@ require 'pathname'
 require Pathname(__FILE__).dirname.expand_path.join('..', 'spec_helper')
 
 describe Yardstick do
-  it 'should be awesome'
+  describe '.measure' do
+    describe 'with no arguments' do
+      before :all do
+        @measurements = Yardstick.measure
+      end
+
+      it_should_behave_like 'measured itself'
+    end
+
+    describe 'with a String path' do
+      before :all do
+        @measurements = Yardstick.measure(Yardstick::ROOT.join('lib', 'yardstick.rb').to_s)
+      end
+
+      it_should_behave_like 'measured itself'
+    end
+
+    describe 'with a Pathname' do
+      before :all do
+        @measurements = Yardstick.measure(Yardstick::ROOT.join('lib', 'yardstick.rb'))
+      end
+
+      it_should_behave_like 'measured itself'
+    end
+
+    describe 'with an Array of String objects' do
+      before :all do
+        @measurements = Yardstick.measure([ Yardstick::ROOT.join('lib', 'yardstick.rb').to_s ])
+      end
+
+      it_should_behave_like 'measured itself'
+    end
+
+    describe 'with an Array of Pathname objects' do
+      before :all do
+        @measurements = Yardstick.measure([ Yardstick::ROOT.join('lib', 'yardstick.rb') ])
+      end
+
+      it_should_behave_like 'measured itself'
+    end
+  end
+
+  describe '.measure_string' do
+    describe 'with a String' do
+      before do
+        @measurements = Yardstick.measure_string('def test; end')
+      end
+
+      it 'should return a MeasurementSet' do
+        @measurements.should be_kind_of(Yardstick::MeasurementSet)
+      end
+
+      it 'should be non-empty' do
+        @measurements.should_not be_empty
+      end
+    end
+
+    describe 'with no arguments' do
+      it 'should raise an exception' do
+        lambda {
+          Yardstick.measure_string
+        }.should raise_error(ArgumentError, 'wrong number of arguments (0 for 1)')
+      end
+    end
+  end
 end

data/spec/rcov.opts

@@ -1,2 +1,6 @@
 --exclude "spec"
 --sort coverage
+--callsites
+--xrefs
+--profile
+--text-summary

data/spec/semipublic/yardstick/rule_spec.rb

@@ -0,0 +1,28 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.join('..', '..', 'spec_helper')
+
+describe Yardstick::Rule do
+  describe '#eql?' do
+    describe 'when rules are equal' do
+      before do
+        @rule  = Yardstick::Rule.new('test rule') { true }
+        @other = Yardstick::Rule.new('test rule') { true }
+      end
+
+      it 'should return true' do
+        @rule.eql?(@other).should be_true
+      end
+    end
+
+    describe 'when rules are not equal' do
+      before do
+        @rule  = Yardstick::Rule.new('test rule')  { true }
+        @other = Yardstick::Rule.new('other rule') { true }
+      end
+
+      it 'should return false' do
+        @rule.eql?(@other).should be_false
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,13 +1,51 @@
-require 'rubygems'
-require 'spec'
 require 'pathname'
+require 'rubygems'
+require 'spec/autorun'
 
-dir = Pathname(__FILE__).dirname.expand_path
-
-$LOAD_PATH.unshift(dir)
-$LOAD_PATH.unshift(dir.parent + 'lib')
+require Pathname(__FILE__).dirname.expand_path.join('..', 'lib', 'yardstick')
 
-require 'yardstick'
+Pathname.glob(Yardstick::ROOT.join('lib', '**', '*.rb').to_s).sort.each do |file|
+  require file.to_s.chomp('.rb')
+end
 
 Spec::Runner.configure do |config|
+  config.before :all do
+    YARD::Registry.clear
+  end
+
+  config.before do
+    YARD::Registry.clear
+  end
+
+  def capture_stdout
+    $stdout = StringIO.new
+    yield
+  ensure
+    $stdout.rewind
+    @output = $stdout.read
+    $stdout = STDOUT
+  end
+
+  def capture_stderr
+    $stderr = StringIO.new
+    yield
+  ensure
+    $stderr.rewind
+    @output = $stderr.read
+    $stderr = STDERR
+  end
+end
+
+shared_examples_for 'measured itself' do
+  it 'should return a MeasurementSet' do
+    @measurements.should be_kind_of(Yardstick::MeasurementSet)
+  end
+
+  it 'should be non-empty' do
+    @measurements.should_not be_empty
+  end
+
+  it 'should all be correct' do
+    @measurements.each { |measurement| measurement.should be_ok }
+  end
 end

data/tasks/ci.rake

@@ -0,0 +1 @@
+task :ci => [ :heckle, 'metrics:all' ]

data/tasks/heckle.rake

@@ -0,0 +1,52 @@
+# original code by Ashley Moran:
+# http://aviewfromafar.net/2007/11/1/rake-task-for-heckling-your-specs
+desc 'Heckle each module and class'
+task :heckle => :verify_rcov do
+  root_module = 'Yardstick'
+  spec_files  = FileList['spec/**/*_spec.rb']
+
+  current_module = nil
+  current_method = nil
+
+  heckle_caught_modules = Hash.new { |hash, key| hash[key] = [] }
+  unhandled_mutations = 0
+
+  IO.popen("spec --heckle #{root_module} #{spec_files} 2>/dev/null") do |pipe|
+    while line = pipe.gets
+      case line = line.chomp
+        when /\A\*\*\*\s+(#{root_module}(?:::)?(?:\w+(?:::)?)*)#(\S+)/
+          current_module, current_method = $1, $2
+        when "The following mutations didn't cause test failures:"
+          heckle_caught_modules[current_module] << current_method
+        when '+++ mutation'
+          unhandled_mutations += 1
+      end
+
+      puts line
+    end
+  end
+
+  if unhandled_mutations > 0
+    error_message_lines = [ "*************\n" ]
+
+    error_message_lines << "Heckle found #{unhandled_mutations} " \
+      "mutation#{"s" unless unhandled_mutations == 1} " \
+      "that didn't cause spec violations\n"
+
+    heckle_caught_modules.each do |mod, methods|
+      error_message_lines << "#{mod} contains the following " \
+        'poorly-specified methods:'
+      methods.each do |method|
+        error_message_lines << " - #{method}"
+      end
+      error_message_lines << ''
+    end
+
+    error_message_lines << 'Get your act together and come back ' \
+      'when your specs are doing their job!'
+
+    raise error_message_lines.join("\n")
+  else
+    puts 'Well done! Your code withstood a heckling.'
+  end
+end

data/tasks/metrics.rake

@@ -1 +1,5 @@
-require 'metric_fu'
+begin
+  require 'metric_fu'
+rescue LoadError
+  # do nothing
+end

data/tasks/spec.rake

@@ -11,65 +11,12 @@ Spec::Rake::SpecTask.new(:spec, &spec_defaults)
 
 Spec::Rake::SpecTask.new(:rcov) do |rcov|
   spec_defaults.call(rcov)
-  rcov.rcov       = true
-  rcov.rcov_opts << File.readlines('spec/rcov.opts').map { |line| line.strip }
+  rcov.rcov      = true
+  rcov.rcov_opts = File.read('spec/rcov.opts').split(/\s+/)
 end
 
 RCov::VerifyTask.new(:verify_rcov => :rcov) do |rcov|
-  rcov.threshold = 94.73
-end
-
-# original code by Ashley Moran:
-# http://aviewfromafar.net/2007/11/1/rake-task-for-heckling-your-specs
-desc 'Heckle each module and class'
-task :heckle => :verify_rcov do
-  root_module = 'Yardstick'
-  spec_files  = FileList['spec/**/*_spec.rb']
-
-  current_module = nil
-  current_method = nil
-
-  heckle_caught_modules = Hash.new { |hash, key| hash[key] = [] }
-  unhandled_mutations = 0
-
-  IO.popen("spec --heckle #{root_module} #{spec_files}") do |pipe|
-    while line = pipe.gets
-      case line = line.chomp
-        when /\A\*\*\*\s+(#{root_module}(?:::)?(?:\w+(?:::)?)*)#(\w+)\b/
-          current_module, current_method = $1, $2
-        when "The following mutations didn't cause test failures:"
-          heckle_caught_modules[current_module] << current_method
-        when '+++ mutation'
-          unhandled_mutations += 1
-      end
-
-      puts line
-    end
-  end
-
-  if unhandled_mutations > 0
-    error_message_lines = [ "*************\n" ]
-
-    error_message_lines << "Heckle found #{unhandled_mutations} " \
-      "mutation#{"s" unless unhandled_mutations == 1} " \
-      "that didn't cause spec violations\n"
-
-    heckle_caught_modules.each do |mod, methods|
-      error_message_lines << "#{mod} contains the following " \
-        'poorly-specified methods:'
-      methods.each do |method|
-        error_message_lines << " - #{method}"
-      end
-      error_message_lines << ''
-    end
-
-    error_message_lines << 'Get your act together and come back ' \
-      'when your specs are doing their job!'
-
-    raise error_message_lines.join("\n")
-  else
-    puts 'Well done! Your code withstood a heckling.'
-  end
+  rcov.threshold = 100
 end
 
 task :default => :spec

data/yardstick.gemspec

@@ -0,0 +1,82 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{yardstick}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dan Kubb"]
+  s.date = %q{2009-07-25}
+  s.default_executable = %q{yardstick}
+  s.email = %q{dan.kubb@gmail.com}
+  s.executables = ["yardstick"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "bin/yardstick",
+     "lib/yardstick.rb",
+     "lib/yardstick/autoload.rb",
+     "lib/yardstick/cli.rb",
+     "lib/yardstick/core_ext/object.rb",
+     "lib/yardstick/measurable.rb",
+     "lib/yardstick/measurement.rb",
+     "lib/yardstick/measurement_set.rb",
+     "lib/yardstick/method.rb",
+     "lib/yardstick/ordered_set.rb",
+     "lib/yardstick/processor.rb",
+     "lib/yardstick/rule.rb",
+     "lib/yardstick/rule_set.rb",
+     "lib/yardstick/yard_ext.rb",
+     "spec/public/yardstick/cli_spec.rb",
+     "spec/public/yardstick/measurement_set_spec.rb",
+     "spec/public/yardstick/measurement_spec.rb",
+     "spec/public/yardstick/method_spec.rb",
+     "spec/public/yardstick_spec.rb",
+     "spec/rcov.opts",
+     "spec/semipublic/yardstick/rule_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "tasks/ci.rake",
+     "tasks/heckle.rake",
+     "tasks/metrics.rake",
+     "tasks/rdoc.rake",
+     "tasks/spec.rake",
+     "yardstick.gemspec"
+  ]
+  s.homepage = %q{http://github.com/dkubb/yardstick}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{yardstick}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A tool for verifying YARD documentation coverage}
+  s.test_files = [
+    "spec/public/yardstick/cli_spec.rb",
+     "spec/public/yardstick/measurement_set_spec.rb",
+     "spec/public/yardstick/measurement_spec.rb",
+     "spec/public/yardstick/method_spec.rb",
+     "spec/public/yardstick_spec.rb",
+     "spec/semipublic/yardstick/rule_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<yard>, ["~> 0.2"])
+    else
+      s.add_dependency(%q<yard>, ["~> 0.2"])
+    end
+  else
+    s.add_dependency(%q<yard>, ["~> 0.2"])
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dkubb-yardstick
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Dan Kubb
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-22 00:00:00 -07:00
+date: 2009-07-25 00:00:00 -07:00
 default_executable: yardstick
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,12 +30,12 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.markdown
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
 - bin/yardstick
@@ -45,18 +45,28 @@ files:
 - lib/yardstick/core_ext/object.rb
 - lib/yardstick/measurable.rb
 - lib/yardstick/measurement.rb
+- lib/yardstick/measurement_set.rb
 - lib/yardstick/method.rb
+- lib/yardstick/ordered_set.rb
 - lib/yardstick/processor.rb
+- lib/yardstick/rule.rb
+- lib/yardstick/rule_set.rb
 - lib/yardstick/yard_ext.rb
+- spec/public/yardstick/cli_spec.rb
+- spec/public/yardstick/measurement_set_spec.rb
 - spec/public/yardstick/measurement_spec.rb
 - spec/public/yardstick/method_spec.rb
 - spec/public/yardstick_spec.rb
 - spec/rcov.opts
+- spec/semipublic/yardstick/rule_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- tasks/ci.rake
+- tasks/heckle.rake
 - tasks/metrics.rake
 - tasks/rdoc.rake
 - tasks/spec.rake
+- yardstick.gemspec
 has_rdoc: false
 homepage: http://github.com/dkubb/yardstick
 post_install_message: 
@@ -84,7 +94,10 @@ signing_key:
 specification_version: 3
 summary: A tool for verifying YARD documentation coverage
 test_files: 
+- spec/public/yardstick/cli_spec.rb
+- spec/public/yardstick/measurement_set_spec.rb
 - spec/public/yardstick/measurement_spec.rb
 - spec/public/yardstick/method_spec.rb
 - spec/public/yardstick_spec.rb
+- spec/semipublic/yardstick/rule_spec.rb
 - spec/spec_helper.rb