simplecov-workspace-lcov 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8fa4f329d71f8646aca013f76a0a03f587911ca658482ac6a754eb9e3a7b84c9
+  data.tar.gz: 3c4946dc2354ed51774bc046cc6f38ce103edfdfed33f0e701dabc812cfc43ea
+SHA512:
+  metadata.gz: 743eb2a508e63c6f08653471fdc61e12f03c2a90466b8c95ab81db23cd30ba81907ddc90aa7c74887c46bc15896431eb3640d9e3f660012eff63dcd36ad153d6
+  data.tar.gz: 2678e8b3a3f811ccfb5f89725cb2cdf6d3504a9d8bbc56a0727b43dcf1d1b4ebc3163e932714ce82187d201b2310f9a8d718626ecb41c4508d1d1eacc191b2e5

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 1.17.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mikko.kokkonen@itsmycargo.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in simplecov-workspace-lcov.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Mikko Kokkonen
+
+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,43 @@
+# Simplecov::Workspace::Lcov
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/simplecov/workspace/lcov`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simplecov-workspace-lcov'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simplecov-workspace-lcov
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/simplecov-workspace-lcov. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Simplecov::Workspace::Lcov project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/simplecov-workspace-lcov/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simplecov/workspace/lcov"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/simplecov-workspace-lcov.rb

@@ -0,0 +1,95 @@
+require 'simplecov'
+
+require_relative 'simplecov-workspace-lcov/version'
+require_relative 'simplecov-workspace-lcov/configuration'
+
+module SimpleCov
+  module Formatter
+    class WorkspaceLcovFormatter
+      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 ||= Configuration.new
+
+          yield @config if block_given?
+
+          @config
+        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 root_path
+        self.class.config.workspace_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') do |f|
+          f.write format_file(file)
+        end
+      end
+
+      def write_lcov_to_single_file!(files)
+        File.open(single_report_path, 'w') do |f|
+          files.each { |file| f.write format_file(file) }
+        end
+      end
+
+      def output_filename(filename)
+        filename.gsub("#{SimpleCov.root}/", '').gsub('/', '-')
+          .tap { |name| name << '.lcov' }
+      end
+
+      def format_file(file)
+        filename = file.filename.gsub("#{root_path}/", './')
+        "SF:#{filename}\n#{format_lines(file)}\nend_of_record\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 format_line(line)
+        "DA:#{line.number},#{line.coverage}"
+      end
+    end
+  end
+end

data/lib/simplecov-workspace-lcov/configuration.rb

@@ -0,0 +1,38 @@
+module SimpleCov
+  module Formatter
+    class WorkspaceLcovFormatter
+      class Configuration
+        attr_writer :report_with_single_file
+        attr_writer :workspace_path
+        attr_writer :output_directory
+        attr_writer :lcov_file_name
+
+        def report_with_single_file?
+          !!@report_with_single_file
+        end
+
+        def workspace_path
+          @workspace_path || SimpleCov.root
+        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
+  end
+end
+

data/lib/simplecov-workspace-lcov/version.rb

@@ -0,0 +1,7 @@
+module SimpleCov
+  module Formatter
+    class WorkspaceLcovFormatter
+      VERSION = "0.1.0"
+    end
+  end
+end

data/simplecov-workspace-lcov.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "simplecov-workspace-lcov/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simplecov-workspace-lcov"
+  spec.version       = SimpleCov::Formatter::WorkspaceLcovFormatter::VERSION
+  spec.authors       = ["Mikko Kokkonen"]
+  spec.email         = ["mikko@mikian.com"]
+
+  spec.summary       = %q{SimpleCov formatter to generate a lcov style coverage for workspaces.}
+  spec.description   = %q{SimpleCov formatter to generate a lcov style coverage reports with full
+    workspace support. Allows to run multiple seperate coverage runs inside different directories
+    (engines) while keeping file names relative to workspace root.}
+  spec.homepage      = "https://github.com/mikian/simplecov-workspace-lcov"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: simplecov-workspace-lcov
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mikko Kokkonen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: |-
+  SimpleCov formatter to generate a lcov style coverage reports with full
+      workspace support. Allows to run multiple seperate coverage runs inside different directories
+      (engines) while keeping file names relative to workspace root.
+email:
+- mikko@mikian.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simplecov-workspace-lcov.rb
+- lib/simplecov-workspace-lcov/configuration.rb
+- lib/simplecov-workspace-lcov/version.rb
+- simplecov-workspace-lcov.gemspec
+homepage: https://github.com/mikian/simplecov-workspace-lcov
+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.0.3
+signing_key: 
+specification_version: 4
+summary: SimpleCov formatter to generate a lcov style coverage for workspaces.
+test_files: []