circleci-coverage_reporter 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7043f473068bec23109876b4e38bf8aca96410f0
-  data.tar.gz: bfeb330edb4de8f150cb1fd4bd0183d33fee6720
+  metadata.gz: 5184426bc67f4c8e7217a623eb7674643204dbc0
+  data.tar.gz: b060f3721644ebf5d7a0704efbf86a1683923a90
 SHA512:
-  metadata.gz: 32ade229dc33219e38c324737c98d8600b70c2bb4a792a486274cd16ccd1e7e0ce1b0ffc886a3251aa4b4a6ac440bed6dcdbad5b8e9d65dd3478e6413550a0f0
-  data.tar.gz: ca44ef9e3ca8faebec5b3510a48bb9142ebac517b66727373445d71e2f96c0d57fac9c4e112827827408e3ffd4d05ec0ba678734b6fbd1fda8546d2332ff04c3
+  metadata.gz: 536bc1d1c085a916efffd13a2c95a729a41c4072b5f8cfa80aa3e33909745bf3de4af84b258ce36a0b0e1210a0d0249e496ef8f2f029ff4f2635ad7d9ce63b48
+  data.tar.gz: 5452ccd5386b7a907a0c1ae2c22a31678c250e6a829ee8b36b14fc6eacdf0abb829fb69ab7cc0fc198b032d7ce443a51d5cfa35f7317782347b72d497c8f9fa9

data/.yardopts

@@ -0,0 +1,4 @@
+--markup markdown
+-
+CHANGELOG.md
+LICENSE.txt

data/CHANGELOG.md

@@ -6,6 +6,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.2.0] - 2017-03-14
+### Added
+- Support [Flow](flowtype.org) coverage reported by [flow-coverage-report](https://github.com/rpl/flow-coverage-report)
+
+### Fixed
+- Disable inactive reporters
+- Fix uninitialized constant `Float::NaN`
+
 ## [0.1.3] - 2017-03-12
 ### Fixed
 - Raise `RequestError` if some API reqeust fails
@@ -26,7 +34,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 - Initial release
 
-[Unreleased]: https://github.com/increments/circleci-coverage_reporter/compare/v0.1.3...HEAD
+[Unreleased]: https://github.com/increments/circleci-coverage_reporter/compare/v0.2.0...HEAD
+[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
 [0.1.1]: https://github.com/increments/circleci-coverage_reporter/compare/v0.1.0...v0.1.1

data/README.md

@@ -34,7 +34,7 @@
     ```yaml
     test:
       post:
-      - bundle exec circleci:report_coverage
+      - bundle exec rake circleci:report_coverage
     ```
 
 ## Run manually
@@ -54,7 +54,7 @@ CircleCI::CoverageReporter.run
 ### SimpleCov
 
 `CircleCI::CoverageReporter::SimpleCov::Reporter` handles coverage files generated by
-[SimpleCov](https://github.com/colszowka/simplecov). It is used by default.
+[SimpleCov](https://github.com/colszowka/simplecov).
 
 It expects that coverage files are located in `$CIRCLE_ARTIFACTS/coverage` directory:
 
@@ -66,11 +66,31 @@ SimpleCov.coverage_dir(File.join(ENV['CIRCLE_ARTIFACTS'], 'coverage')) if ENV['C
 SimpleCov.start
 ```
 
-If you put files in directory, say `$CIRCLE_ARTIFACTS/foo/bar`, you have to set reporter as follows:
+If you put files in another directory, say `$CIRCLE_ARTIFACTS/foo/bar`, you have to set reporter as follows:
 
 ```ruby
 CircleCI::CoverageReporter.configure do |config|
-  config.reporters = [CircleCI::CoverageReporter::SimpleCov::Reporter.new('foo/bar')]
+  config.reporters << CircleCI::CoverageReporter::SimpleCov::Reporter.new('foo/bar')
+end
+```
+
+### Flow
+
+`CircleCI::CoverageReporter::Flow::Reporter` 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`:
+
+```bash
+$(npm bin)/flow-coverage-report -t json -o $CIRCLE_ARTIFACTS/flow-coverage
+```
+
+If you put the file in another path, say `$CIRCLE_ARTIFACTS/foo/bar/flow-coverage.json`,
+you have to set reporter as follows:
+
+```ruby
+CircleCI::CoverageReporter.configure do |config|
+  config.reporters << CircleCI::CoverageReporter::Flow::Reporter.new('foo/bar')
 end
 ```
 

data/lib/circleci/coverage_reporter.rb

@@ -1,5 +1,6 @@
-require_relative 'coverage_reporter/configuration'
 require_relative 'coverage_reporter/client'
+require_relative 'coverage_reporter/configuration'
+require_relative 'coverage_reporter/errors'
 require_relative 'coverage_reporter/runner'
 
 module CircleCI
@@ -23,27 +24,10 @@ module CircleCI
 
     # @return [void]
     def self.run
-      dump
-      Runner.new.run
-    end
-
-    # @return [void]
-    def self.dump # rubocop:disable AbcSize
-      puts <<-EOF
-Configuration         | Value
-----------------------|----------------------------------------------------------------------------
-artifacts_dir         | #{configuration.artifacts_dir.inspect}
-base_revision         | #{configuration.base_revision.inspect}
-circleci_token        | #{configuration.circleci_token[-4..-1].rjust(40, '*').inspect}
-current_build_number  | #{configuration.current_build_number.inspect}
-current_revision      | #{configuration.current_revision.inspect}
-previous_build_number | #{configuration.previous_build_number.inspect}
-reporters             | #{configuration.reporters.inspect}
-repository_name       | #{configuration.repository_name.inspect}
-user_name             | #{configuration.user_name.inspect}
-vcs_token             | #{configuration.vcs_token[-4..-1].rjust(40, '*').inspect}
-vcs_type              | #{configuration.vcs_type.inspect}
-      EOF
+      configuration.reporters.select!(&:active?)
+      configuration.dump
+      raise NoActiveReporter if configuration.reporters.empty?
+      Runner.new.tap(&:dump).run
     end
   end
 end

data/lib/circleci/coverage_reporter/abstract_reporter.rb

@@ -5,6 +5,16 @@ module CircleCI
     # @abstract Subclass and override {#name}, {#create_build_result} and {#create_current_result}
     #   to implement a custom Reporter class.
     class AbstractReporter
+      # @param path [String] 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(CoverageReporter.configuration.artifacts_dir, path))
+      end
+
       # @param base_build [Build, nil]
       # @param previous_build [Build, nil]
       # @return [Report]
@@ -24,6 +34,8 @@ module CircleCI
 
       private
 
+      attr_reader :path
+
       # @param build [Build, nil]
       # @return [AbstractResult, nil]
       def create_build_result(build) # rubocop:disable Lint/UnusedMethodArgument

data/lib/circleci/coverage_reporter/configuration.rb

@@ -1,9 +1,13 @@
+require_relative 'flow/reporter'
 require_relative 'simplecov/reporter'
 
 module CircleCI
   module CoverageReporter
     class Configuration
-      DEFAULT_REPORTERS = [SimpleCov::Reporter.new].freeze
+      DEFAULT_REPORTERS = [
+        SimpleCov::Reporter.new,
+        Flow::Reporter.new
+      ].freeze
       DEFAULT_VCS_TYPE = 'github'.freeze
 
       attr_accessor :circleci_token, :vcs_token
@@ -17,7 +21,7 @@ module CircleCI
 
       # @return [Array<AbstractReporter>]
       def reporters
-        @reporters ||= DEFAULT_REPORTERS
+        @reporters ||= DEFAULT_REPORTERS.dup
       end
 
       # @return [String]
@@ -59,6 +63,25 @@ module CircleCI
       def user_name
         @user_name ||= ENV['CIRCLE_PROJECT_USERNAME']
       end
+
+      # @return [void]
+      def dump # rubocop:disable AbcSize
+        puts <<-EOF
+Configuration         | Value
+----------------------|----------------------------------------------------------------------------
+artifacts_dir         | #{artifacts_dir.inspect}
+base_revision         | #{base_revision.inspect}
+circleci_token        | #{circleci_token[-4..-1].rjust(40, '*').inspect}
+current_build_number  | #{current_build_number.inspect}
+current_revision      | #{current_revision.inspect}
+previous_build_number | #{previous_build_number.inspect}
+reporters             | #{reporters.inspect}
+repository_name       | #{repository_name.inspect}
+user_name             | #{user_name.inspect}
+vcs_token             | #{vcs_token[-4..-1].rjust(40, '*').inspect}
+vcs_type              | #{vcs_type.inspect}
+        EOF
+      end
     end
   end
 end

data/lib/circleci/coverage_reporter/errors.rb

@@ -13,5 +13,7 @@ module CircleCI
         super(message)
       end
     end
+
+    class NoActiveReporter < Error; end
   end
 end

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

@@ -0,0 +1,40 @@
+require_relative '../abstract_result'
+
+module CircleCI
+  module CoverageReporter
+    module Flow
+      class BuildResult < AbstractResult
+        # @param path [String]
+        # @param build [Build]
+        def initialize(path, build)
+          @path = path
+          @build = build
+        end
+
+        # @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']
+        end
+
+        # @note Implement {AbstractResult#url}
+        # @return [String]
+        def url
+          index_html = find_artifact('index.html') or return '#'
+          index_html.url
+        end
+
+        private
+
+        attr_reader :build, :path
+
+        # @param end_with [String]
+        # @return [Artifact]
+        def find_artifact(end_with)
+          build.artifacts.find { |a| a.end_with?("#{path}/#{end_with}") }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+require_relative '../abstract_result'
+
+module CircleCI
+  module CoverageReporter
+    module Flow
+      class CurrentResult < AbstractResult
+        # @param path [String] path to coverage directory
+        def initialize(path)
+          @path = path
+        end
+
+        # @note Implement {AbstractResult#coverage}
+        # @return [Float]
+        def coverage
+          JSON.parse(File.read(join('flow-coverage.json')))['percent']
+        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,
+            'index.html'
+          ].join('/')
+        end
+
+        private
+
+        attr_reader :path
+
+        # @return
+        def join(name)
+          File.join(configuration.artifacts_dir, path, name)
+        end
+
+        # @return [Client]
+        def configuration
+          CoverageReporter.client.configuration
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+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/runner.rb

@@ -5,13 +5,10 @@ module CircleCI
     class Runner
       # @return [void]
       def run
-        dump
         reports = reporters.map { |reporter| reporter.report(base_build, previous_build) }
         vcs_client.create_comment(reports)
       end
 
-      private
-
       # @return [void]
       def dump
         puts <<-EOF
@@ -23,6 +20,8 @@ previous_build    | #{previous_build.inspect}
         EOF
       end
 
+      private
+
       # @return [AbstractVCSClient]
       def vcs_client
         case client.configuration.vcs_type

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

@@ -4,15 +4,17 @@ module CircleCI
   module CoverageReporter
     module SimpleCov
       class BuildResult < AbstractResult
+        # @param path [String]
         # @param build [Build]
-        def initialize(build)
+        def initialize(path, build)
+          @path = path
           @build = build
         end
 
         # @note Implement {AbstractResult#coverage}
         # @return [Float]
         def coverage
-          last_run_json = find_artifact('.last_run.json') or return Float::NaN
+          last_run_json = find_artifact('.last_run.json') or return Float::NAN
           JSON.parse(last_run_json.body)['result']['covered_percent']
         end
 
@@ -25,12 +27,12 @@ module CircleCI
 
         private
 
-        attr_reader :build
+        attr_reader :build, :path
 
         # @param end_with [String]
         # @return [Artifact]
         def find_artifact(end_with)
-          build.artifacts.find { |a| a.end_with?(end_with) }
+          build.artifacts.find { |a| a.end_with?("#{path}/#{end_with}") }
         end
       end
     end

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

@@ -10,11 +10,6 @@ module CircleCI
       class Reporter < AbstractReporter
         DEFAULT_PATH = 'coverage'.freeze
 
-        # @param path [String] relative path from artifacts dir to coverage directory
-        def initialize(path = DEFAULT_PATH)
-          @path = path
-        end
-
         # @note Implement {AbstractReporter#name}
         # @return [String]
         def name
@@ -23,14 +18,12 @@ module CircleCI
 
         private
 
-        attr_reader :path
-
         # @note Implement {AbstractReporter#create_build_result}
         # @param build [Build, nil]
         # @return [BuildResult, nil]
         def create_build_result(build)
           return unless build
-          BuildResult.new(build)
+          BuildResult.new(path, build)
         end
 
         # @note Implement {AbstractReporter#create_current_result}

data/lib/circleci/coverage_reporter/version.rb

@@ -2,8 +2,8 @@ module CircleCI
   module CoverageReporter
     module Version
       MAJOR = 0
-      MINOR = 1
-      PATCH = 3
+      MINOR = 2
+      PATCH = 0
 
       def self.to_s
         [MAJOR, MINOR, PATCH].join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circleci-coverage_reporter
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Yuku Takahashi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-11 00:00:00.000000000 Z
+date: 2017-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -48,6 +48,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -65,6 +66,9 @@ files:
 - 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/rake_task.rb
 - lib/circleci/coverage_reporter/report.rb