couve 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b00642800c7fb55e834a786a5243dafe3ff38ae2dc1e638b0c041f4686bc3c28
-  data.tar.gz: 9d5bf8a939b2c46e528ec47add60d325fdd4105232127f06ffdbe0690840475f
+  metadata.gz: 91781d6bb92f7f023f6ab39ea4d0f7f707318bef6d09ef8cced4a9c2810e78c2
+  data.tar.gz: ff8ad3ff9c1a7c7c2318ab23d53db3a45f629d9b6c2f44104bf7c5d89beccb3b
 SHA512:
-  metadata.gz: 85783f6edf42296754670765ea005c6a63ae4a40aaa26de8ca56ec0861d63155ec30e7e8ab376a09bb9bd0ea76c7d4037520a71a00ad472d496bdb86234c1e65
-  data.tar.gz: 9f1cc2e8da3106fcdcd0b64450d0d16f28b530c2f33c126df69871cc0387408788f4f4b09c7908b2be99056d9a144df1654d9d2b219745a60848916b56cfa93f
+  metadata.gz: b921af295d7211b7db8d8fd3e3bea3628f64529ccc031a46a02fc88f42fada6b76acc21f4309f80d2faaea2783fa02783519c3503f67a2d44cfe3054b7c5831b
+  data.tar.gz: fb3836c3e78b7c686f84b559e7344398bc1bed5e6ffca394c6025a4a3389a0b01914f7ab945fbd3a65f697a57b3598da7b8772c919c5b5c20499691c620111f5

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.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    couve (0.4.0)
+    couve (0.6.0)
 
 GEM
   remote: https://rubygems.org/
@@ -33,10 +33,10 @@ 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-x86_64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.15.3-x86_64-linux)
+    nokogiri (1.15.3)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     notiffany (0.1.3)
       nenv (~> 0.1)
@@ -88,6 +88,7 @@ GEM
     unicode-display_width (2.4.2)
 
 PLATFORMS
+  arm64-darwin-23
   x86_64-darwin-21
   x86_64-linux
 

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/lib/couve/parser.rb

@@ -38,6 +38,23 @@ module Couve
       HTML
     end
 
+    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
+
     private
 
     # rubocop:disable Metrics/MethodLength
@@ -84,6 +101,16 @@ module Couve
       end
     end
 
+    def percentage_indicator(percentage)
+      if percentage < 33.33
+        "🔴"
+      elsif percentage < 66.66
+        "🟡"
+      else
+        "🟢"
+      end
+    end
+
     def not_covered_lines(source_file)
       total_lines = JSON.parse(source_file[:coverage])
 

data/lib/couve/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Couve
-  VERSION = "0.5.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.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Cezinha
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-24 00:00:00.000000000 Z
+date: 2026-06-04 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -58,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !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.