danger-findbugs 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffe6bb377073d1c3c12cfd2721783ea1a911d77c
-  data.tar.gz: '04594ed10d6f94484c5b16550e9bd864cec3dc55'
+  metadata.gz: 3046d0b60cb2518acd1e4661142a429b09448266
+  data.tar.gz: 558294bdc689242e984cb9257d72d9dd501f6fc8
 SHA512:
-  metadata.gz: a119ead333921b1d9815c54c304d96e43622551868c12410735a35fc4ce21eb60dad1f62156f85d578c658e05017004d6705b1620cadb72b763c59a16b35917b
-  data.tar.gz: b65b91b1c4625e468131b9c0209e2b3dd498721a243e351ef4d97b4f850fc0c34bfffff30f0693dbdd9a1598513e5f171b04478a3fbba0b3daae06d4ff61411a
+  metadata.gz: 348ba4ae2228a9fe308d54767fa2009450a235d0ef0fcbcb129e7b9004006dd28a02f4e6847a4906ad82312b65ebbacf29c1556a9e4470d09935d5c3bf2af4ec
+  data.tar.gz: cb3887f5cec26254ac4eb1e2972b2cae0c4e4012c168c18ad93a1330364db1bb4ff86c63efecdb7ed3d8076d91a692b85e6f159873c8972d5cf705300cb83202

data/.yardoc/checksums

@@ -0,0 +1,5 @@
+/Users/kazukiyoshida/.ghq/github.com/kazy1991/danger-findbugs/lib/danger_findbugs.rb ed1b710ccaba0d5083ec06a8a878b7845803f9fe
+/Users/kazukiyoshida/.ghq/github.com/kazy1991/danger-findbugs/lib/danger_plugin.rb d17a1cd87e3957d27aeb0555be3444bb8a0b5b80
+/Users/kazukiyoshida/.ghq/github.com/kazy1991/danger-findbugs/lib/findbugs/bug_issue.rb 4027ab9de6bf6007069aaf5796c7a1659f0ac9fe
+/Users/kazukiyoshida/.ghq/github.com/kazy1991/danger-findbugs/lib/findbugs/gem_version.rb f922cd210d6ae8001390f0b9ca965826dc376f22
+/Users/kazukiyoshida/.ghq/github.com/kazy1991/danger-findbugs/lib/findbugs/plugin.rb 2d3abb832db8419fb067b35db47c07e773b0f7de

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-findbugs (0.0.2)
+    danger-findbugs (0.0.3)
       danger-plugin-api (~> 1.0)
       oga (~> 2.10)
 
@@ -21,7 +21,7 @@ GEM
     colored2 (3.1.2)
     cork (0.3.0)
       colored2 (~> 3.1)
-    danger (5.2.0)
+    danger (5.2.1)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)

data/README.md

@@ -1,20 +1,62 @@
-# danger-findbugs
 
-A description of danger-findbugs.
 
-## Installation
+### findbugs
 
-    $ gem install danger-findbugs
+Checks on your gradle project's Java source files.
+This is done using [finbugs](http://findbugs.sourceforge.net/)
+Results are passed out as tables in markdown.
+
+<blockquote>Running Findbugs with its basic configuration
+  <pre>
+findbugs.report</pre>
+</blockquote>
+
+<blockquote>Running Findbugs with a specific gradle task or report_file
+  <pre>
+findbugs.gradle_task = "app:findbugs" #defalut: findbugs
+findbugs.report_file = "app/build/reports/findbugs/findbugs.xml"
+findbugs.report</pre>
+</blockquote>
+
+
+
+#### Attributes
+
+`gradle_module` - Custom gradle module to run.
+This is useful when your project has different flavors.
+Defaults to "app".
+
+`gradle_task` - Custom gradle task to run.
+This is useful when your project has different flavors.
+Defaults to "findbugs".
+
+`report_file` - Location of report file
+If your findbugs task outputs to a different location, you can specify it here.
+Defaults to "build/reports/findbugs_report.xml".
+
+
+
+
+#### Methods
+
+`report` - Calls findbugs task of your gradle project.
+It fails if `gradlew` cannot be found inside current directory.
+It fails if `report_file` cannot be found inside current directory.
+
+`target_files` - A getter for current updated files
+
+`exec_gradle_task` - Run gradle task
+
+`gradlew_exists?` - Check gradlew file exists in current directory
+
+`report_file_exist?` - Check report_file exists in current directory
+
+`findbugs_report` - A getter for `gradle_task`, returning "findbugs" if value is nil.
+
+`bug_issues` - A getter for `gradle_task`, returning "findbugs" if value is nil.
+
+`send_inline_comment` - Send inline comment with danger's warn or fail method
 
-## Usage
 
-    Methods and attributes from this plugin are available in
-    your `Dangerfile` under the `findbugs` namespace.
 
-## Development
 
-1. Clone this repo
-2. Run `bundle install` to setup dependencies.
-3. Run `bundle exec rake spec` to run the tests.
-4. Use `bundle exec guard` to automatically have tests run as you make changes.
-5. Make your changes.

data/lib/findbugs/gem_version.rb

@@ -1,3 +1,3 @@
 module Findbugs
-  VERSION = "0.0.2".freeze
+  VERSION = "0.0.3".freeze
 end

data/lib/findbugs/plugin.rb

@@ -1,15 +1,48 @@
 module Danger
+  # Checks on your gradle project's Java source files.
+  # This is done using [finbugs](http://findbugs.sourceforge.net/)
+  # Results are passed out as tables in markdown.
+  #
+  # @example Running Findbugs with its basic configuration
+  #
+  #          findbugs.report
+  #
+  # @example Running Findbugs with a specific gradle task or report_file
+  #
+  #          findbugs.gradle_task = "app:findbugs" #defalut: findbugs
+  #          findbugs.report_file = "app/build/reports/findbugs/findbugs.xml"
+  #          findbugs.report
+  #
+  # @see kazy1991/danger-findbugs
+  # @tags android, findbugs
+
   class DangerFindbugs < Plugin
-    require 'oga'
     require_relative './bug_issue'
 
+    # Custom gradle module to run.
+    # This is useful when your project has different flavors.
+    # Defaults to "app".
+    # @return [String]
     attr_writer :gradle_module
+    # Custom gradle task to run.
+    # This is useful when your project has different flavors.
+    # Defaults to "findbugs".
+    # @return [String]
     attr_writer :gradle_task
+    # Location of report file
+    # If your findbugs task outputs to a different location, you can specify it here.
+    # Defaults to "build/reports/findbugs_report.xml".
+    # @return [String]
     attr_writer :report_file
 
     GRADLEW_NOT_FOUND = "Could not find `gradlew` inside current directory"
     REPORT_FILE_NOT_FOUND = "Findbugs report not found"
 
+    # Calls findbugs task of your gradle project.
+    # It fails if `gradlew` cannot be found inside current directory.
+    # It fails if `report_file` cannot be found inside current directory.
+    # @return [void]
+    #
     def report
       return fail(GRADLEW_NOT_FOUND) unless gradlew_exists?
       exec_gradle_task
@@ -17,44 +50,66 @@ module Danger
       send_inline_comment
     end
 
+    # A getter for `gradle_module`, returning "app" if value is nil.
+    # @return [String]
     def gradle_module
       @gradle_module ||= 'app'
     end
 
+    # A getter for `gradle_task`, returning "findbugs" if value is nil.
+    # @return [String]
     def gradle_task
       @gradle_task  ||= 'findbugs'
     end
 
+    # A getter for `report_file`, returning "build/reports/findbugs_report.xml" if value is nil.
+    # @return [String]
     def report_file
       @report_file ||= 'build/reports/findbugs_report.xml'
     end
 
+    # A getter for current updated files
+    # @return [Array[String]]
     def target_files
       @target_files ||= (git.modified_files - git.deleted_files) + git.added_files
     end
 
+    # Run gradle task
+    # @return [void]
     def exec_gradle_task
       system "./gradlew #{gradle_task}"
     end
 
+    # Check gradlew file exists in current directory
+    # @return [Bool]
     def gradlew_exists?
       `ls gradlew`.strip.empty? == false
     end
 
+    # Check report_file exists in current directory
+    # @return [Bool]
     def report_file_exist?
       File.exists?(report_file)
     end
 
+    # A getter for `gradle_task`, returning "findbugs" if value is nil.
+    # @return [Oga::XML::Document]
     def findbugs_report
+      require 'oga'
       @findbugs_report ||= Oga.parse_xml(File.open(report_file))
     end
 
+    # A getter for `gradle_task`, returning "findbugs" if value is nil.
+    # @return [Array[BugIssue]]
     def bug_issues
       @bug_issues ||= findbugs_report.xpath("//BugInstance").map do |buginfo|
         BugIssue.new(gradle_module, buginfo)
       end
     end
 
+    # Send inline comment with danger's warn or fail method
+    #
+    # @return [void]
     def send_inline_comment
       bug_issues.each do |issue|
         next unless target_files.include? issue.absolute_path

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-findbugs
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - kazuki-yoshida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-14 00:00:00.000000000 Z
+date: 2017-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -173,6 +173,11 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- ".yardoc/checksums"
+- ".yardoc/complete"
+- ".yardoc/object_types"
+- ".yardoc/objects/root.dat"
+- ".yardoc/proxy_types"
 - Gemfile
 - Gemfile.lock
 - Guardfile