circleci-coverage_reporter 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5184426bc67f4c8e7217a623eb7674643204dbc0
-  data.tar.gz: b060f3721644ebf5d7a0704efbf86a1683923a90
+  metadata.gz: e70ba98da0da373e2022747216c6ebb4f383b9cb
+  data.tar.gz: 379e075fd8a0a361ce4ec08ec3aa74d65d84c024
 SHA512:
-  metadata.gz: 536bc1d1c085a916efffd13a2c95a729a41c4072b5f8cfa80aa3e33909745bf3de4af84b258ce36a0b0e1210a0d0249e496ef8f2f029ff4f2635ad7d9ce63b48
-  data.tar.gz: 5452ccd5386b7a907a0c1ae2c22a31678c250e6a829ee8b36b14fc6eacdf0abb829fb69ab7cc0fc198b032d7ce443a51d5cfa35f7317782347b72d497c8f9fa9
+  metadata.gz: 42b3e6d604b30c7df6fc950464ed002857f859076b5a8b4fba9319f97eb51e4655014d00087a4f91963c2a02622f682787811759cfc8ad1512b9325887b20b46
+  data.tar.gz: d711d87cc5ca74dff09051b3eddaed3b2ccead6c3e77dad3e3016103acd64c2f12c0fd8b0dd567460c1a1a6e526ce2ff49cf88145701396764c91cef52ccbf74

data/.rubocop.yml

@@ -4,6 +4,10 @@ AllCops:
 Metrics/LineLength:
   Max: 125
 
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
 Style/AndOr:
   EnforcedStyle: conditionals
 

data/CHANGELOG.md

@@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.3.0] - 2017-03-16
+### Added
+- Add template configuration
+
+### Changed
+- Remove `CircleCI::CoverageReporter::Client#configuration`
+
+### Fixed
+- Run each example in sandbox
+
 ## [0.2.0] - 2017-03-14
 ### Added
 - Support [Flow](flowtype.org) coverage reported by [flow-coverage-report](https://github.com/rpl/flow-coverage-report)
@@ -21,20 +31,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [0.1.2] - 2017-03-12
 ### Fixed
-
 - Set `nil` to previous_build_number if CIRCLE_PREVIOUS_BUILD_NUM environment variable is empty
 
 ## [0.1.1] - 2017-03-12
 ### Fixed
-
 - Ignore base_build if it is on master branch
 
 ## 0.1.0 - 2017-03-12
 ### Added
-
 - Initial release
 
-[Unreleased]: https://github.com/increments/circleci-coverage_reporter/compare/v0.2.0...HEAD
+[Unreleased]: https://github.com/increments/circleci-coverage_reporter/compare/v0.3.0...HEAD
+[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
 [0.1.3]: https://github.com/increments/circleci-coverage_reporter/compare/v0.1.2...v0.1.3
 [0.1.2]: https://github.com/increments/circleci-coverage_reporter/compare/v0.1.1...v0.1.2

data/README.md

@@ -1,6 +1,7 @@
 # CircleCI::CoverageReporter
 
 [![CircleCI](https://circleci.com/gh/increments/circleci-coverage_reporter.svg?style=svg)](https://circleci.com/gh/increments/circleci-coverage_reporter)
+[![Gem](https://img.shields.io/gem/v/circleci-coverage_reporter.svg)](https://rubygems.org/gems/circleci-coverage_reporter)
 
 **CircleCI::CoverageReporter** reports test coverage to your GitHub repository.
 
@@ -94,6 +95,23 @@ CircleCI::CoverageReporter.configure do |config|
 end
 ```
 
+## Configuring
+### Template
+
+You can change template for comment body in ERB format with `reports` (an array of
+[`Report`](http://www.rubydoc.info/gems/circleci-coverage_reporter/CircleCI/CoverageReporter/Report))
+and `vcs_type` (always `"github"`).
+
+```rb
+CircleCI::CoverageReporter.configure do |config|
+  config.tempalte = <<-'ERB'
+<%- reports.each do |report| -%>
+[<%= report.type %>](<%= report.url %>) <%= report.coverage %>%
+<%- end -%>
+  ERB
+end
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/circleci/coverage_reporter/abstract_reporter.rb

@@ -12,7 +12,7 @@ module CircleCI
 
       # @return [Boolean] whether it is active
       def active?
-        File.directory?(File.join(CoverageReporter.configuration.artifacts_dir, path))
+        File.directory?(File.join(configuration.artifacts_dir, path))
       end
 
       # @param base_build [Build, nil]
@@ -21,7 +21,7 @@ module CircleCI
       def report(base_build, previous_build)
         Report.new(
           self,
-          current: create_current_result,
+          create_current_result,
           base: create_build_result(base_build),
           previous: create_build_result(previous_build)
         )
@@ -47,9 +47,9 @@ module CircleCI
         raise NotImplementedError
       end
 
-      # @return [Client]
-      def client
-        CoverageReporter.client
+      # @return [Configuration]
+      def configuration
+        CoverageReporter.configuration
       end
     end
   end

data/lib/circleci/coverage_reporter/abstract_vcs_client.rb

@@ -7,9 +7,9 @@ module CircleCI
         @token = token
       end
 
-      # @param reports [Array<Report>]
+      # @param body [String]
       # @return [void]
-      def create_comment(reports) # rubocop:disable Lint/UnusedMethodArgument
+      def create_comment(body) # rubocop:disable Lint/UnusedMethodArgument
         raise NotImplementedError
       end
 

data/lib/circleci/coverage_reporter/client.rb

@@ -9,14 +9,6 @@ module CircleCI
     class Client
       CIRCLECI_ENDPOINT = 'https://circleci.com/api/v1.1'.freeze
 
-      # @return [Configuration]
-      attr_reader :configuration
-
-      # @param configuration [Configuration]
-      def initialize(configuration)
-        @configuration = configuration
-      end
-
       # @param build_number [Integer, nil]
       # @return [Build, nil]
       # @raise [RequestError]
@@ -56,6 +48,11 @@ module CircleCI
 
       private
 
+      # @return [Configuration]
+      def configuration
+        CoverageReporter.configuration
+      end
+
       # @param build_number [Integer]
       # @return [String]
       def artifacts_url(build_number)

data/lib/circleci/coverage_reporter/configuration.rb

@@ -8,11 +8,25 @@ module CircleCI
         SimpleCov::Reporter.new,
         Flow::Reporter.new
       ].freeze
+      DEFAULT_TEMPLATE = <<-'ERB'.freeze
+<%- reports.each do |report| -%>
+<%
+  link = "[#{report.reporter.name}](#{report.current_result.url})"
+  emoji = report.base_diff.nil? ? nil : report.base_diff.positive? ? ' :chart_with_upwards_trend:' : ' :chart_with_downwards_trend:'
+  base_progress = report.base_diff ? "[master](#{report.base_result.url}): #{report.pretty_base_diff}" : nil
+  branch_progress = report.branch_diff ? "[previous](#{report.previous_result.url}): #{report.pretty_branch_diff}" : nil
+  progresses = [base_progress, branch_progress].compact
+  progress = progresses.empty? ? nil : " (#{progresses.join(', ')})"
+-%>
+<%= link %>: <%= report.current_result.coverage %>%<%= emoji %><%= progress %>
+<%- end -%>
+      ERB
+      DEFAULT_TEMPLATE_TRIM_MODE = '-'.freeze
       DEFAULT_VCS_TYPE = 'github'.freeze
 
       attr_accessor :circleci_token, :vcs_token
       attr_writer :artifacts_dir, :base_revision, :current_build_number, :current_revision, :previous_build_number,
-                  :reporters, :repository_name, :user_name, :vcs_type
+                  :reporters, :repository_name, :template, :template_safe_mode, :template_safe_mode, :user_name, :vcs_type
 
       # @return [String]
       def project
@@ -59,6 +73,16 @@ module CircleCI
         @repository_name ||= ENV['CIRCLE_PROJECT_REPONAME']
       end
 
+      # @return [String]
+      def template
+        @template ||= DEFAULT_TEMPLATE
+      end
+
+      # @return [String, nil]
+      def template_trim_mode
+        @template_trim_mode ||= DEFAULT_TEMPLATE_TRIM_MODE
+      end
+
       # @return [String]
       def user_name
         @user_name ||= ENV['CIRCLE_PROJECT_USERNAME']

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

@@ -38,9 +38,9 @@ module CircleCI
           File.join(configuration.artifacts_dir, path, name)
         end
 
-        # @return [Client]
+        # @return [Configuration]
         def configuration
-          CoverageReporter.client.configuration
+          CoverageReporter.configuration
         end
       end
     end

data/lib/circleci/coverage_reporter/github_client.rb

@@ -5,31 +5,30 @@ module CircleCI
   module CoverageReporter
     class GitHubClient < AbstractVCSClient
       # @note Implement {AbstractVCSClient#create_comment}
-      # @param reports [Array<Report>]
+      # @param body [String]
       # @return [void]
       # @raise [RequestError]
-      def create_comment(reports)
-        resp = request(reports)
-        body = JSON.parse(resp.body)
-        raise RequestError.new(body['message'], resp) unless resp.success?
+      def create_comment(body)
+        resp = request(body)
+        raise RequestError.new(JSON.parse(resp.body)['message'], resp) unless resp.success?
       end
 
       private
 
-      # @param reports [Array<Report>]
+      # @param body [String]
       # @return [Faraday::Response]
-      def request(reports)
+      def request(body)
         Faraday.new(url: 'https://api.github.com').post do |req|
           req.url ['/repos', configuration.project, 'commits', configuration.current_revision, 'comments'].join('/')
           req.headers['Authorization'] = "token #{token}"
           req.headers['Content-Type'] = 'application/json'
-          req.body = JSON.generate(body: reports.join("\n"))
+          req.body = JSON.generate(body: body)
         end
       end
 
-      # @return [Client]
+      # @return [Configuration]
       def configuration
-        CoverageReporter.client.configuration
+        CoverageReporter.configuration
       end
     end
   end

data/lib/circleci/coverage_reporter/report.rb

@@ -1,70 +1,79 @@
 module CircleCI
   module CoverageReporter
     class Report
+      # @return [AbstractReporter]
+      attr_reader :reporter
+
+      # @return [AbstractResult]
+      attr_reader :current_result
+
+      # @return [AbstractResult, nil]
+      attr_reader :base_result
+
+      # @return [AbstractResult, nil]
+      attr_reader :previous_result
+
       # @param reporter [AbstractReporter]
       # @param current [AbstractResult]
       # @param base [AbstractResult, nil]
       # @param previous [AbstractResult, nil]
-      def initialize(reporter, current:, base:, previous:)
+      def initialize(reporter, current, base: nil, previous: nil)
         @reporter = reporter
         @current_result = current
         @base_result = base
         @previous_result = previous
       end
 
-      # @return [String]
-      def to_s
-        "#{link}: #{current_result.coverage}%#{emoji}#{progress}"
+      # @return [String] coverage reporter name
+      def type
+        reporter.name
       end
 
-      private
-
-      attr_reader :reporter, :current_result, :base_result, :previous_result
+      # @return [Float] coverage percent of the current build result
+      def coverage
+        current_result.coverage
+      end
 
-      # @return [String]
-      def link
-        "[#{reporter.name}](#{current_result.url})"
+      # @return [String] URL for current coverage build result
+      def url
+        current_result.url
       end
 
       # @return [String, nil]
-      def emoji
-        return unless base_result
-        if current_result.coverage < base_result.coverage
-          ' :chart_with_downwards_trend:'
-        elsif current_result.coverage > base_result.coverage
-          ' :chart_with_upwards_trend:'
-        end
+      def pretty_base_diff
+        return unless base_diff
+        pretty_diff(base_diff.round(2))
       end
 
       # @return [String, nil]
-      def progress
-        elements = [base_progress, branch_progress].compact
-        elements.empty? ? nil : " (#{elements.join(', ')})"
+      def pretty_branch_diff
+        return unless branch_diff
+        pretty_diff(branch_diff.round(2))
       end
 
-      # @return [String, nil]
-      def base_progress
+      # @return [Float, nil]
+      def base_diff
         return unless base_result
-        "[master](#{base_result.url}): #{diff(current_result, base_result)}"
+        current_result.coverage - base_result.coverage
       end
 
-      # @return [String, nil]
-      def branch_progress
+      # @return [Float, nil]
+      def branch_diff
         return unless previous_result
-        "[previous](#{previous_result.url}): #{diff(current_result, previous_result)}"
+        current_result.coverage - previous_result.coverage
       end
 
-      # @param after_result [AbstractResult]
-      # @param before_result [AbstractResult]
+      private
+
+      # @param diff [Float]
       # @return [String]
-      def diff(after_result, before_result)
-        value = (after_result.coverage - before_result.coverage).round(2)
-        if value.nan?
+      def pretty_diff(diff)
+        if diff.nan?
           'NaN'
-        elsif value.positive?
-          "+#{value}"
-        elsif value.negative?
-          value.to_s
+        elsif diff.positive?
+          "+#{diff}"
+        elsif diff.negative?
+          diff.to_s
         else
           '±0'
         end

data/lib/circleci/coverage_reporter/reports_renderer.rb

@@ -0,0 +1,24 @@
+require 'erb'
+
+module CircleCI
+  module CoverageReporter
+    class ReportsRenderer
+      # @param reports [Array<Report>]
+      # @return [String]
+      def render(reports)
+        ERB.new(
+          CoverageReporter.configuration.template,
+          nil,
+          CoverageReporter.configuration.template_trim_mode
+        ).result(binding)
+      end
+
+      private
+
+      # @return [String]
+      def vcs_type
+        CoverageReporter.configuration.vcs_type
+      end
+    end
+  end
+end

data/lib/circleci/coverage_reporter/runner.rb

@@ -1,4 +1,5 @@
 require_relative 'github_client'
+require_relative 'reports_renderer'
 
 module CircleCI
   module CoverageReporter
@@ -6,7 +7,7 @@ module CircleCI
       # @return [void]
       def run
         reports = reporters.map { |reporter| reporter.report(base_build, previous_build) }
-        vcs_client.create_comment(reports)
+        vcs_client.create_comment(reports_renderer.render(reports))
       end
 
       # @return [void]
@@ -22,11 +23,16 @@ previous_build    | #{previous_build.inspect}
 
       private
 
+      # @return [ReportsRenderer]
+      def reports_renderer
+        ReportsRenderer.new
+      end
+
       # @return [AbstractVCSClient]
       def vcs_client
-        case client.configuration.vcs_type
+        case configuration.vcs_type
         when 'github'
-          GitHubClient.new(client.configuration.vcs_token)
+          GitHubClient.new(configuration.vcs_token)
         else
           raise NotImplementedError
         end
@@ -47,24 +53,29 @@ previous_build    | #{previous_build.inspect}
         CoverageReporter.client
       end
 
+      # @return [Configuration]
+      def configuration
+        CoverageReporter.configuration
+      end
+
       # @return [String, nil]
       def base_revision
-        client.configuration.base_revision
+        configuration.base_revision
       end
 
       # @return [Integer, nil]
       def previous_build_number
-        client.configuration.previous_build_number
+        configuration.previous_build_number
       end
 
       # @return [Array<AbstractReporter>]
       def reporters
-        client.configuration.reporters
+        configuration.reporters
       end
 
       # @return [Integer, nil]
       def base_build_number
-        return if client.configuration.base_revision == client.configuration.current_revision
+        return if configuration.base_revision == configuration.current_revision
         @base_build_number ||= client.build_number_by_revision(base_revision, branch: 'master')
       end
     end

data/lib/circleci/coverage_reporter/sandbox.rb

@@ -0,0 +1,32 @@
+require_relative '../coverage_reporter'
+require_relative 'client'
+require_relative 'configuration'
+
+module CircleCI
+  module CoverageReporter
+    # A sandbox isolates the enclosed code into an environment that looks 'new'
+    # meaning globally accessed objects are reset for the duration of the sandbox.
+    #
+    # @note This module is not normally available. You must require
+    #   `circleci/coverage_reporter/sandbox` to load it.
+    module Sandbox
+      # Execute a provided block with CircleCI::CoverageReporter global objects(
+      # configuration, client) reset.
+      #
+      # @yield [Configuration]
+      # @return [void]
+      def self.sandboxed
+        orig_config = CoverageReporter.configuration
+        orig_client = CoverageReporter.client
+
+        CoverageReporter.configuration = Configuration.new
+        CoverageReporter.client = Client.new
+
+        yield CoverageReporter.configuration
+      ensure
+        CoverageReporter.configuration = orig_config
+        CoverageReporter.client = orig_client
+      end
+    end
+  end
+end

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

@@ -38,9 +38,9 @@ module CircleCI
           File.join(configuration.artifacts_dir, path, name)
         end
 
-        # @return [Client]
+        # @return [Configuration]
         def configuration
-          CoverageReporter.client.configuration
+          CoverageReporter.configuration
         end
       end
     end

data/lib/circleci/coverage_reporter/version.rb

@@ -2,7 +2,7 @@ module CircleCI
   module CoverageReporter
     module Version
       MAJOR = 0
-      MINOR = 2
+      MINOR = 3
       PATCH = 0
 
       def self.to_s

data/lib/circleci/coverage_reporter.rb

@@ -5,6 +5,12 @@ require_relative 'coverage_reporter/runner'
 
 module CircleCI
   module CoverageReporter
+    class << self
+      # Setters for shared global objects
+      # @api private
+      attr_writer :client, :configuration
+    end
+
     # @return [Configuration]
     def self.configuration
       @configuration ||= Configuration.new
@@ -12,7 +18,7 @@ module CircleCI
 
     # @return [Client]
     def self.client
-      @client ||= Client.new(configuration)
+      @client ||= Client.new
     end
 
     # Yields the global configuration to a block.

metadata

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