rubocop-checkstyle_formatter 0.1.1 → 0.5.0

data/gemfiles/rubocop_1.19.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rubocop", "1.19.1"
+
+gemspec path: "../"

data/gemfiles/rubocop_1.19.1.gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: ..
+  specs:
+    rubocop-checkstyle_formatter (0.5.0)
+      rubocop (>= 1.14.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    appraisal (2.4.1)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (1.19.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.10.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    thor (1.1.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 2.4.1)
+  bundler (>= 2.2.10)
+  rake (>= 12.3.3)
+  rspec (~> 3.5.0)
+  rubocop (= 1.19.1)
+  rubocop-checkstyle_formatter!
+
+BUNDLED WITH
+   2.2.25

data/lib/rubocop/formatter/checkstyle_formatter.rb

@@ -1,14 +1,16 @@
 # -*- coding: utf-8 -*-
 require 'rexml/document'
+require 'rubocop/formatter/base_formatter'
 
 # XXX: Renamed to RuboCop since 0.23.0
-RuboCop = Rubocop if defined?(Rubocop) && ! defined?(RuboCop)
+RuboCop = Rubocop if defined?(Rubocop) && !defined?(RuboCop)
 
 module RuboCop
   module Formatter
     # = This formatter reports in Checkstyle format.
     class CheckstyleFormatter < BaseFormatter
-      def started(target_file)
+      include PathUtil if defined?(PathUtil)
+      def started(_target_file)
         @document = REXML::Document.new.tap do |d|
           d << REXML::XMLDecl.new
         end
@@ -17,12 +19,14 @@ module RuboCop
 
       def file_finished(file, offences)
         REXML::Element.new('file', @checkstyle).tap do |f|
-          f.attributes['name'] = file
+          path_name = file
+          path_name = relative_path(path_name) if !ENV.has_key?('RUBOCOP_CHECKSTYLE_FORMATTER_ABSOLUTE_PATH') && defined?(relative_path)
+          f.attributes['name'] = path_name
           add_offences(f, offences)
         end
       end
 
-      def finished(inspected_files)
+      def finished(_inspected_files)
         @document.write(output, 2)
       end
 
@@ -31,15 +35,21 @@ module RuboCop
       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.to_s)
-            e.attributes['message'] = offence.message
-            e.attributes['source'] = 'com.puppycrawl.tools.checkstyle.' + offence.cop_name
+            e.add_attributes(offence_attributes(offence))
           end
         end
       end
 
+      def offence_attributes(offence)
+        {
+          'line' => offence.line,
+          'column' => offence.column,
+          'severity' => to_checkstyle_severity(offence.severity.to_s),
+          'message' => offence.message,
+          'source' => 'com.puppycrawl.tools.checkstyle.' + offence.cop_name
+        }
+      end
+
       # TODO be able to configure severity mapping
       def to_checkstyle_severity(rubocop_severity)
         case rubocop_severity.to_s

data/rubocop-checkstyle_formatter.gemspec

@@ -1,25 +1,27 @@
 # -*- encoding: utf-8 -*-
+
+require 'English'
 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.1.1'
+  gem.version       = '0.5.0'
   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.description   = 'A formatter for rubocop that outputs in checkstyle format'
+  gem.summary       = 'A formatter for rubocop that outputs in checkstyle format'
   gem.homepage      = 'https://github.com/eitoball/rubocop-checkstyle_formatter'
   gem.license       = 'MIT'
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  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.14.0'
-  gem.add_development_dependency 'appraisal', '~> 1.0.0'
-  gem.add_development_dependency 'bundler', '~> 1.3'
-  gem.add_development_dependency 'rake', '~> 10.1'
-  gem.add_development_dependency 'rspec', '~> 2.14.0'
+  gem.add_dependency 'rubocop', '>= 1.14.0'
+  gem.add_development_dependency 'appraisal', '~> 2.4.1'
+  gem.add_development_dependency 'bundler', '>= 2.2.10'
+  gem.add_development_dependency 'rake', '>= 12.3.3'
+  gem.add_development_dependency 'rspec', '~> 3.5.0'
 end

data/spec/rubocop/formatter/checkstyle_formatter_spec.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+
 require 'spec_helper'
 require 'stringio'
 require 'rexml/document'
@@ -6,25 +7,18 @@ require 'rexml/document'
 module RuboCop
   module Formatter
     describe CheckstyleFormatter do
-      let(:severities) { [:refactor, :convention, :warning, :error, :fatal] }
+      let(:severities) { %i[refactor convention warning error fatal] }
       let(:cop) do
         Cop::Cop.new.tap do |c|
+          c.send(:begin_investigation, RuboCop::ProcessedSource.new(file, 2.7, 'sample.rb'))
           source_buffer = Parser::Source::Buffer.new('sample.rb', 1).tap { |b| b.source = '' }
           severities.each_with_index do |severity, index|
-            if c.respond_to?(:add_offense)
-              c.add_offense(nil, Parser::Source::Range.new(source_buffer, 0, index), severity.to_s, severity)
-            else
-              begin
-                c.add_offence(severity, nil, Parser::Source::Range.new(source_buffer, 0, index), severity.to_s)
-              rescue
-                c.add_offence(nil, Parser::Source::Range.new(source_buffer, 0, index), severity.to_s, severity)
-              end
-            end
+            c.add_offense(nil, location: Parser::Source::Range.new(source_buffer, 0, index), message: severity.to_s)
           end
         end
       end
       let(:output) { StringIO.new }
-      let(:file) { 'sample.rb' }
+      let(:file) { File.join(Dir.pwd, 'sample.rb') }
 
       before do
         formatter = described_class.new(output)
@@ -35,14 +29,38 @@ module RuboCop
 
       it 'should convert rubocop severity to checkstyle severity' do
         doc = REXML::Document.new(output.string)
-        REXML::XPath.match(doc, '/checkstyle/file/error').each do |error|
-          message = error.attribute('message').value
-          severity = error.attribute('severity').value
-          case message
-          when 'refactor', 'convention'; expect(severity).to eq('info')
-          when 'warning'; expect(severity).to eq('warning')
-          when 'error', 'fatal'; expect(severity).to eq('error')
+        REXML::XPath.match(doc, '/checkstyle/file').each do |file|
+          if defined?(PathUtil)
+            expect(file.attribute('name').value).to eq('sample.rb')
           end
+          REXML::XPath.match(file, '/error').each do |error|
+            message = error.attribute('message').value
+            severity = error.attribute('severity').value
+            case message
+            when 'refactor', 'convention' then expect(severity).to eq('info')
+            when 'warning' then expect(severity).to eq('warning')
+            when 'error', 'fatal' then expect(severity).to eq('error')
+            end
+          end
+        end
+      end
+
+      context 'RUBOCOP_CHECKSTYLE_FORMATTER_ABSOLUTE_PATH is defined' do
+        around do |example|
+          ENV['RUBOCOP_CHECKSTYLE_FORMATTER_ABSOLUTE_PATH'] = 'true'
+          example.run
+          ENV.delete('RUBOCOP_CHECKSTYLE_FORMATTER_ABSOLUTE_PATH')
+        end
+
+        it 'should use absolute path in name attribute of file tag' do
+          output = StringIO.new
+          formatter = described_class.new(output)
+          formatter.started(file)
+          formatter.file_finished(file, cop.respond_to?(:offenses) ? cop.offenses : cop.offences)
+          formatter.finished([file])
+          doc = REXML::Document.new(output.string)
+          file = REXML::XPath.first(doc, '/checkstyle/file')
+          expect(Pathname.new(file.attributes['name'])).to be_absolute
         end
       end
     end

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w{ .. lib }))
+$LOAD_PATH.unshift(File.absolute_path('../../lib', __FILE__))
 require 'rspec'
 require 'rubocop'
 require 'rubocop/formatter/checkstyle_formatter'

metadata

@@ -1,96 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-checkstyle_formatter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.5.0
 platform: ruby
 authors:
 - Eito Katagiri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-05 00:00:00.000000000 Z
+date: 2021-08-19 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.14.0
+        version: 1.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 1.14.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 2.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 2.4.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: 3.5.0
 description: A formatter for rubocop that outputs in checkstyle format
 email:
 - eitoball@gmail.com
@@ -98,33 +87,27 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".github/workflows/build.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - Appraisals
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- gemfiles/rubocop_0.14.1.gemfile
-- gemfiles/rubocop_0.14.1.gemfile.lock
-- gemfiles/rubocop_0.15.0.gemfile
-- gemfiles/rubocop_0.15.0.gemfile.lock
-- gemfiles/rubocop_0.16.0.gemfile
-- gemfiles/rubocop_0.16.0.gemfile.lock
-- gemfiles/rubocop_0.17.0.gemfile
-- gemfiles/rubocop_0.17.0.gemfile.lock
-- gemfiles/rubocop_0.18.1.gemfile
-- gemfiles/rubocop_0.18.1.gemfile.lock
-- gemfiles/rubocop_0.19.1.gemfile
-- gemfiles/rubocop_0.19.1.gemfile.lock
-- gemfiles/rubocop_0.20.1.gemfile
-- gemfiles/rubocop_0.20.1.gemfile.lock
-- gemfiles/rubocop_0.21.0.gemfile
-- gemfiles/rubocop_0.21.0.gemfile.lock
-- gemfiles/rubocop_0.22.0.gemfile
-- gemfiles/rubocop_0.22.0.gemfile.lock
-- gemfiles/rubocop_0.23.0.gemfile
-- gemfiles/rubocop_0.23.0.gemfile.lock
+- gemfiles/rubocop_1.14.0.gemfile
+- gemfiles/rubocop_1.14.0.gemfile.lock
+- gemfiles/rubocop_1.15.0.gemfile
+- gemfiles/rubocop_1.15.0.gemfile.lock
+- gemfiles/rubocop_1.16.1.gemfile
+- gemfiles/rubocop_1.16.1.gemfile.lock
+- gemfiles/rubocop_1.17.0.gemfile
+- gemfiles/rubocop_1.17.0.gemfile.lock
+- gemfiles/rubocop_1.18.4.gemfile
+- gemfiles/rubocop_1.18.4.gemfile.lock
+- gemfiles/rubocop_1.19.1.gemfile
+- gemfiles/rubocop_1.19.1.gemfile.lock
 - lib/rubocop/formatter/checkstyle_formatter.rb
 - rubocop-checkstyle_formatter.gemspec
 - spec/rubocop/formatter/checkstyle_formatter_spec.rb
@@ -132,33 +115,25 @@ files:
 homepage: https://github.com/eitoball/rubocop-checkstyle_formatter
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3272514483018578912
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3272514483018578912
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 3.2.9
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A formatter for rubocop that outputs in checkstyle format
 test_files:
 - spec/rubocop/formatter/checkstyle_formatter_spec.rb