simplecov_json_formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b0d112d3b0643b66b0d605539bac724fb29fc39baa66c90d23acecb6ecedab84
+  data.tar.gz: 1d057ce0f5bbfe3f772c2f4174498d652994ad33d537d0975b6a3a23c0c8fbad
+SHA512:
+  metadata.gz: d6941f2c0e5f625da3f3bff5530ecf9c8f4b8ef4234ff9c13604a2410019b6838753218d8e6745ac2552575658e74e52d855dbba1bef39d75604a80afe9e10e6
+  data.tar.gz: e7c14f4dd0ba5fcad9e058fd9c507b8e2ce32303eb91a94908c9d2a3364d48a25a7adb087f0b7b8ea28484f6d4ae708f7a8783bdeb29eaa82884ffe422f08d28

data/README.md

@@ -0,0 +1,28 @@
+# JSON formatter for SimpleCov
+
+***Note: To learn more about SimpleCov, check out the main repo at [https://github.com/simplecov-ruby/simplecov](https://github.com/colszowka/simplecov***)***
+
+Generates a formatted JSON report of your [SimpleCov](https://github.com/simplecov-ruby/simplecov) ruby code coverage results on ruby 2.4+. Originally intended to add `simplecov`'s results reading capacity to CI tools. 
+
+## Overview
+
+You can expect for this gem to produce a `coverage.json` file, located at the `coverage` folder. 
+
+Depending on your `SimpleCoV`'s settings you will experiment different outcomes. Particularly depending on which type of coverage are you running `SimpleCov` with:
+
+- If you configure `SimpleCov` to run with `branch` coverage you should expect an output formatted like [sample_with_branch.json](https://github.com/fede-moya/simplecov_json_formatter/blob/master/spec/fixtures/sample_with_branch.json)
+- Otherwise you should expect an output formatted like [sample.json](https://github.com/fede-moya/simplecov_json_formatter/blob/master/spec/fixtures/sample.json)
+
+## Development
+
+We encourage you to use docker for common operations like running tests, or debugging your code. Running `make sh` will run a new container instance based on the `Dockerfile` provided at root, finally a shell prompt will be displayed on your terminal. Also, syncronization with your local files will be already set. 
+### Tests
+`make test` will trigger the excution of both running tests and running rubocop as linter, by simply running `rake`, this actions will be run inside a new container but using your local files.
+
+### Format
+
+`make format` will run `rubocop -a` which stands for _autocorrect_ and format your code according to the `.rubocop.yml` config file. 
+
+## Copyright
+
+See License ?

data/lib/simplecov_json_formatter.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+require 'simplecov_json_formatter/result_hash_formatter'
+require 'simplecov_json_formatter/result_exporter'
+require 'json'
+
+module SimpleCov
+  module Formatter
+    class JSONFormatter
+      def format(result)
+        result_hash = format_result(result)
+
+        export_formatted_result(result_hash)
+
+        puts output_message(result)
+      end
+
+      private
+
+      def format_result(result)
+        result_hash_formater = SimpleCovJSONFormatter::ResultHashFormatter.new(result)
+        result_hash_formater.format
+      end
+
+      def export_formatted_result(result_hash)
+        result_exporter = SimpleCovJSONFormatter::ResultExporter.new(result_hash)
+        result_exporter.export
+      end
+
+      def output_message(result)
+        "JSON Coverage report generated for #{result.command_name} to #{SimpleCov.coverage_path}. \
+        #{result.covered_lines} / #{result.total_lines} LOC (#{result.covered_percent.round(2)}%) covered."
+      end
+    end
+  end
+end

data/lib/simplecov_json_formatter/result_exporter.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module SimpleCovJSONFormatter
+  class ResultExporter
+    FILENAME = 'coverage.json'
+
+    def initialize(result_hash)
+      @result = result_hash
+    end
+
+    def export
+      File.open(export_path, 'w') do |file|
+        file << json_result
+      end
+    end
+
+    private
+
+    def json_result
+      JSON.pretty_generate(@result)
+    end
+
+    def export_path
+      File.join(SimpleCov.coverage_path, FILENAME)
+    end
+  end
+end

data/lib/simplecov_json_formatter/result_hash_formatter.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'simplecov_json_formatter/source_file_formatter'
+
+module SimpleCovJSONFormatter
+  class ResultHashFormatter
+    def initialize(result)
+      @result = result
+    end
+
+    def format
+      @result.files.each do |source_file|
+        formatted_result[:coverage][source_file.filename] =
+          format_source_file(source_file)
+      end
+
+      formatted_result
+    end
+
+    private
+
+    def formatted_result
+      @formatted_result ||= {
+        meta: {
+          simplecov_version: SimpleCov::VERSION
+        },
+        coverage: {}
+      }
+    end
+
+    def format_source_file(source_file)
+      source_file_formatter = SourceFileFormatter.new(source_file)
+      source_file_formatter.format
+    end
+  end
+end

data/lib/simplecov_json_formatter/source_file_formatter.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module SimpleCovJSONFormatter
+  class SourceFileFormatter
+    def initialize(source_file)
+      @source_file = source_file
+    end
+
+    def format
+      if SimpleCov.branch_coverage?
+        line_coverage.merge(branch_coverage)
+      else
+        line_coverage
+      end
+    end
+
+    private
+
+    def line_coverage
+      @line_coverage || {
+        lines: lines
+      }
+    end
+
+    def branch_coverage
+      {
+        branches: branches
+      }
+    end
+
+    def lines
+      lines = []
+      @source_file.lines.each do |line|
+        lines << parse_line(line)
+      end
+
+      lines
+    end
+
+    def branches
+      branches = []
+      @source_file.branches.each do |branch|
+        branches << parse_branch(branch)
+      end
+
+      branches
+    end
+
+    def parse_line(line)
+      return line.coverage unless line.skipped?
+
+      'ignored'
+    end
+
+    def parse_branch(branch)
+      {
+        type: branch.type,
+        start_line: branch.start_line,
+        end_line: branch.end_line,
+        coverage: parse_line(branch)
+      }
+    end
+  end
+end

data/lib/simplecov_json_formatter/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SimpleCovJSONFormatter
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: simplecov_json_formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Federico Moya
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-08-31 00:00:00.000000000 Z
+dependencies: []
+description: JSON formatter for SimpleCov
+email:
+- federicomoyamartin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/simplecov_json_formatter.rb
+- lib/simplecov_json_formatter/result_exporter.rb
+- lib/simplecov_json_formatter/result_hash_formatter.rb
+- lib/simplecov_json_formatter/source_file_formatter.rb
+- lib/simplecov_json_formatter/version.rb
+homepage: https://github.com/fede-moya/simplecov_json_formatter
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: JSON formatter for SimpleCov
+test_files: []