couve 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2d77a7f4ff4d71e6a6b44dbbce503b7e24db2781949c690fe0dbea9abc1e925
-  data.tar.gz: 6907bd5e49f9018a56fe693b53f31d320691fc2237d04b68a8d9e29c007295b1
+  metadata.gz: 91781d6bb92f7f023f6ab39ea4d0f7f707318bef6d09ef8cced4a9c2810e78c2
+  data.tar.gz: ff8ad3ff9c1a7c7c2318ab23d53db3a45f629d9b6c2f44104bf7c5d89beccb3b
 SHA512:
-  metadata.gz: 2cf6728d574b655ef2a6e4632a2d103cccb2eeaba0ad1d620bc3d92db5f0a2b98b5480f4e7137b7099aba3cd4ca0b16247b003a7e84cba47a340c3785d200992
-  data.tar.gz: 2d2c6c9e145e31e61b47c4fb1cf4350f4974a8d4ac34e448588925b5805ac0a57bfb59145f59298987749c512135a6456a699293cc57da079e034c9ef79217d4
+  metadata.gz: b921af295d7211b7db8d8fd3e3bea3628f64529ccc031a46a02fc88f42fada6b76acc21f4309f80d2faaea2783fa02783519c3503f67a2d44cfe3054b7c5831b
+  data.tar.gz: fb3836c3e78b7c686f84b559e7344398bc1bed5e6ffca394c6025a4a3389a0b01914f7ab945fbd3a65f697a57b3598da7b8772c919c5b5c20499691c620111f5

data/.rubocop.yml

@@ -1,5 +1,30 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.0.3
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - 'bin/**/*'
+    - 'config/**/*'
+    - 'log/**/*'
+    - 'tmp/**/*'
+    - 'public/**/*'
+    - 'vendor/**/*'
+    - 'db/**/*'
+    - 'spec/spec_helper.rb'
+    - 'spec/rails_helper.rb'
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+   - 'spec/**/*.rb'
 
 Style/StringLiterals:
   Enabled: true
@@ -9,12 +34,8 @@ Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
 
-Layout/LineLength:
-  Max: 120
+Style/SymbolArray:
+  EnforcedStyle: brackets
 
 Style/Documentation:
   Enabled: false
-
-Metrics/BlockLength:
-  Exclude:
-   - 'spec/**/*.rb'

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.6.0] - 2026-06-04
+
+- Add Markdown output format, selected from the output file extension (`.md`). HTML remains the default.
+
 ## [0.1.0] - 2023-07-19
 
 - Initial release

data/Gemfile

@@ -5,8 +5,10 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in couve.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.0"
-gem "rubocop", "~> 1.21"
-gem "guard", "~> 2.18"
-gem "guard-rspec", "~> 4.7"
+gem "rake", "~> 13.0", group: [:test, :development]
+gem "rspec", "~> 3.0", group: [:test, :development]
+gem "rubocop", "~> 1.21", group: [:test, :development]
+gem "guard", "~> 2.18", group: :development
+gem "guard-rspec", "~> 4.7", group: :development, require: false
+gem "nokogiri", "~> 1.15", group: [:test, :development]
+gem "byebug", group: :development

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    couve (0.1.0)
+    couve (0.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    byebug (11.1.3)
     coderay (1.1.3)
     diff-lcs (1.5.0)
     ffi (1.15.5)
@@ -32,7 +33,11 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.9)
     method_source (1.0.0)
+    mini_portile2 (2.8.9)
     nenv (0.3.0)
+    nokogiri (1.15.3)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
@@ -83,12 +88,16 @@ GEM
     unicode-display_width (2.4.2)
 
 PLATFORMS
+  arm64-darwin-23
   x86_64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
+  byebug
   couve!
   guard (~> 2.18)
   guard-rspec (~> 4.7)
+  nokogiri (~> 1.15)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)

data/Guardfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
@@ -18,5 +20,5 @@
 guard :rspec, cmd: "rspec" do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
+  watch("spec/spec_helper.rb")  { "spec" }
 end

data/README.md

@@ -1,8 +1,6 @@
-# Couve
+# Couve - Generate Human Readable CodeClimate Test Reporter
 
-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/couve`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Couve is a Ruby gem that aims to simplify the generation of human-readable reports for the CodeClimate test-reporter gem. With Couve, you can quickly and easily generate insightful reports based on the test coverage data in a human-friendly format.
 
 ## Installation
 
@@ -22,18 +20,96 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+1. Install the `couve` gem.
+
+```ruby
+gem install couve
+```
+
+2. Run the following command in your terminal, providing the path to your JSON coverage file and the desired output file.
+
+```
+$ couve path/to/coverage.json path/to/output.html
+```
+
+Couve will process the coverage data and generate a human-readable HTML report, providing insights into your project's test coverage.
+
+### Output formats
+
+Couve picks the output format from the output file's extension:
+
+- `.html` (or anything else) — a self-contained, styled **HTML** report. Great for uploading as a CI artifact.
+- `.md` — a **Markdown** report. Great for posting as a pull request comment.
+
+```
+$ couve path/to/coverage.json path/to/report.html   # HTML report
+$ couve path/to/coverage.json path/to/report.md      # Markdown report
+```
+
+The Markdown report renders as a GitHub-flavored table, with a colored rating indicator (🔴/🟡/🟢) reflecting each file's coverage level:
+
+```markdown
+## Coverage problems
+
+| Rating | Coverage | File | Not covered lines |
+| :---: | ---: | :--- | :--- |
+| 🔴 | 30% | app/models/foo.rb | 3, 8, 21 |
+| 🟡 | 50% | app/services/bar.rb | 5, 6 |
+```
+
+A typical CI setup keeps the HTML report as an artifact and posts the Markdown report to the pull request, e.g. with the GitHub CLI:
+
+```sh
+couve coverage.json coverage.html   # upload as a CI artifact
+couve coverage.json coverage.md     # post to the PR
+gh pr comment "$PR_NUMBER" --body-file coverage.md
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+To contribute to Couve's development, follow these steps:
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+1. Clone the repository from GitHub:
+
+```
+$ git clone https://github.com/asseinfo/couve.git
+```
+
+2. Install the gem dependencies by running:
+
+```
+$ bin/setup
+```
+
+3. Run the tests to ensure everything is set up correctly:
+
+```
+$ rake spec
+```
+
+4. You can also use the interactive prompt to experiment with the code:
+
+```
+$ bin/console
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/couve.
+We welcome bug reports and pull requests from the community. If you encounter any issues with Couve or have suggestions for improvements, please open an issue on [GitHub](https://github.com/asseinfo/couve) to let us know.
 
-## License
+If you'd like to contribute directly, please follow these steps:
+
+1. Fork the repository on GitHub.
+
+2. Create a new branch from the `main` branch.
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+3. Make your changes and commit them with descriptive commit messages.
+
+4. Push your changes to your fork.
+
+5. Submit a pull request to the `main` branch of the original repository.
+
+We appreciate your contributions and will review and merge pull requests as appropriate.
+
+## License
+Couve is released under the [MIT License](https://opensource.org/licenses/MIT), which allows you to use, modify, and distribute the gem freely. See the LICENSE file for more details.

data/Rakefile

@@ -9,4 +9,4 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+task default: [:spec, :rubocop]

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/couve.gemspec

@@ -7,6 +7,7 @@ Gem::Specification.new do |spec|
   spec.version = Couve::VERSION
   spec.authors = ["Cezinha"]
   spec.email = ["cesar@asseinfo.com.br"]
+  spec.metadata = { "rubygems_mfa_required" => "true" }
 
   spec.summary = "Generate a human readable report for CodeClimate test-reporter gem."
 
@@ -20,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib", "lib/couve"]
+  spec.required_ruby_version = ">= 3"
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"

data/lib/couve/parser.rb

@@ -1,67 +1,126 @@
+# frozen_string_literal: true
+
 require "json"
 
-class Couve::Parser
-  def initialize(coverage)
-    @coverage = JSON.parse(coverage, symbolize_names: true)
-    @coverage[:source_files].reject! { |file| file[:covered_percent] == 100 }
-    @coverage[:source_files].sort_by! { |file| file[:covered_percent] }
-  end
+module Couve
+  class Parser
+    def initialize(coverage)
+      @coverage = JSON.parse(coverage, symbolize_names: true)
+      @coverage[:source_files].reject! { |file| file[:covered_percent] == 100 }
+      @coverage[:source_files].sort_by! { |file| file[:covered_percent] }
+    end
 
-  def to_html
-    <<~HTML
-      <html>
-        <body>
-          <div class="container mt-5">
-            <h1 class="display-5">
-              Coverage problems
-            </h1>
-
-            <table class="table table-hover mt-5">
-              <thead>
-                <tr>
-                  <th class="col-1 text-end">Coverage</th>
-                  <th class="col-8">File</th>
-                  <th class="col-3">Not covered lines</th>
-                </tr>
-              </thead>
-              #{body}
-            </table>
-          </div>
-
-          <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous">
-          <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/js/bootstrap.bundle.min.js" integrity="sha384-MrcW6ZMFYlzcLA8Nl+NtUVF0sA7MsXsP1UyJoMp4YLEuNSfAP+JcXn/tWtIaxVXM" crossorigin="anonymous"></script>
-        </body>
-      </html>
-    HTML
-  end
+    def to_html
+      <<~HTML
+        <html>
+          <body>
+            <div class="container mt-5">
+              <h1 class="display-5">
+                Coverage problems
+              </h1>
 
-  private
+              <table class="table table-hover mt-5">
+                <thead>
+                  <tr>
+                    <th class="col-1" colspan="2">Coverage</th>
+                    <th class="col-7">File</th>
+                    <th class="col-3">Not covered lines</th>
+                  </tr>
+                </thead>
+                #{body}
+              </table>
+            </div>
 
-  def body
-    html = ["<tbody>"]
+            <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous">
+            <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/js/bootstrap.bundle.min.js" integrity="sha384-MrcW6ZMFYlzcLA8Nl+NtUVF0sA7MsXsP1UyJoMp4YLEuNSfAP+JcXn/tWtIaxVXM" crossorigin="anonymous"></script>
+          </body>
+        </html>
+      HTML
+    end
 
-    @coverage[:source_files].each do |source_file|
-      html << "  <tr>"
-      html << "    <td class=\"col-1 text-end\">#{source_file[:covered_percent].round(2)}%</td>"
-      html << "    <td class=\"col-8 text-break\">#{source_file[:name]}</td>"
-      html << "    <td class=\"col-3 text-break\">#{not_covered_lines(source_file)}</td>"
-      html << "  </tr>"
+    def to_markdown
+      rows = @coverage[:source_files].map do |source_file|
+        percentage = source_file[:covered_percent].round(2)
+        indicator = percentage_indicator(percentage)
+
+        "| #{indicator} | #{percentage}% | #{source_file[:name]} | #{not_covered_lines(source_file)} |"
+      end
+
+      <<~MARKDOWN
+        ## Coverage problems
+
+        | Rating | Coverage | File | Not covered lines |
+        | :---: | ---: | :--- | :--- |
+        #{rows.join("\n")}
+      MARKDOWN
     end
 
-    html << "</tbody>"
+    private
 
-    html.join("\n        ")
-  end
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
+    def body
+      html = ["<tbody>"]
 
-  def not_covered_lines(source_file)
-    total_lines = JSON.parse(source_file[:coverage])
+      @coverage[:source_files].each do |source_file|
+        percentage = source_file[:covered_percent].round(2)
+        bg_color = percentage_bar_color(percentage)
 
-    not_covered = total_lines.each_with_index.map do |line, index|
-      next if line != 0
+        html << "  <tr>"
+        html << "    <td class=\"col-1\">"
+        html << "      <div class=\"progress\">"
+        html << "        <div"
+        html << "          class=\"progress-bar #{bg_color}\""
+        html << "          role=\"progressbar\""
+        html << "          style=\"width: #{percentage}%;\""
+        html << "          aria-valuenow=\"#{percentage}\""
+        html << "          aria-valuemin=\"0\" aria-valuemax=\"100\">"
+        html << "        </div>"
+        html << "      </div>"
+        html << "    </td>"
+        html << "    <td class=\"col-1\">#{percentage}%</td>"
+        html << "    <td class=\"col-8 text-break\">#{source_file[:name]}</td>"
+        html << "    <td class=\"col-3 text-break\">#{not_covered_lines(source_file)}</td>"
+        html << "  </tr>"
+      end
 
-      index + 1
+      html << "</tbody>"
+
+      html.join("\n        ")
+    end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
+
+    def percentage_bar_color(percentage)
+      if percentage < 33.33
+        "bg-danger"
+      elsif percentage < 66.66
+        "bg-warning"
+      else
+        "bg-success"
+      end
+    end
+
+    def percentage_indicator(percentage)
+      if percentage < 33.33
+        "🔴"
+      elsif percentage < 66.66
+        "🟡"
+      else
+        "🟢"
+      end
     end
 
-    not_covered.compact.join(", ")
+    def not_covered_lines(source_file)
+      total_lines = JSON.parse(source_file[:coverage])
+
+      not_covered = total_lines.each_with_index.map do |line, index|
+        next if line != 0
+
+        index + 1
+      end
+
+      not_covered.compact.join(", ")
+    end
   end
 end

data/lib/couve/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Couve
-  VERSION = "0.4.0"
+  VERSION = "0.6.0"
 end

data/lib/couve.rb

@@ -11,8 +11,10 @@ module Couve
     coverage = File.read(coverage_file)
     parser = Couve::Parser.new(coverage)
 
+    report = output_file.end_with?(".md") ? parser.to_markdown : parser.to_html
+
     File.open(output_file, "w") do |f|
-      f.puts parser.to_html
+      f.puts report
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: couve
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Cezinha
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-19 00:00:00.000000000 Z
+date: 2026-06-04 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -30,15 +30,18 @@ files:
 - bin/_guard-core
 - bin/console
 - bin/guard
+- bin/rubocop
 - bin/setup
 - couve.gemspec
 - exe/couve
 - lib/couve.rb
 - lib/couve/parser.rb
 - lib/couve/version.rb
+- tmp/.keep
 homepage:
 licenses: []
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -48,14 +51,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Generate a human readable report for CodeClimate test-reporter gem.