circleci-coverage_reporter 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b6110a90fbfd7d2fc4c619c19e3fde834e00f47
-  data.tar.gz: a6a18c2bc9e49123deab1ab7b4fada4716005179
+  metadata.gz: a7aca8bd4148d9c5416e8238dea67eb03dbd6f2c
+  data.tar.gz: 693fafae6e3340ce02cad34b682b5dbbc9f00b48
 SHA512:
-  metadata.gz: bd8c11e4303da250ff42dc38f5fa7ed39d4dda60316c2b71d79c385c7b223d8af8ced3afbde6b1f9f6d16c8f67eb3be868b7c1e125a9ed3ce5504e343dc95245
-  data.tar.gz: 9cd3f642aa61f91e7295769c16bea3af2f8809cfedd5204cf5a671c94055aaa60ff3c1e31a9d1feda998454d7a522de91e30cf7b2767521c4a9856eaf38d6a33
+  metadata.gz: 8864275c0508988de280fd1424ffab28075e980c0388eb8a82b741517266d056d0cf9f01822cbdb60d369ba7520eab6a73c2d632ffba9afbe4f6330426edc82a
+  data.tar.gz: 0fa44d79b06c75752d09dfaa4f8b4a7faf177e470bce2bcc2190686b3ea111def27dbc3e7ccdee1bea713eb95b8369a510ee634175fddfdb37be2a6f00c85246

data/.rubocop.yml

@@ -11,6 +11,10 @@ Metrics/BlockLength:
 Style/AndOr:
   EnforcedStyle: conditionals
 
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'spec/**/*.rb'
+
 Style/Documentation:
   Enabled: false
 

data/CHANGELOG.md

@@ -6,6 +6,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.6.0] - 2017-05-30
+### Changed
+- Refactor how to implement reporter. Now a reporter consists of a single ruby class
+
+### Removed
+- Remove template configuration
+
 ## [0.5.0] - 2017-05-18
 ### Added
 - Add Link reporter
@@ -60,7 +67,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 - Initial release
 
-[Unreleased]: https://github.com/increments/circleci-coverage_reporter/compare/v0.5.0...HEAD
+[Unreleased]: https://github.com/increments/circleci-coverage_reporter/compare/v0.6.0...HEAD
+[0.6.0]: https://github.com/increments/circleci-coverage_reporter/compare/v0.5.0...v0.6.0
 [0.5.0]: https://github.com/increments/circleci-coverage_reporter/compare/v0.4.0...v0.5.0
 [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

data/Gemfile

@@ -3,6 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
+  gem 'ffaker', '~> 2.5'
   gem 'rake', '~> 11.0'
   gem 'rspec', '~> 3.5'
   gem 'rspec_junit_formatter', '~> 0.2', require: false

data/README.md

@@ -56,7 +56,7 @@ CircleCI::CoverageReporter.run
 ## Reporters
 ### SimpleCov
 
-`CircleCI::CoverageReporter::SimpleCov::Reporter` handles coverage files generated by
+`CircleCI::CoverageReporter::Reporters::SimpleCovReporter` handles coverage files generated by
 [SimpleCov](https://github.com/colszowka/simplecov).
 
 It expects that coverage files are located in `$CIRCLE_ARTIFACTS/coverage` directory:
@@ -73,13 +73,13 @@ If you put files in another directory, say `$CIRCLE_ARTIFACTS/foo/bar`, you have
 
 ```ruby
 CircleCI::CoverageReporter.configure do |config|
-  config.reporters << CircleCI::CoverageReporter::SimpleCov::Reporter.new('foo/bar')
+  config.reporters << CircleCI::CoverageReporter::Reporters::SimpleCov.new(dir: 'foo/bar')
 end
 ```
 
 ### Flow
 
-`CircleCI::CoverageReporter::Flow::Reporter` handles coverage files generated by
+`CircleCI::CoverageReporter::Reporters::FlowReporter` handles coverage files generated by
 [flow-coverage-report](https://github.com/rpl/flow-coverage-report)
 
 It expects that there is `$CIRCLE_ARTIFACTS/flow-coverage/flow-coverage.json`:
@@ -93,36 +93,27 @@ you have to set reporter as follows:
 
 ```ruby
 CircleCI::CoverageReporter.configure do |config|
-  config.reporters << CircleCI::CoverageReporter::Flow::Reporter.new('foo/bar')
+  config.reporters << CircleCI::CoverageReporter::Reporters::Flow.new(dir: 'foo/bar')
 end
 ```
 
 ### RubyCritic
 
-`CircleCI::CoverageReporter::RubyCritic::Reporter` handles code quality files generated by
+`CircleCI::CoverageReporter::Reporters::RubyCritic` 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
+bundle exec rubycritic -p $CIRCLE_ARTIFACTS/rubycritic -f html --no-browser --mode-ci app
 ```
 
-## Configuring
-### Template
+### Link
 
-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"`).
+`CircleCI::CoverageReporter::Reporters::Link` reports a link to an artifact file.
 
-```rb
+```ruby
 CircleCI::CoverageReporter.configure do |config|
-  config.tempalte = <<-'ERB'
-<%- reports.each do |report| -%>
-[<%= report.type %>](<%= report.url %>) <%= report.coverage %>%
-<%- end -%>
-  ERB
+  config.reporters << CircleCI::CoverateReporter::Reporters::Link.new(path: 'path/to/file', name: 'NAME')
 end
 ```
 

data/Rakefile

@@ -14,7 +14,7 @@ RuboCop::RakeTask.new
 YARD::Rake::YardocTask.new
 
 CircleCI::CoverageReporter.configure do |config|
-  config.reporters << CircleCI::CoverageReporter::Link::Reporter.new('doc', 'index.html', name: 'YARD')
+  config.reporters << CircleCI::CoverageReporter::Reporters::Link.new(path: 'doc/index.html', name: 'YARD')
 end
 
 desc 'Run RubyCritic'

data/bin/rspec

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/rubocop

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

data/bin/yard

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'yard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yard')

data/lib/circleci/coverage_reporter/artifact.rb

@@ -1,13 +1,17 @@
 module CircleCI
   module CoverageReporter
     # Encapsulate a CircleCI artifact
-    Artifact = Struct.new(:path, :pretty_path, :node_index, :url) do
+    #
+    # @attr path [String] abstract path to the artifact in CircleCI container
+    # @attr url [String] URL of the artifact
+    Artifact = Struct.new(:path, :url) do
+      # @param value [String]
       # @return [Boolean]
-      def end_with?(value)
-        pretty_path.end_with?(value)
+      def match?(value)
+        path.end_with?(value)
       end
 
-      # @return [String]
+      # @return [String] content of the artifact
       def body
         @body ||= CoverageReporter.client.get(url).body
       end

data/lib/circleci/coverage_reporter/build.rb

@@ -1,6 +1,9 @@
 module CircleCI
   module CoverageReporter
     # Encapsulate a CircleCI build
+    #
+    # @attr vcs_revision [String] revision of git
+    # @attr build_number [Integer] the ID of the CircleCI build
     Build = Struct.new(:vcs_revision, :build_number) do
       # @param revision [String]
       # @return [Boolean]
@@ -12,6 +15,12 @@ module CircleCI
       def artifacts
         @artifacts ||= CoverageReporter.client.artifacts(build_number)
       end
+
+      # @param string [String]
+      # @return [Artifact, nil]
+      def find_artifact(string)
+        artifacts.find { |artifact| artifact.match?(string) }
+      end
     end
   end
 end

data/lib/circleci/coverage_reporter/client.rb

@@ -6,12 +6,16 @@ require_relative 'errors'
 
 module CircleCI
   module CoverageReporter
+    # CircleCI API client
     class Client
       CIRCLECI_ENDPOINT = 'https://circleci.com/api/v1.1'.freeze
 
+      # Fetch a build data from API and create a {Build} object for it.
+      #
       # @param build_number [Integer, nil]
       # @return [Build, nil]
       # @raise [RequestError]
+      # @see https://circleci.com/docs/api/v1-reference/#build
       def single_build(build_number)
         return unless build_number
         resp = get(single_build_url(build_number))
@@ -20,9 +24,12 @@ module CircleCI
         create_build(body)
       end
 
+      # Retrieve artifacts for the build.
+      #
       # @param build_number [Integer]
       # @return [Array<Artifact>]
       # @raise [RequestError]
+      # @see https://circleci.com/docs/api/v1-reference/#build-artifacts
       def artifacts(build_number)
         resp = get(artifacts_url(build_number))
         body = JSON.parse(resp.body)
@@ -30,6 +37,8 @@ module CircleCI
         body.map(&method(:create_artifact))
       end
 
+      # Find the latest build number for the given vcs revision.
+      #
       # @param revision [String]
       # @param branch [String, nil]
       # @return [Integer, nil]
@@ -38,6 +47,8 @@ module CircleCI
         build ? build.build_number : nil
       end
 
+      # Raw entry point for GET APIs.
+      #
       # @param url [String]
       # @param params [Hash]
       # @return [Faraday::Response]
@@ -54,7 +65,7 @@ module CircleCI
       end
 
       # @param build_number [Integer]
-      # @return [String]
+      # @return [String] URL for "Artifacts of a Bulid API"
       def artifacts_url(build_number)
         [
           CIRCLECI_ENDPOINT,
@@ -104,7 +115,7 @@ module CircleCI
       # @param hash [Hash]
       # @return [Artifact]
       def create_artifact(hash)
-        Artifact.new(hash['path'], hash['pretty_path'], hash['node_index'], hash['url'])
+        Artifact.new(hash['path'], hash['url'])
       end
 
       # @param hash [Hash]

data/lib/circleci/coverage_reporter/configuration.rb

@@ -1,29 +1,15 @@
-require_relative 'flow/reporter'
-require_relative 'rubycritic/reporter'
-require_relative 'simplecov/reporter'
+require_relative 'reporters/flow'
+require_relative 'reporters/rubycritic'
+require_relative 'reporters/simplecov'
 
 module CircleCI
   module CoverageReporter
     class Configuration
       DEFAULT_REPORTERS = [
-        SimpleCov::Reporter.new,
-        Flow::Reporter.new,
-        RubyCritic::Reporter.new
+        Reporters::SimpleCov.new,
+        Reporters::Flow.new,
+        Reporters::RubyCritic.new
       ].freeze
-      DEFAULT_TEMPLATE = <<~'ERB'.freeze
-        <%- reports.each do |report| -%>
-        <%
-          link = "[#{report.reporter.name}](#{report.current_result.url})"
-          emoji = report.base_diff.nil? || report.base_diff.nan? || report.base_diff.round(2).zero? ? 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.pretty_coverage %><%= emoji %><%= progress %>
-        <%- end -%>
-      ERB
-      DEFAULT_TEMPLATE_TRIM_MODE = '-'.freeze
       DEFAULT_VCS_TYPE = 'github'.freeze
 
       attr_accessor :circleci_token, :vcs_token
@@ -35,7 +21,7 @@ module CircleCI
         "#{user_name}/#{repository_name}"
       end
 
-      # @return [Array<AbstractReporter>]
+      # @return [Array<Reporters::Base>]
       def reporters
         @reporters ||= DEFAULT_REPORTERS.dup
       end
@@ -75,16 +61,6 @@ 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/report.rb

@@ -1,22 +1,13 @@
 module CircleCI
   module CoverageReporter
+    # Encapsulate a report created by a reporter.
+    #
+    # @see Reporters::Base#report
     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 [AbstractCurrentResult]
-      # @param base [AbstractBuildResult, nil]
-      # @param previous [AbstractBuildResult, nil]
+      # @param reporter [Reporters::Base] the reporter of the report
+      # @param current [Result]
+      # @param base [Result, nil] result at master branch
+      # @param previous [Result, nil] result at previous build in same branch
       def initialize(reporter, current, base: nil, previous: nil)
         @reporter = reporter
         @current_result = current
@@ -24,24 +15,49 @@ module CircleCI
         @previous_result = previous
       end
 
-      # @return [String] coverage reporter name
-      def type
-        reporter.name
+      # @return [String]
+      def to_s
+        "#{link}: #{current_result.pretty_coverage}#{emoji}#{progress}"
+      end
+
+      private
+
+      attr_reader :reporter, :current_result, :base_result, :previous_result
+
+      # @return [String]
+      def link
+        "[#{reporter.name}](#{current_result.url})"
+      end
+
+      # @return [String]
+      def emoji
+        if base_diff.nil? || base_diff.nan? || base_diff.round(2).zero?
+          ''
+        elsif base_diff.positive?
+          ':chart_with_upwards_trend:'
+        else
+          ':chart_with_downwards_trend:'
+        end
       end
 
       # @return [String]
-      def pretty_coverage
-        current_result.pretty_coverage
+      def progress
+        progresses.empty? ? '' : "(#{progresses.join(', ')})"
       end
 
-      # @return [Float] coverage percent of the current build result
-      def coverage
-        current_result.coverage
+      # @return [Array<String>]
+      def progresses
+        [base_progress, branch_progress].compact
       end
 
-      # @return [String] URL for current coverage build result
-      def url
-        current_result.url
+      # @return [String, nil]
+      def base_progress
+        base_diff ? "[master](#{base_result.url}): #{pretty_base_diff}" : nil
+      end
+
+      # @return [String, nil]
+      def branch_progress
+        branch_diff ? "[previous](#{previous_result.url}): #{pretty_branch_diff}" : nil
       end
 
       # @return [String, nil]
@@ -68,8 +84,6 @@ module CircleCI
         current_result.coverage - previous_result.coverage
       end
 
-      private
-
       # @param diff [Float]
       # @return [String]
       def pretty_diff(diff)