circleci-coverage_reporter 0.5.0 → 0.6.0

data/lib/circleci/coverage_reporter/abstract_build_result.rb

@@ -1,24 +0,0 @@
-require_relative 'abstract_result'
-
-module CircleCI
-  module CoverageReporter
-    class AbstractBuildResult < AbstractResult
-      # @param path [String]
-      # @param build [Build]
-      def initialize(path, build)
-        @path = path
-        @build = build
-      end
-
-      private
-
-      attr_reader :build, :path
-
-      # @param end_with [String]
-      # @return [Artifact]
-      def find_artifact(end_with)
-        build.artifacts.find { |artifact| artifact.end_with?("#{path}/#{end_with}") }
-      end
-    end
-  end
-end

data/lib/circleci/coverage_reporter/abstract_current_result.rb

@@ -1,45 +0,0 @@
-require_relative 'abstract_result'
-
-module CircleCI
-  module CoverageReporter
-    class AbstractCurrentResult < AbstractResult
-      # @param path [String] path to coverage directory
-      def initialize(path)
-        @path = path
-      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,
-          html_file_name
-        ].compact.join('/')
-      end
-
-      private
-
-      attr_reader :path
-
-      # @return [String]
-      def html_file_name
-        raise NotImplementedError
-      end
-
-      # @return
-      def join(name)
-        File.join(configuration.artifacts_dir, path, name)
-      end
-
-      # @return [Configuration]
-      def configuration
-        CoverageReporter.configuration
-      end
-    end
-  end
-end

data/lib/circleci/coverage_reporter/abstract_reporter.rb

@@ -1,56 +0,0 @@
-require_relative 'report'
-
-module CircleCI
-  module CoverageReporter
-    # @abstract Subclass and override {#name}, {#create_build_result} and {#create_current_result}
-    #   to implement a custom Reporter class.
-    class AbstractReporter
-      # @param path [String, nil] relative path from artifacts dir to coverage directory
-      def initialize(path = self.class::DEFAULT_PATH)
-        @path = path
-      end
-
-      # @return [Boolean] whether it is active
-      def active?
-        File.directory?(File.join(configuration.artifacts_dir, path || ''))
-      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: create_build_result(base_build),
-          previous: create_build_result(previous_build)
-        )
-      end
-
-      # @return [String]
-      def name
-        raise NotImplementedError
-      end
-
-      private
-
-      attr_reader :path
-
-      # @param build [Build, nil]
-      # @return [AbstractResult, nil]
-      def create_build_result(build) # rubocop:disable Lint/UnusedMethodArgument
-        raise NotImplementedError
-      end
-
-      # @return [AbstractResult]
-      def create_current_result
-        raise NotImplementedError
-      end
-
-      # @return [Configuration]
-      def configuration
-        CoverageReporter.configuration
-      end
-    end
-  end
-end

data/lib/circleci/coverage_reporter/abstract_result.rb

@@ -1,21 +0,0 @@
-module CircleCI
-  module CoverageReporter
-    # @abstract Subclass and override {#coverage} and {#url} to implement a custom Result class.
-    class AbstractResult
-      # @return [Float]
-      def coverage
-        raise NotImplementedError
-      end
-
-      # @return [String] URL for coverage index.html
-      def url
-        raise NotImplementedError
-      end
-
-      # @return [String]
-      def pretty_coverage
-        "#{coverage.round(2)}%"
-      end
-    end
-  end
-end

data/lib/circleci/coverage_reporter/abstract_vcs_client.rb

@@ -1,21 +0,0 @@
-module CircleCI
-  module CoverageReporter
-    # @abstract Subclass and override {#create_comment} to implement a custom VCS client class.
-    class AbstractVCSClient
-      # @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

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

@@ -1,23 +0,0 @@
-require_relative '../abstract_build_result'
-
-module CircleCI
-  module CoverageReporter
-    module Flow
-      class BuildResult < AbstractBuildResult
-        # @note Implement {AbstractResult#coverage}
-        # @return [Float]
-        def coverage
-          flow_coverage_json = find_artifact('flow-coverage.json') or return Float::NAN
-          JSON.parse(flow_coverage_json.body)['percent'].to_f
-        end
-
-        # @note Implement {AbstractResult#url}
-        # @return [String]
-        def url
-          index_html = find_artifact('index.html') or return '#'
-          index_html.url
-        end
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-require_relative '../abstract_current_result'
-
-module CircleCI
-  module CoverageReporter
-    module Flow
-      class CurrentResult < AbstractCurrentResult
-        # @note Implement {AbstractResult#coverage}
-        # @return [Float]
-        def coverage
-          JSON.parse(File.read(join('flow-coverage.json')))['percent'].to_f
-        end
-
-        private
-
-        # @note Implementation for {AbstractCurrentResult#html_file_name}
-        # @return [String]
-        def html_file_name
-          'index.html'
-        end
-      end
-    end
-  end
-end

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

@@ -1,37 +0,0 @@
-require 'json'
-
-require_relative '../abstract_reporter'
-require_relative 'build_result'
-require_relative 'current_result'
-
-module CircleCI
-  module CoverageReporter
-    module Flow
-      class Reporter < AbstractReporter
-        DEFAULT_PATH = 'flow-coverage'.freeze
-
-        # @note Implement {AbstractReporter#name}
-        # @return [String]
-        def name
-          'Flow'
-        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/github_client.rb

@@ -1,35 +0,0 @@
-require_relative 'abstract_vcs_client'
-require_relative 'errors'
-
-module CircleCI
-  module CoverageReporter
-    class GitHubClient < AbstractVCSClient
-      # @note Implement {AbstractVCSClient#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

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

@@ -1,28 +0,0 @@
-module CircleCI
-  module CoverageReporter
-    module Link
-      class CurrentResult < AbstractCurrentResult
-        # @note Override
-        def initialize(path, html_file_name)
-          @html_file_name = html_file_name
-          super(path)
-        end
-
-        # @note Implement {AbstractResult#coverage}
-        # @return [Float]
-        def coverage
-          Float::NAN
-        end
-
-        # @note Override {AbstractResult#pretty_coverage}
-        def pretty_coverage
-          ''
-        end
-
-        private
-
-        attr_reader :html_file_name
-      end
-    end
-  end
-end

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

@@ -1,35 +0,0 @@
-require_relative 'current_result'
-
-module CircleCI
-  module CoverageReporter
-    module Link
-      class Reporter < AbstractReporter
-        attr_reader :name
-
-        # @param path [String, nil] relative path from artifacts dir to coverage directory
-        # @param file_name [String] file name
-        # @param name [String] reporter name
-        def initialize(path, file_name, name: nil)
-          @path = path
-          @file_name = file_name
-          @name = name || file_name
-        end
-
-        private
-
-        # @note Implement {AbstractReporter#create_build_result}
-        # @param _build [Build, nil]
-        # @return [nil]
-        def create_build_result(_build)
-          nil
-        end
-
-        # @note Implement {AbstractReporter#create_current_result}
-        # @return [CurrentResult]
-        def create_current_result
-          CurrentResult.new(path, @file_name)
-        end
-      end
-    end
-  end
-end

data/lib/circleci/coverage_reporter/reports_renderer.rb

@@ -1,24 +0,0 @@
-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/rubycritic/build_result.rb

@@ -1,23 +0,0 @@
-require_relative '../abstract_build_result'
-
-module CircleCI
-  module CoverageReporter
-    module RubyCritic
-      class BuildResult < AbstractBuildResult
-        # @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
-      end
-    end
-  end
-end

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

@@ -1,29 +0,0 @@
-require_relative '../abstract_current_result'
-
-module CircleCI
-  module CoverageReporter
-    module RubyCritic
-      class CurrentResult < AbstractCurrentResult
-        # @note Implement {AbstractResult#coverage}
-        # @return [Float]
-        def coverage
-          JSON.parse(File.read(join('report.json')))['score'].to_f
-        end
-
-        # @note Override {AbstractResult#pretty_coverage}
-        # @return [String]
-        def pretty_coverage
-          "#{coverage.round(2)}pt"
-        end
-
-        private
-
-        # @note Implementation for {AbstractCurrentResult#html_file_name}
-        # @return [String]
-        def html_file_name
-          'overview.html'
-        end
-      end
-    end
-  end
-end