yardstick 0.9.6 → 0.9.7

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

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require 'yardstick/rake/measurement'
+
+describe Yardstick::Rake::Measurement do
+  let(:output) { Pathname('measurements/report.txt') }
+
+  before do
+    output.dirname.rmtree if output.dirname.exist?
+
+    Yardstick::Rake::Measurement.new do |config|
+      config.path = 'lib/yardstick.rb'
+    end
+  end
+
+  it 'should write the report' do
+    Rake::Task['yardstick_measure'].execute
+    expect(output.read)
+      .to eql("\nYARD-Coverage: 100.0%  Success: 30  Failed: 0  Total: 30\n")
+  end
+end

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

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require 'yardstick/rake/verify'
+
+describe Yardstick::Rake::Verify do
+  before do
+    Yardstick::Rake::Verify.new do |verify|
+      verify.threshold = 100
+      verify.path = 'lib/yardstick.rb'
+    end
+  end
+
+  it 'should display coverage summary when executed' do
+    capture_stdout { Rake::Task['verify_measurements'].execute }
+
+    expect(@output).to eql("YARD-Coverage: 100.0% (threshold: 100%)\n")
+  end
+end

data/spec/shared/measured_itself_behavior.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+shared_examples_for 'measured itself' do
+  it 'should return a MeasurementSet' do
+    expect(@measurements).to be_kind_of(Yardstick::MeasurementSet)
+  end
+
+  it 'should be non-empty' do
+    expect(@measurements).to_not be_empty
+  end
+
+  it 'should all be correct' do
+    @measurements.each { |measurement| expect(measurement).to be_ok }
+  end
+end

data/spec/spec_helper.rb

@@ -10,32 +10,33 @@ if ENV['COVERAGE'] == 'true'
   ]
 
   SimpleCov.start do
-    command_name     'spec:unit'
-    add_filter       'config'
-    add_filter       'spec'
+    command_name 'spec:unit'
+
+    add_filter 'config'
+    add_filter 'spec'
+    add_filter 'vendor'
+
     minimum_coverage 100
   end
 end
 
 require 'yardstick'
-require 'spec'
-require 'spec/autorun' if RUBY_VERSION < '1.9'
+require 'devtools/spec_helper'
 
-# require spec support files and shared behavior
-Dir[File.expand_path('../{support,shared}/**/*.rb', __FILE__)].each do |file|
-  require file
-end
+RSpec.configure do |config|
+  config.expect_with :rspec do |expect_with|
+    expect_with.syntax = :expect
+  end
 
-Spec::Runner.configure do |config|
   clear_tasks = proc { Rake::Task.clear }
 
   config.before(:all, &clear_tasks)
-  config.before(      &clear_tasks)
+  config.before(&clear_tasks)
 
   clear_yard_registry = proc { YARD::Registry.clear }
 
   config.before(:all, &clear_yard_registry)
-  config.before(      &clear_yard_registry)
+  config.before(&clear_yard_registry)
 
   def capture_stdout
     $stdout = StringIO.new
@@ -46,17 +47,3 @@ Spec::Runner.configure do |config|
     $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/spec/support/document_mock.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+# Mock Document object
+class DocumentMock
+  def path
+    'Foo#bar'
+  end
+
+  def file
+    '(stdin)'
+  end
+
+  def line
+    2
+  end
+end

data/spec/support/rules.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+class ValidRule
+  class << self
+    attr_accessor :description
+  end
+
+  attr_reader :document
+
+  def initialize(document, *)
+    @document = document
+  end
+
+  self.description = 'successful'
+
+  def enabled?
+    true
+  end
+
+  def valid?
+    true
+  end
+
+  def validatable?
+    true
+  end
+end
+
+class NotValidatableRule < ValidRule
+  self.description = 'skipped'
+
+  def validatable?
+    false
+  end
+end
+
+class InvalidRule < ValidRule
+  self.description = 'not successful'
+
+  def valid?
+    false
+  end
+end
+
+class DisabledRule < ValidRule
+  self.description = 'not enabled'
+
+  def enabled?
+    false
+  end
+end

data/spec/unit/yardstick/class_methods/measure_spec.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick, '.measure' do
+  context 'when no arguments' do
+    subject { described_class.measure }
+
+    it 'delegates to Processor' do
+      processor = double('processor')
+      Yardstick::Processor.stub(:new).with(instance_of(Yardstick::Config)) do
+        processor
+      end
+      processor.should_receive(:process)
+      subject
+    end
+  end
+
+  context 'when custom config' do
+    subject { described_class.measure(config) }
+
+    let(:config) { double('config') }
+
+    it 'delegates to Processor' do
+      processor = double('processor')
+      Yardstick::Processor.stub(:new).with(config) { processor }
+      processor.should_receive(:process)
+      subject
+    end
+  end
+end

data/spec/unit/yardstick/class_methods/measure_string_spec.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick, '.measure' do
+  let(:string) { double('string') }
+
+  context 'when no arguments' do
+    subject { described_class.measure_string(string) }
+
+    it 'delegates to Processor' do
+      processor = double('processor')
+      Yardstick::Processor.stub(:new).with(instance_of(Yardstick::Config)) do
+        processor
+      end
+      processor.should_receive(:process_string).with(string)
+      subject
+    end
+  end
+
+  context 'when custom config' do
+    subject { described_class.measure_string(string, config) }
+
+    let(:config) { double('config') }
+
+    it 'delegates to Processor' do
+      processor = double('processor')
+      Yardstick::Processor.stub(:new).with(config) { processor }
+      processor.should_receive(:process_string).with(string)
+      subject
+    end
+  end
+end

data/spec/unit/yardstick/cli_spec.rb

@@ -5,30 +5,33 @@ require 'yardstick/cli'
 
 shared_examples_for 'displays help' do
   it 'should display the help message' do
-    @output.should == <<-OUTPUT.gsub(/^\s{6}/, '')
+    expect(@output).to eql(<<-OUTPUT.gsub(/^\s{6}/, '')
       Usage: #{OptionParser.new.program_name} [options]
           -v, --version                    print version information and exit
           -h, --help                       display this help and exit
-    OUTPUT
+      OUTPUT
+    )
   end
 end
 
 shared_examples_for 'displays version' do
   it 'should display the program and version' do
-    @output.should == "#{OptionParser.new.program_name} #{Yardstick::VERSION}\n"
+    expect(@output)
+      .to eql("#{OptionParser.new.program_name} #{Yardstick::VERSION}\n")
   end
 end
 
 shared_examples_for 'displays coverage summary' do
   it 'should output the coverage summary' do
-    @output.should == "\nYARD-Coverage: 100.0%  Success: 20  Failed: 0  Total: 20\n"
+    expect(@output)
+      .to eql("\nYARD-Coverage: 100.0%  Success: 30  Failed: 0  Total: 30\n")
   end
 end
 
 describe Yardstick::CLI do
   def capture_display(&block)
     capture_stdout do
-      block.should raise_error(SystemExit)
+      expect(block).to raise_error(SystemExit)
     end
   end
 
@@ -81,7 +84,7 @@ describe Yardstick::CLI do
 
     describe 'with an Array of String objects' do
       before :all do
-        @measurements = capture_stdout { Yardstick::CLI.run(*[ Yardstick::ROOT.join('lib', 'yardstick.rb').to_s ]) }
+        @measurements = capture_stdout { Yardstick::CLI.run(*[Yardstick::ROOT.join('lib', 'yardstick.rb').to_s]) }
       end
 
       it_should_behave_like 'measured itself'
@@ -90,7 +93,7 @@ describe Yardstick::CLI do
 
     describe 'with an Array of Pathname objects' do
       before :all do
-        @measurements = capture_stdout { Yardstick::CLI.run(*[ Yardstick::ROOT.join('lib', 'yardstick.rb') ]) }
+        @measurements = capture_stdout { Yardstick::CLI.run(*[Yardstick::ROOT.join('lib', 'yardstick.rb')]) }
       end
 
       it_should_behave_like 'measured itself'
@@ -103,7 +106,7 @@ describe Yardstick::CLI do
       end
 
       it 'should display the invalid option message' do
-        @output.should == "invalid option: --invalid\n"
+        expect(@output).to eql("invalid option: --invalid\n")
       end
     end
   end

data/spec/unit/yardstick/config/class_methods/coerce_spec.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Config, '.coerce' do
+  let(:hash) { { 'rules' => { 'foo' => 'bar' } } }
+
+  context 'when without block' do
+    subject { described_class.coerce(hash) }
+
+    it { should be_instance_of(described_class) }
+
+    it 'coerces hash' do
+      rules = subject.instance_variable_get(:@rules)
+      expect(rules).to eql(foo: 'bar')
+    end
+  end
+
+  context 'when block provided' do
+    subject do
+      described_class.coerce(hash) { |config| config.path = new_path }
+    end
+
+    let(:new_path) { 'custom' }
+
+    it { should be_instance_of(described_class) }
+
+    it 'executes block as config' do
+      expect(subject.path).to eql(new_path)
+    end
+  end
+end

data/spec/unit/yardstick/config/for_rule_spec.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+
+require 'spec_helper'
+
+describe Yardstick::Config, '#for_rule' do
+  subject { described_class.new(options).for_rule(rule_class) }
+
+  let(:options) do
+    { rules: { 'Summary::Presence'.to_sym => { enabled: false } } }
+  end
+
+  let(:rule_config) { double('RuleConfig') }
+
+  context 'when rule is present' do
+    let(:rule_class) { Yardstick::Rules::Summary::Presence }
+
+    before do
+      allow(Yardstick::RuleConfig).to receive(:new).with(enabled: false)
+        .and_return(rule_config)
+    end
+
+    it { should be(rule_config) }
+  end
+
+  context 'when config does not have given rule' do
+    let(:rule_class) { Yardstick::Rules::Summary::Length }
+
+    before do
+      allow(Yardstick::RuleConfig).to receive(:new).with({})
+        .and_return(rule_config)
+    end
+
+    it { should be(rule_config) }
+  end
+
+  context 'when invalid rule given' do
+    let(:rule_class) { Object }
+
+    it 'raises InvalidRule error' do
+      msg = 'every rule must begin with Yardstick::Rules::'
+
+      expect { subject }
+        .to raise_error(described_class::InvalidRule, msg)
+    end
+  end
+end

data/spec/unit/yardstick/config/initialize_spec.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Config, '#initialize' do
+  it { should be_instance_of(described_class) }
+
+  context 'when block provided' do
+    subject do
+      described_class.new { |config| config.path = new_path }
+    end
+
+    let(:new_path) { 'custom' }
+
+    it { should be_instance_of(described_class) }
+
+    it 'executes block as config' do
+      expect(subject.path).to eql(new_path)
+    end
+  end
+end

data/spec/unit/yardstick/config/output_spec.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Config, '#output' do
+  subject { described_class.new(options).output }
+
+  context 'when default options' do
+    let(:options) { {} }
+
+    it { should be_instance_of(Yardstick::ReportOutput) }
+
+    its(:to_s) { should == 'measurements/report.txt' }
+  end
+end