Contents

# -*- coding: utf-8 -*-
require 'rexml/document'

module Rubocop
  module Formatter
    # = This formatter reports in Checkstyle format.
    class CheckstyleFormatter < BaseFormatter
      def started(target_file)
        @document = REXML::Document.new.tap do |d|
          d << REXML::XMLDecl.new
        end
        @checkstyle = REXML::Element.new('checkstyle', @document)
      end

      def file_finished(file, offences)
        REXML::Element.new('file', @checkstyle).tap do |f|
          f.attributes['name'] = file
          add_offences(f, offences)
        end
      end

      def finished(inspected_files)
        @document.write(output, 2)
      end

      private

      def add_offences(parent, offences)
        offences.each do |offence|
          REXML::Element.new('error', parent).tap do |e|
            e.attributes['line'] = offence.line
            e.attributes['column'] = offence.column
            e.attributes['severity'] = to_checkstyle_severity(offence.severity)
            e.attributes['message'] = offence.message
            e.attributes['source'] = offence.cop_name
          end
        end
      end

      # TODO be able to configure severity mapping
      def to_checkstyle_severity(rubocop_severity)
        case rubocop_severity
        when :fatal, :error; 'error'
        when :warning; 'warning'
        when :convention, :refactor; 'info'
        else; 'warning'
        end
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
rubocop-checkstyle_formatter-0.0.4	lib/rubocop/formatter/checkstyle_formatter.rb