yardstick 0.1.0

data/spec/public/yardstick/rake/measurement_spec.rb

@@ -0,0 +1,173 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.join('..', '..', '..', 'spec_helper')
+
+shared_examples_for 'set default name for measurement task' do
+  it 'should set name to :yardstick_measure' do
+    @task.instance_variable_get(:@name).should == :yardstick_measure
+  end
+end
+
+shared_examples_for 'set default path for measurement task' do
+  path = 'lib/**/*.rb'
+
+  it "should set path to #{path.inspect}" do
+    @task.instance_variable_get(:@path).should == path
+  end
+end
+
+shared_examples_for 'set default output for measurement task' do
+  it 'should set output to "measurements/report.txt"' do
+    @task.instance_variable_get(:@output).should == @output
+  end
+end
+
+shared_examples_for 'report writer' do
+  it 'should write the report' do
+    @task.path = 'lib/yardstick.rb'  # speed up execution
+    execute_action
+    @output.read.should == "\nCoverage: 100.0%  Success: 20  Failed: 0  Total: 20\n"
+  end
+end
+
+describe Yardstick::Rake::Measurement do
+  before do
+    @output = Pathname('measurements/report.txt')
+    @output.dirname.rmtree if @output.dirname.exist?
+  end
+
+  describe '.new' do
+    describe 'with no arguments' do
+      before do
+        @task = Yardstick::Rake::Measurement.new
+      end
+
+      it 'should initialize a Measurement instance' do
+        @task.should be_kind_of(Yardstick::Rake::Measurement)
+      end
+
+      it_should_behave_like 'set default name for measurement task'
+      it_should_behave_like 'set default path for measurement task'
+      it_should_behave_like 'set default output for measurement task'
+
+      it 'should create a task named yardstick_measure' do
+        Rake::Task['yardstick_measure'].should be_kind_of(Rake::Task)
+      end
+
+      it 'should include the path in the task name' do
+        Rake::Task['yardstick_measure'].comment.should == 'Measure docs in lib/**/*.rb with yardstick'
+      end
+
+      def execute_action
+        Rake::Task['yardstick_measure'].execute
+      end
+
+      it_should_behave_like 'report writer'
+    end
+
+    describe 'with name provided' do
+      before do
+        @task = Yardstick::Rake::Measurement.new(:custom_task_name)
+      end
+
+      it 'should initialize a Measurement instance' do
+        @task.should be_kind_of(Yardstick::Rake::Measurement)
+      end
+
+      it 'should set name to :custom_task_name' do
+        @task.instance_variable_get(:@name).should == :custom_task_name
+      end
+
+      it_should_behave_like 'set default path for measurement task'
+      it_should_behave_like 'set default output for measurement task'
+
+      it 'should create a task named custom_task_name' do
+        Rake::Task['custom_task_name'].should be_kind_of(Rake::Task)
+      end
+
+      it 'should include the path in the task name' do
+        Rake::Task['custom_task_name'].comment.should == 'Measure docs in lib/**/*.rb with yardstick'
+      end
+
+      def execute_action
+        Rake::Task['custom_task_name'].execute
+      end
+
+      it_should_behave_like 'report writer'
+    end
+
+    describe 'with block provided' do
+      before do
+        @task = Yardstick::Rake::Measurement.new do |*args|
+          @yield = args
+        end
+      end
+
+      it 'should initialize a Measurement instance' do
+        @task.should be_kind_of(Yardstick::Rake::Measurement)
+      end
+
+      it_should_behave_like 'set default name for measurement task'
+      it_should_behave_like 'set default path for measurement task'
+      it_should_behave_like 'set default output for measurement task'
+
+      it 'should yield to self' do
+        @yield.should == [ @task ]
+        @yield.first.should equal(@task)
+      end
+
+      it 'should create a task named yardstick_measure' do
+        Rake::Task['yardstick_measure'].should be_kind_of(Rake::Task)
+      end
+
+      it 'should include the path in the task name' do
+        Rake::Task['yardstick_measure'].comment.should == 'Measure docs in lib/**/*.rb with yardstick'
+      end
+
+      def execute_action
+        Rake::Task['yardstick_measure'].execute
+      end
+
+      it_should_behave_like 'report writer'
+    end
+  end
+
+  describe '#path=' do
+    before do
+      @path = 'lib/yardstick.rb'
+
+      @task = Yardstick::Rake::Measurement.new do |measurement|
+        measurement.path = @path
+      end
+    end
+
+    it 'should set path' do
+      @task.instance_variable_get(:@path).should equal(@path)
+    end
+  end
+
+  describe '#output=' do
+    before do
+      @task = Yardstick::Rake::Measurement.new do |measurement|
+        measurement.output = @output
+      end
+    end
+
+    it 'should set output' do
+      @task.instance_variable_get(:@output).should eql(@output)
+    end
+  end
+
+  describe '#yardstick_measure' do
+    before do
+      @task = Yardstick::Rake::Measurement.new do |task|
+        task.output = @output
+      end
+    end
+
+    def execute_action
+      @task.yardstick_measure
+    end
+
+    it_should_behave_like 'report writer'
+  end
+end

data/spec/public/yardstick/rake/verify_spec.rb

@@ -0,0 +1,229 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.join('..', '..', '..', 'spec_helper')
+
+shared_examples_for 'set default name for verify task' do
+  it 'should set name to :verify_measurements' do
+    @task.instance_variable_get(:@name).should == :verify_measurements
+  end
+end
+
+shared_examples_for 'set default require_exact_threshold for verify task' do
+  it 'should set require_exact_threshold to true' do
+    @task.instance_variable_get(:@require_exact_threshold).should be_true
+  end
+end
+
+shared_examples_for 'set default path for verify task' do
+  path = 'lib/**/*.rb'
+
+  it "should set path to #{path.inspect}" do
+    @task.instance_variable_get(:@path).should == path
+  end
+end
+
+shared_examples_for 'set default verbose for verify task' do
+  it 'should set verbose to true' do
+    @task.instance_variable_get(:@verbose).should be_true
+  end
+end
+
+describe Yardstick::Rake::Verify do
+  describe '.new' do
+    describe 'with no arguments' do
+      before do
+        @task = Yardstick::Rake::Verify.new do |verify|
+          verify.threshold = 100
+        end
+      end
+
+      it 'should initialize a Verify instance' do
+        @task.should be_kind_of(Yardstick::Rake::Verify)
+      end
+
+      it_should_behave_like 'set default name for verify task'
+      it_should_behave_like 'set default require_exact_threshold for verify task'
+      it_should_behave_like 'set default path for verify task'
+      it_should_behave_like 'set default verbose for verify task'
+
+      it 'should create a task named verify_measurements' do
+        Rake::Task['verify_measurements'].should be_kind_of(Rake::Task)
+      end
+
+      it 'should include the threshold in the task name' do
+        Rake::Task['verify_measurements'].comment.should == 'Verify that yardstick coverage is at least 100%'
+      end
+
+      it 'should display coverage summary when executed' do
+        @task.path = 'lib/yardstick.rb'  # speed up execution
+
+        capture_stdout { Rake::Task['verify_measurements'].execute }
+
+        @output.should == "Coverage: 100.0% (threshold: 100%)\n"
+      end
+    end
+
+    describe 'with name provided' do
+      before do
+        @task = Yardstick::Rake::Verify.new(:custom_task_name) do |verify|
+          verify.threshold = 100
+        end
+      end
+
+      it 'should initialize a Verify instance' do
+        @task.should be_kind_of(Yardstick::Rake::Verify)
+      end
+
+      it 'should set name to :custom_task_name' do
+        @task.instance_variable_get(:@name).should == :custom_task_name
+      end
+
+      it_should_behave_like 'set default require_exact_threshold for verify task'
+      it_should_behave_like 'set default path for verify task'
+      it_should_behave_like 'set default verbose for verify task'
+
+      it 'should create a task named custom_task_name' do
+        Rake::Task['custom_task_name'].should be_kind_of(Rake::Task)
+      end
+
+      it 'should include the threshold in the task name' do
+        Rake::Task['custom_task_name'].comment.should == 'Verify that yardstick coverage is at least 100%'
+      end
+
+      it 'should display coverage summary when executed' do
+        @task.path = 'lib/yardstick.rb'  # speed up execution
+
+        capture_stdout { Rake::Task['custom_task_name'].execute }
+
+        @output.should == "Coverage: 100.0% (threshold: 100%)\n"
+      end
+    end
+
+    describe 'with threshold not provided' do
+      it 'should raise an exception' do
+        lambda {
+          Yardstick::Rake::Verify.new {}
+        }.should raise_error(RuntimeError, 'threshold must be set')
+      end
+    end
+
+    describe 'with no block provided' do
+      it 'should raise an exception' do
+        lambda {
+          Yardstick::Rake::Verify.new
+        }.should raise_error(LocalJumpError)
+      end
+    end
+  end
+
+  describe '#threshold=' do
+    before do
+      @task = Yardstick::Rake::Verify.new do |verify|
+        verify.threshold = 100
+      end
+    end
+
+    it 'should set threshold' do
+      @task.instance_variable_get(:@threshold).should == 100
+    end
+  end
+
+  describe '#require_exact_threshold=' do
+    before do
+      @task = Yardstick::Rake::Verify.new do |verify|
+        verify.threshold               = 100
+        verify.require_exact_threshold = false
+      end
+    end
+
+    it 'should set require_exact_threshold' do
+      @task.instance_variable_get(:@require_exact_threshold).should == false
+    end
+  end
+
+  describe '#path=' do
+    before do
+      @path = 'lib/yardstick.rb'
+
+      @task = Yardstick::Rake::Verify.new do |verify|
+        verify.threshold = 100
+        verify.path      = @path
+      end
+    end
+
+    it 'should set path' do
+      @task.instance_variable_get(:@path).should equal(@path)
+    end
+  end
+
+  describe '#verbose=' do
+    before do
+      @task = Yardstick::Rake::Verify.new do |verify|
+        verify.threshold = 100
+        verify.verbose   = false
+      end
+    end
+
+    it 'should set verbose' do
+      @task.instance_variable_get(:@verbose).should be_false
+    end
+  end
+
+  describe '#verify_measurements' do
+    describe 'with threshold met' do
+      before do
+        @task = Yardstick::Rake::Verify.new do |verify|
+          verify.threshold = 100
+          verify.path      = 'lib/yardstick.rb'
+        end
+
+        capture_stdout do
+          @task.verify_measurements
+        end
+      end
+
+      it 'should output coverage summary' do
+        @output.should == "Coverage: 100.0% (threshold: 100%)\n"
+      end
+    end
+
+    describe 'with threshold not met' do
+      before do
+        @task = Yardstick::Rake::Verify.new do |verify|
+          verify.threshold = 0.1
+          verify.path      = 'spec/spec_helper.rb'
+        end
+      end
+
+      it 'should raise an exception' do
+        lambda {
+          capture_stdout do
+            @task.verify_measurements
+          end
+        }.should raise_error(RuntimeError, 'Coverage must be at least 0.1% but was 0.0%')
+
+        # check the stdout output
+        @output.should == "Coverage: 0.0% (threshold: 0.1%)\n"
+      end
+    end
+
+    describe 'with threshold met, but not equal to coverage' do
+      before do
+        @task = Yardstick::Rake::Verify.new do |verify|
+          verify.threshold = 99.9
+          verify.path      = 'lib/yardstick.rb'
+        end
+      end
+
+      it 'should raise an exception' do
+        lambda {
+          capture_stdout do
+            @task.verify_measurements
+          end
+        }.should raise_error(RuntimeError, 'Coverage has increased above the threshold of 99.9% to 100.0%. You should update your threshold value.')
+
+        # check the stdout output
+        @output.should == "Coverage: 100.0% (threshold: 99.9%)\n"
+      end
+    end
+  end
+end

data/spec/public/yardstick_spec.rb

@@ -0,0 +1,70 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.join('..', 'spec_helper')
+
+describe Yardstick do
+  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)
+      end
+    end
+  end
+end

data/spec/rcov.opts

@@ -0,0 +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.opts

@@ -0,0 +1,4 @@
+--color
+--loadby random
+--format profile
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+require 'pathname'
+require 'rubygems'
+require 'spec/autorun'
+
+require Pathname(__FILE__).dirname.expand_path.join('..', 'lib', '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|
+  clear_tasks = lambda { Rake::Task.clear }
+
+  config.before(:all, &clear_tasks)
+  config.before(      &clear_tasks)
+
+  clear_yard_registry = lambda { YARD::Registry.clear }
+
+  config.before(:all, &clear_yard_registry)
+  config.before(      &clear_yard_registry)
+
+
+  def capture_stdout
+    $stdout = StringIO.new
+    yield
+  ensure
+    $stdout.rewind
+    @output = $stdout.read
+    $stdout = STDOUT
+  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 => [ :verify_measurements, :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

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

data/tasks/rdoc.rake

@@ -0,0 +1,15 @@
+require 'rake/rdoctask'
+
+Rake::RDocTask.new do |rdoc|
+  version = if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    ''
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "yardstick #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/tasks/spec.rake

@@ -0,0 +1,22 @@
+require 'spec/rake/spectask'
+require 'spec/rake/verify_rcov'
+
+spec_defaults = lambda do |spec|
+  spec.pattern    = 'spec/**/*_spec.rb'
+  spec.libs      << 'lib' << 'spec'
+  spec.spec_opts << '--options' << 'spec/spec.opts'
+end
+
+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.read('spec/rcov.opts').split(/\s+/)
+end
+
+RCov::VerifyTask.new(:verify_rcov => :rcov) do |rcov|
+  rcov.threshold = 100
+end
+
+task :default => :spec

data/tasks/yardstick.rake

@@ -0,0 +1,9 @@
+require Pathname(__FILE__).dirname.expand_path.join('..', 'lib', 'yardstick')
+
+# yardstick_measure task
+Yardstick::Rake::Measurement.new
+
+# verify_measurements task
+Yardstick::Rake::Verify.new do |verify|
+  verify.threshold = 100
+end