rubocop-checkstyle_formatter 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubocop_checkstyle.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Eito Katagiri
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+# Rubocop Checkstyle Formatter
+
+A formatter for rubocop that outputs in checkstyle format.
+It requires rubocop version 0.9.0 or above.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rubocop-checkstyle_formatter', require: false
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubocop-checkstyle_formatter
+
+## Usage
+
+rubocop --require rubocop/formatter/checkstyle_formatter --format Rubocop::Formatter::CheckstyleFormatter
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rubocop/formatter/checkstyle_formatter.rb

@@ -0,0 +1,41 @@
+# -*- 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'] = offence.severity
+            e.attributes['message'] = offence.message
+            e.attributes['source'] = offence.cop_name
+          end
+        end
+      end
+    end
+  end
+end

data/rubocop-checkstyle_formatter.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'rubocop-checkstyle_formatter'
+  gem.version       = '0.0.1'
+  gem.authors       = ['Eito Katagiri']
+  gem.email         = ['eitoball@gmail.com']
+  gem.description   = %q{A formatter for rubocop that outputs in checkstyle format}
+  gem.summary       = %q{A formatter for rubocop that outputs in checkstyle format}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'rubocop', '>= 0.9.0'
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-checkstyle_formatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Eito Katagiri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: A formatter for rubocop that outputs in checkstyle format
+email:
+- eitoball@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rubocop/formatter/checkstyle_formatter.rb
+- rubocop-checkstyle_formatter.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A formatter for rubocop that outputs in checkstyle format
+test_files: []