circleci-coverage_reporter 0.5.0 → 0.6.0

data/lib/circleci/coverage_reporter/reporters/base.rb

@@ -0,0 +1,119 @@
+require_relative '../report'
+
+module CircleCI
+  module CoverageReporter
+    module Reporters
+      # @abstract Subclass and override {.default_dir}, {.default_html_file_name},
+      #   {.default_json_file_name} and {#parse_json} to implement a custom Reporter class.
+      class Base
+        def self.default_dir
+          raise NotImplementedError
+        end
+
+        def self.default_html_file_name
+          raise NotImplementedError
+        end
+
+        def self.default_json_file_name
+          raise NotImplementedError
+        end
+
+        def initialize(options = {})
+          @options = options
+        end
+
+        # @return [Boolean]
+        def active?
+          File.directory?(File.join(configuration.artifacts_dir, dir))
+        end
+
+        # @param base_build [Build, nil]
+        # @param previous_build [Build, nil]
+        # @return [Report]
+        def report(base_build, previous_build)
+          Report.new(
+            self,
+            create_current_result,
+            base: base_build ? create_build_result(base_build) : nil,
+            previous: previous_build ? create_build_result(previous_build) : nil
+          )
+        end
+
+        # Name of reporter.
+        #
+        # @return [String]
+        def name
+          self.class.name.split('::').last
+        end
+
+        private
+
+        # @return [String]
+        def dir
+          @options[:dir] || self.class.default_dir
+        end
+
+        def html_file_name
+          @options[:html_file_name] || self.class.default_html_file_name
+        end
+
+        def json_file_name
+          @options[:json_file_name] || self.class.default_json_file_name
+        end
+
+        # @param build [Build, nil]
+        # @return [Result, nil]
+        def create_build_result(build)
+          Result.new(build_coverage(build), build_url(build))
+        end
+
+        # @return [AbstractResult]
+        def create_current_result
+          Result.new(current_coverage, current_url)
+        end
+
+        # @return [Float]
+        def current_coverage
+          parse_json(File.read(File.join(configuration.artifacts_dir, dir, json_file_name)))
+        end
+
+        # @return [String]
+        def current_url
+          [
+            'https://circle-artifacts.com/gh',
+            configuration.project,
+            configuration.current_build_number,
+            'artifacts',
+            "0#{configuration.artifacts_dir}",
+            dir,
+            html_file_name
+          ].join('/')
+        end
+
+        # @param build [Build]
+        # @return [Float]
+        def build_coverage(build)
+          artifact = build.find_artifact(json_file_name) or return Float::NAN
+          parse_json(artifact.body)
+        end
+
+        # @param build [Build]
+        # @return [String]
+        def build_url(build)
+          artifact = build.find_artifact(html_file_name) or return '#'
+          artifact.url
+        end
+
+        def configuration
+          CoverageReporter.configuration
+        end
+
+        # @param json [String]
+        # @return [Float]
+        def parse_json(json) # rubocop:disable Lint/UnusedMethodArgument
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+require 'json'
+
+require_relative '../result'
+require_relative './base'
+
+module CircleCI
+  module CoverageReporter
+    module Reporters
+      class Flow < Base
+        def self.default_dir
+          'flow-coverage'
+        end
+
+        def self.default_html_file_name
+          'index.html'
+        end
+
+        def self.default_json_file_name
+          'flow-coverage.json'
+        end
+
+        private
+
+        # @param json [String]
+        # @return [Float]
+        def parse_json(json)
+          JSON.parse(json)['percent'].to_f
+        end
+      end
+    end
+  end
+end

data/lib/circleci/coverage_reporter/reporters/link.rb

@@ -0,0 +1,51 @@
+require_relative '../result'
+
+module CircleCI
+  module CoverageReporter
+    module Reporters
+      class Link
+        LinkReport = Struct.new(:name, :url) do
+          def to_s
+            "[#{name}](#{url})"
+          end
+        end
+
+        def initialize(options = {})
+          @options = options
+        end
+
+        # @note Implementation for {Base#active?}
+        def active?
+          File.file?(File.join(configuration.artifacts_dir, @options[:path]))
+        end
+
+        # @note Override {Base#name}
+        def name
+          @options[:name]
+        end
+
+        def report(_base_build, _previous_build)
+          LinkReport.new(@options[:name], url)
+        end
+
+        private
+
+        # @return [String]
+        def url
+          [
+            'https://circle-artifacts.com/gh',
+            configuration.project,
+            configuration.current_build_number,
+            'artifacts',
+            "0#{configuration.artifacts_dir}",
+            @options[:path]
+          ].join('/')
+        end
+
+        def configuration
+          CoverageReporter.configuration
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+require 'json'
+
+require_relative '../result'
+require_relative './base'
+
+module CircleCI
+  module CoverageReporter
+    module Reporters
+      class RubyCritic < Base
+        DEFAULT_DIR = 'rubycritic'.freeze
+        def self.default_dir
+          'rubycritic'
+        end
+
+        def self.default_html_file_name
+          'overview.html'
+        end
+
+        def self.default_json_file_name
+          'report.json'
+        end
+
+        private
+
+        # @param json [String]
+        # @return [Float]
+        def parse_json(json)
+          JSON.parse(json)['score'].to_f
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+require 'json'
+
+require_relative '../result'
+require_relative './base'
+
+module CircleCI
+  module CoverageReporter
+    module Reporters
+      class SimpleCov < Base
+        def self.default_dir
+          'coverage'
+        end
+
+        def self.default_html_file_name
+          'index.html'
+        end
+
+        def self.default_json_file_name
+          '.last_run.json'
+        end
+
+        private
+
+        # @param json [String]
+        # @return [Float]
+        def parse_json(json)
+          JSON.parse(json)['result']['covered_percent'].to_f
+        end
+      end
+    end
+  end
+end

data/lib/circleci/coverage_reporter/result.rb

@@ -0,0 +1,12 @@
+module CircleCI
+  module CoverageReporter
+    # @attr coverage [Float]
+    # @attr url [String] URL for coverage index.html
+    Result = Struct.new(:coverage, :url) do
+      # @return [String]
+      def pretty_coverage
+        "#{coverage.round(2)}%"
+      end
+    end
+  end
+end

data/lib/circleci/coverage_reporter/runner.rb

@@ -1,5 +1,4 @@
-require_relative 'github_client'
-require_relative 'reports_renderer'
+require_relative 'vcs/github'
 
 module CircleCI
   module CoverageReporter
@@ -7,7 +6,7 @@ module CircleCI
       # @return [void]
       def run
         reports = reporters.map { |reporter| reporter.report(base_build, previous_build) }
-        vcs_client.create_comment(reports_renderer.render(reports))
+        vcs_client.create_comment(reports.map(&:to_s).join("\n"))
       end
 
       # @return [void]
@@ -23,16 +22,11 @@ module CircleCI
 
       private
 
-      # @return [ReportsRenderer]
-      def reports_renderer
-        ReportsRenderer.new
-      end
-
       # @return [AbstractVCSClient]
       def vcs_client
         case configuration.vcs_type
         when 'github'
-          GitHubClient.new(configuration.vcs_token)
+          VCS::GitHub.new(configuration.vcs_token)
         else
           raise NotImplementedError
         end

data/lib/circleci/coverage_reporter/vcs/base.rb

@@ -0,0 +1,23 @@
+module CircleCI
+  module CoverageReporter
+    module VCS
+      # @abstract Subclass and override {#create_comment} to implement a custom VCS client class.
+      class Base
+        # @param token [String]
+        def initialize(token)
+          @token = token
+        end
+
+        # @param body [String]
+        # @return [void]
+        def create_comment(body) # rubocop:disable Lint/UnusedMethodArgument
+          raise NotImplementedError
+        end
+
+        private
+
+        attr_reader :token
+      end
+    end
+  end
+end

data/lib/circleci/coverage_reporter/vcs/github.rb

@@ -0,0 +1,39 @@
+require 'faraday'
+
+require_relative '../errors'
+require_relative 'base'
+
+module CircleCI
+  module CoverageReporter
+    module VCS
+      class GitHub < Base
+        # @note Implement {Base#create_comment}
+        # @param body [String]
+        # @return [void]
+        # @raise [RequestError]
+        def create_comment(body)
+          resp = request(body)
+          raise RequestError.new(JSON.parse(resp.body)['message'], resp) unless resp.success?
+        end
+
+        private
+
+        # @param body [String]
+        # @return [Faraday::Response]
+        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: body)
+          end
+        end
+
+        # @return [Configuration]
+        def configuration
+          CoverageReporter.configuration
+        end
+      end
+    end
+  end
+end

data/lib/circleci/coverage_reporter/version.rb

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

data/lib/circleci/coverage_reporter.rb

@@ -3,10 +3,10 @@ require_relative 'coverage_reporter/configuration'
 require_relative 'coverage_reporter/errors'
 require_relative 'coverage_reporter/runner'
 
-require_relative 'coverage_reporter/flow/reporter'
-require_relative 'coverage_reporter/link/reporter'
-require_relative 'coverage_reporter/rubycritic/reporter'
-require_relative 'coverage_reporter/simplecov/reporter'
+require_relative 'coverage_reporter/reporters/flow'
+require_relative 'coverage_reporter/reporters/link'
+require_relative 'coverage_reporter/reporters/rubycritic'
+require_relative 'coverage_reporter/reporters/simplecov'
 
 module CircleCI
   module CoverageReporter

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circleci-coverage_reporter
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Yuku Takahashi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-18 00:00:00.000000000 Z
+date: 2017-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -55,37 +55,30 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/rspec
+- bin/rubocop
 - bin/setup
+- bin/yard
 - circle.yml
 - circleci-coverage_reporter.gemspec
 - lib/circleci/coverage_reporter.rb
-- lib/circleci/coverage_reporter/abstract_build_result.rb
-- lib/circleci/coverage_reporter/abstract_current_result.rb
-- lib/circleci/coverage_reporter/abstract_reporter.rb
-- lib/circleci/coverage_reporter/abstract_result.rb
-- lib/circleci/coverage_reporter/abstract_vcs_client.rb
 - lib/circleci/coverage_reporter/artifact.rb
 - lib/circleci/coverage_reporter/build.rb
 - lib/circleci/coverage_reporter/client.rb
 - lib/circleci/coverage_reporter/configuration.rb
 - lib/circleci/coverage_reporter/errors.rb
-- lib/circleci/coverage_reporter/flow/build_result.rb
-- lib/circleci/coverage_reporter/flow/current_result.rb
-- lib/circleci/coverage_reporter/flow/reporter.rb
-- lib/circleci/coverage_reporter/github_client.rb
-- lib/circleci/coverage_reporter/link/current_result.rb
-- lib/circleci/coverage_reporter/link/reporter.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/rubycritic/build_result.rb
-- lib/circleci/coverage_reporter/rubycritic/current_result.rb
-- lib/circleci/coverage_reporter/rubycritic/reporter.rb
+- lib/circleci/coverage_reporter/reporters/base.rb
+- lib/circleci/coverage_reporter/reporters/flow.rb
+- lib/circleci/coverage_reporter/reporters/link.rb
+- lib/circleci/coverage_reporter/reporters/rubycritic.rb
+- lib/circleci/coverage_reporter/reporters/simplecov.rb
+- lib/circleci/coverage_reporter/result.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
+- lib/circleci/coverage_reporter/vcs/base.rb
+- lib/circleci/coverage_reporter/vcs/github.rb
 - lib/circleci/coverage_reporter/version.rb
 homepage: https://github.com/increments/circleci-coverage_reporter
 licenses: