circleci-coverage_reporter 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b4cdc92e39f53cc9d6feca7e80de243b47f373d
-  data.tar.gz: 0d7a2a515139c2d88821453c9452df4b6b5a6abf
+  metadata.gz: f7d215064f144f89d7c7cb0eaf5fc46f6a90c591
+  data.tar.gz: dffd6d1a3c59adff8223915cb69c2075c90c33be
 SHA512:
-  metadata.gz: 985c37b0a460c358fc0f7d3b4e4af999a04654bdef2b45d024c659d927c3d9da827cf403c38ea1096eb35968913db93b8627581008480490018fafd4a0dc2d61
-  data.tar.gz: 820d20ebb038e4c2200dd487508cd990a032ee26bcc615d81544b655c25f87c90c58f0d29eb5785fbc332dbd77852ea7c3e1eaa95bd507d6682cc99ef5b98935
+  metadata.gz: a98704328e56f06af1e9261770406151aaf7bc87ffa86d3ddc0fd4aa310f9c7b3651e1b1b73767c7252244f7bfbc395fdb762f48d55fcce41580f6b3aed0711f
+  data.tar.gz: 238d8434cb7748191201f59da63f20baf77c88bb6b5145c7ad5987b0f40572833eb14d122e164583874e0d4db9507d3e29111b239db9d1a69f25b53c646db722

data/CHANGELOG.md

@@ -6,6 +6,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.4.0] - 2017-03-18
+### Added
+- Support [RubyCritic](https://github.com/whitesmith/rubycritic) score
+- Enable to change score unit
+
+### Changed
+- Round coverage by default
+
+### Fixed
+- Make sure that `#coverage` methods return a `Float` object
+
 ## [0.3.1] - 2017-03-17
 ### Fixed
 - Suppress emoji if base diff is NaN or zero
@@ -22,7 +33,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [0.2.0] - 2017-03-14
 ### Added
-- Support [Flow](flowtype.org) coverage reported by [flow-coverage-report](https://github.com/rpl/flow-coverage-report)
+- Support [Flow](https://flowtype.org) coverage reported by [flow-coverage-report](https://github.com/rpl/flow-coverage-report)
 
 ### Fixed
 - Disable inactive reporters
@@ -45,7 +56,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 - Initial release
 
-[Unreleased]: https://github.com/increments/circleci-coverage_reporter/compare/v0.3.1...HEAD
+[Unreleased]: https://github.com/increments/circleci-coverage_reporter/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/increments/circleci-coverage_reporter/compare/v0.3.1...v0.4.0
 [0.3.1]: https://github.com/increments/circleci-coverage_reporter/compare/v0.3.0...v0.3.1
 [0.3.0]: https://github.com/increments/circleci-coverage_reporter/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/increments/circleci-coverage_reporter/compare/v0.1.3...v0.2.0

data/README.md

@@ -97,6 +97,18 @@ CircleCI::CoverageReporter.configure do |config|
 end
 ```
 
+### RubyCritic
+
+`CircleCI::CoverageReporter::RubyCritic::Reporter` handles code quality files generated by
+[rubycritic](https://github.com/whitesmith/rubycritic)
+
+At least json format report is required:
+
+```bash
+bundle exec rubycritic -p $CIRCLE_ARTIFACTS/rubycritic -f json --no-browser --mode-ci app
+bundle exec rubycritic -p $CIRCLE_ARTIFACTS/rubycritic -f html --no-browser --mode-ci app # optional
+```
+
 ## Configuring
 ### Template
 

data/lib/circleci/coverage_reporter/abstract_result.rb

@@ -11,6 +11,11 @@ module CircleCI
       def url
         raise NotImplementedError
       end
+
+      # @return [String]
+      def pretty_coverage
+        "#{coverage.round(2)}%"
+      end
     end
   end
 end

data/lib/circleci/coverage_reporter/configuration.rb

@@ -1,4 +1,5 @@
 require_relative 'flow/reporter'
+require_relative 'rubycritic/reporter'
 require_relative 'simplecov/reporter'
 
 module CircleCI
@@ -6,7 +7,8 @@ module CircleCI
     class Configuration
       DEFAULT_REPORTERS = [
         SimpleCov::Reporter.new,
-        Flow::Reporter.new
+        Flow::Reporter.new,
+        RubyCritic::Reporter.new
       ].freeze
       DEFAULT_TEMPLATE = <<-'ERB'.freeze
 <%- reports.each do |report| -%>
@@ -18,7 +20,7 @@ module CircleCI
   progresses = [base_progress, branch_progress].compact
   progress = progresses.empty? ? nil : " (#{progresses.join(', ')})"
 -%>
-<%= link %>: <%= report.current_result.coverage %>%<%= emoji %><%= progress %>
+<%= link %>: <%= report.current_result.pretty_coverage %><%= emoji %><%= progress %>
 <%- end -%>
       ERB
       DEFAULT_TEMPLATE_TRIM_MODE = '-'.freeze

data/lib/circleci/coverage_reporter/flow/build_result.rb

@@ -15,7 +15,7 @@ module CircleCI
         # @return [Float]
         def coverage
           flow_coverage_json = find_artifact('flow-coverage.json') or return Float::NAN
-          JSON.parse(flow_coverage_json.body)['percent']
+          JSON.parse(flow_coverage_json.body)['percent'].to_f
         end
 
         # @note Implement {AbstractResult#url}

data/lib/circleci/coverage_reporter/flow/current_result.rb

@@ -12,7 +12,7 @@ module CircleCI
         # @note Implement {AbstractResult#coverage}
         # @return [Float]
         def coverage
-          JSON.parse(File.read(join('flow-coverage.json')))['percent']
+          JSON.parse(File.read(join('flow-coverage.json')))['percent'].to_f
         end
 
         # @note Implement {AbstractResult#url}

data/lib/circleci/coverage_reporter/report.rb

@@ -29,6 +29,11 @@ module CircleCI
         reporter.name
       end
 
+      # @return [String]
+      def pretty_coverage
+        current_result.pretty_coverage
+      end
+
       # @return [Float] coverage percent of the current build result
       def coverage
         current_result.coverage

data/lib/circleci/coverage_reporter/rubycritic/build_result.rb

@@ -0,0 +1,40 @@
+require_relative '../abstract_result'
+
+module CircleCI
+  module CoverageReporter
+    module RubyCritic
+      class BuildResult < AbstractResult
+        # @param path [String]
+        # @param build [Build]
+        def initialize(path, build)
+          @path = path
+          @build = build
+        end
+
+        # @note Implement {AbstractResult#coverage}
+        # @return [Float]
+        def coverage
+          last_run_json = find_artifact('report.json') or return Float::NAN
+          JSON.parse(last_run_json.body)['score'].to_f
+        end
+
+        # @note Implement {AbstractResult#url}
+        # @return [String]
+        def url
+          index_html = find_artifact('overview.html') or return '#'
+          index_html.url
+        end
+
+        private
+
+        attr_reader :build, :path
+
+        # @param end_with [String]
+        # @return [Artifact]
+        def find_artifact(end_with)
+          build.artifacts.find { |a| a.end_with?("#{path}/#{end_with}") }
+        end
+      end
+    end
+  end
+end

data/lib/circleci/coverage_reporter/rubycritic/current_result.rb

@@ -0,0 +1,54 @@
+require_relative '../abstract_result'
+
+module CircleCI
+  module CoverageReporter
+    module RubyCritic
+      class CurrentResult < AbstractResult
+        # @param path [String] path to coverage directory
+        def initialize(path)
+          @path = path
+        end
+
+        # @note Implement {AbstractResult#coverage}
+        # @return [Float]
+        def coverage
+          JSON.parse(File.read(join('report.json')))['score'].to_f
+        end
+
+        # @note Implement {AbstractResult#url}
+        # @return [String]
+        def url
+          [
+            'https://circle-artifacts.com/gh',
+            configuration.project,
+            configuration.current_build_number,
+            'artifacts',
+            "0#{configuration.artifacts_dir}",
+            path,
+            'overview.html'
+          ].join('/')
+        end
+
+        # @note Override {AbstractResult#pretty_coverage}
+        # @return [String]
+        def pretty_coverage
+          "#{coverage.round(2)}pt"
+        end
+
+        private
+
+        attr_reader :path
+
+        # @return
+        def join(name)
+          File.join(configuration.artifacts_dir, path, name)
+        end
+
+        # @return [Configuration]
+        def configuration
+          CoverageReporter.configuration
+        end
+      end
+    end
+  end
+end

data/lib/circleci/coverage_reporter/rubycritic/reporter.rb

@@ -0,0 +1,37 @@
+require 'json'
+
+require_relative '../abstract_reporter'
+require_relative 'build_result'
+require_relative 'current_result'
+
+module CircleCI
+  module CoverageReporter
+    module RubyCritic
+      class Reporter < AbstractReporter
+        DEFAULT_PATH = 'rubycritic'.freeze
+
+        # @note Implement {AbstractReporter#name}
+        # @return [String]
+        def name
+          'RubyCritic'
+        end
+
+        private
+
+        # @note Implement {AbstractReporter#create_build_result}
+        # @param build [Build, nil]
+        # @return [BuildResult, nil]
+        def create_build_result(build)
+          return unless build
+          BuildResult.new(path, build)
+        end
+
+        # @note Implement {AbstractReporter#create_current_result}
+        # @return [CurrentResult]
+        def create_current_result
+          CurrentResult.new(path)
+        end
+      end
+    end
+  end
+end

data/lib/circleci/coverage_reporter/simplecov/build_result.rb

@@ -15,7 +15,7 @@ module CircleCI
         # @return [Float]
         def coverage
           last_run_json = find_artifact('.last_run.json') or return Float::NAN
-          JSON.parse(last_run_json.body)['result']['covered_percent']
+          JSON.parse(last_run_json.body)['result']['covered_percent'].to_f
         end
 
         # @note Implement {AbstractResult#url}

data/lib/circleci/coverage_reporter/simplecov/current_result.rb

@@ -12,7 +12,7 @@ module CircleCI
         # @note Implement {AbstractResult#coverage}
         # @return [Float]
         def coverage
-          JSON.parse(File.read(join('.last_run.json')))['result']['covered_percent']
+          JSON.parse(File.read(join('.last_run.json')))['result']['covered_percent'].to_f
         end
 
         # @note Implement {AbstractResult#url}

data/lib/circleci/coverage_reporter/version.rb

@@ -2,8 +2,8 @@ module CircleCI
   module CoverageReporter
     module Version
       MAJOR = 0
-      MINOR = 3
-      PATCH = 1
+      MINOR = 4
+      PATCH = 0
 
       def self.to_s
         [MAJOR, MINOR, PATCH].join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circleci-coverage_reporter
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Yuku Takahashi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-16 00:00:00.000000000 Z
+date: 2017-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -73,6 +73,9 @@ files:
 - lib/circleci/coverage_reporter/rake_task.rb
 - lib/circleci/coverage_reporter/report.rb
 - lib/circleci/coverage_reporter/reports_renderer.rb
+- lib/circleci/coverage_reporter/rubycritic/build_result.rb
+- lib/circleci/coverage_reporter/rubycritic/current_result.rb
+- lib/circleci/coverage_reporter/rubycritic/reporter.rb
 - lib/circleci/coverage_reporter/runner.rb
 - lib/circleci/coverage_reporter/sandbox.rb
 - lib/circleci/coverage_reporter/simplecov/build_result.rb