gem_hadar 1.27.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db714afa72ba58c1676c20ec7efdfe235300f384f839ea663880b0ae976a9a0b
-  data.tar.gz: 6f1ebe9a6446fc600e00d0964a9f3f215cccc264454468bec4dc93e9ff8c674a
+  metadata.gz: 461476c530dd6931e016e354762f020bd62cde41cdff6833a409e7f6a9e52a8c
+  data.tar.gz: e920f140411d7847dabcba1c6c6e9e4a4f7737a72953498cb76b3d260dd9b531
 SHA512:
-  metadata.gz: c89a930270aa72bb13179e6bedd38c4cc5971f8924aba2f86c588925a62baf5141191d065289f6b7a75d1e05f99beb17b91db78f09c23529ab04625d3147b271
-  data.tar.gz: 5a1eddb1dba0410f324a519b3b445036ec8c6e53c2406968161169133d9f7fd17c1e4e558f9fa72d4b1bdbca4f532ec0e93a4ef616a0796521f2de2d86452dc2
+  metadata.gz: e694c32ec183e670a70e1bef998599e5218e523c71c5aeaec9cc21d6424c0ee4b19413ba95877819d993f3a3857d71e9adc5a7da35dfb3fe3f1ac6c67542dc67
+  data.tar.gz: f54b76af265cc9da659f577b9d1400cddbd6a23310036c09937a6fa60f623a11e5d01735ad0bbbc39de7b10ff61844e0fcb0a888da8be9a7e13280af36870040

data/README.md

@@ -77,7 +77,7 @@ graph TD
 
 The source of this library is located at
 
-* http://github.com/flori/gem\_hadar
+* http://github.com/flori/gem_hadar
 
 or can be installed via
 
@@ -112,7 +112,7 @@ The following environment variables can be used to configure `gem_hadar`:
 
 To publish gems to RubyGems.org, you'll need to set up an API key:
 
-1. Generate a new API key at: https://rubygems.org/profile/api\_keys/new
+1. Generate a new API key at: https://rubygems.org/profile/api_keys/new
 2. Set the environment variable:
 
 ```bash
@@ -476,7 +476,51 @@ $ rake -T
 - `rake github:release` - Create a new GitHub release for the current version
   with AI-generated changelog
 
-### Update Version
+### Code Coverage with SimpleCov
+
+To enable detailed code coverage reporting in your project using `GemHadar`,
+follow these steps:
+
+1. **Install Required Dependencies**
+
+   Ensure that `simplecov` is included in your `Gemfile`:
+
+   ```ruby
+   gem 'simplecov'
+   ```
+
+2. **Initialize Coverage in Your Test Setup**
+
+   Add this line to the top of your test helper file (e.g., `spec_helper.rb`,
+   `test_helper.rb`):
+
+   ```ruby
+   require 'gem_hadar/simplecov'
+   GemHadar::SimpleCov.start
+   ```
+
+3. **Enable Coverage Reporting**
+
+   Run tests with the environment variable `START_SIMPLECOV=1`:
+
+   ```bash
+   START_SIMPLECOV=1 bundle exec rspec
+   ```
+
+   This will generate coverage reports in both HTML and JSON formats.
+
+4. **Viewing Reports**
+
+   After running tests, you can view:
+   - **HTML Report**: `coverage/index.html`
+   - **JSON Context**: `coverage/coverage_context.json`
+
+> 🧪 *Tip:* Enable coverage reporting by setting the `START_SIMPLECOV`
+> environment variable to `1`. The JSON output includes detailed line and
+> branch coverage statistics per file, making it ideal for integration with CI
+> tools or custom dashboards.
+
+### Update Gem Version
 
 Use one of the following rake tasks to bump the version:
 

data/VERSION

@@ -1 +1 @@
-1.27.0
+2.0.0

data/gem_hadar.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: gem_hadar 1.27.0 ruby lib
+# stub: gem_hadar 2.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "gem_hadar".freeze
-  s.version = "1.27.0".freeze
+  s.version = "2.0.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -12,8 +12,8 @@ Gem::Specification.new do |s|
   s.description = "This library contains some useful functionality to support the development of Ruby Gems".freeze
   s.email = "flori@ping.de".freeze
   s.executables = ["gem_hadar".freeze]
-  s.extra_rdoc_files = ["README.md".freeze, "lib/gem_hadar.rb".freeze, "lib/gem_hadar/github.rb".freeze, "lib/gem_hadar/prompt_template.rb".freeze, "lib/gem_hadar/setup.rb".freeze, "lib/gem_hadar/template_compiler.rb".freeze, "lib/gem_hadar/utils.rb".freeze, "lib/gem_hadar/version.rb".freeze]
-  s.files = [".gitignore".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/gem_hadar".freeze, "gem_hadar.gemspec".freeze, "lib/gem_hadar.rb".freeze, "lib/gem_hadar/github.rb".freeze, "lib/gem_hadar/prompt_template.rb".freeze, "lib/gem_hadar/setup.rb".freeze, "lib/gem_hadar/template_compiler.rb".freeze, "lib/gem_hadar/utils.rb".freeze, "lib/gem_hadar/version.rb".freeze]
+  s.extra_rdoc_files = ["README.md".freeze, "lib/gem_hadar.rb".freeze, "lib/gem_hadar/github.rb".freeze, "lib/gem_hadar/prompt_template.rb".freeze, "lib/gem_hadar/setup.rb".freeze, "lib/gem_hadar/simplecov.rb".freeze, "lib/gem_hadar/template_compiler.rb".freeze, "lib/gem_hadar/utils.rb".freeze, "lib/gem_hadar/version.rb".freeze]
+  s.files = [".gitignore".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/gem_hadar".freeze, "gem_hadar.gemspec".freeze, "lib/gem_hadar.rb".freeze, "lib/gem_hadar/github.rb".freeze, "lib/gem_hadar/prompt_template.rb".freeze, "lib/gem_hadar/setup.rb".freeze, "lib/gem_hadar/simplecov.rb".freeze, "lib/gem_hadar/template_compiler.rb".freeze, "lib/gem_hadar/utils.rb".freeze, "lib/gem_hadar/version.rb".freeze]
   s.homepage = "https://github.com/flori/gem_hadar".freeze
   s.licenses = ["MIT".freeze]
   s.rdoc_options = ["--title".freeze, "GemHadar - Library for the development of Ruby Gems".freeze, "--main".freeze, "README.md".freeze]

data/lib/gem_hadar/simplecov.rb

@@ -0,0 +1,182 @@
+require 'term/ansicolor'
+require 'tins/xt/secure_write'
+require 'fileutils'
+require 'pathname'
+
+class GemHadar
+end
+
+module GemHadar::SimpleCov
+  module WarnModule
+    # The warn method displays warning messages using orange colored output.
+    #
+    # This method takes an array of message strings, applies orange color
+    # formatting to each message, and then passes them to the superclass's warn
+    # method for display. The uplevel: 1 option ensures that the warning
+    # originates from the caller's context rather than from within this method
+    # itself.
+    #
+    # @param msgs [ Array<String> ] the array of message strings to display as warnings
+    def warn(*msgs)
+      msgs.map! { |m| color(208) { m } }
+      super(*msgs, uplevel: 1)
+    end
+  end
+
+  class ContextFormatter
+    include FileUtils
+
+    # The format method processes code coverage results and generates a
+    # detailed JSON report.
+    #
+    # This method takes a SimpleCov result object and transforms its coverage
+    # data into a structured format that includes both line and branch coverage
+    # statistics for individual files, as well as overall project coverage
+    # metrics. It calculates various percentages and counts, then writes the
+    # complete coverage data to a JSON file in the coverage directory.
+    #
+    # @param result [ SimpleCov::Result ] the coverage result object containing files and statistics
+    #
+    # @return [ String ] an empty string, as the method's primary purpose is to write data to a file
+    def format(result)
+      files = result.files.map do |file|
+        line_coverage_statistics = extract_coverage_info(file.coverage_statistics[:line])
+        branch_coverage_statistics = extract_coverage_info(file.coverage_statistics[:branch])
+        {
+          filename: file.filename,
+          line_coverage_statistics:,
+          branch_coverage_statistics:,
+        }
+      end
+      covered_files = result.files.count { |file| file.coverage_statistics[:line].covered > 0 }
+      uncovered_files = result.files.count { |file| file.coverage_statistics[:line].covered == 0 }
+      files_count = result.files.length
+      files_covered_percent = files_count > 0 ? (100 * covered_files.to_f / files_count).round(2) : 0
+      branch_covered_percent =
+        result.total_branches > 0 ? (result.covered_branches.to_f / result.total_branches * 100).round(2) : 0
+      coverage_data = {
+        project_name:,
+        version:,
+        timestamp: Time.now.iso8601,
+        files:,
+        overall_coverage: {
+          covered_percent: result.covered_percent.round(2),
+          total_lines: result.total_lines,
+          covered_lines: result.covered_lines,
+          missed_lines: result.missed_lines,
+          branch_covered_percent:,
+          total_branches: result.total_branches,
+          covered_branches: result.covered_branches,
+          missed_branches: result.missed_branches,
+          coverage_strength: result.covered_strength.round(2),
+          least_covered_file: result.least_covered_file,
+          covered_files:,
+          uncovered_files:,
+          files_count:,
+          files_covered_percent:,
+        },
+      }
+
+      # Write to a dedicated coverage data file,
+      coverage_dir = Pathname.new('coverage')
+      mkdir_p coverage_dir
+      filename = File.expand_path(coverage_dir + 'coverage_context.json')
+      File.secure_write(filename, JSON.pretty_generate(coverage_data))
+      STDERR.puts "Wrote detailed coverage context to #{filename.to_s.inspect}."
+      ""
+    end
+
+    private
+
+    include WarnModule
+
+    # The project_name method retrieves the name of the current working
+    # directory.
+    #
+    # This method obtains the absolute path of the current working directory
+    # and extracts its basename, returning it as a string. It is typically used
+    # to identify the project name based on the directory structure.
+    #
+    # @return [ String ] the name of the current working directory
+    def project_name
+      Pathname.pwd.basename.to_s # I hope…
+    end
+
+    # The version method reads and returns the current version string from the
+    # VERSION file.
+    #
+    # This method attempts to read the contents of the VERSION file, removing
+    # any trailing whitespace. If the VERSION file does not exist, it returns
+    # the string 'unknown' instead.
+    #
+    # @return [ String ] the version string read from the VERSION file, or
+    # 'unknown' if the file is missing
+    def version
+      File.read('VERSION').chomp
+    rescue Errno::ENOENT => e
+      warn "Using version 'unknown', caught #{e.class}: #{e}"
+      'unknown'
+    end
+
+    # The extract_coverage_info method transforms coverage statistics into a
+    # structured hash format.
+    #
+    # This method takes a coverage statistics object and extracts specific
+    # attributes into a new hash, making the data more accessible for reporting
+    # and analysis.
+    #
+    # @param coverage_statistics [ SimpleCov::CoverageStatistics ] the coverage
+    # statistics object to process
+    #
+    # @return [ Hash ] a hash containing the extracted coverage metrics with
+    # keys :total, :covered, :missed, :strength, and :percent
+    def extract_coverage_info(coverage_statistics)
+      %i[ total covered missed strength percent ].each_with_object({}) do |attr, hash|
+        hash[attr] = coverage_statistics.send(attr)
+      end
+    end
+  end
+
+  class << self
+    include Term::ANSIColor
+
+    # The start method initializes and configures SimpleCov for code coverage
+    # analysis.
+    #
+    # This method checks if the START_SIMPLECOV environment variable is set to
+    # 1 before proceeding with SimpleCov setup. If disabled, it outputs a
+    # message indicating that SimpleCov startup is skipped. When enabled, it
+    # requires the simplecov gem, configures coverage to include branch
+    # coverage, adds a filter based on the caller's directory, and sets up
+    # multiple formatters including SimpleFormatter, HTMLFormatter, and a
+    # custom ContextFormatter.
+    def start
+      if ENV['START_SIMPLECOV'].to_i != 1
+        STDERR.puts color(226) {
+          "Skip starting Simplecov for code coverage, "\
+          "enable by setting env var: START_SIMPLECOV=1"
+        }
+        return
+      end
+      require 'simplecov'
+      STDERR.puts color(76) { "Configuring Simplecov for code coverage." }
+      filter = "#{File.basename(File.dirname(caller.first))}/"
+      SimpleCov.start do
+        enable_coverage :branch
+        add_filter filter
+        formatter SimpleCov::Formatter::MultiFormatter.new([
+          SimpleCov::Formatter::SimpleFormatter,
+          SimpleCov::Formatter::HTMLFormatter,
+          GemHadar::SimpleCov::ContextFormatter,
+        ])
+      end
+    rescue LoadError => e
+      warn "Caught #{e.class}: #{e}"
+      STDERR.puts "Install with: gem install simplecov"
+    end
+
+    private
+
+    include WarnModule
+  end
+end

data/lib/gem_hadar/version.rb

@@ -1,6 +1,6 @@
 class GemHadar
   # GemHadar version
-  VERSION         = '1.27.0'
+  VERSION         = '2.0.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/lib/gem_hadar.rb

@@ -1525,19 +1525,6 @@ class GemHadar
       remotes_uris.find { |uri| uri.hostname == 'github.com' }
     end
   end
-
-  class << self
-    # The start_simplecov method initializes SimpleCov and configures it to
-    # ignore coverage data from the directory containing the caller. This can be
-    # called from a test or spec helper.
-    def start_simplecov
-      defined? SimpleCov or return
-      filter = "#{File.basename(File.dirname(caller.first))}/"
-      SimpleCov.start do
-        add_filter filter
-      end
-    end
-  end
 end
 
 def GemHadar(&block)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem_hadar
 version: !ruby/object:Gem::Version
-  version: 1.27.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Florian Frank
@@ -119,6 +119,7 @@ extra_rdoc_files:
 - lib/gem_hadar/github.rb
 - lib/gem_hadar/prompt_template.rb
 - lib/gem_hadar/setup.rb
+- lib/gem_hadar/simplecov.rb
 - lib/gem_hadar/template_compiler.rb
 - lib/gem_hadar/utils.rb
 - lib/gem_hadar/version.rb
@@ -135,6 +136,7 @@ files:
 - lib/gem_hadar/github.rb
 - lib/gem_hadar/prompt_template.rb
 - lib/gem_hadar/setup.rb
+- lib/gem_hadar/simplecov.rb
 - lib/gem_hadar/template_compiler.rb
 - lib/gem_hadar/utils.rb
 - lib/gem_hadar/version.rb