katachi 0.0.1.3 → 0.0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a56c24fb1996ba05c3111e89897cbaa3dc1bddf984b681255b17b999219bfa60
-  data.tar.gz: e4ab4c85cf9f93872b3a504ad91d1509df732e2b6dd3635b3ca1b132974d4c7b
+  metadata.gz: bb4f96db6d56228c268dd8c0a247528714414d1ebe4d60e0f7cb377b00323a61
+  data.tar.gz: 1112a9919b574b8c8755e44bcfb711d2f08dbc9d2f67ef2e5343554f5400fb4c
 SHA512:
-  metadata.gz: b5d3ba9a516ffe9ea0ecd4ce3c40b63b1cdbf9f912cd8e4c8feed05abba1f83b4048693b48ed86b246bdb687acbb7c49e64c57c9608043dee4439ec00e405cf4
-  data.tar.gz: 6fbdc8dedf8ff0e65c15de6f0c5e9b71f479c773866d63842d2da0373a56bc501bc27e91ee17fbd58abe5dd7471b63d4e8222ef7be538a1de586091c9ee8940f
+  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,13 +291,11 @@ 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
 - [ ] Shape-to-OpenAPI conversion
-- [ ] Recursive shape definitions (e.g. `:$user => {name: String, spouse: Kt.any_of(:$user, nil)}`)
-- [ ] `katachi-rspec-api` for testing+documenting APIs in a way inspired [RSwag](https://github.com/rswag/rswag)
+- [ ] `katachi-rspec-api` for testing+documenting APIs in a way inspired by [RSwag](https://github.com/rswag/rswag)
 
 ## Installation
 

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/docs/HASH_COMPARISON_DESIGN.md

@@ -12,7 +12,7 @@ Here's the story of how they led to the design of Katachi's hash comparison:
 OpenAPI has handled `null` values a few different ways over the years.
 
 - OpenAPI 2.0 (Swagger) didn't support `null` values at all, so people used `x-nullable: true`
-- OpenAPI 3.0 make this official by supporting `nullable: true`
+- OpenAPI 3.0 made this official by supporting `nullable: true`
 - OpenAPI 3.1 found a much simpler way by treating `null` as a type: `type: ["string", "null"]`
 
 I like the 3.1 approach of treating `null` as just another possible type.
@@ -140,7 +140,7 @@ Another problem with using `Object => Object` for extra keys is that it's means
 
 If the comparison threw a `:hash_mismatch` when the user's hash didn't literally have a key-value pair `Object => Object`, that'd ruin that whole feature.
 
-The lazy solution was to just ignore `Object => Object`, but what if users wanted to be a bit stricter about their extra keys?
+The lazy solution was to just ignore `Object => Object`, but what if users want to be a bit stricter about their extra keys?
 
 - `Symbol => String` is a normal data structure to enforce.
 - `:$email => User` is an excellent description for a lookup hash.
@@ -231,7 +231,7 @@ But it makes for an awesome user experience :)
 
 ```ruby
 shape = {
-    :$guid => {
+    :$uuid => {
         email: :$email,
         first_name: String,
         last_name: String,

data/lib/katachi/comparator.rb

@@ -18,6 +18,7 @@ module Katachi::Comparator
     retrieved_shape = Katachi::Shapes[shape]
     return retrieved_shape.kt_compare(value) if retrieved_shape.respond_to?(:kt_compare)
     return compare_equalities(value:, shape: retrieved_shape) if retrieved_shape.is_a?(Proc)
+    return object_class_universal_match(value:) if retrieved_shape == Object
 
     case value
     when Array then compare_array(value:, shape: retrieved_shape)
@@ -40,4 +41,8 @@ module Katachi::Comparator
            end
     Katachi::ComparisonResult.new(value:, shape:, code:)
   end
+
+  private_class_method def self.object_class_universal_match(value:)
+    Katachi::ComparisonResult.new(value:, shape: Object, code: :object_class_universal_match)
+  end
 end

data/lib/katachi/comparison_result.rb

@@ -9,10 +9,11 @@ class Katachi::ComparisonResult
   # For example, :match is considered a match, while :mismatch is not.
   CODES = {
     # General
+    class_mismatch: false,
     exact_match: true,
     match: true,
     mismatch: false,
-    class_mismatch: false,
+    object_class_universal_match: true,
     # AnyOf
     any_of_match: true,
     any_of_mismatch: false,

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/predefined_shapes.rb

@@ -3,3 +3,5 @@
 require_relative "shapes"
 
 Katachi::Shapes.add(:$uuid, /\A\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\z/)
+Katachi::Shapes.add(:$guid, /\A\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\z/)
+# TODO: make :$guid reference the :$uuid shape; requires recursive shape resolution

data/lib/katachi/version.rb

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

metadata

@@ -1,23 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: katachi
 version: !ruby/object:Gem::Version
-  version: 0.0.1.3
+  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 = {
-        :$guid => {
+        :$uuid => {
             email: :$email,
             first_name: String,
             last_name: String,
@@ -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