simplecov_lcov_formatter 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 27bad063daa9b20b4d40eb8da0135e518b310c64468c257d92bf85be74e2171e
+  data.tar.gz: 6a5d795e0f71554eecfbefbb120ca3a9c0db6aa25b09696efef8c16e4f4a9b77
+SHA512:
+  metadata.gz: 35333006ab5ed7030231ace40f366729ec931f8f25885949f43aba9c8c6d9c576a3e34ce9da1c2fc979c7f5a58462e18eb4cd121e1d3d619df93b69ba9ac60cd
+  data.tar.gz: 4882623cc22d650145f23fb82ed35420d135e55b81dbb027010f315724826f8a2496adf8052973548e13795194ed5fe9d1a580bf54fed87ac652e5c62ff7fd5a

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 t-mario-y
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# simplecov_lcov_formatter
+
+LCOV formatter for SimpleCov. Successor of [simplecov-lcov](https://github.com/fortissimo1997/simplecov-lcov).
+
+## Usage
+
+Output report per file:
+
+```Ruby
+require 'simplecov'
+require 'simplecov_lcov_formatter'
+SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
+SimpleCov.start
+```
+
+Output report as single file:
+
+```Ruby
+require 'simplecov'
+require 'simplecov_lcov_formatter'
+SimpleCov::Formatter::LcovFormatter.config.report_with_single_file = true
+SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
+SimpleCov.start
+```
+
+Other available configuration options for single file report:
+
+```Ruby
+SimpleCov::Formatter::LcovFormatter.config do |c|
+  c.output_directory = 'your/path' # default: "coverage/lcov"
+  c.lcov_file_name = 'lcov.info' # default: "YOUR_PROJECT_NAME.lcov"
+  c.single_report_path = 'your/path/lcov.info'
+end
+```
+
+## Contributing
+
+TBD

data/lib/simplecov_lcov_formatter/configuration.rb

@@ -0,0 +1,28 @@
+module SimpleCovLcovFormatter
+  class Configuration
+    attr_writer :report_with_single_file
+    attr_writer :output_directory
+    attr_writer :lcov_file_name
+
+    def report_with_single_file?
+      !!@report_with_single_file
+    end
+
+    def output_directory
+      @output_directory || File.join(SimpleCov.coverage_path, 'lcov')
+    end
+
+    def single_report_path=(new_path)
+      self.output_directory = File.dirname(new_path)
+      @single_report_path = new_path
+    end
+
+    def single_report_path
+      @single_report_path || File.join(output_directory, lcov_file_name)
+    end
+
+    def lcov_file_name
+      @lcov_file_name || "#{Pathname.new(SimpleCov.root).basename}.lcov"
+    end
+  end
+end

data/lib/simplecov_lcov_formatter/version.rb

@@ -0,0 +1,3 @@
+module SimpleCovLcovFormatter
+  VERSION = '0.9.0'
+end

data/lib/simplecov_lcov_formatter.rb

@@ -0,0 +1,130 @@
+require 'fileutils'
+require 'pathname'
+require 'simplecov'
+
+require_relative 'simplecov_lcov_formatter/configuration'
+
+module SimpleCov
+  module Formatter
+    # Custom Formatter to generate lcov style coverage for simplecov
+    class LcovFormatter
+      # generate lcov style coverage.
+      # ==== Args
+      # _result_ :: [SimpleCov::Result] abcoverage result instance.
+      def format(result)
+        create_output_directory!
+
+        if report_with_single_file?
+          write_lcov_to_single_file!(result.files)
+        else
+          result.files.each { |file| write_lcov!(file) }
+        end
+
+        puts "Lcov style coverage report generated for #{result.command_name} to #{lcov_results_path}"
+      end
+
+      class << self
+        def config
+          @config ||= SimpleCovLcovFormatter::Configuration.new
+          yield @config if block_given?
+          @config
+        end
+
+        def report_with_single_file=(value)
+          deprecation_message =
+            "#{caller(1..1).first} " \
+              "`#{LcovFormatter}.report_with_single_file=` is deprecated. " \
+              "Use `#{LcovFormatter}.config.report_with_single_file=` instead"
+
+          warn deprecation_message
+          config.report_with_single_file = value
+        end
+      end
+
+      private
+
+      def output_directory
+        self.class.config.output_directory
+      end
+
+      def lcov_results_path
+        report_with_single_file? ? single_report_path : output_directory
+      end
+
+      def report_with_single_file?
+        self.class.config.report_with_single_file?
+      end
+
+      def single_report_path
+        self.class.config.single_report_path
+      end
+
+      def create_output_directory!
+        return if Dir.exist?(output_directory)
+        FileUtils.mkdir_p(output_directory)
+      end
+
+      def write_lcov!(file)
+        File.open(File.join(output_directory, output_filename(file.filename)), 'w') { |f| f.write format_file(file) }
+      end
+
+      def write_lcov_to_single_file!(files)
+        File.open(single_report_path, 'w') { |f| files.each { |file| f.write format_file(file) } }
+      end
+
+      def output_filename(filename)
+        filename.gsub("#{SimpleCov.root}/", '').gsub('/', '-').tap { |name| name << '.lcov' }
+      end
+
+      def format_file(file)
+        filename = file.filename.gsub("#{SimpleCov.root}/", './')
+        pieces = []
+        pieces << "SF:#{filename}"
+        pieces << format_lines(file)
+        pieces << "LF:#{file.lines.filter { |el| el.coverage }.count}"
+        pieces << "LH:#{file.lines.filter { |el| el.coverage && el.coverage > 0 }.count}"
+
+        if SimpleCov.branch_coverage?
+          branch_data = format_branches(file)
+          pieces << branch_data if branch_data.length > 0
+          pieces << "BRF:#{file.total_branches.length}"
+          pieces << "BRH:#{file.covered_branches.length}"
+        end
+        pieces << 'end_of_record'
+        pieces << ''
+        pieces.join("\n")
+      end
+
+      def format_branches(file)
+        branch_idx = 0
+        filtered_branches(file)
+          .map do |branch|
+            branch_idx += 1
+            format_branch(branch, branch_idx)
+          end
+          .join("\n")
+      end
+
+      def format_lines(file)
+        filtered_lines(file).map { |line| format_line(line) }.join("\n")
+      end
+
+      def filtered_lines(file)
+        file.lines.reject(&:never?).reject(&:skipped?)
+      end
+
+      def filtered_branches(file)
+        file.branches.reject(&:skipped?)
+      end
+
+      def format_branch(branch, branch_idx)
+        taken = branch.coverage == 0 ? '-' : branch.coverage
+        "BRDA:#{branch.report_line},0,#{branch_idx},#{taken}"
+      end
+
+      def format_line(line)
+        "DA:#{line.number},#{line.coverage}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: simplecov_lcov_formatter
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- t-mario-y
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: syntax_tree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.18'
+description: LCOV formatter for SimpleCov. Successor of simplecov-lcov.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/simplecov_lcov_formatter.rb
+- lib/simplecov_lcov_formatter/configuration.rb
+- lib/simplecov_lcov_formatter/version.rb
+homepage: https://github.com/t-mario-y/simplecov_lcov_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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: LCOV formatter for SimpleCov. Successor of simplecov-lcov.
+test_files: []