yardstick 0.9.6 → 0.9.7

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

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Config, '#output=' do
+  subject { config.output = output }
+
+  let(:config) { described_class.new }
+  let(:path)   { 'tmp/*.rb'          }
+
+  before { config.output = path }
+
+  context 'output' do
+    subject { config.output }
+
+    it { should be_a(Yardstick::ReportOutput) }
+
+    its(:to_s) { should == 'tmp/*.rb' }
+  end
+end

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

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Config, '#path' do
+  subject { described_class.new(options).path }
+
+  context 'when default options' do
+    let(:options) { {} }
+
+    it { should == 'lib/**/*.rb' }
+  end
+end

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

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Config, '#path=' do
+  subject { described_class.new }
+
+  before { subject.path = '/tmp/*.rb' }
+
+  its(:path) { should == '/tmp/*.rb' }
+end

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

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Config, '#require_exact_threshold?' do
+  subject { described_class.new(config).require_exact_threshold? }
+
+  context 'when set to true' do
+    let(:config) { { require_exact_threshold: true } }
+
+    it { should be(true) }
+  end
+
+  context 'when set to false' do
+    let(:config) { { require_exact_threshold: false } }
+
+    it { should be(false) }
+  end
+end

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

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Config, '#require_exact_threshold=' do
+  subject { described_class.new }
+
+  context 'when argument is true' do
+    before { subject.require_exact_threshold = true }
+
+    its(:require_exact_threshold?) { should be(true) }
+  end
+
+  context 'when argument is false' do
+    before { subject.require_exact_threshold = false }
+
+    its(:require_exact_threshold?) { should be(false) }
+  end
+end

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

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Config, '#set_defaults' do
+  subject { described_class.new(options) }
+
+  context 'when without options' do
+    let(:options) { {} }
+
+    its(:threshold) { should be(100) }
+
+    its(:verbose?) { should be(true) }
+
+    its(:path) { should eq('lib/**/*.rb') }
+
+    its(:require_exact_threshold?) { should be(true) }
+
+    it 'sets rules to empty hash' do
+      expect(subject.instance_variable_get(:@rules)).to eq({})
+    end
+  end
+
+  context 'when with options' do
+    let(:options) do
+      {
+        threshold: 15,
+        verbose: false,
+        path: 'tmp/*.rb',
+        require_exact_threshold: false
+      }
+    end
+
+    its(:threshold) { should be(15) }
+
+    its(:verbose?) { should be(false) }
+
+    its(:path) { should eq('tmp/*.rb') }
+
+    its(:require_exact_threshold?) { should be(false) }
+  end
+end

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

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Config, '#threshold=' do
+  subject { described_class.new }
+
+  let(:new_threshold) { 34 }
+
+  before do
+    subject.threshold = new_threshold
+  end
+
+  its(:threshold) { should be(new_threshold) }
+end

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

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Config, '#verbose?' do
+  subject { described_class.new(config).verbose? }
+
+  context 'when set to true' do
+    let(:config) { { verbose: true } }
+
+    it { should be(true) }
+  end
+
+  context 'when set to false' do
+    let(:config) { { verbose: false } }
+
+    it { should be(false) }
+  end
+end

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

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Config, '#verbose=' do
+  subject { described_class.new }
+
+  context 'when argument is true' do
+    before { subject.verbose = true }
+
+    it { should be_verbose }
+  end
+
+  context 'when argument is false' do
+    before { subject.verbose = false }
+
+    it { should_not be_verbose }
+  end
+end

data/spec/unit/yardstick/document/api_predicate_spec.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Document, '#api?' do
+  subject { described_class.new(docstring).api?(types) }
+
+  let(:docstring) { double('docstring') }
+
+  before do
+    docstring.stub(:tag).with('api') { double(text: 'private') }
+  end
+
+  context 'when tag is equal' do
+    let(:types) { ['private'] }
+
+    it { should be(true) }
+  end
+
+  context 'when tag is not equal' do
+    let(:types) { ['public'] }
+
+    it { should be(false) }
+  end
+end

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

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Document, '.measure' do
+  subject { described_class.measure(document, config) }
+
+  let(:config)    { Yardstick::Config.new }
+  let(:document)  { double('document')    }
+
+  let(:registered_rules) do
+    described_class.instance_variable_get(:@registered_rules)
+  end
+
+  before do
+    registered_rules.each do |rule_class|
+      rule_class.should_receive(:coerce).with(document, config)
+        .and_return(ValidRule.new(document))
+    end
+  end
+
+  it { should be_a(Yardstick::MeasurementSet) }
+
+  its(:first) { should be_a(Yardstick::Measurement) }
+end

data/spec/unit/yardstick/document/class_methods/register_rule_spec.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Document, '.register_rule' do
+  subject { described_class.register_rule(rule_class) }
+
+  let(:rule_class)   { Class.new                        }
+  let(:rule_classes) { described_class.registered_rules }
+
+  after do
+    rule_classes.delete(rule_class)
+  end
+
+  it 'adds rule_class to registered_rules' do
+    subject
+    expect(rule_classes).to include(rule_class)
+  end
+end

data/spec/unit/yardstick/document/class_methods/registered_rules_spec.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Document, '.registered_rules' do
+  subject { described_class.registered_rules }
+
+  it { should_not be_empty }
+end

data/spec/unit/yardstick/document/docstring_spec.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Document, '#docstring' do
+  subject { described_class.new(docstring).docstring }
+
+  let(:docstring) { double('docstring') }
+
+  it { should be(docstring) }
+end

data/spec/unit/yardstick/document/file_spec.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Document, '#file' do
+  subject { described_class.new(docstring).file }
+
+  let(:docstring) { double('docstring', object: object)   }
+  let(:object)    { double('object', file: '/foo/bar.rb') }
+
+  it { should be_kind_of(Pathname) }
+
+  its(:to_s) { should == '/foo/bar.rb' }
+end

data/spec/unit/yardstick/document/has_tag_predicate_spec.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Document, '#has_tag?' do
+  subject { described_class.new(docstring).has_tag?(name) }
+
+  let(:docstring) { double('docstring') }
+  let(:name)      { 'tag name'          }
+
+  it 'delegates to docstring' do
+    docstring.should_receive(:has_tag?).with(name)
+    subject
+  end
+end

data/spec/unit/yardstick/document/line_spec.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Document, '#line' do
+  subject { described_class.new(docstring).line }
+
+  let(:docstring) { double('docstring', object: object) }
+  let(:object)    { double('object', line: 3)           }
+
+  it { should be(3) }
+end

data/spec/unit/yardstick/document/null_tag/text_spec.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Document::NullTag, '#text' do
+  subject { described_class.new.text }
+
+  it { should be_nil }
+end

data/spec/unit/yardstick/document/null_tag/types_spec.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Document::NullTag, '#types' do
+  subject { described_class.new.types }
+
+  it { should eq([]) }
+end

data/spec/unit/yardstick/document/path_spec.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Document, '#path' do
+  subject { described_class.new(docstring).path }
+
+  let(:docstring) { double('docstring', object: object) }
+  let(:object)    { double('object', path: 'Foo#bar')   }
+
+  it { should eq('Foo#bar') }
+end

data/spec/unit/yardstick/document/summary_text_spec.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Document, '#summary_text' do
+  subject { described_class.new(docstring).summary_text }
+
+  context 'when with summary' do
+    let(:docstring) do
+      "This is a method summary\n\nThis is a method body"
+    end
+
+    it { should eq('This is a method summary') }
+  end
+
+  context 'when without summary' do
+    let(:docstring) do
+      "\n\nThis is a method body"
+    end
+
+    it { should eq('') }
+  end
+end

data/spec/unit/yardstick/document/tag_text_spec.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Document, '#tag_text' do
+  subject { described_class.new(docstring).tag_text(name) }
+
+  let(:name)      { 'api'                   }
+  let(:docstring) { double('docstring')     }
+  let(:yard_tag)  { double(text: 'private') }
+
+  before do
+    docstring.stub(:tag).with(name) { yard_tag }
+  end
+
+  it { should eq('private') }
+end

data/spec/unit/yardstick/document/tag_types_spec.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Document, '#tag_types' do
+  subject { described_class.new(docstring).tag_types(name) }
+
+  let(:name)      { 'tag name'           }
+  let(:docstring) { double('docstring')  }
+  let(:yard_tag)  { double(types: types) }
+  let(:types)     { %w[type1 type2]      }
+
+  before do
+    docstring.stub(:tag).with(name) { yard_tag }
+  end
+
+  it { should be(types) }
+end

data/spec/unit/yardstick/document/visibility_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Document, '#visibility' do
+  subject { described_class.new(docstring).visibility }
+
+  let(:docstring) { double('docstring', object: object)      }
+  let(:object)    { double('object', visibility: visibility) }
+
+  context 'when true' do
+    let(:visibility) { true }
+
+    it { should be(true) }
+  end
+
+  context 'when false' do
+    let(:visibility) { false }
+
+    it { should be(false) }
+  end
+end