danger-checkstyle_format 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3cb327d641d2806aace612dc184a36b6e37f5237
-  data.tar.gz: '073691ba3631ca7cd762b4496b6b6ab4a6483d71'
+  metadata.gz: 979204d1d5978fbd6d160175238a593c408585d7
+  data.tar.gz: 1c46f43bc1452d88c76775152b07fcca9345cfa3
 SHA512:
-  metadata.gz: 4877e47a3d7772a5f484fea83458ca7417479cee0a8a11081d052a0495730af94c0af786cdc082312b3298aaf9b3dec79b027ff29437571f5e91ede3455daf4a
-  data.tar.gz: b8922e625b420623837a87c9da70f45397b24f2873bdc7e75aa036a5e59869739ca3bfea73e2481715ac31e5c9567cd4522064631e6796023bce4b5e11edd2e9
+  metadata.gz: d679c9d8a9f5c4d52c473705d1203bb21980185340b146e244eb3e0be82041cdc0c1f52a34c5fe3dedbeed6d55279135599aef9af4b85e1e8d550f69a3331669
+  data.tar.gz: 2d3da84229b1764ea7637144d41f3dc36fd0eaa379ba45ae4799c17fb76746e09ecb360e39027fa2e6975c1c5b53b2145c73e83f4204bd1b21623d474573d0c1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-checkstyle_format (0.0.4)
+    danger-checkstyle_format (0.1.0)
       danger-plugin-api (~> 1.0)
       ox (~> 2.0)
 

data/README.md

@@ -16,6 +16,12 @@ checkstyle_format.base_path = Dir.pwd
 checkstyle_format.report 'app/build/reports/checkstyle/checkstyle.xml'</pre>
 </blockquote>
 
+<blockquote>Parse the XML text, and let the plugin do your reporting
+  <pre>
+checkstyle_format.base_path = Dir.pwd
+checkstyle_format.report_by_text '<?xml ...'</pre>
+</blockquote>
+
 ## Development
 
 1. Clone this repo

data/lib/checkstyle_format/gem_version.rb

@@ -1,3 +1,3 @@
 module CheckstyleFormat
-  VERSION = "0.0.4".freeze
+  VERSION = "0.1.0".freeze
 end

data/lib/checkstyle_format/plugin.rb

@@ -8,6 +8,11 @@ module Danger
   #          checkstyle_format.base_path = Dir.pwd
   #          checkstyle_format.report 'app/build/reports/checkstyle/checkstyle.xml'
   #
+  # @example Parse the XML text, and let the plugin do your reporting
+  #
+  #          checkstyle_format.base_path = Dir.pwd
+  #          checkstyle_format.report_by_text '<?xml ...'
+  #
   # @see  noboru-i/danger-checkstyle_format
   # @tags lint, reporting
   #
@@ -18,26 +23,32 @@ module Danger
     attr_accessor :base_path
 
     # Report checkstyle warnings
-    # @return   [void]
     #
+    # @return   [void]
     def report(file, inline_mode = true)
       raise "Please specify file name." if file.empty?
       raise "No checkstyle file was found at #{file}" unless File.exist? file
-      errors = parse(file)
+      errors = parse(File.read(file))
 
-      if inline_mode
-        send_inline_comment(errors)
-      else
-        raise "not implemented." # TODO: not implemented.
-      end
+      send_comment(errors, inline_mode)
+    end
+
+    # Report checkstyle warnings by XML text
+    #
+    # @return   [void]
+    def report_by_text(text, inline_mode = true)
+      raise "Please specify xml text." if text.empty?
+      errors = parse(text)
+
+      send_comment(errors, inline_mode)
     end
 
     private
 
-    def parse(file)
+    def parse(text)
       require "ox"
 
-      doc = Ox.parse(File.read(file))
+      doc = Ox.parse(text)
       present_elements = doc.nodes.first.nodes.reject do |test|
         test.nodes.empty?
       end
@@ -52,6 +63,14 @@ module Danger
       elements
     end
 
+    def send_comment(errors, inline_mode)
+      if inline_mode
+        send_inline_comment(errors)
+      else
+        raise "not implemented." # TODO: not implemented.
+      end
+    end
+
     def send_inline_comment(errors)
       errors.each do |error|
         warn(error.message, file: error.file_name, line: error.line)

data/spec/checkstyle_format_spec.rb

@@ -28,7 +28,7 @@ module Danger
       describe ".parse" do
         subject(:errors) do
           @checkstyle_format.base_path = "/path/to"
-          @checkstyle_format.send(:parse, "spec/fixtures/checkstyle.xml")
+          @checkstyle_format.send(:parse, File.read("spec/fixtures/checkstyle.xml"))
         end
         it "have 4 items" do
           expect(errors.size).to be 4

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-checkstyle_format
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - noboru-i
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-05 00:00:00.000000000 Z
+date: 2017-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api