simplecov_covview 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9cfefe5ecc6d9189158b4e206bd3d085f78a644b7b52a4af732bd20ef83823d6
+  data.tar.gz: de86a0a0d01bec7314875c43ff787006d3d8ac729bcd6e2ae30e61ce51060d2d
+SHA512:
+  metadata.gz: b0748769c3ac19d2e7845d6b5517df5419483b162058f035f553ba877732430b6e76f86654acc8dd13c8bdb40c863a726ded84079f4e8083ad81eeac9cb1a3d5
+  data.tar.gz: 16585701e76e9b0a27d62c5608dbcb83a1daf16a8ed41acb1e998f137fa88549ec94ba6fbca920d688a1fb7a162855070f0238b9f813a94efd56f031c4207293

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in simplecov_covview.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "simplecov"
+
+gem "test-unit", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 icm7216
+
+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,60 @@
+# Simplecov_covview
+
+simplecov_covview is a coverage viewer for SimpleCov.
+
+This formatter Generates a console report of your SimpleCov ruby code coverage results on Ruby.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simplecov_covview'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install simplecov_covview
+
+## Usage
+
+```ruby
+SimpleCov.formatter = SimpleCov::Formatter::CovView
+# or
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::CovView
+  ])
+```
+
+Example output:
+
+```text
+
+----- file => foo.rb -----
+4 lines covered and 1 lines missed.
+line#   status   count  code
+   1: [  never] [   - ] # foo.rb
+   2: [covered] [   1 ] def foo(n)
+   3: [covered] [  10 ]   if n <= 10
+   4: [covered] [  10 ]     p "n < 10"
+   5: [  never] [   - ]   else
+   6: [ missed] [   0 ]     p "n >= 10"
+   7: [  never] [   - ]   end
+   8: [  never] [   - ] end
+   9: [  never] [   - ]
+  10: [covered] [  11 ] (1..10).each {|x| foo(x)}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/icm7216/simplecov_covview.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+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"]
+  t.options = "-v"
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "simplecov_covview"
+
+# 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_covview.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "simplecov_covview/version"
+require_relative "simplecov_covview/formatter"
+require_relative "simplecov_covview/resultfile.rb"
+require_relative "simplecov_covview/srcfile.rb"
+require_relative "simplecov_covview/line.rb"
+
+module SimpleCov
+  module Formatter
+    class CovView
+      def format(result)
+        covview = SimplecovCovview::CovView.new(result)
+        covview.formatter.render
+      end
+    end
+  end
+end

data/lib/simplecov_covview/formatter.rb

@@ -0,0 +1,42 @@
+module SimplecovCovview
+  class CovView
+    attr_accessor :src_files_list
+
+    def initialize(result)
+      @result = result
+      @src_files_list = nil
+    end
+
+    def formatter
+      @src_files_list = @result.source_files.map do |file|
+        contents = file.lines.map do |line|
+          coverage = line.coverage.nil? ? "-" : "#{line.coverage}"
+          {
+            num: line.number,
+            status: line.status,
+            cov: coverage,
+            src: line.src,
+          }
+        end
+
+        result_file = SimplecovCovview::CovView::Resultfile.new(file)
+        file_contents = { contents: contents }
+        file_contents.merge(result_file.status)
+      end
+
+      self
+    end
+
+    def render
+      @src_files_list.each do |src_file|
+        source_file = SimplecovCovview::CovView::Srcfile.new(src_file)
+        puts source_file.header
+
+        src_file[:contents].each do |line|
+          row = SimplecovCovview::CovView::Srcfile::Line.new(line, src_file)
+          puts row.contents
+        end
+      end
+    end
+  end
+end

data/lib/simplecov_covview/line.rb

@@ -0,0 +1,49 @@
+# Create text for each line from @src_files_list.
+#
+# @param [Hash] line @src_files_list
+# @param [Hash] src_file @src_files_list
+module SimplecovCovview
+  class CovView
+    class Srcfile
+      class Line
+        def initialize(line, src_file)
+          @line = line
+          @src_file = src_file
+        end
+
+        def line_number
+          @line[:num]
+        end
+
+        def line_width
+          @src_file[:line_digit] < 4 ? 4 : @src_file[:line_digit]
+        end
+
+        def status
+          @line[:status]
+        end
+
+        def cov_count
+          @line[:cov]
+        end
+
+        def cov_width
+          @src_file[:cov_digit] < 4 ? 4 : @src_file[:cov_digit] + 1
+        end
+
+        def source_code
+          @line[:src]
+        end
+
+        def contents
+          [
+            sprintf("%#{line_width}s: ", line_number),
+            sprintf("[%7s] ", status),
+            sprintf("[%#{cov_width}s ] ", cov_count),
+            source_code,
+          ].join
+        end
+      end
+    end
+  end
+end

data/lib/simplecov_covview/resultfile.rb

@@ -0,0 +1,40 @@
+# The Resultfile class stores source file's information.
+#
+# @param [Hash] file SimpleCov::SourceFile
+module SimplecovCovview
+  class CovView
+    class Resultfile
+
+      def initialize(file)
+        @file = file
+      end
+
+      def covered_count
+        @file.covered_lines.count
+      end
+
+      def missed_count
+        @file.missed_lines.count
+      end
+
+      def line_digit
+        @file.lines.count.to_s.size
+      end
+
+      def cov_digit
+        @file.coverage_data["lines"].map(&:to_i).max.to_s.size
+      end
+
+      def status
+        {
+          filename: File.basename(@file.filename),
+          line_digit: line_digit,
+          cov_digit: cov_digit,
+          covered: covered_count,
+          missed: missed_count,
+        }
+      end
+
+    end
+  end
+end

data/lib/simplecov_covview/srcfile.rb

@@ -0,0 +1,35 @@
+# Create coverage header from @src_files_list.
+#
+# @param [Hash] src_file @src_files_list
+module SimplecovCovview
+  class CovView
+    class Srcfile
+      def initialize(src_file)
+        @src_file = src_file
+      end
+
+      def filename
+        @src_file[:filename]
+      end
+
+      def status
+        {
+          covered: @src_file[:covered],
+          missed: @src_file[:missed],
+        }
+      end
+
+      def title
+        "line#   status   count  code"
+      end
+
+      def header
+        [
+          "\n----- file => #{filename} -----",
+          "#{status[:covered]} lines covered and #{status[:missed]} lines missed.",
+          title,
+        ]
+      end
+    end
+  end
+end

data/lib/simplecov_covview/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SimplecovCovview
+  VERSION = "0.1.0"
+end

data/simplecov_covview.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "lib/simplecov_covview/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simplecov_covview"
+  spec.version       = SimplecovCovview::VERSION
+  spec.authors       = ["icm7216"]
+  spec.email         = ["icm7216d@gmail.com"]
+
+  spec.summary       = "Coverage viewer for simplecov."
+  spec.description   = "Coverage console output formatter for SimpleCov."
+  spec.homepage      = "https://github.com/icm7216/simplecov_covview"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "test-unit"
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: simplecov_covview
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- icm7216
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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'
+description: Coverage console output formatter for SimpleCov.
+email:
+- icm7216d@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simplecov_covview.rb
+- lib/simplecov_covview/formatter.rb
+- lib/simplecov_covview/line.rb
+- lib/simplecov_covview/resultfile.rb
+- lib/simplecov_covview/srcfile.rb
+- lib/simplecov_covview/version.rb
+- simplecov_covview.gemspec
+homepage: https://github.com/icm7216/simplecov_covview
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.17
+signing_key:
+specification_version: 4
+summary: Coverage viewer for simplecov.
+test_files: []