katachi 0.0.1.2 → 0.0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7261fd339cbee8210baf5fda5540cae8e3e7a2f887e056bbe279ad8f5b2d56a9
-  data.tar.gz: bb55f2b4593eca21d7834d15c9a9ee61443a7ac488fb73754b65fd0baf06d050
+  metadata.gz: 883bae0ce10ea6f6788e55dd3dd26429da93b6514f3e098f84fef2d77e7c96a5
+  data.tar.gz: a944845c4d55b3dc54be12c3e8d0e80879c9ad00194f2e2afed6431e9a09bd3f
 SHA512:
-  metadata.gz: a5c8f3e5c9fee2b329c1b005bd5a8473f01206ba7e74dc2035aa934524857faafaea9742dde9fbcb2e2cd1b266e402e3ba92b2433fa3a073ebeae0f6c34afc9b
-  data.tar.gz: 3adb7701d9a50619fd1a2e974b87e03b4d56f5092495ba5214f74b515fc244b10d92042eecf21b12536f8df859da7388854ddb13300b8470fb7b7abd9991391a
+  metadata.gz: 17f01032afb9118fabd8235a8df89a569475fc6175d26d3c64fb857fa57fe4698faa2ee983f85defc5963651bbd4236fb5d00adc259ec38c1d686f96ad749b74
+  data.tar.gz: 4857e4aec605a1500cd4cc8f44cacc7c8d71e5313b1e1e8fecaa9f00a043f3ebff15cd25ef1999e65ea73e72ecc213081541bd110c1b3d4aa9c7ad9e34b06084

data/README.md

@@ -280,8 +280,7 @@ RESULT
 - [ ] 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/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,12 +231,12 @@ But it makes for an awesome user experience :)
 
 ```ruby
 shape = {
-    :$guid => {
+    :$uuid => {
         email: :$email,
         first_name: String,
         last_name: String,
         preferred_name: AnyOf[String, nil],
-        admin_only_information: AnyOf[Symbol => String, :$undefined],
+        admin_only_information: AnyOf[{Symbol => String}, :$undefined],
         Symbol => Object,
     },
 }

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/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.2"
+  VERSION = "0.0.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: katachi
 version: !ruby/object:Gem::Version
-  version: 0.0.1.2
+  version: 0.0.1.4
 platform: ruby
 authors:
 - Joel Tannas
@@ -17,12 +17,12 @@ description: |
   Example usage:
 
     shape = {
-        :$guid => {
+        :$uuid => {
             email: :$email,
             first_name: String,
             last_name: String,
             preferred_name: AnyOf[String, nil],
-            admin_only_information: AnyOf[Symbol => String, :$undefined],
+            admin_only_information: AnyOf[{Symbol => String}, :$undefined],
             Symbol => Object,
         },
     }