simplecov-compare 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1c84aeb5ca7098e9ef46d238a442ff1033e3ab9591cb035b010a51db6e64cf0
-  data.tar.gz: de4cdfdf2bd6ad0dddffba37a480c0f14d26a51b93721628bf43ebeabe51529f
+  metadata.gz: d7ec00dedbd96313e447c4d4cd4b229cc6580a0b7594e695b37fa671a47c790b
+  data.tar.gz: 75cf2e34a0ad0e6da31f7d0c2a476c17fe7e3a21c2cd45cf139e6c432f07481e
 SHA512:
-  metadata.gz: 8243f62a3094c48af6fd763fbaece4ac75a5d4a54b38e01154ff609ac4ecd868e3a455b12d7fc552d1e3aa839240ba292065d2d4d8dc52227602e0fc2014e066
-  data.tar.gz: d9ff76b1d1035420e950fc5b5ceb2a4affc74cd68f024c39cfdd1493e3ff6c308e9546b1ff39a1427a5986baf2271d9b279c38fedab2fc7b191b1df1b6456378
+  metadata.gz: 5a1bd555a0a92a6b2cc614b914a2c323ddc5aa012fee89c5796bed1dbd36f317dadb006d8f8b5f76adb4de0480a48e2bd6d014eaa040b023ec5d0bb62b509ee9
+  data.tar.gz: 2176c41b305a0707e1e6043a5aa11416047344e19d9afa760a8c8699ffff02ae93633f43758f6ab24ca2b114ff6692bb19ce067006d167ef6e4fcecbba46ebe0

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## Current release (in development)
+
+## 0.1.1 [2026-03-08]
+
+* Add checks that file paths are provided
+
+  *Kevin Murphy*
+
+## 0.1.0 [2026-03-08]
+
+* Initial Release
+
+  *Kevin Murphy*

data/README.md

@@ -6,18 +6,16 @@ mechanism to compare two Simplecov results.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add simplecov-compare
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install simplecov-compare
 ```
 
 ## Usage

data/lib/simplecov/compare/version.rb

@@ -2,6 +2,6 @@
 
 module Simplecov
   module Compare
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/simplecov/compare.rb

@@ -13,7 +13,16 @@ require_relative "compare/result_set_comparison"
 
 module Simplecov
   module Compare
+    class NoPathError < StandardError
+      def initialize(msg="Required path not provided")
+        super
+      end
+    end
+
     def self.report(base_path:, to_path:, formatter_class: Formatter::MarkdownFormatter, reporter_class: Reporter::GlamourReporter)
+      raise NoPathError, "Base path not provided" if base_path.nil?
+      raise NoPathError, "To path not provided" if to_path.nil?
+
       base = ResultSet.new(ResultFile.new(base_path).coverage_data)
       other = ResultSet.new(ResultFile.new(to_path).coverage_data)
       comparison = ResultSetComparison.new(base, to: other)

data/test/simplecov/compare_test.rb

@@ -32,6 +32,29 @@ describe Simplecov::Compare do
         )
       end
     end
+
+    it "raises an exception when no base path is provided" do
+      assert_raises(Simplecov::Compare::NoPathError, "Base path not provided") do
+        Simplecov::Compare.report(
+          base_path: nil,
+          to_path: "test/fixtures/sample_resultset.json",
+          formatter_class: Simplecov::Compare::Formatter::MarkdownFormatter,
+          reporter_class: Simplecov::Compare::Reporter::SimpleReporter,
+        )
+      end
+
+    end
+
+    it "raises an exception when no to path is provided" do
+      assert_raises(Simplecov::Compare::NoPathError, "To path not provided") do
+        Simplecov::Compare.report(
+          base_path: "test/fixtures/sample_resultset.json",
+          to_path: nil,
+          formatter_class: Simplecov::Compare::Formatter::MarkdownFormatter,
+          reporter_class: Simplecov::Compare::Reporter::SimpleReporter,
+        )
+      end
+    end
   end
 
   it "has a version number" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simplecov-compare
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kevin Murphy
@@ -31,6 +31,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md