findbugs_translate_checkstyle_format 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dec5b39073bfae8407421ca05ec98ac9536ec70f
-  data.tar.gz: 2a5ba5b1d3783659f807c9d54f3d6fdab95b55dd
+  metadata.gz: c7867d159bd387785e12961f0aefc24dcf16b670
+  data.tar.gz: 2b3bae8fab45a7aba5c7eb0522894809fd47b2df
 SHA512:
-  metadata.gz: f13b5356eed10c82ca1ed26f9c462a4b37e565cce4236ac7645bce2212846baacf9adacc1a9be143a0f1437d142665e1dd85ea0658c1aa09b3e6c66ecb5f5615
-  data.tar.gz: e004ec9023b3b8ff31e8579b3c8ad4bf2cdc12ea9e3ffbaa4320bc4e8da0e430d86d7fc2cd2f4750b9680807972e4d55e0cef62f1ae948c039dcbccba232fa8b
+  metadata.gz: 2b8ed8a89965516a156fbf72984aa6858c07a8d5507b53fa46d7c540384afbe1b7159c416ae5e3b97ff3ce82224255cee79bae03c8e4ba94d30c95d986052db3
+  data.tar.gz: 22e0f4709d39530c9d5a3238a750a6e5e88497cbe3e0f90fd715567e9835dd9c9c3c26889d564db30d5f8fbb29f5429507c1088272d7c6aaf843fb839c0c8bb0

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+/samples/

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Metrics/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 30

data/README.md

@@ -1,8 +1,11 @@
 # FindbugsTranslateCheckstyleFormat
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/findbugs_translate_checkstyle_format`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/findbugs_translate_checkstyle_format.svg)](http://badge.fury.io/rb/findbugs_translate_checkstyle_format)
+[![Build Status](https://travis-ci.org/noboru-i/findbugs_translate_checkstyle_format.svg?branch=master)](https://travis-ci.org/noboru-i/findbugs_translate_checkstyle_format)
+[![Code Climate](https://codeclimate.com/github/noboru-i/findbugs_translate_checkstyle_format/badges/gpa.svg)](https://codeclimate.com/github/noboru-i/findbugs_translate_checkstyle_format)
+[![Coverage Status](https://coveralls.io/repos/noboru-i/findbugs_translate_checkstyle_format/badge.svg)](https://coveralls.io/r/noboru-i/findbugs_translate_checkstyle_format)
 
-TODO: Delete this and the text above, and describe your gem
+Translate findbugs format into checkstyle format.
 
 ## Installation
 
@@ -22,7 +25,17 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Use pipe
+
+```
+cat findbugs.xml | findbugs_translate_checkstyle_format translate
+```
+
+### Use command-line option
+
+```
+findbugs_translate_checkstyle_format translate --file="findbugs.xml"
+```
 
 ## Development
 

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "findbugs_translate_checkstyle_format"
+require 'bundler/setup'
+require 'findbugs_translate_checkstyle_format'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "findbugs_translate_checkstyle_format"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/exe/findbugs_translate_checkstyle_format

@@ -3,4 +3,4 @@
 require 'findbugs_translate_checkstyle_format'
 require 'findbugs_translate_checkstyle_format/cli'
 
-FindbugsTranslateCheckstyleFormat::CLI.start
+FindbugsTranslateCheckstyleFormat::CLI.start

data/findbugs_translate_checkstyle_format.gemspec

@@ -4,25 +4,26 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'findbugs_translate_checkstyle_format/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "findbugs_translate_checkstyle_format"
+  spec.name          = 'findbugs_translate_checkstyle_format'
   spec.version       = FindbugsTranslateCheckstyleFormat::VERSION
-  spec.authors       = ["noboru-i"]
-  spec.email         = ["ishikura.noboru@gmail.com"]
+  spec.authors       = ['noboru-i']
+  spec.email         = ['ishikura.noboru@gmail.com']
 
-  spec.summary       = %q{Translate findbugs format into checkstyle format.}
-  spec.description   = %q{Translate findbugs format into checkstyle format.}
-  spec.homepage      = "https://github.com/noboru-i/findbugs_translate_checkstyle_format"
-  spec.license       = "MIT"
+  spec.summary       = 'Translate findbugs format into checkstyle format.'
+  spec.description   = 'Translate findbugs format into checkstyle format.'
+  spec.homepage      = 'https://github.com/noboru-i/findbugs_translate_checkstyle_format'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'thor'
   spec.add_runtime_dependency 'nori'
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'coveralls'
 end

data/lib/findbugs_translate_checkstyle_format/translate.rb

@@ -1,4 +1,5 @@
 require 'nori'
+require 'rexml/document'
 
 module FindbugsTranslateCheckstyleFormat
   module Translate
@@ -9,39 +10,53 @@ module FindbugsTranslateCheckstyleFormat
     end
 
     def trans(xml)
-      require 'rexml/document'
       doc = REXML::Document.new
       doc << REXML::XMLDecl.new('1.0', 'UTF-8')
 
-      checkstyle = doc.add_element("checkstyle")
-      if xml['BugCollection']['BugInstance']
-        bugInstances = xml['BugCollection']['BugInstance'].is_a?(Array) ? xml['BugCollection']['BugInstance'] : [xml['BugCollection']['BugInstance']]
-        bugInstances.each do |bugInstance|
-          file = checkstyle.add_element("file", {
-            'name' => fqcn_to_path(bugInstance['SourceLine']['@classname'], xml)
-            })
-          file.add_element("error", {
-            'line' => bugInstance['SourceLine']['@start'],
-            'severity' => '',
-            'message' => "[#{bugInstance['@category']}] #{bugInstance['LongMessage']}"
-            })
-        end
-      else
-        # create dummy
-        dummy_src_dir = xml['BugCollection']['Project']['SrcDir'].first
-        file = checkstyle.add_element("file", {
-          'name' => dummy_src_dir
-          })
+      checkstyle = doc.add_element('checkstyle')
+      bug_instances = xml['BugCollection']['BugInstance']
+      if bug_instances.blank?
+        FindbugsTranslateCheckstyleFormat::Translate.set_dummy(xml, checkstyle)
+        return doc
+      end
+
+      bug_instances = [bug_instances] if bug_instances.is_a?(Hash)
+      bug_instances.each do |bug_instance|
+        source_line = bug_instance['SourceLine']
+        file = checkstyle.add_element('file',
+                                      'name' => FindbugsTranslateCheckstyleFormat::Translate.fqcn_to_path(source_line['@classname'], xml)
+                                     )
+        file.add_element('error',
+                         'line' => source_line['@start'],
+                         'severity' => 'error',
+                         'message' => FindbugsTranslateCheckstyleFormat::Translate.create_message(bug_instance)
+                        )
       end
 
       doc
     end
 
-    def fqcn_to_path(fqcn, xml)
-      path = fqcn.gsub('.', '/') + '.java'
-      xml['BugCollection']['Project']['SrcDir'].find do |src|
-        src.index(path) != nil
-      end
+    def self.fqcn_to_path(fqcn, xml)
+      path = fqcn.tr('.', '/') + '.java'
+      src_dirs = xml['BugCollection']['Project']['SrcDir']
+      src_dirs = [src_dirs] unless src_dirs.is_a?(Array)
+      src_dirs.find { |src| !src.index(path).nil? }
+    end
+
+    def self.set_dummy(xml, checkstyle)
+      dummy_src_dir = xml['BugCollection']['Project']['SrcDir']
+      dummy_src_dir = dummy_src_dir.first if dummy_src_dir.is_a?(Array)
+
+      checkstyle.add_element('file',
+                             'name' => dummy_src_dir
+                            )
+
+      checkstyle
+    end
+
+    def self.create_message(bug_instance)
+      link = "http://findbugs.sourceforge.net/bugDescriptions.html##{bug_instance['@type']}"
+      "[#{bug_instance['@category']}][#{bug_instance['@type']}] #{bug_instance['LongMessage']}\n#{link}"
     end
   end
 end

data/lib/findbugs_translate_checkstyle_format/version.rb

@@ -1,3 +1,3 @@
 module FindbugsTranslateCheckstyleFormat
-  VERSION = "0.1.6"
+  VERSION = '0.2.0'
 end

data/lib/findbugs_translate_checkstyle_format.rb

@@ -1,5 +1,5 @@
-require "findbugs_translate_checkstyle_format/version"
-require "findbugs_translate_checkstyle_format/translate"
+require 'findbugs_translate_checkstyle_format/version'
+require 'findbugs_translate_checkstyle_format/translate'
 
 module FindbugsTranslateCheckstyleFormat
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: findbugs_translate_checkstyle_format
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - noboru-i
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-12 00:00:00.000000000 Z
+date: 2015-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Translate findbugs format into checkstyle format.
 email:
 - ishikura.noboru@gmail.com
@@ -88,8 +102,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -124,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Translate findbugs format into checkstyle format.