circleci_reporter 1.0.0

data/lib/circleci_reporter/reporters/base.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require_relative '../report'
+
+module CircleCIReporter
+  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, node_index: 0) 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, node_index: 0) or return '#'
+        artifact.url
+      end
+
+      def configuration
+        CircleCIReporter.configuration
+      end
+
+      # @param json [String]
+      # @return [Float]
+      def parse_json(json)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/circleci_reporter/reporters/flow.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'json'
+
+require_relative '../result'
+require_relative './base'
+
+module CircleCIReporter
+  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

data/lib/circleci_reporter/reporters/link.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative '../result'
+
+module CircleCIReporter
+  module Reporters
+    class Link
+      # @attr name [String]
+      # @attr url [String]
+      # @attr base_url [String, nil]
+      # @attr previous_url [String, nil]
+      LinkReport = Struct.new(:name, :url, :base_url, :previous_url) do
+        # @return [String]
+        def to_s
+          links = []
+          links << "[master](#{base_url})" if base_url
+          links << "[previous](#{previous_url})" if previous_url
+          link = links.empty? ? nil : " (#{links.join(', ')})"
+          "[#{name}](#{url})#{link}"
+        end
+      end
+
+      # @param path [String]
+      # @param name [String]
+      def initialize(path:, name:)
+        @path = path
+        @name = name
+      end
+
+      # @note Implementation for {Base#active?}
+      def active?
+        File.file?(File.join(configuration.artifacts_dir, path))
+      end
+
+      # @note Override {Base#name}
+      attr_reader :name
+
+      # @param base_build [Build, nil]
+      # @param previous_build [Build, nil]
+      # @return [LinkReport]
+      def report(base_build, previous_build)
+        LinkReport.new(name, url, extract_artifact_url(base_build), extract_artifact_url(previous_build))
+      end
+
+      private
+
+      attr_reader :path
+
+      # @return [String]
+      def url
+        [
+          'https://circle-artifacts.com/gh',
+          configuration.project,
+          configuration.current_build_number,
+          'artifacts',
+          "0/#{configuration.artifacts_dir}",
+          path
+        ].join('/')
+      end
+
+      def configuration
+        CircleCIReporter.configuration
+      end
+
+      # @param build [Build, nil]
+      # @return [String, nil]
+      def extract_artifact_url(build)
+        return unless build
+
+        artifact = build.find_artifact(path)
+        artifact ? artifact.url : nil
+      end
+    end
+  end
+end

data/lib/circleci_reporter/reporters/rubycritic.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'json'
+
+require_relative '../result'
+require_relative './base'
+
+module CircleCIReporter
+  module Reporters
+    class RubyCritic < Base
+      DEFAULT_DIR = 'rubycritic'
+      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

data/lib/circleci_reporter/reporters/simplecov.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'json'
+
+require_relative '../result'
+require_relative './base'
+
+module CircleCIReporter
+  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']['line'].to_f
+      end
+    end
+  end
+end

data/lib/circleci_reporter/result.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module CircleCIReporter
+  # @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

data/lib/circleci_reporter/runner.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative 'vcs/github'
+
+module CircleCIReporter
+  class Runner
+    # @return [void]
+    def run
+      reports = reporters.map { |reporter| reporter.report(base_build, previous_build) }
+      vcs_client.create_comment(reports.map(&:to_s).join("\n"))
+    end
+
+    # @return [void]
+    def dump
+      puts <<~RUNNER
+        Runner            | Value
+        ------------------|-----------------------------------------------------------------------------------
+        base_build        | #{base_build.inspect}
+        base_build_number | #{base_build_number.inspect}
+        previous_build    | #{previous_build.inspect}
+      RUNNER
+    end
+
+    private
+
+    # @return [AbstractVCSClient]
+    def vcs_client
+      case configuration.vcs_type
+      when 'github'
+        VCS::GitHub.new(configuration.vcs_token)
+      else
+        raise NotImplementedError
+      end
+    end
+
+    # @return [Build, nil]
+    def base_build
+      @base_build ||= client.single_build(base_build_number)
+    end
+
+    # @return [Build, nil]
+    def previous_build
+      @previous_build ||= client.single_build(previous_build_number)
+    end
+
+    # @return [Client]
+    def client
+      CircleCIReporter.client
+    end
+
+    # @return [Configuration]
+    def configuration
+      CircleCIReporter.configuration
+    end
+
+    # @return [String, nil]
+    def base_revision
+      configuration.base_revision
+    end
+
+    # @return [Integer, nil]
+    def previous_build_number
+      configuration.previous_build_number
+    end
+
+    # @return [Array<AbstractReporter>]
+    def reporters
+      configuration.reporters
+    end
+
+    # @return [Integer, nil]
+    def base_build_number
+      return if configuration.base_revision == configuration.current_revision
+
+      @base_build_number ||= client.build_number_by_revision(base_revision, branch: 'master')
+    end
+  end
+end

data/lib/circleci_reporter/sandbox.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../circleci_reporter'
+require_relative 'client'
+require_relative 'configuration'
+
+module CircleCIReporter
+  # 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_reporter/sandbox` to load it.
+  module Sandbox
+    # Execute a provided block with CircleCIReporter global objects(
+    # configuration, client) reset.
+    #
+    # @yield [Configuration]
+    # @return [void]
+    def self.sandboxed
+      orig_config = CircleCIReporter.configuration
+      orig_client = CircleCIReporter.client
+
+      CircleCIReporter.configuration = Configuration.new
+      CircleCIReporter.client = Client.new
+
+      yield CircleCIReporter.configuration
+    ensure
+      CircleCIReporter.configuration = orig_config
+      CircleCIReporter.client = orig_client
+    end
+  end
+end

data/lib/circleci_reporter/vcs/base.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CircleCIReporter
+  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)
+        raise NotImplementedError
+      end
+
+      private
+
+      attr_reader :token
+    end
+  end
+end