katachi 0.0.1.4 → 0.0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 883bae0ce10ea6f6788e55dd3dd26429da93b6514f3e098f84fef2d77e7c96a5
-  data.tar.gz: a944845c4d55b3dc54be12c3e8d0e80879c9ad00194f2e2afed6431e9a09bd3f
+  metadata.gz: bb4f96db6d56228c268dd8c0a247528714414d1ebe4d60e0f7cb377b00323a61
+  data.tar.gz: 1112a9919b574b8c8755e44bcfb711d2f08dbc9d2f67ef2e5343554f5400fb4c
 SHA512:
-  metadata.gz: 17f01032afb9118fabd8235a8df89a569475fc6175d26d3c64fb857fa57fe4698faa2ee983f85defc5963651bbd4236fb5d00adc259ec38c1d686f96ad749b74
-  data.tar.gz: 4857e4aec605a1500cd4cc8f44cacc7c8d71e5313b1e1e8fecaa9f00a043f3ebff15cd25ef1999e65ea73e72ecc213081541bd110c1b3d4aa9c7ad9e34b06084
+  metadata.gz: 99587618b46fcb57fd8ebe9c383e447cb0e56ce81758c508b7979ee16828f086f43fc15534f806662d0b5e0268b1a5c1e5f937b841e866d40513d75033bc2573
+  data.tar.gz: 1976286dc99e9c797e6f9bc5bf1533823a66a1c460f02c7f5705f256b6a862aa2c165f2924f77691449dc3874eba713b42b064385c1a6872f70f5af6ae8d8377

data/README.md

@@ -1,4 +1,5 @@
 ![Gem Version](https://img.shields.io/gem/v/katachi)
+[![Coverage Status](https://coveralls.io/repos/github/jtannas/katachi/badge.svg?branch=main)](https://coveralls.io/github/jtannas/katachi?branch=main)
 
 # Katachi
 
@@ -241,6 +242,21 @@ expect('abc').to have_shape(String)
 expect('abc').to have_shape('abc').with_code(:exact_match)
 ```
 
+### Minitest Integration
+
+We provide both custom assertions and expectations for Minitest.
+
+```ruby
+require 'katachi/minitest'
+
+shape = [1, 2, 3]
+assert_shape(shape, [1, 2, 3])
+refute_shape(shape, [1, 2, 4])
+
+_([1, 2, 3]).must_match_shape(shape)
+_([1, 2, 4]).wont_match_shape(shape)
+```
+
 ### Detailed Diagnostics
 
 All comparisons return a `Katachi::Result` object that contains detailed information about the comparison.
@@ -275,7 +291,6 @@ RESULT
 - [ ] Docusaurus github pages for documentation
 - [ ] More output formats (e.g. `to_json`, `to_hash`, etc...)
 - [ ] Custom shape codes (e.g. `:email_is_invalid`)
-- [ ] Minitest integration
 - [ ] Rails integration (e.g. `validates_shape_of`)
 - [ ] Shape-to-TypeScript conversion
 - [ ] Shape-to-Zod conversion

data/Rakefile

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
+require "rake/testtask"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
@@ -9,7 +10,7 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+task default: %i[test spec rubocop]
 
 desc "Opens a console with Katachi loaded for easier experimentation"
 task :console do
@@ -24,3 +25,10 @@ desc "All the steps necessary to get the project ready for development"
 task :setup do
   system "bundle install"
 end
+
+desc "Test the minitest integration"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end

data/cspell.config.yaml

@@ -1,6 +1,7 @@
 $schema: https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json
 version: "0.2"
 words:
+  - autorun
   - bindir
   - diffable
   - kata
@@ -17,3 +18,4 @@ words:
   - rubygems
   - shapeables
   - Tannas
+  - testtask

data/lib/katachi/minitest.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "minitest/assertions"
+require "katachi"
+
+# Minitest assertions for shape matching
+module Minitest::Assertions
+  def assert_shape(expected, actual)
+    assert Katachi.compare(shape: expected, value: actual).match?, "Expected #{actual} to match #{expected}"
+  end
+
+  def refute_shape(expected, actual)
+    refute Katachi.compare(shape: expected, value: actual).match?, "Expected #{actual} not to match #{expected}"
+  end
+end
+
+# Minitest expectations for shape matching
+module Minitest::Expectations
+  infect_an_assertion :assert_shape, :must_match_shape
+  infect_an_assertion :refute_shape, :wont_match_shape
+end

data/lib/katachi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Katachi
-  VERSION = "0.0.1.4"
+  VERSION = "0.0.2.0"
 end

metadata

@@ -1,19 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: katachi
 version: !ruby/object:Gem::Version
-  version: 0.0.1.4
+  version: 0.0.2.0
 platform: ruby
 authors:
 - Joel Tannas
 bindir: exe
 cert_chain: []
-date: 2025-03-18 00:00:00.000000000 Z
+date: 2025-03-19 00:00:00.000000000 Z
 dependencies: []
 description: |
   == Description
 
   A tool for describing and validating objects as intuitively as possible.
   Easier to read and write than JSON Schema, and more powerful than a simple hash comparison.
+
   Example usage:
 
     shape = {
@@ -54,6 +55,7 @@ files:
 - lib/katachi/comparator/compare_hash.rb
 - lib/katachi/comparator/compare_kv.rb
 - lib/katachi/comparison_result.rb
+- lib/katachi/minitest.rb
 - lib/katachi/predefined_shapes.rb
 - lib/katachi/rspec.rb
 - lib/katachi/shapes.rb