simplecov-markdown 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e0207d59884b631bfc6107b33d21a6ad25d60b0b
-  data.tar.gz: b76bcd574facf30150c39f7a4d8cc3322fb4e5b9
+SHA256:
+  metadata.gz: 4ee812d070b98156101ee6b0186a3b6a11ae67325a3f593894fdf9036b702ac0
+  data.tar.gz: 65aa27e39c12f6916b4a3144eeab39bad45a4903d1273b3321c79a4a0700652f
 SHA512:
-  metadata.gz: 1a914736f43aaf0b3bea518c6e44b3f5189d56657e9b07a2bf8ed4d1470ecfba7ef0e85cdc28785746e2d48e099b8983cc3873bff0f6c3d476153607e83be881
-  data.tar.gz: 6269d2d8f0927418e863034f93fbf55d08903ce6f7466db83da585683793f3db85bc67eaa7e51185981ea6e44de08cfcd0a440c63d75873cf6909a5d3699d06a
+  metadata.gz: 1a026ad0b6128b40e366928d33961dab0a068ab9d0f2c1f15cac7c304c38263a898aa8a97d4ace3abdb8414d7d7d192dfc9f80ed446793641d04a331c72c4491
+  data.tar.gz: 93fbdfd1da279271c15bae0bff46b45a8dbf35884640a91a55324c5be838642b0621c7502a834e6ed1071297dcd965710d5db10fcdf9155705576132bc4ab31e

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.2', '3.3', '4.0']
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rspec

data/.ruby-version

@@ -0,0 +1 @@
+4.0.1

data/Gemfile.lock

@@ -1,64 +1,74 @@
 PATH
   remote: .
   specs:
-    simplecov-markdown (0.2.0)
+    simplecov-markdown (1.0.0)
       simplecov
 
 GEM
   remote: https://rubygems.org/
   specs:
     ansi (1.5.0)
-    coveralls (0.8.15)
-      json (>= 1.8, < 3)
-      simplecov (~> 0.12.0)
-      term-ansicolor (~> 1.3)
-      thor (~> 0.19.1)
-      tins (>= 1.6.0, < 2)
-    diff-lcs (1.2.5)
-    docile (1.1.5)
-    hirb (0.7.3)
-    json (2.0.2)
-    rake (10.5.0)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.3)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
+    diff-lcs (1.6.2)
+    docile (1.4.1)
+    rake (13.3.1)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.8)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    rspec-temp_dir (0.0.4)
-      rspec
-    simplecov (0.12.0)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-console (0.3.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.7)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-console (0.9.5)
       ansi
-      hirb
       simplecov
-    simplecov-html (0.10.0)
-    term-ansicolor (1.3.2)
-      tins (~> 1.0)
-    thor (0.19.1)
-    tins (1.12.0)
+      terminal-table
+    simplecov-html (0.13.2)
+    simplecov_json_formatter (0.1.4)
+    terminal-table (4.0.0)
+      unicode-display_width (>= 1.1.1, < 4)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
 
 PLATFORMS
+  arm64-darwin-25
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0)
-  coveralls
-  rake (~> 10.0)
+  bundler (>= 2.0)
+  rake (>= 10.0)
   rspec
-  rspec-temp_dir (~> 0.0.3)
   simplecov-console
   simplecov-markdown!
 
+CHECKSUMS
+  ansi (1.5.0) sha256=5408253274e33d9d27d4a98c46d2998266fd51cba58a7eb9d08f50e57ed23592
+  diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
+  docile (1.4.1) sha256=96159be799bfa73cdb721b840e9802126e4e03dfc26863db73647204c727f21e
+  rake (13.3.1) sha256=8c9e89d09f66a26a01264e7e3480ec0607f0c497a861ef16063604b1b08eb19c
+  rspec (3.13.2) sha256=206284a08ad798e61f86d7ca3e376718d52c0bc944626b2349266f239f820587
+  rspec-core (3.13.6) sha256=a8823c6411667b60a8bca135364351dda34cd55e44ff94c4be4633b37d828b2d
+  rspec-expectations (3.13.5) sha256=33a4d3a1d95060aea4c94e9f237030a8f9eae5615e9bd85718fe3a09e4b58836
+  rspec-mocks (3.13.8) sha256=086ad3d3d17533f4237643de0b5c42f04b66348c28bf6b9c2d3f4a3b01af1d47
+  rspec-support (3.13.7) sha256=0640e5570872aafefd79867901deeeeb40b0c9875a36b983d85f54fb7381c47c
+  simplecov (0.22.0) sha256=fe2622c7834ff23b98066bb0a854284b2729a569ac659f82621fc22ef36213a5
+  simplecov-console (0.9.5) sha256=b1108bcfff5f210143e2b8301698c367b01586f20d25a73e95475a5df6fc6ff6
+  simplecov-html (0.13.2) sha256=bd0b8e54e7c2d7685927e8d6286466359b6f16b18cb0df47b508e8d73c777246
+  simplecov-markdown (1.0.0)
+  simplecov_json_formatter (0.1.4) sha256=529418fbe8de1713ac2b2d612aa3daa56d316975d307244399fa4838c601b428
+  terminal-table (4.0.0) sha256=f504793203f8251b2ea7c7068333053f0beeea26093ec9962e62ea79f94301d2
+  unicode-display_width (3.2.0) sha256=0cdd96b5681a5949cdbc2c55e7b420facae74c4aaf9a9815eee1087cb1853c42
+  unicode-emoji (4.2.0) sha256=519e69150f75652e40bf736106cfbc8f0f73aa3fb6a65afe62fefa7f80b0f80f
+
 BUNDLED WITH
-   1.12.5
+  4.0.5

data/README.md

@@ -1,10 +1,8 @@
 SimpleCov Markdown Formatter
 ==================================
 
-[![Gem Version](https://badge.fury.io/rb/simplecov-markdown.svg)](http://badge.fury.io/rb/simplecov-markdown)
-[![Build Status](https://travis-ci.org/holyshared/simplecov-markdown.svg?branch=master)](https://travis-ci.org/holyshared/simplecov-markdown)
-[![Coverage Status](https://coveralls.io/repos/holyshared/simplecov-markdown/badge.png)](https://coveralls.io/r/holyshared/simplecov-markdown)
-[![Code Climate](https://codeclimate.com/github/holyshared/simplecov-markdown/badges/gpa.svg)](https://codeclimate.com/github/holyshared/simplecov-markdown)
+[![Gem Version](https://badge.fury.io/rb/simplecov-markdown.svg)](https://badge.fury.io/rb/simplecov-markdown)
+[![CI](https://github.com/renuo/simplecov-markdown/actions/workflows/ci.yml/badge.svg)](https://github.com/renuo/simplecov-markdown/actions/workflows/ci.yml)
 
 Install
 ----------------------------
@@ -15,6 +13,6 @@ Usage
 ----------------------------
 
 ```ruby
-require 'simplecov-csv'
+require 'simplecov-markdown'
 SimpleCov.formatter = SimpleCov::Formatter::MarkdownFormatter
 ```

data/lib/simplecov-markdown/version.rb

@@ -1,7 +1,7 @@
 module SimpleCov
   module Formatter
     class MarkdownFormatter
-      VERSION = "0.2.0"
+      VERSION = "1.0.0"
     end
   end
 end

data/lib/simplecov-markdown.rb

@@ -8,6 +8,7 @@ class SimpleCov::Formatter::MarkdownFormatter
     report_writer.write_result(result)
     report_writer.destroy!
   end
+
   def self.output_path
     File.join(SimpleCov.coverage_path, 'report.md')
   end
@@ -34,13 +35,14 @@ class SimpleCov::Formatter::MarkdownFormatter
 
     def write_result(result)
       @table_writer.write_header
-      result.files.each do |file|
+      result.files.sort_by(&:covered_percent).each do |file|
+        missing_lines = file.missed_lines.map(&:line_number).join(", ")
         @table_writer.write_record(
-          file.filename,
           file.covered_percent.round(2).to_s + "%",
-          file.covered_lines.size,
+          file.filename,
+          file.lines_of_code,
           file.missed_lines.size,
-          file.lines_of_code
+          missing_lines
         )
       end
       @table_writer.destroy!
@@ -57,20 +59,20 @@ class SimpleCov::Formatter::MarkdownFormatter
 
     def initialize(report)
       @report = report
-      @columns_headers = ["File", "Coverage", "Covered", "Missed", "Total"]
-      @columns_header_aligns = [:left, :right, :right, :right, :right]
+      @columns_headers = ["Coverage", "File", "Total lines", "Total missed", "Missing line numbers"]
+      @columns_header_aligns = [:right, :left, :right, :right, :left]
     end
 
     def write_header
       write_values @columns_headers
       headers = @columns_header_aligns.map do |align|
         case align
-          when :left
-            ":--"
-          when :right 
-            "--:"
-          else
-            "--" 
+        when :left
+          ":--"
+        when :right
+          "--:"
+        else
+          "--"
         end
       end
       write_values headers

data/simplecov-markdown.gemspec

@@ -6,11 +6,11 @@ require 'simplecov-markdown/version'
 Gem::Specification.new do |spec|
   spec.name          = "simplecov-markdown"
   spec.version       = SimpleCov::Formatter::MarkdownFormatter::VERSION
-  spec.authors       = ["Noritaka Horio"]
-  spec.email         = ["holy.shared.design@gmail.com"]
+  spec.authors       = ["Alessandro Rodi"]
+  spec.email         = ["alessandro.rodi@renuo.ch"]
   spec.summary       = "Markdown formatter for simplecov"
   spec.description   = "Markdown formatter for simplecov"
-  spec.homepage      = "https://github.com/holyshared/simplecov-markdown"
+  spec.homepage      = "https://github.com/renuo/simplecov-markdown"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -20,10 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'simplecov'
 
-  spec.add_development_dependency "rspec-temp_dir", "~> 0.0.3"
-  spec.add_development_dependency "bundler", "~> 1.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", ">= 2.0"
+  spec.add_development_dependency "rake", ">= 10.0"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "coveralls"
   spec.add_development_dependency "simplecov-console"
 end

data/spec/fixtures/expected_report.md.erb

@@ -0,0 +1,11 @@
+Code Coverage Report
+====================
+
+Project name: <%= project_name %>
+Created at: <%= created_at %>
+
+|Coverage|File|Total lines|Total missed|Missing line numbers|
+|--:|:--|--:|--:|:--|
+|62.5%|<%= root_directory %>/fixtures/sample3.rb|8|3|8, 12, 13|
+|80.0%|<%= root_directory %>/fixtures/sample2.rb|5|1|8|
+|100.0%|<%= root_directory %>/fixtures/sample1.rb|5|0||

data/spec/fixtures/sample3.rb

@@ -0,0 +1,14 @@
+# Sample3 class
+class Sample3
+  def initialize
+    @foo = 'baz'
+  end
+
+  def bar
+    @foo
+  end
+
+  def baz
+    @foo + 'baz'
+  end
+end

data/spec/simplecov-markdown_spec.rb

@@ -1,38 +1,41 @@
 require 'simplecov'
 require 'erb'
-require 'rspec/temp_dir'
 
-describe 'MarkdownFormatter' do
-  include_context "uses temp dir"
+RSpec.describe 'MarkdownFormatter' do
+  let(:report_path) { File.expand_path('../../tmp/report.md', __FILE__) }
 
   let(:formatter) do
     allow(SimpleCov::Formatter::MarkdownFormatter).to receive(:output_path).and_return(report_path)
     SimpleCov::Formatter::MarkdownFormatter.new
   end
-  let(:report_path) { File.join(temp_dir_path, 'report.md') }
-  let(:expect_report) do
+
+  let(:expected_report) do
     root_directory = File.dirname(__FILE__)
     project_name = SimpleCov.project_name
     created_at = result.created_at
-    erb_script = File.open(File.join(File.dirname(__FILE__), 'fixtures/report.md.erb')).read
+    erb_script = File.open(File.join(File.dirname(__FILE__), 'fixtures/expected_report.md.erb')).read
     ERB.new(erb_script).result(binding)
   end
   let(:result) do
     sample1 = File.join(File.dirname(__FILE__), 'fixtures', 'sample1.rb')
     sample2 = File.join(File.dirname(__FILE__), 'fixtures', 'sample2.rb')
+    sample3 = File.join(File.dirname(__FILE__), 'fixtures', 'sample3.rb')
 
     original_result = {
-      sample1 => [nil, 1, 1, 1, nil, nil, 1, 1, nil, nil],
-      sample2 => [nil, 1, 1, 1, nil, nil, 1, 0, nil, nil]
+      sample1 => { "lines" => [nil, 1, 1, 1, nil, nil, 1, 1, nil, nil] },
+      sample2 => { "lines" => [nil, 1, 1, 1, nil, nil, 1, 0, nil, nil] },
+      sample3 => { "lines" => [nil, 1, 1, 1, nil, nil, 1, 0, nil, nil, 1, 0, 0, nil] }
     }
     SimpleCov::Result.new(original_result)
   end
 
+  before { FileUtils.mkdir_p(File.dirname(report_path)) }
+
   describe '#result' do
     it 'format by markdown' do
       formatter.format(result)
       actual_report = File.open(report_path).read
-      expect(actual_report).to be_eql(expect_report)
+      expect(actual_report).to eq(expected_report)
     end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: simplecov-markdown
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
-- Noritaka Horio
-autorequire: 
+- Alessandro Rodi
 bindir: bin
 cert_chain: []
-date: 2016-09-20 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -24,46 +23,32 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec-temp_dir
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !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
@@ -80,20 +65,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  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-console
   requirement: !ruby/object:Gem::Requirement
@@ -110,14 +81,16 @@ dependencies:
         version: '0'
 description: Markdown formatter for simplecov
 email:
-- holy.shared.design@gmail.com
+- alessandro.rodi@renuo.ch
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".coveralls.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock
@@ -127,16 +100,16 @@ files:
 - lib/simplecov-markdown.rb
 - lib/simplecov-markdown/version.rb
 - simplecov-markdown.gemspec
-- spec/fixtures/report.md.erb
+- spec/fixtures/expected_report.md.erb
 - spec/fixtures/sample1.rb
 - spec/fixtures/sample2.rb
+- spec/fixtures/sample3.rb
 - spec/simplecov-markdown_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/holyshared/simplecov-markdown
+homepage: https://github.com/renuo/simplecov-markdown
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -151,14 +124,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Markdown formatter for simplecov
 test_files:
-- spec/fixtures/report.md.erb
+- spec/fixtures/expected_report.md.erb
 - spec/fixtures/sample1.rb
 - spec/fixtures/sample2.rb
+- spec/fixtures/sample3.rb
 - spec/simplecov-markdown_spec.rb
 - spec/spec_helper.rb

data/spec/fixtures/report.md.erb

@@ -1,10 +0,0 @@
-Code Coverage Report
-====================
-
-Project name: <%= project_name %>
-Created at: <%= created_at %>
-
-|File|Coverage|Covered|Missed|Total|
-|:--|--:|--:|--:|--:|
-|<%= root_directory %>/fixtures/sample1.rb|100.0%|5|0|5|
-|<%= root_directory %>/fixtures/sample2.rb|80.0%|4|1|5|