Contents

require 'colored'
module RakeCheck
  module Checker
    ##
    # YardChecker checks the output for undocumented classes and methods
    class Yard < Base
      def run
        run_command 'yard'
      end

      def short_message
        colored = case percentage
        when 0..80
          "#{percentage}%".red
        when 80..90
          "#{percentage}%".yellow
        when 90..100
          "#{percentage}%".green
        end
        colored + " documented"
      end

      def percentage
        check_output[/(\d+\.\d+)% documented/, 1].to_f
      end

      def success?
        percentage > 80
      end
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
rake_check-0.4.2	lib/rake_check/checker/yard.rb
rake_check-0.4.1	lib/rake_check/checker/yard.rb
rake_check-0.4.0	lib/rake_check/checker/yard.rb
rake_check-0.3.6	lib/rake_check/checker/yard.rb