yardstick 0.1.0

data/lib/yardstick/rule.rb

@@ -0,0 +1,61 @@
+module Yardstick
+  class Rule
+
+    # Return a Rule instance
+    #
+    # @param [#to_str] description
+    #   the description of the Rule
+    #
+    # @yield []
+    #   the measurement for the rule
+    #
+    # @return [Rule]
+    #   the rule instance
+    #
+    # @api private
+    def initialize(description, &block)
+      @description = description.to_str
+      @block       = block
+    end
+
+    # Return a Measurement for a docstring
+    #
+    # @param [YARD::Docstring] docstring
+    #   the docstring to measure
+    #
+    # @return [Measurement]
+    #   the measurement
+    #
+    # @api private
+    def measure(docstring)
+      Measurement.new(@description, docstring, &@block)
+    end
+
+    # Test if Rule is equal to another rule
+    #
+    # @example
+    #   rule == equal_rule  # => true
+    #
+    # @param [Rule] other
+    #   the other Rule
+    #
+    # @return [Boolean]
+    #   true if the Rule is equal to the other, false if not
+    #
+    # @api semipublic
+    def eql?(other)
+      @description.eql?(other.instance_variable_get(:@description))
+    end
+
+    # Return hash identifier for the Rule
+    #
+    # @return [Integer]
+    #   the hash identifier
+    #
+    # @api private
+    def hash
+      @description.hash
+    end
+
+  end # class Rule
+end # module Yardstick

data/lib/yardstick/rule_set.rb

@@ -0,0 +1,18 @@
+module Yardstick
+  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/lib/yardstick/yard_ext.rb

@@ -0,0 +1,20 @@
+module YARD  #:nodoc: all
+  module CodeObjects
+    class MethodObject
+
+      # Return the docstring associated with the method
+      #
+      # @example
+      #   method_object.docstring  # => YARD::Docstring instance
+      #
+      # @return [YARD::Docstring]
+      #   the docstring for this method
+      #
+      # @api public
+      def docstring
+        super.extend(Yardstick::Method)
+      end
+
+    end # class MethodObject
+  end # module CodeObjects
+end # module YARD

data/lib/yardstick.rb

@@ -0,0 +1,52 @@
+require 'pathname'
+require 'yard'
+
+module Yardstick
+  VERSION = '0.1.0'.freeze
+  ROOT    = Pathname(__FILE__).dirname.parent.expand_path.freeze
+
+  # Measure a list of files
+  #
+  # @example
+  #   Yardstick.measure('article.rb')  # => [ Measurement ]
+  #
+  # @param [Array<#to_s>, #to_s] path
+  #   optional list of paths to measure
+  # @param [Hash] options
+  #   optional configuration
+  #
+  # @return [MeasurementSet]
+  #   the measurements for each file
+  #
+  # @api public
+  def self.measure(path = 'lib/**/*.rb', options = {})
+    Yardstick::Processor.process_path(path)
+  end
+
+  # Measure a string of code and YARD documentation
+  #
+  # @example
+  #   string = "def my_method; end"
+  #
+  #   Yardstick.measure_string(string)  # => [ Measurement ]
+  #
+  # @param [#to_str] string
+  #   the string to measure
+  # @param [Hash] options
+  #   optional configuration
+  #
+  # @return [MeasurementSet]
+  #   the measurements for the string
+  #
+  # @api public
+  def self.measure_string(string, options = {})
+    Yardstick::Processor.process_string(string)
+  end
+
+end # module Yardstick
+
+$LOAD_PATH.unshift(Yardstick::ROOT + 'lib')
+
+require 'yardstick/core_ext/object'
+require 'yardstick/yard_ext'
+require 'yardstick/autoload'

data/spec/public/yardstick/cli_spec.rb

@@ -0,0 +1,108 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.join('..', '..', 'spec_helper')
+
+shared_examples_for 'displays help' do
+  it 'should display the help message' do
+    @output.should == <<-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
+  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"
+  end
+end
+
+shared_examples_for 'displays coverage summary' do
+  it 'should output the coverage summary' do
+    @output.should == "\nCoverage: 100.0%  Success: 20  Failed: 0  Total: 20\n"
+  end
+end
+
+describe Yardstick::CLI do
+  def capture_display(&block)
+    capture_stdout do
+      block.should raise_error(SystemExit)
+    end
+  end
+
+  describe '.run' do
+    describe 'with no arguments' do
+      before do
+        capture_display { Yardstick::CLI.run }
+      end
+
+      it_should_behave_like 'displays help'
+    end
+
+    %w[ -h --help ].each do |help_option|
+      describe "with #{help_option} option" do
+        before do
+          capture_display { Yardstick::CLI.run(help_option) }
+        end
+
+        it_should_behave_like 'displays help'
+      end
+    end
+
+    %w[ -v --version ].each do |version_option|
+      describe "with #{version_option} option" do
+        before do
+          capture_display { Yardstick::CLI.run(version_option) }
+        end
+
+        it_should_behave_like 'displays version'
+      end
+    end
+
+    describe 'with a String path' do
+      before :all do
+        @measurements = capture_stdout { Yardstick::CLI.run(Yardstick::ROOT.join('lib', 'yardstick.rb').to_s) }
+      end
+
+      it_should_behave_like 'measured itself'
+      it_should_behave_like 'displays coverage summary'
+    end
+
+    describe 'with a Pathname' do
+      before :all do
+        @measurements = capture_stdout { Yardstick::CLI.run(Yardstick::ROOT.join('lib', 'yardstick.rb')) }
+      end
+
+      it_should_behave_like 'measured itself'
+      it_should_behave_like 'displays coverage summary'
+    end
+
+    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 ]) }
+      end
+
+      it_should_behave_like 'measured itself'
+      it_should_behave_like 'displays coverage summary'
+    end
+
+    describe 'with an Array of Pathname objects' do
+      before :all do
+        @measurements = capture_stdout { Yardstick::CLI.run(*[ Yardstick::ROOT.join('lib', 'yardstick.rb') ]) }
+      end
+
+      it_should_behave_like 'measured itself'
+      it_should_behave_like 'displays coverage summary'
+    end
+
+    describe 'with invalid option' do
+      before do
+        capture_display { Yardstick::CLI.run('--invalid') }
+      end
+
+      it 'should display the invalid option message' do
+        @output.should == "invalid option: --invalid\n"
+      end
+    end
+  end
+end

data/spec/public/yardstick/measurement_set_spec.rb

@@ -0,0 +1,265 @@
+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 '#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" \
+          "\nCoverage: 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" \
+          "\nCoverage: 0.0%  Success: 0  Failed: 1  Total: 1\n"
+      end
+    end
+  end
+end