camille 0.5.11 → 0.5.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d5030e35bf654863f03d80dbd09f8adb03b335f3f66d52c745404f6344e7efc
-  data.tar.gz: 7cc7a7000f5ce205f8edabfa31046933b7c7e04a71b18a270a8a080b37ed0c71
+  metadata.gz: 321511ba40eb05246be9d567a74ac7c753287088b22e282207d6affe5cd2c7b6
+  data.tar.gz: 4f7bec2b9a36f8dec419131cbbd1a98e3d4735f20155320b2419e6e2fe6600e4
 SHA512:
-  metadata.gz: 746548d7942f95c217ad8763add318a2dab939dbe2fb1abbd26d88b3c7da76023f58946a5622b15d5e3107ea7a88bfb919c78526eac78dbd6f9520d4f6e11469
-  data.tar.gz: 5460ccaaa044c4a4a1255b68d3df78e1f251931a725b26ff36155dd29695c0422097287c07efb0f405d2928aa088022c03fd8bbf64ed652c64f450a688c9d1c1
+  metadata.gz: 676055618b2b681f821b3a2d0fa87bf0f60f52e0416aad2dbdbc51eb4186bd19c699f4a121265cba56d5a1128f241f1e9f3bd32a9d1779dca58cc902b888fd71
+  data.tar.gz: e6545da7d1c98881b0fac58802b16c2a50ad2447039b9802d3617caf5f89d3ce68e67aaa2871f338b636fc463fb813f21ef1a040d13f5f43e70bf9ee890e2b29

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 0.5.12
+
+### Added
+
+* Added `.test` to `Camille::Type`
+* Added error details to `Camille::TypeError#inspect` and `#to_s`
+
+### Changed
+
+* Removed `Camille::TypeError#print` since details are now in `#inspect`
+
 ## 0.5.11
 
 ### Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    camille (0.5.11)
+    camille (0.5.12)
       rails (>= 6.1, < 8)
 
 GEM

data/README.md

@@ -128,6 +128,17 @@ Each custom type is considered a type alias in TypeScript. And `alias_of` define
 type Product = {id: number, name: string}
 ```
 
+You can perform a type check on a value using `test`, which might be handy in testing:
+
+```ruby
+error = Camille::Types::Product.test(hash)
+if error.nil?
+  # the hash is accepted by Camille::Types::Product type
+else
+  p error
+end
+```
+
 ### Available syntax for types
 
 Camille supports most of the type syntax in TypeScript. Below is a list of types that you can use in type and schema definition.

data/lib/camille/type.rb

@@ -26,6 +26,15 @@ module Camille
       @underlying.transform_and_check transformed
     end
 
+    def test value
+      error, _ = transform_and_check value
+      error
+    end
+
+    def self.test value
+      new.test value
+    end
+
     def self.klass_name
       name.gsub(/^Camille::Types::/, '')
     end

data/lib/camille/type_error.rb

@@ -18,8 +18,14 @@ module Camille
       !!@message
     end
 
-    def print io = STDOUT
-      Camille::TypeErrorPrinter.new(self).print io
+    def inspect
+      string_io = StringIO.new
+      Camille::TypeErrorPrinter.new(self).print string_io
+      "#<Camille::TypeError\n#{string_io.string}>"
+    end
+
+    def to_s
+      inspect
     end
   end
 end

data/lib/camille/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Camille
-  VERSION = "0.5.11"
+  VERSION = "0.5.12"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camille
 version: !ruby/object:Gem::Version
-  version: 0.5.11
+  version: 0.5.12
 platform: ruby
 authors:
 - 辻彩
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-10 00:00:00.000000000 Z
+date: 2023-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails