yardstick 0.9.6 → 0.9.7

data/lib/yardstick/document_set.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+module Yardstick
+
+  # A set of yardstick documents
+  class DocumentSet < OrderedSet
+
+    # Measure documents using given config
+    #
+    # @return [Yardstick::MeasurementSet]
+    #   a collection of measurements
+    #
+    # @api private
+    def measure(config)
+      each_with_object(MeasurementSet.new) do |document, set|
+        set.merge(Document.measure(document, config))
+      end
+    end
+
+  end
+end

data/lib/yardstick/measurement.rb

@@ -4,48 +4,22 @@ module Yardstick
 
   # A measurement given a constraint on the docs
   class Measurement
-
-    # Return the Measurement description
-    #
-    # @example
-    #   measurement.description  # => "The description"
-    #
-    # @return [String]
-    #   the description
-    #
-    # @api public
-    attr_reader :description
-
-    # Return the method docstring
-    #
-    # @return [YARD::Docstring]
-    #
-    # @api private
-    attr_reader :docstring
-    protected :docstring
-
     # Return a Measurement instance
     #
     # @example
-    #   measurement = Measurement.new('The description', docstring, :successful_method)
-    #
-    # @param [#to_str] description
-    #   the measurement description
-    # @param [YARD::Docstring] docstring
-    #   the docstring to measure
+    #   measurement = Measurement.new(document, rule)
     #
-    # @yield []
-    #   the measurement to perform
+    # @param [Yardstick::Document] document
+    # @param [Yardstick::Rule] rule
     #
     # @return [Yardstick::Measurement]
     #   the measurement instance
     #
     # @api public
-    def initialize(description, docstring, &block)
-      @description = description.to_str
-      @docstring   = docstring
-      @block       = block
-      @result      = measure
+    def initialize(rule)
+      @document = rule.document
+      @rule     = rule
+      @result   = measure
     end
 
     # Return true if the measurement was successful
@@ -80,22 +54,6 @@ module Yardstick
       @result == :skip
     end
 
-    # Return true if the measurement is not implemented
-    #
-    # @example Measurement not implemented
-    #   measurement.todo?  # => true
-    #
-    # @example Measurement implemented
-    #   measurement.todo?  # => false
-    #
-    # @return [Boolean]
-    #   true if the measurement is not implemented, false if not
-    #
-    # @api public
-    def todo?
-      @result == :todo
-    end
-
     # Warns the results the measurement if it was not successful
     #
     # @example
@@ -109,121 +67,36 @@ module Yardstick
     # @api public
     def puts(io = $stdout)
       unless ok?
-        io.puts("#{file}:#{line}: #{path}: #{description}")
+        io.puts("#{@document.file}:#{@document.line}: #{@document.path}: #{description}")
       end
     end
 
-    # Test if Measurement is equal to another measurement
+    # Return the Measurement description
     #
     # @example
-    #   measurement == equal_measurement  # => true
-    #
-    # @param [Yardstick::Measurement] other
-    #   the other Measurement
-    #
-    # @return [Boolean]
-    #   true if the Measurement is equal to the other, false if not
-    #
-    # @api semipublic
-    def eql?(other)
-      other.kind_of?(self.class) &&
-      description.eql?(other.description) &&
-      docstring.eql?(other.docstring)
-    end
-
-    # Return hash identifier for the Measurement
+    #   measurement.description  # => "The description"
     #
-    # @return [Integer]
-    #   the hash identifier
+    # @return [String]
+    #   the description
     #
-    # @api private
-    def hash
-      description.hash ^ docstring.hash
+    # @api public
+    def description
+      @rule.class.description
     end
 
   private
 
-    # Measure the docstring using the method provided to the constructor
+    # Measure the document using the rule provided to the constructor
     #
     # @return [Boolean, Symbol]
     #   true if the test is successful, false if not
-    #   :todo if the test is not implemented
     #   :skip if the test does not apply
     #
     # @api private
     def measure
-      catch :measurement do
-        docstring.instance_eval(&@block)
-      end
-    end
-
-    # The code object for the docstring
-    #
-    # @return [YARD::CodeObjects::Base]
-    #   the code object
-    #
-    # @api private
-    def object
-      docstring.object
-    end
-
-    # The filename for the code
-    #
-    # @return [Pathname]
-    #   the filename
-    #
-    # @api private
-    def file
-      Pathname(object.file)
+      return :skip if !@rule.enabled? || !@rule.validatable?
+      @rule.valid?
     end
 
-    # The line number for the code
-    #
-    # @return [Integer]
-    #   the line number
-    #
-    # @api private
-    def line
-      object.line
-    end
-
-    # The class and method name for the code
-    #
-    # @return [String]
-    #   the class and method name
-    #
-    # @api private
-    def path
-      object.path
-    end
-
-    module UtilityMethods  #:nodoc:
-      private
-
-      # Throw a :skip measurement message to the caller
-      #
-      # This method allows you to short-circuit measurement methods when
-      # the measurement does not apply due to specific object states.
-      #
-      # @return [undefined]
-      #
-      # @api private
-      def skip
-        throw :measurement, :skip
-      end
-
-      # Throw a :todo measurement message to the caller
-      #
-      # This method allows you to short-circuit measurement methods when
-      # the measurement is not implemented.
-      #
-      # @return [undefined]
-      #
-      # @api private
-      def todo
-        throw :measurement, :todo
-      end
-
-    end # module UtilityMethods
   end # class Measurement
 end # module Yardstick

data/lib/yardstick/measurement_set.rb

@@ -85,7 +85,7 @@ module Yardstick
     #
     # @api private
     def puts_summary(io)
-      io.puts("\n#{[ coverage_text, successful_text, failed_text, total_text ].join('  ')}")
+      io.puts("\n#{[coverage_text, successful_text, failed_text, total_text].join('  ')}")
     end
 
     # The text for the coverage percentage to include in the summary
@@ -95,7 +95,7 @@ module Yardstick
     #
     # @api private
     def coverage_text
-      'YARD-Coverage: %.1f%%' % (coverage * 100)
+      'YARD-Coverage: %.1f%%' % Yardstick.round_percentage(coverage * 100)
     end
 
     # The text for the successful measurements to include in the summary

data/lib/yardstick/parser.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+
+module Yardstick
+
+  # Parses files and strings using YARD
+  class Parser
+
+    # Measure files specified in the paths
+    #
+    # @return [Array<Document>]
+    #   a collection of parsed documents
+    #
+    # @api private
+    def self.parse_paths(paths)
+      YARD.parse(paths, [], YARD::Logger::ERROR)
+      documents
+    end
+
+    # Measure string provided
+    #
+    # @param [#to_str] string
+    #   the string to measure
+    #
+    # @return [Array<Document>]
+    #   a collection of parsed documents
+    #
+    # @api private
+    def self.parse_string(string)
+      YARD.parse_string(string.to_str)
+      documents
+    end
+
+    # Coerces method objects into documents
+    #
+    # @return [Yardstick::DocumentSet]
+    #
+    # @api private
+    def self.documents
+      method_objects.each_with_object(DocumentSet.new) do |method_object, set|
+        set << Document.new(method_object.docstring)
+      end
+    end
+    private_class_method :documents
+
+    # Return method objects in YARD registry
+    #
+    # @return [Array<YARD::CodeObjects::MethodObject>]
+    #   a collection of method objects
+    #
+    # @api private
+    def self.method_objects
+      YARD::Registry.all(:method).sort_by do |method_object|
+        [method_object.file, method_object.line]
+      end
+    ensure
+      YARD::Registry.clear
+    end
+    private_class_method :method_objects
+
+  end
+end

data/lib/yardstick/processor.rb

@@ -5,64 +5,50 @@ module Yardstick
   # Handle procesing a docstring or path of files
   class Processor
 
-    # Measure files provided
+    # Initializes new Processor instance
     #
-    # @param [Array<#to_s>, #to_s] path
-    #   the files to measure
+    # @param [Yardstick::Config] config
+    #   a configuration
     #
-    # @return [Yardstick::MeasurementSet]
-    #   a collection of measurements
+    # @return [undefined]
     #
     # @api private
-    def self.process_path(path)
-      YARD.parse(Array(path).map(&:to_s), [], YARD::Logger::ERROR)
-      measurements
+    def initialize(config)
+      @config = config
     end
 
-    # Measure string provided
-    #
-    # @param [#to_str] string
-    #   the string to measure
+    # Measure files specified in the config
     #
     # @return [Yardstick::MeasurementSet]
     #   a collection of measurements
     #
     # @api private
-    def self.process_string(string)
-      YARD.parse_string(string.to_str)
-      measurements
+    def process
+      Parser.parse_paths(paths).measure(@config)
     end
 
-    # Measure method objects in YARD registry
+    # Measure string provided
+    #
+    # @param [#to_str] string
+    #   the string to measure
     #
     # @return [Yardstick::MeasurementSet]
     #   a collection of measurements
     #
     # @api private
-    def self.measurements
-      measurements = MeasurementSet.new
-      method_objects.each do |method_object|
-        measurements.merge(method_object.docstring.measure)
-      end
-      measurements
+    def process_string(string)
+      Parser.parse_string(string).measure(@config)
     end
 
-    # Return method objects in YARD registry
+    private
+
+    # Return config's possible paths
     #
-    # @return [Array<YARD::CodeObjects::MethodObject>]
-    #   a collection of method objects
+    # @return [Array<String>]
     #
     # @api private
-    def self.method_objects
-      YARD::Registry.all(:method).sort_by do |method_object|
-        [ method_object.file, method_object.line ]
-      end
-    ensure
-      YARD::Registry.clear
-    end
-
-    class << self
-      private :measurements, :method_objects
+    def paths
+      Array(@config.path).map(&:to_s)
     end
 
   end # class Processor

data/lib/yardstick/rake/measurement.rb

@@ -12,25 +12,6 @@ module Yardstick
     # A rake task for measuring docs in a set of files
     class Measurement < ::Rake::TaskLib
 
-      # List of paths to measure
-      #
-      # @return [undefined]
-      #
-      # @api public
-      attr_writer :path
-
-      # The path to the file where the measurements will be written
-      #
-      # @param [String, Pathname] output
-      #   optional output path for measurements
-      #
-      # @return [undefined]
-      #
-      # @api public
-      def output=(output)
-        @output = Pathname(output)
-      end
-
       # Initializes a Measurement task
       #
       # @example
@@ -39,23 +20,16 @@ module Yardstick
       # @param [Symbol] name
       #   optional task name
       #
-      # @yield [task]
-      #   yield to self
-      #
-      # @yieldparam [Yardstick::Rake::Measurement] task
-      #   the measurement task
+      # @yieldparam [Yardstick::Config] config
+      #   the config object
       #
       # @return [Yardstick::Rake::Measurement]
       #   the measurement task
       #
       # @api public
-      def initialize(name = :yardstick_measure)
-        @name = name
-        @path = 'lib/**/*.rb'
-
-        self.output = 'measurements/report.txt'
-
-        yield self if block_given?
+      def initialize(name = :yardstick_measure, options = {}, &block)
+        @name   = name
+        @config = Config.coerce(options, &block)
 
         define
       end
@@ -69,7 +43,7 @@ module Yardstick
       #
       # @api public
       def yardstick_measure
-        write_report { |io| Yardstick.measure(@path).puts(io) }
+        @config.output.write { |io| Yardstick.measure(@config).puts(io) }
       end
 
     private
@@ -80,26 +54,10 @@ module Yardstick
       #
       # @api private
       def define
-        desc "Measure docs in #{@path} with yardstick"
+        desc "Measure docs in #{@config.path} with yardstick"
         task(@name) { yardstick_measure }
       end
 
-      # Open up a report for writing
-      #
-      # @yield [io]
-      #   yield to an object that responds to #puts
-      #
-      # @yieldparam [#puts] io
-      #   the object that responds to #puts
-      #
-      # @return [undefined]
-      #
-      # @api private
-      def write_report(&block)
-        @output.dirname.mkpath
-        @output.open('w', &block)
-      end
-
     end # class Measurement
   end # module Rake
 end # module Yardstick