Contents

require 'pathname'
require 'rational'

require 'backports'
require 'yard'

require 'yardstick/ordered_set'
require 'yardstick/rule_set'
require 'yardstick/measurement'

require 'yardstick/measurement_set'
require 'yardstick/processor'
require 'yardstick/rule'

require 'yardstick/measurable'
require 'yardstick/method'

require 'yardstick/yard_ext'

require 'yardstick/version'

module Yardstick
  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 [Yardstick::MeasurementSet]
  #   the measurements for each file
  #
  # @api public
  def self.measure(path = 'lib/**/*.rb', options = {})
    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 [Yardstick::MeasurementSet]
  #   the measurements for the string
  #
  # @api public
  def self.measure_string(string, options = {})
    Processor.process_string(string)
  end

end # module Yardstick

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
yardstick-0.9.2	lib/yardstick.rb
yardstick-0.9.1	lib/yardstick.rb
yardstick-0.9.0	lib/yardstick.rb
yardstick-0.8.0	lib/yardstick.rb