yardstick 0.9.6 → 0.9.7

data/.rvmrc

@@ -1 +0,0 @@
-rvm use @$(basename `pwd`) --create

data/lib/yardstick/measurable.rb

@@ -1,67 +0,0 @@
-# encoding: utf-8
-
-module Yardstick
-  module Measurable
-    include Measurement::UtilityMethods
-
-    module ClassMethods
-
-      # Include the class or module with measurable class methods
-      #
-      # @param [Module] mod
-      #   the module to include within
-      #
-      # @return [undefined]
-      #
-      # @api private
-      def included(mod)
-        mod.extend(ClassMethods).rules.merge(rules)
-      end
-
-      # List of rules for this class
-      #
-      # @return [Yardstick::RuleSet<Rule>]
-      #   the rules for this class
-      #
-      # @api private
-      def rules
-        @rules ||= RuleSet.new
-      end
-
-      # Set the description for the rule
-      #
-      # @param [#to_str] description
-      #   the rule description
-      #
-      # @yield []
-      #   the rule to perform
-      #
-      # @yieldreturn [Boolean]
-      #   return true if successful, false if not
-      #
-      # @return [undefined]
-      #
-      # @api private
-      def rule(description, &block)
-        rules << Rule.new(description, &block)
-      end
-
-    end # module ClassMethods
-
-    extend ClassMethods
-
-    # Return a list of measurements for this docstring instance
-    #
-    # @example
-    #   docstring.measure  # => [ Measurement ]
-    #
-    # @return [Yardstick::MeasurementSet]
-    #   a collection of measurements
-    #
-    # @api public
-    def measure
-      self.class.rules.measure(self)
-    end
-
-  end # module Measurable
-end # module Yardstick

data/lib/yardstick/method.rb

@@ -1,113 +0,0 @@
-# encoding: utf-8
-
-module Yardstick
-  module Method
-    include Measurable
-
-    rule 'The method summary should be specified' do
-      skip if has_tag?('see')
-      summary_text != ''
-    end
-
-    rule 'The method summary should be less than 80 characters in length' do
-      summary_text.split(//).length <= 80
-    end
-
-    rule 'The method summary should not end in a period' do
-      summary_text[-1, 1] != '.'
-    end
-
-    rule 'The method summary should be a single line' do
-      !summary_text.include?("\n")
-    end
-
-    rule 'The public/semipublic method should have an example specified' do
-      skip if api?(%w[ private ]) || tag_types('return') == %w[ undefined ]
-      has_tag?('example')
-    end
-
-    rule 'The @api tag should be specified' do
-      has_tag?('api')
-    end
-
-    rule 'The @api tag must be either public, semipublic or private' do
-      %w[ public semipublic private ].include?(tag_text('api'))
-    end
-
-    rule 'A method with protected visibility must have an @api tag of semipublic or private' do
-      skip unless visibility == :protected
-      api?(%w[ semipublic private ])
-    end
-
-    rule 'A method with private visibility must have an @api tag of private' do
-      skip unless visibility == :private
-      api?(%w[ private ])
-    end
-
-    rule 'The @return tag should be specified' do
-      has_tag?('return')
-    end
-
-  private
-
-    # The raw text for the summary
-    #
-    # @return [String]
-    #   the summary text
-    #
-    # @api private
-    def summary_text
-      split(/\r?\n\r?\n/).first || ''
-    end
-
-    # The text for a specified tag
-    #
-    # @param [String] tag_name
-    #   the name of the tag
-    #
-    # @return [String, nil]
-    #   the tag text if the tag exists
-    #
-    # @api private
-    def tag_text(tag_name)
-      tag(tag_name).text if has_tag?(tag_name)
-    end
-
-    # The types for a specified tag
-    #
-    # @param [String] tag_name
-    #   the name of the tag
-    #
-    # @return [Array<String>, nil]
-    #   a collection of tag types if the tag exists
-    #
-    # @api private
-    def tag_types(tag_name)
-      tag(tag_name).types if has_tag?(tag_name)
-    end
-
-    # The method visibility: public, protected or private
-    #
-    # @return [Symbol]
-    #   the visibility of the method
-    #
-    # @api private
-    def visibility
-      object.visibility
-    end
-
-    # Check if the method API type matches
-    #
-    # @param [Array<String>] types
-    #   a collection of API types
-    #
-    # @return [Boolean]
-    #   true if the API type matches
-    #
-    # @api private
-    def api?(types)
-      types.include?(tag_text('api'))
-    end
-
-  end # module Method
-end # module Yardstick

data/lib/yardstick/rule_set.rb

@@ -1,22 +0,0 @@
-# encoding: utf-8
-
-module Yardstick
-
-  # A set of rules to apply to docs
-  class RuleSet < OrderedSet
-
-    # Measure a docstring with all Rules
-    #
-    # @param [YARD::Docstring] docstring
-    #   the docstring to measure
-    #
-    # @return [MeasurementSet]
-    #   a collection of measurements
-    #
-    # @api private
-    def measure(docstring)
-      MeasurementSet.new(map { |rule| rule.measure(docstring) })
-    end
-
-  end # class RuleSet
-end # module Yardstick

data/spec/support/config_alias.rb

@@ -1,5 +0,0 @@
-# encoding: utf-8
-
-require 'rbconfig'
-
-::Config = RbConfig unless defined?(::Config)

data/spec/unit/yardstick/measurement_set_spec.rb

@@ -1,266 +0,0 @@
-# encoding: utf-8
-
-require '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 1' do
-        @measurements.coverage.should eql(1)
-      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 '#puts' do
-    before do
-      @measurements << Yardstick::Measurement.new(@description, @docstring) { false }
-    end
-
-    describe 'with no arguments' do
-      before do
-        capture_stdout { @measurements.puts }
-      end
-
-      it 'should output the summary' do
-        @output.should == "(stdin):1: #test: test measurement\n" \
-          "\nYARD-Coverage: 0.0%  Success: 0  Failed: 1  Total: 1\n"
-      end
-    end
-
-    describe 'with an object implementing #puts' do
-      before do
-        io = StringIO.new
-        @measurements.puts(io)
-        io.rewind
-        @output = io.read
-      end
-
-      it 'should output the summary' do
-        @output.should == "(stdin):1: #test: test measurement\n" \
-          "\nYARD-Coverage: 0.0%  Success: 0  Failed: 1  Total: 1\n"
-      end
-    end
-  end
-end