dkubb-yardstick 0.0.1 → 0.1.0

data/spec/public/yardstick/measurement_set_spec.rb

@@ -0,0 +1,247 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.join('..', '..', 'spec_helper')
+
+describe Yardstick::MeasurementSet do
+  before do
+    YARD.parse_string('def test; end')
+
+    @description  = 'test measurement'
+    @docstring    = YARD::Registry.all(:method).first.docstring
+
+    @measurement  = Yardstick::Measurement.new(@description, @docstring) { true }
+    @measurements = Yardstick::MeasurementSet.new
+  end
+
+  it 'should be Enumerable' do
+    Yardstick::MeasurementSet.new.should be_kind_of(Enumerable)
+  end
+
+  describe '.new' do
+    describe 'with no arguments' do
+      before do
+        @measurements = Yardstick::MeasurementSet.new
+      end
+
+      it 'should return a MeasurementSet' do
+        @measurements.should be_kind_of(Yardstick::MeasurementSet)
+      end
+
+      it 'should be empty' do
+        @measurements.should be_empty
+      end
+    end
+
+    describe 'with Measurements' do
+      before do
+        @measurements = Yardstick::MeasurementSet.new([ @measurement ])
+      end
+
+      it 'should return a MeasurementSet' do
+        @measurements.should be_kind_of(Yardstick::MeasurementSet)
+      end
+
+      it 'should include the Measurements' do
+        @measurements.should include(@measurement)
+      end
+    end
+  end
+
+  describe '#<<' do
+    describe 'with a new Measurement' do
+      before do
+        @response = @measurements << @measurement
+      end
+
+      it 'should return self' do
+        @response.should be_equal(@measurements)
+      end
+
+      it 'should append the Measurement' do
+        @measurements.to_a.last.should equal(@measurement)
+      end
+    end
+
+    describe 'with an equivalent Measurement' do
+      before do
+        @measurements << @measurement
+        @measurements.to_a.should == [ @measurement ]
+
+        @response = @measurements << Yardstick::Measurement.new(@description, @docstring) { true }
+      end
+
+      it 'should return self' do
+        @response.should be_equal(@measurements)
+      end
+
+      it 'should not append the Measurement again' do
+        @measurements.to_a.should == [ @measurement ]
+      end
+    end
+  end
+
+  describe '#merge' do
+    before do
+      @other = Yardstick::MeasurementSet.new
+      @other << @measurement
+
+      @response = @measurements.merge(@other)
+    end
+
+    it 'should return self' do
+      @response.should be_equal(@measurements)
+    end
+
+    it 'should merge the other Measurements' do
+      @measurements.should include(*@other)
+    end
+  end
+
+  describe '#each' do
+    before do
+      @measurements << @measurement
+
+      @yield = []
+
+      @response = @measurements.each { |*args| @yield << args }
+    end
+
+    it 'should return self' do
+      @response.should be_equal(@measurements)
+    end
+
+    it 'should yield measurements' do
+      @yield.should eql([ [ @measurement ] ])
+    end
+  end
+
+  describe '#empty?' do
+    describe 'when there are no measurements' do
+      it 'should return true' do
+        @measurements.empty?.should be_true
+      end
+    end
+
+    describe 'when there are measurements' do
+      before do
+        @measurements << @measurement
+      end
+
+      it 'should return false' do
+        @measurements.empty?.should be_false
+      end
+    end
+  end
+
+  describe '#include?' do
+    describe 'when provided an included measurement' do
+      before do
+        @measurements << @measurement
+
+        @response = @measurements.include?(@measurement)
+      end
+
+      it 'should return true' do
+        @response.should be_true
+      end
+    end
+
+    describe 'when provided an excluded measurement' do
+      before do
+        @response = @measurements.include?(@measurement)
+      end
+
+      it 'should return false' do
+        @response.should be_false
+      end
+    end
+  end
+
+  describe '#index' do
+    describe 'when provided an included measurement' do
+      before do
+        @measurements << @measurement
+
+        @response = @measurements.index(@measurement)
+      end
+
+      it 'should return the index' do
+        @response.should eql(0)
+      end
+    end
+
+    describe 'when provided an excluded measurement' do
+      before do
+        @response = @measurements.index(@measurement)
+      end
+
+      it 'should return nil' do
+        @response.should == nil
+      end
+    end
+  end
+
+  describe '#total' do
+    before do
+      @measurements << @measurement
+    end
+
+    it 'should return the number of total measurements' do
+      @measurements.total.should eql(1)
+    end
+  end
+
+  describe '#successful' do
+    before do
+      @measurements << @measurement
+    end
+
+    it 'should return the number of successful measurements' do
+      @measurements.successful.should eql(1)
+    end
+  end
+
+  describe '#failed' do
+    before do
+      @measurements << @measurement
+    end
+
+    it 'should return the number of failed measurements' do
+      @measurements.failed.should eql(0)
+    end
+  end
+
+  describe '#coverage' do
+    describe 'when there are no measurements' do
+      it 'should return 0' do
+        @measurements.coverage.should eql(0)
+      end
+    end
+
+    describe 'when there are measurements' do
+      before do
+        @response = @measurements << @measurement
+      end
+
+      it 'should return a Rational' do
+        @measurements.coverage.should be_kind_of(Rational)
+      end
+
+      it 'should return the expected value' do
+        @measurements.coverage.should == 1
+      end
+    end
+  end
+
+  describe '#warn' do
+    before do
+      @measurements << Yardstick::Measurement.new(@description, @docstring) { false }
+
+      capture_stderr { @measurements.warn }
+    end
+
+    it 'should output the summary' do
+      @output.should == "(stdin):1: #test: test measurement\n" \
+        "\nCoverage: 0.0%  Success: 0  Failed: 1  Total: 1\n"
+    end
+  end
+end

data/spec/public/yardstick/measurement_spec.rb

@@ -2,55 +2,61 @@ require 'pathname'
 require Pathname(__FILE__).dirname.expand_path.join('..', '..', 'spec_helper')
 
 shared_examples_for 'measurement is successful' do
-  before :all do
+  before do
     @measurement = Yardstick::Measurement.new('successful', @docstring) { true }
   end
 end
 
 shared_examples_for 'measurement is skipped' do
-  before :all do
+  before do
     @measurement = Yardstick::Measurement.new('skipped', @docstring) { skip }
   end
 end
 
 shared_examples_for 'measurement is not successful' do
-  before :all do
+  before do
     @measurement = Yardstick::Measurement.new('not successful', @docstring) { false }
   end
 end
 
 shared_examples_for 'measurement is not implemented' do
-  before :all do
+  before do
     @measurement = Yardstick::Measurement.new('not implemented', @docstring) { todo }
   end
 end
 
 shared_examples_for 'measurement is warned' do
-  before :all do
-    $stderr = StringIO.new
-    @response = @measurement.warn
-    $stderr.rewind
-    @output = $stderr.read
-  end
-
-  it 'should return nil' do
-    @response.should be_nil
+  before do
+    capture_stderr { @measurement.warn }
   end
 end
 
 describe Yardstick::Measurement do
-  before :all do
+  before do
     YARD.parse_string('def test; end')
+
     @docstring = YARD::Registry.all(:method).first.docstring
   end
 
   describe '.new' do
-    before :all do
-      @response = Yardstick::Measurement.new('test measurement', @docstring) { true }
+    before do
+      @measurement = Yardstick::Measurement.new('test measurement', @docstring) { true }
     end
 
     it 'should return a Measurement' do
-      @response.should be_kind_of(Yardstick::Measurement)
+      @measurement.should be_kind_of(Yardstick::Measurement)
+    end
+  end
+
+  describe '#description' do
+    before do
+      @description = 'test measurement'
+
+      @measurement = Yardstick::Measurement.new(@description, @docstring) { true }
+    end
+
+    it 'should return the expected description' do
+      @measurement.description.should equal(@description)
     end
   end
 

data/spec/public/yardstick/method_spec.rb

@@ -1,6 +1,356 @@
 require 'pathname'
 require Pathname(__FILE__).dirname.expand_path.join('..', '..', 'spec_helper')
 
+shared_examples_for 'method is measured' do
+  before do
+    @measurements = docstring.measure
+  end
+
+  it 'should return a MeasurementSet' do
+    @measurements.should be_kind_of(Yardstick::MeasurementSet)
+  end
+end
+
+shared_examples_for 'a valid method' do
+  before do
+    YARD.parse_string(<<-RUBY)
+      # This is a method summary that is the maximum --- exactly 80 characters in length
+      #
+      # @example
+      #   test('Hello World')  # => nil
+      #
+      # @param [#to_str] value
+      #   the value
+      #
+      # @return [nil]
+      #   returns nil
+      #
+      # @api public
+      def test(value)
+      end
+    RUBY
+  end
+end
+
 describe Yardstick::Method do
-  it 'should be awesome'
+  def docstring
+    YARD::Registry.all(:method).first.docstring
+  end
+
+  describe '#measure' do
+    describe 'with a method summary' do
+      it_should_behave_like 'a valid method'
+      it_should_behave_like 'method is measured'
+
+      it 'should have a correct measurement' do
+        @measurements.detect { |measurement| measurement.description == 'The method summary should be specified' }.should be_ok
+      end
+    end
+
+    describe 'without a method summary' do
+      before do
+        YARD.parse_string('def test(value); end')
+      end
+
+      it_should_behave_like 'method is measured'
+
+      it 'should have an incorrect measurement' do
+        @measurements.detect { |measurement| measurement.description == 'The method summary should be specified' }.should_not be_ok
+      end
+    end
+
+    describe 'with a method summary that is 80 characters in length' do
+      it_should_behave_like 'a valid method'
+      it_should_behave_like 'method is measured'
+
+      it 'should have a correct measurement' do
+        @measurements.detect { |measurement| measurement.description == 'The method summary should be less than 80 characters in length' }.should be_ok
+      end
+    end
+
+    describe 'with a method summary that is 81 characters in length' do
+      before do
+        YARD.parse_string(<<-RUBY)
+          # This is a method summary greater than the maximum - it is 81 characters in length
+          def test(value)
+          end
+        RUBY
+      end
+
+      it_should_behave_like 'method is measured'
+
+      it 'should have an incorrect measurement' do
+        @measurements.detect { |measurement| measurement.description == 'The method summary should be less than 80 characters in length' }.should_not be_ok
+      end
+    end
+
+    describe 'with a method summary that does not end in a period' do
+      it_should_behave_like 'a valid method'
+      it_should_behave_like 'method is measured'
+
+      it 'should have a correct measurement' do
+        @measurements.detect { |measurement| measurement.description == 'The method summary should not end in a period' }.should be_ok
+      end
+    end
+
+    describe 'with a method summary that does end in a period' do
+      before do
+        YARD.parse_string(<<-RUBY)
+          # This method summary ends in a period.
+          def test(value)
+          end
+        RUBY
+      end
+
+      it_should_behave_like 'method is measured'
+
+      it 'should have an incorrect measurement' do
+        @measurements.detect { |measurement| measurement.description == 'The method summary should not end in a period' }.should_not be_ok
+      end
+    end
+
+    describe 'with a method summary that is on one line' do
+      it_should_behave_like 'a valid method'
+      it_should_behave_like 'method is measured'
+
+      it 'should have a correct measurement' do
+        @measurements.detect { |measurement| measurement.description == 'The method summary should be a single line' }.should be_ok
+      end
+    end
+
+    describe 'with a method summary that is not on one line' do
+      before do
+        YARD.parse_string(<<-RUBY)
+          # This method summary
+          # is on two lines
+          def test(value)
+          end
+        RUBY
+      end
+
+      it_should_behave_like 'method is measured'
+
+      it 'should have an incorrect measurement' do
+        @measurements.detect { |measurement| measurement.description == 'The method summary should be a single line' }.should_not be_ok
+      end
+    end
+
+    describe 'with a method that has an @example tag' do
+      it_should_behave_like 'a valid method'
+      it_should_behave_like 'method is measured'
+
+      it 'should have a correct measurement' do
+        @measurements.detect { |measurement| measurement.description == 'The public/semipublic method should have an example specified' }.should be_ok
+      end
+    end
+
+    describe 'with a method that is private' do
+      before do
+        YARD.parse_string(<<-RUBY)
+          # @api private
+          def test(value)
+          end
+        RUBY
+      end
+
+      it_should_behave_like 'method is measured'
+
+      it 'should be skipped' do
+        @measurements.detect { |measurement| measurement.description == 'The public/semipublic method should have an example specified' }.should be_skip
+      end
+    end
+
+    describe 'with a method that does not have an @example tag, and has an undefined @return tag' do
+        before do
+          YARD.parse_string(<<-RUBY)
+            # @return [undefined]
+            #
+            # @api public
+            def test(value)
+            end
+          RUBY
+        end
+
+        it_should_behave_like 'method is measured'
+
+        it 'should be skipped' do
+          @measurements.detect { |measurement| measurement.description == 'The public/semipublic method should have an example specified' }.should be_skip
+        end
+      end
+
+    describe 'with a method that has an @api tag' do
+      it_should_behave_like 'a valid method'
+      it_should_behave_like 'method is measured'
+
+      it 'should have a correct measurement' do
+        @measurements.detect { |measurement| measurement.description == 'The @api tag should be specified' }.should be_ok
+      end
+    end
+
+    describe 'with a method that does not have an @api tag' do
+      before do
+        YARD.parse_string('def test(value); end')
+      end
+
+      it_should_behave_like 'method is measured'
+
+      it 'should have an incorrect measurement' do
+        @measurements.detect { |measurement| measurement.description == 'The @api tag should be specified' }.should_not be_ok
+      end
+    end
+
+    describe 'with a method that has a public @api tag' do
+      it_should_behave_like 'a valid method'
+      it_should_behave_like 'method is measured'
+
+      it 'should have a correct measurement' do
+        @measurements.detect { |measurement| measurement.description == 'The @api tag must be either public, semipublic or private' }.should be_ok
+      end
+    end
+
+    describe 'with a method that has an invalid @api tag' do
+      before do
+        YARD.parse_string(<<-RUBY)
+          # @api invalid
+          def test(value)
+          end
+        RUBY
+      end
+
+      it_should_behave_like 'method is measured'
+
+      it 'should have an incorrect measurement' do
+        @measurements.detect { |measurement| measurement.description == 'The @api tag must be either public, semipublic or private' }.should_not be_ok
+      end
+    end
+
+    describe 'with a protected method and a semipublic @api tag' do
+      before do
+        YARD.parse_string(<<-RUBY)
+          protected
+
+          # @api semipublic
+          def test(value)
+          end
+        RUBY
+      end
+
+      it_should_behave_like 'method is measured'
+
+      it 'should have a correct measurement' do
+        @measurements.detect { |measurement| measurement.description == 'A method with protected visibility must have an @api tag of semipublic or private' }.should be_ok
+      end
+    end
+
+    describe 'with a protected method and a private @api tag' do
+      before do
+        YARD.parse_string(<<-RUBY)
+          protected
+
+          # @api private
+          def test(value)
+          end
+        RUBY
+      end
+
+      it_should_behave_like 'method is measured'
+
+      it 'should have a correct measurement' do
+        @measurements.detect { |measurement| measurement.description == 'A method with protected visibility must have an @api tag of semipublic or private' }.should be_ok
+      end
+    end
+
+    describe 'with a protected method and a public @api tag' do
+      before do
+        YARD.parse_string(<<-RUBY)
+          protected
+
+          # @api public
+          def test(value)
+          end
+        RUBY
+      end
+
+      it_should_behave_like 'method is measured'
+
+      it 'should have an incorrect measurement' do
+        @measurements.detect { |measurement| measurement.description == 'A method with protected visibility must have an @api tag of semipublic or private' }.should_not be_ok
+      end
+    end
+
+    describe 'with a private method and a private @api tag' do
+      before do
+        YARD.parse_string(<<-RUBY)
+          private
+
+          # @api private
+          def test(value)
+          end
+        RUBY
+      end
+
+      it_should_behave_like 'method is measured'
+
+      it 'should have a correct measurement' do
+        @measurements.detect { |measurement| measurement.description == 'A method with private visibility must have an @api tag of private' }.should be_ok
+      end
+    end
+
+    describe 'with a private method and a public @api tag' do
+      before do
+        YARD.parse_string(<<-RUBY)
+          private
+
+          # @api public
+          def test(value)
+          end
+        RUBY
+      end
+
+      it_should_behave_like 'method is measured'
+
+      it 'should have an incorrect measurement' do
+        @measurements.detect { |measurement| measurement.description == 'A method with private visibility must have an @api tag of private' }.should_not be_ok
+      end
+    end
+
+    describe 'with a private method and a semipublic @api tag' do
+      before do
+        YARD.parse_string(<<-RUBY)
+          private
+
+          # @api semipublic
+          def test(value)
+          end
+        RUBY
+      end
+
+      it_should_behave_like 'method is measured'
+
+      it 'should have an incorrect measurement' do
+        @measurements.detect { |measurement| measurement.description == 'A method with private visibility must have an @api tag of private' }.should_not be_ok
+      end
+    end
+
+    describe 'with a method that has a @return tag' do
+      it_should_behave_like 'a valid method'
+      it_should_behave_like 'method is measured'
+
+      it 'should have a correct measurement' do
+        @measurements.detect { |measurement| measurement.description == 'The @return tag should be specified' }.should be_ok
+      end
+    end
+
+    describe 'with a method that does not have a @return tag' do
+      before do
+        YARD.parse_string('def test(value); end')
+      end
+
+      it_should_behave_like 'method is measured'
+
+      it 'should have an incorrect measurement' do
+        @measurements.detect { |measurement| measurement.description == 'The @return tag should be specified' }.should_not be_ok
+      end
+    end
+  end
 end