ruby_branch_coverage 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3b0478d4bc19f46bbd4f43cc6657ba9cdcbf5f8ac53fb370bf949956c4601377
+  data.tar.gz: 4cb88e0c0c437f7794d578b451b9132c5dd736614d2fd1d75b51c4cba91b792e
+SHA512:
+  metadata.gz: 166bfbba86784a2b6b400e229d8bd612eb7e60c948af715829043da15d2c7e28003560b09ebd5c024ac8df9bdb493cb421a0f9513047299a29cc54fd6a25a2ec
+  data.tar.gz: bf3484f97dcf07e39dae7fa1b0e92c78bfead69c1137ad0025ea41e252a96eb3261f4653faa9f455fe3da6f73604208909af6e043d62b475209a29a3e103b9ad

data/.circleci/config.yml

@@ -0,0 +1,58 @@
+version: 2.1
+
+common: &common
+  working_directory: ~/workspace
+  parallelism: 1
+  resource_class: small
+  steps:
+    - checkout
+    - restore_cache:
+        keys:
+          - bundle-v1-{{ checksum "ruby_branch_coverage.gemspec" }}
+
+    - run:
+        name: Build gem dependencies
+        command: |
+          gem install bundler
+          bundle lock
+          bundle config --local path '.bundle'
+          bundle check || bundle install --jobs 4
+          bundle clean
+
+    - save_cache:
+        key: bundle-v1-{{ checksum "ruby_branch_coverage.gemspec" }}
+        paths:
+          - .bundle
+
+    - run:
+        name: Run tests
+        command: |
+          mkdir coverage
+          bundle exec rspec
+
+jobs:
+  test_3_2:
+    docker:
+      - image: cimg/ruby:3.2
+    <<: *common
+
+  upload_coveralls:
+    working_directory: ~/workspace
+    docker:
+      - image: cimg/ruby:3.2
+    steps:
+      - attach_workspace:
+          at: ~/workspace
+      - run:
+          name: Run upload coveralls
+          command: |
+            curl -k https://coveralls.io/webhook?repo_token=$COVERALLS_REPO_TOKEN -d "payload[build_num]=$CIRCLE_BUILD_NUM&payload[status]=done"
+
+workflows:
+  version: 2
+  build-and-test:
+    jobs:
+      - test_3_2
+      - upload_coveralls:
+          requires:
+            - test_3_2

data/.github/workflows/lint.yml

@@ -0,0 +1,41 @@
+name: Lint
+
+on: [pull_request]
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  rubocop:
+    name: runner / rubocop
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
+      - uses: ruby/setup-ruby@c4e5b1316158f92e3d49443a9d58b31d25ac0f8f # v1.306.0
+      - name: rubocop
+        uses: reviewdog/action-rubocop@b6d5e953a5fc0bf3ab65254e77730ea2174d6d6d # v2.22.0
+        with:
+          rubocop_version: gemfile
+          rubocop_extensions: rubocop-rspec:gemfile rubocop-checkstyle_formatter:gemfile rubocop-thread_safety:gemfile
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          fail_on_error: true
+          reporter: github-pr-review
+
+  brakeman:
+    name: runner / brakeman
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@c4e5b1316158f92e3d49443a9d58b31d25ac0f8f # v1.306.0
+      - name: brakeman
+        uses: reviewdog/action-brakeman@5083efd49634e26645a0736681b618ccc3fb7f14 # v2.19.2
+        with:
+          brakeman_version: gemfile
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          fail_on_error: true
+          reporter: github-pr-review
+          brakeman_flags: '--force'

data/.github/workflows/publish_gem.yml

@@ -0,0 +1,30 @@
+name: Publish gem to github private registry
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - lib/ruby_branch_coverage/version.rb
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 2
+    steps:
+      - uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2.7.0
+      - name: Tag with the gem version
+        run: |
+          GEM_VERSION=$(ruby -e "require 'rubygems'; gemspec = Dir.glob(\"./**/*.gemspec\").first; puts Gem::Specification::load(gemspec).version")
+          TAG="v$GEM_VERSION"
+          git tag $TAG && git push origin $TAG
+      - name: Set up github private registry key
+        run: |
+          mkdir -p ~/.gem
+          touch ~/.gem/credentials
+          chmod 600 ~/.gem/credentials
+          echo ":github: Bearer ${{ secrets.GITHUB_TOKEN }}" >> ~/.gem/credentials
+      - name: build and push gem
+        run: |
+          gem build *.gemspec
+          gem push --key github --host https://rubygems.pkg.github.com/moneyforward ./*.gem

data/.gitignore

@@ -0,0 +1,68 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/spec/dummy/coverage/
+/spec/dummy/coverage_results/
+/spec/dummy/db/*.sqlite3
+/spec/dummy/public/packs-test/
+/spec/dummy/tmp/
+/spec/dummy/log/
+/spec/dummy/lib/
+/spec/dummy/node_modules/
+/spec/dummy/storage/
+/spec/dummy/vendor/
+/spec/dummy/.rspec
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/.idea/
+Gemfile.lock
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--exclude-pattern "spec/dummy/**/*_spec.rb"

data/.rubocop.yml

@@ -0,0 +1,20 @@
+require:
+  - rubocop-rspec
+  - rubocop-thread_safety
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - 'bin/*'
+    - 'script/**/*'
+    - 'vendor/**/*'
+    - 'spec/**/*'
+    - 'tmp/**/*'
+    - '**/Rakefile'
+    - '**/Gemfile'
+    - '*.gemspec'
+    - 'node_modules/**/*'
+  CacheRootDirectory: tmp/cache/rubocop
+  EnforcedStyle/compact:
+    Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+4.0.4

data/Gemfile

@@ -0,0 +1,21 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem 'rspec'      # testing framework
+  gem 'simplecov', require: false
+  gem 'json'
+  gem 'simplecov_json_formatter'
+  gem 'builder'
+  gem 'rubocop', require: false
+  gem 'rubocop-checkstyle_formatter', require: false
+  gem 'rubocop-rspec', require: false
+  gem 'rubocop-thread_safety'
+  gem 'brakeman'
+  gem 'coveralls_reborn', '~> 0.27.0', require: false
+end
+
+group :development do
+  gem 'sqlite3'
+end

data/README.md

@@ -0,0 +1,39 @@
+# branchcov-xmlruby-sonar
+
+
+[![Coverage Status](https://coveralls.io/repos/github/moneyforwardvietnam/branchcov-xmlruby-sonar/badge.svg?branch=main&t=v4X7VE)](https://coveralls.io/github/moneyforwardvietnam/branchcov-xmlruby-sonar?branch=main)
+
+下記をアプリ側の`spec_helper`に追加して使用してください
+
+```ruby
+SimpleCov.start 'rails' do
+  enable_coverage :branch
+
+  add_filter '/spec/'
+  add_filter '/config/'
+  add_filter '/db/'
+  add_filter '/vendor/'
+
+  add_group 'Decorators', 'app/decorators'
+  add_group 'Forms', 'app/forms'
+  add_group 'Services', 'app/services'
+  add_group 'ViewObjects', 'app/view_objects'
+  add_group 'Batches', 'app/batches'
+
+  merge_timeout 3600
+end
+```
+
+`simplecov.rake`を動かす際には、下記のようにディレクトリを作成してコピーする必要があります
+```ruby
+# example of circleci/.config
+
+- run:
+  name: Stash coverage results
+  command: |
+    mkdir coverage_results
+    cp -R coverage/.resultset.json coverage_results/.resultset-${CIRCLE_NODE_INDEX}.json || exit 0
+```
+
+### Kibela page
+Check [this](https://moneyforward.kibe.la/notes/265405#circleci-using-gem) document for more configuration

data/Rakefile

@@ -0,0 +1,17 @@
+# require "bundler/setup"
+
+# APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+# load "rails/tasks/engine.rake"
+
+# load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+# require "rake/testtask"
+
+# Rake.add_rakelib 'lib/tasks'
+
+# # add rspec rake task
+# require 'rspec/core/rake_task'
+# RSpec::Core::RakeTask.new(:spec)
+# task default: :spec

data/bin/rails

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/branchcov/xmlruby/sonar/engine', __dir__)
+APP_PATH = File.expand_path('../spec/dummy/config/application', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "rails/all"
+require "rails/engine/commands"

data/lib/ruby_branch_coverage/engine.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require "rails"
+
+# rubocop:disable Style/Documentation
+class RubyBranchCoverage
+  class Engine < ::Rails::Engine
+    isolate_namespace RubyBranchCoverage
+  end
+end
+# rubocop:enable Style/Documentation

data/lib/ruby_branch_coverage/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class RubyBranchCoverage
+  VERSION = '1.0.0'
+end

data/lib/ruby_branch_coverage.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'builder'
+require_relative 'ruby_branch_coverage/version'
+require_relative 'ruby_branch_coverage/engine'
+# Convert JSON to XML for branch coverage
+class RubyBranchCoverage
+  def read_json_and_getxml(filepath, parallelism_count = 0, parallelism_processors = 0)
+    file = File.read(filepath)
+    data_hash = JSON.parse(file)
+
+    file_elements = if parallelism_count != 0 || parallelism_processors != 0
+                      extract_file_elements_using_parallelism_args(data_hash, parallelism_count, parallelism_processors)
+                    else
+                      extract_file_elements(data_hash)
+                    end
+
+    create_xml(file_elements)
+    file_elements.size.positive?
+  end
+
+  private
+
+  def extract_file_elements_using_parallelism_args(data_hash, parallelism_count, parallelism_processors)
+    warn 'parallelism_count and parallelism_processors as argument will deprecate.'
+    rspec_key = find_rspec_key(parallelism_count, parallelism_processors)
+
+    return [] if data_hash.empty? || data_hash[rspec_key].nil? || data_hash[rspec_key]['coverage'].nil?
+
+    create_file_elements(data_hash[rspec_key]['coverage'])
+  end
+
+  def extract_file_elements(data_hash)
+    raise 'No coverage data found in the JSON file' if valid_coverage_hash?(data_hash)
+
+    file_elements = []
+    data_hash.each do |_key, value|
+      file_elements.concat(create_file_elements(value['coverage'])) if value.key?('coverage')
+    end
+    file_elements
+  end
+
+  def find_rspec_key(parallelism, parallelism_processors)
+    if parallelism_processors.positive?
+      # when parallelism is 4 and parallelism processor is 4
+      # (1/4), (1/4), (1/4), (1/4), (2/4), (2/4), (2/4), (2/4), (3/4), (3/4), (3/4), (3/4), (4/4), (4/4), (4/4), (4/4)
+      parallelism.times.map do |i|
+        parallelism_processors.times.map do |_j|
+          "(#{i + 1}/#{parallelism})"
+        end.join(', ') # (x/4), (x/4), (x/4), (x/4)
+      end.join(', ')
+    else
+      # when parallelism is 4 and parallelism processor is 0
+      # Rspec, RSpec, RSpec, RSpec
+      parallelism.times.map { |_i| 'RSpec' }.join(', ')
+    end
+  end
+
+  def valid_coverage_hash?(data_hash)
+    data_hash.empty? || data_hash.values.none? { |v| v.is_a?(Hash) && v.key?('coverage') }
+  end
+
+  def create_file_elements(coverage_block_by_key)
+    file_elements = []
+    coverage_block_by_key.each do |filename, value|
+      branches = value['branches']
+
+      next if branches.nil? || branches.keys.empty?
+
+      file_element = { path: filename, lineElements: line_to_cover_array(branches) }
+      file_elements.push(file_element)
+    end
+
+    file_elements
+  end
+
+  def line_to_cover_array(branches)
+    line_to_cover_array = []
+    branches.each do |branch, conditions_map|
+      line_number = branch.split(',')[2].strip
+      not_covered = find_notcovered_branches conditions_map
+      covered = (conditions_map.keys.size - not_covered)
+
+      line_tocover_element = line_tocover_element_by_branch(covered, line_number, conditions_map.keys.size)
+      index = check_for_duplicate_line line_number, line_to_cover_array
+      update_line_to_cover_array_by_index(line_to_cover_array, index, line_tocover_element)
+    end
+
+    line_to_cover_array
+  end
+
+  def find_notcovered_branches(conditions_map)
+    conditions_map.count { |_condition, hit_count| hit_count.zero? }
+  end
+
+  def line_tocover_element_by_branch(covered, line_number, branches_to_cover)
+    {
+      lineNumber: line_number,
+      covered: covered.positive?,
+      branchesToCover: branches_to_cover,
+      coveredBranches: covered
+    }
+  end
+
+  # To check line already present in list of lineToCover element
+  def check_for_duplicate_line(line_number, line_tocover_elements)
+    line_tocover_elements.each_with_index do |element, idx|
+      return idx if element[:lineNumber] == line_number
+    end
+
+    -1
+  end
+
+  def update_line_to_cover_array_by_index(line_to_cover_array, index, line_tocover_element)
+    return line_to_cover_array.push(line_tocover_element) if index == -1
+
+    # if index == -1
+    #   line_to_cover_array.push(line_tocover_element)
+    # else
+    old_line_tocover_element = line_to_cover_array[index]
+    old_line_tocover_element[:branchesToCover] =
+      old_line_tocover_element[:branchesToCover] + line_tocover_element[:branchesToCover]
+    old_line_tocover_element[:coveredBranches] =
+      old_line_tocover_element[:coveredBranches] + line_tocover_element[:coveredBranches]
+    old_line_tocover_element[:covered] = old_line_tocover_element[:covered] && line_tocover_element[:covered]
+    line_to_cover_array[index] = old_line_tocover_element
+    # end
+  end
+
+  # def update_line_to_cover_array()
+  #
+  # end
+
+  def create_xml(file_elements)
+    xml = Builder::XmlMarkup.new(indent: 2)
+    puts "Total Files: #{file_elements.size}"
+    prepare_xml_builder xml, file_elements
+    File.write('coverage/branch-coverage.xml', xml.target!)
+  end
+
+  def prepare_xml_builder(xml, file_elements)
+    xml.coverage('version' => '1') do
+      file_elements.each do |file_element|
+        xml.file('path' => file_element[:path]) do
+          file_element[:lineElements].each do |element|
+            xml.lineToCover(line_to_cover_hash(element))
+          end
+        end
+      end
+    end
+  end
+
+  def line_to_cover_hash(element)
+    {
+      'lineNumber' => element[:lineNumber],
+      'covered' => element[:covered],
+      'branchesToCover' => element[:branchesToCover],
+      'coveredBranches' => element[:coveredBranches]
+    }
+  end
+end

data/lib/tasks/simplecov.rake

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+require 'simplecov_json_formatter'
+
+namespace :simplecov do
+  desc 'Merge coverage results'
+  task :report_coverage, %i[parallelism processors] => [:environment] do |_t, args|
+    SimpleCov.start 'rails' do
+      enable_coverage :branch
+
+      add_filter '/spec/'
+      add_filter '/config/'
+      add_filter '/db/'
+      add_filter '/vendor/'
+
+      add_group 'Decorators', 'app/decorators'
+      add_group 'Forms', 'app/forms'
+      add_group 'Services', 'app/services'
+      add_group 'ViewObjects', 'app/view_objects'
+      add_group 'Batches', 'app/batches'
+
+      merge_timeout 3600
+    end
+
+    SimpleCov.collate Dir['./coverage_results/.resultset*.json'], 'rails' do
+      formatter SimpleCov::Formatter::MultiFormatter.new([
+                                                           SimpleCov::Formatter::HTMLFormatter,
+                                                           SimpleCov::Formatter::JSONFormatter
+                                                         ])
+    end
+    ruby_branch = RubyBranchCoverage.new
+    ruby_branch.read_json_and_getxml('coverage/.resultset.json', args[:parallelism].to_i, args[:processors].to_i)
+  end
+end

data/ruby_branch_coverage.gemspec

@@ -0,0 +1,18 @@
+require_relative 'lib/ruby_branch_coverage/version'
+
+Gem::Specification.new do |s|
+    s.name        = 'ruby_branch_coverage'
+    s.version     = RubyBranchCoverage::VERSION
+    s.summary     = 'Branch Coverage Ruby!'
+    s.description = 'A program to convert json to xml test coverage format gem'
+    s.authors     = ['Suganya']
+    s.email       = ['kuppusamy.suganya@moneyforward.co.jp']
+    s.files = `git ls-files -z`.split("\x0").
+      reject { |f| f.match(%r{^(test|spec|features)/}) }
+    s.homepage    =
+      'https://github.com/moneyforward/ruby_branch_coverage'
+
+    s.add_development_dependency "rspec-rails"
+    s.add_dependency "rails"
+    s.add_dependency 'simplecov'
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: ruby_branch_coverage
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Suganya
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A program to convert json to xml test coverage format gem
+email:
+- kuppusamy.suganya@moneyforward.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".github/workflows/lint.yml"
+- ".github/workflows/publish_gem.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- README.md
+- Rakefile
+- bin/rails
+- lib/ruby_branch_coverage.rb
+- lib/ruby_branch_coverage/engine.rb
+- lib/ruby_branch_coverage/version.rb
+- lib/tasks/simplecov.rake
+- ruby_branch_coverage.gemspec
+homepage: https://github.com/moneyforward/ruby_branch_coverage
+licenses: []
+metadata: {}
+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: 4.0.10
+specification_version: 4
+summary: Branch Coverage Ruby!
+test_files: []