yardstick 0.9.6 → 0.9.7

data/spec/unit/yardstick/round_percentage_spec.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick, '.round_percentage' do
+  subject { described_class.round_percentage(12.3456) }
+
+  it { should eq(12.3) }
+end

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

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Rule, '.coerce' do
+  subject { described_class.coerce(document, config) }
+
+  let(:document)    { DocumentMock.new                          }
+  let(:config)      { double('config')                          }
+  let(:rule_config) { Yardstick::RuleConfig.new(enabled: false) }
+
+  before do
+    config.stub(:for_rule).with(described_class) { rule_config }
+  end
+
+  it { should be_a(described_class) }
+
+  it { should_not be_enabled }
+
+  its(:document) { should be(document) }
+end

data/spec/unit/yardstick/rule/class_methods/inherited_spec.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Rule, '.inherited' do
+  let(:subclass) { Class.new(Yardstick::Rule) }
+
+  after do
+    Yardstick::Document.registered_rules.delete(subclass)
+  end
+
+  it 'registers rule' do
+    expect(Yardstick::Document.registered_rules).to include(subclass)
+  end
+end

data/spec/unit/yardstick/rule/enabled_predicate_spec.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Rule, '#enabled?' do
+  subject { described_class.new(document, config).enabled? }
+
+  let(:document)     { double('document', path: 'Foo#bar') }
+  let(:config)       { double('RuleConfig')                }
+  let(:return_value) { double('Boolean')                   }
+
+  before do
+    allow(config).to receive(:enabled_for_path?).with('Foo#bar')
+      .and_return(return_value)
+  end
+
+  it { should eq(return_value) }
+end

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

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Rule, '#initialize' do
+  let(:document) { DocumentMock.new }
+
+  context 'when rule config not given' do
+    subject { described_class.new(document) }
+
+    it { should be_a(described_class) }
+
+    it { should be_enabled }
+  end
+
+  context 'when rule config is given' do
+    subject { described_class.new(document, config) }
+
+    let(:config) { Yardstick::RuleConfig.new(enabled: false) }
+
+    it { should be_a(described_class) }
+
+    it { should_not be_enabled }
+  end
+end

data/spec/unit/yardstick/rule/validatable_predicate_spec.rb

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

data/spec/unit/yardstick/rule_config/enabled_for_path_predicate_spec.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::RuleConfig, '#enabled_for_path?' do
+  subject { described_class.new(options).enabled_for_path?(path) }
+
+  let(:options) { {} }
+
+  %w[ Foo::Bar#baz Foo::Bar.baz ].each do |method|
+    let(:path) { method }
+
+    context 'when no restrictions' do
+      it { should be(true) }
+    end
+
+    context 'when disabled' do
+      before { options[:enabled] = false }
+
+      it { should be(false) }
+    end
+
+    context 'when excluded by exact path' do
+      before { options[:exclude] = [path] }
+
+      it { should be(false) }
+    end
+
+    context 'when excluded by class or module' do
+      before { options[:exclude] = ['Foo::Bar'] }
+
+      it { should be(false) }
+    end
+
+    context 'when excluded by superclass or subclass' do
+      before { options[:exclude] = ['Foo', 'Foo::Bar::Sub'] }
+
+      it { should be(true) }
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::RuleConfig, '#initialize' do
+  context 'when no options given' do
+    subject { described_class.new }
+
+    it 'does not apply restrictions' do
+      expect(subject.enabled_for_path?('Foo#bar')).to be(true)
+
+      # Satisfy mutant
+      expect(subject.instance_variable_get(:@exclude)).to eq([])
+    end
+  end
+end

data/spec/unit/yardstick/rules/api_tag/inclusion/valid_predicate_spec.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Rules::ApiTag::Inclusion, '#valid?' do
+  subject { described_class.new(document).valid? }
+
+  let(:document) { double('document') }
+
+  %w[public semipublic private].each do |method_visibility|
+    context "with #{method_visibility} method" do
+      before do
+        document.stub(:tag_text).with('api').and_return(method_visibility)
+      end
+
+      it { should be(true) }
+    end
+  end
+
+  context 'with unknown method visibility' do
+    before do
+      document.stub(:tag_text).with('api').and_return('unknown')
+    end
+
+    it { should be(false) }
+  end
+end

data/spec/unit/yardstick/rules/api_tag/presence/valid_predicate_spec.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Rules::ApiTag::Presence, '#valid?' do
+  subject { described_class.new(document).valid? }
+
+  let(:document) { double('document') }
+
+  context 'with api tag' do
+    before do
+      document.stub(:has_tag?).with('api').and_return(true)
+    end
+
+    it { should be(true) }
+  end
+
+  context 'without api tag' do
+    before do
+      document.stub(:has_tag?).with('api').and_return(false)
+    end
+
+    it { should be(false) }
+  end
+end

data/spec/unit/yardstick/rules/api_tag/private_method/valid_predicate_spec.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Rules::ApiTag::PrivateMethod, '#valid?' do
+  subject { described_class.new(document).valid? }
+
+  let(:document) { double('document') }
+
+  context 'when with protected api tag' do
+    before { document.stub(:api?).with(%w[ private ]).and_return(true) }
+
+    it { should be(true) }
+  end
+
+  context 'when not protected visibility' do
+    before { document.stub(:api?).with(%w[ private ]).and_return(false) }
+
+    it { should be(false) }
+  end
+end

data/spec/unit/yardstick/rules/api_tag/private_method/validatable_predicate_spec.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Rules::ApiTag::PrivateMethod, '#validatable?' do
+  subject { described_class.new(document).validatable? }
+
+  let(:document) { double('document', visibility: visibility) }
+
+  context 'when protected visibility' do
+    let(:visibility) { :private }
+
+    it { should be(true) }
+  end
+
+  context 'when not protected visibility' do
+    let(:visibility) { :something }
+
+    it { should be(false) }
+  end
+end

data/spec/unit/yardstick/rules/api_tag/protected_method/valid_predicate_spec.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Rules::ApiTag::ProtectedMethod, '#valid?' do
+  subject { described_class.new(document).valid? }
+
+  let(:document) { double('document') }
+
+  context 'when with protected api tag' do
+    before do
+      document.stub(:api?).with(%w[ semipublic private ]).and_return(true)
+    end
+
+    it { should be(true) }
+  end
+
+  context 'when not protected visibility' do
+    before do
+      document.stub(:api?).with(%w[semipublic private]).and_return(false)
+    end
+
+    it { should be(false) }
+  end
+end

data/spec/unit/yardstick/rules/api_tag/protected_method/validatable_predicate_spec.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Rules::ApiTag::ProtectedMethod, '#validatable?' do
+  subject { described_class.new(document).validatable? }
+
+  let(:document) { double('document', visibility: visibility) }
+
+  context 'when protected visibility' do
+    let(:visibility) { :protected }
+
+    it { should be(true) }
+  end
+
+  context 'when not protected visibility' do
+    let(:visibility) { :something }
+
+    it { should be(false) }
+  end
+end

data/spec/unit/yardstick/rules/example_tag/valid_predicate_spec.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Rules::ExampleTag, '#valid?' do
+  subject { described_class.new(document).valid? }
+
+  let(:document) { double('document') }
+
+  context 'with example tag' do
+    before do
+      document.stub(:has_tag?).with('example').and_return(true)
+    end
+
+    it { should be(true) }
+  end
+
+  context 'without example tag' do
+    before do
+      document.stub(:has_tag?).with('example').and_return(false)
+    end
+
+    it { should be(false) }
+  end
+end

data/spec/unit/yardstick/rules/example_tag/validatable_predicate_spec.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Rules::ExampleTag, '#validatable?' do
+  subject { described_class.new(document).validatable? }
+
+  let(:document) { double('document') }
+
+  before do
+    document.stub(:api?).with(['private']) { false }
+    document.stub(:tag_types).with('return') { %w[Object] }
+  end
+
+  it { should be(true) }
+
+  context 'with private api' do
+    before do
+      document.stub(:api?).with(['private']).and_return(true)
+    end
+
+    it { should be(false) }
+  end
+
+  context 'with undefined return' do
+    before do
+      document.stub(:tag_types).with('return').and_return(['undefined'])
+    end
+
+    it { should be(false) }
+  end
+end

data/spec/unit/yardstick/rules/return_tag/valid_predicate_spec.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Rules::ReturnTag, '#valid?' do
+  subject { described_class.new(document).valid? }
+
+  let(:document) { double('document') }
+
+  context 'when with protected api tag' do
+    before { document.stub(:has_tag?).with('return').and_return(true) }
+
+    it { should be(true) }
+  end
+
+  context 'when not protected visibility' do
+    before { document.stub(:has_tag?).with('return').and_return(false) }
+
+    it { should be(false) }
+  end
+end

data/spec/unit/yardstick/rules/summary/delimiter/valid_predicate_spec.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Rules::Summary::Delimiter, '#valid?' do
+  subject { described_class.new(document).valid? }
+
+  let(:document) { double('document', summary_text: text) }
+
+  context 'without a dot' do
+    let(:text) { 'A summary' }
+
+    it { should be(true) }
+  end
+
+  context 'with a dot' do
+    let(:text) { 'A summary.' }
+
+    it { should be(false) }
+  end
+end

data/spec/unit/yardstick/rules/summary/length/valid_predicate_spec.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Yardstick::Rules::Summary::Length, '#valid?' do
+  subject { described_class.new(document).valid? }
+
+  let(:document) { double('document', summary_text: text) }
+
+  context 'with short summary' do
+    let(:text) { 'A summary' }
+
+    it { should be(true) }
+  end
+
+  context 'with short summary that includes umlauts' do
+    let(:text) { 'ö' * 79 }
+
+    it { should be(true) }
+  end
+
+  context 'with too long summary' do
+    let(:text) { 'a' * 81 }
+
+    it { should be(false) }
+  end
+end