camille 0.5.10 → 0.5.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 247a0f8bf5424ac104e9c4b71a073c4b7a6e38399434dc57a9a3b13f40b72d0b
-  data.tar.gz: db54f6d86bab52b6f50bc09cc3aa42c4b2b9c00c10a484394de270bc4a1c8351
+  metadata.gz: 321511ba40eb05246be9d567a74ac7c753287088b22e282207d6affe5cd2c7b6
+  data.tar.gz: 4f7bec2b9a36f8dec419131cbbd1a98e3d4735f20155320b2419e6e2fe6600e4
 SHA512:
-  metadata.gz: aa084c1032e46b35a3330a5500bdf2a31dd19d57585ca7fd12bbd8c93083d1f2b5f9df1c53c68dd10ab53167d27fe8f4680cf4a7f8f8567f4e9dd3b279d13022
-  data.tar.gz: be8d2cc143b82614cd99ef6d0b38c2fcc756152a9856db840e04595f1d566d97e8c01f51caadcb7ba88ff9d00924f3ff1e048a821b9a08f50a164c3047b8aba5
+  metadata.gz: 676055618b2b681f821b3a2d0fa87bf0f60f52e0416aad2dbdbc51eb4186bd19c699f4a121265cba56d5a1128f241f1e9f3bd32a9d1779dca58cc902b888fd71
+  data.tar.gz: e6545da7d1c98881b0fac58802b16c2a50ad2447039b9802d3617caf5f89d3ce68e67aaa2871f338b636fc463fb813f21ef1a040d13f5f43e70bf9ee890e2b29

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # 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
+
+* Optional fields are now preserved in generated TypeScript as having `?` suffix
+
 ## 0.5.10
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    camille (0.5.10)
+    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/types/object.rb

@@ -14,11 +14,10 @@ module Camille
           keys = (@fields.keys + value.keys).uniq
           transform_and_check_results = keys.map do |key|
             if type = @fields[key]
-              error, transformed = type.transform_and_check(value[key])
-              if @optional_keys.include?(key) && !error && transformed.nil?
+              if @optional_keys.include?(key) && value[key].nil?
                 nil
               else
-                [key, [error, transformed]]
+                [key, type.transform_and_check(value[key])]
               end
             else
               [key, [nil, value[key]]]
@@ -43,7 +42,7 @@ module Camille
       end
 
       def literal
-        "{#{@fields.map{|k,v| "#{ActiveSupport::Inflector.camelize k.to_s, false}: #{v.literal}"}.join(', ')}}"
+        "{#{@fields.map{|k,v| "#{literal_key k}: #{v.literal}"}.join(', ')}}"
       end
 
       private
@@ -54,7 +53,7 @@ module Camille
             if key.end_with?('?')
               new_key = remove_question_mark(key)
               @optional_keys << new_key
-              [new_key, type | Camille::Types::Undefined.new]
+              [new_key, type]
             else
               [key, type]
             end
@@ -65,6 +64,10 @@ module Camille
           sym.to_s.gsub(/\?$/, '').to_sym
         end
 
+        def literal_key key
+          "#{ActiveSupport::Inflector.camelize key.to_s, false}#{@optional_keys.include?(key) ? '?' : ''}"
+        end
+
         def check_case_conversion_safe sym
           str = sym.to_s
           if str != str.camelize.underscore

data/lib/camille/version.rb

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

metadata

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