camille 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2370ceb41fe8fdd701b99671f1d4d82678fc103218e96a10a52e60b9b2d1ad1f
-  data.tar.gz: ef8fe63ad679a1744fdef8c58971148d3642be0be2c5e23ff53b510dfef2b449
+  metadata.gz: 3d0df267ba626a69935cbe5da75d90c08bf319b048fd210712953bc2a0e83b45
+  data.tar.gz: f93164ee26857fb30eb3a1c4c77dd8341e7aa6a52b6476134658c4061f030c58
 SHA512:
-  metadata.gz: 6b8068692bd238a82cded511bad5e15d3f0993640a487b335cfd7d1592fe3c8cb45f88924753a1b580ae7448a59d58e423c29332842fa9be09472585bc810ea7
-  data.tar.gz: 71bc242a3a3fc9224c0d2e7d3598d9e4be378ff7b2a028e02b55833927cfb516d6309c44bbc7b2296b0b9b780ffe07458435e40a89a1953d6044a465621e7ef9
+  metadata.gz: 84e73bdb5f359904024658a6ce47e9585851eeb60fb28a093323ec169fa8dc6903b358255380b9b9daafc8f24490628fecd173c6ab97f46f6190bddfe29eaf72
+  data.tar.gz: 40e888902aea15a1964e6fddb09476d896c12645717f750869b76c08708529bce2d6baa8eb96dc0adffae2e65a85a70883855788d546d41c9661033378ec2132

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 0.4.3
+
+### Fixed
+
+* Fixed the error that values not getting transformed in array/tuple/union types
+* Fixed optional fields getting `nil` due to transformation
+
+## 0.4.2
+
+### Added
+
+* Supported `transform` for custom types
+* Added default DateTime and Decimal type to install generator
+
 ## 0.4.1
 
 ### Added

data/Gemfile.lock

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

data/README.md

@@ -237,7 +237,7 @@ Camille will print the following error:
 ```
 object:
   array:
-    [2]: Expected number, got "3".
+    array[2]: Expected number, got "3".
 ```
 
 ### Reloading

data/lib/camille/basic_type.rb

@@ -11,6 +11,15 @@ module Camille
       Camille::Types::Array.new(self)
     end
 
+    def transform_and_check value
+      transformed = transform value
+      [check(value), transformed]
+    end
+
+    def transform value
+      value
+    end
+
     def self.| other
       Camille::Type.instance(self) | other
     end

data/lib/camille/controller_extension.rb

@@ -15,16 +15,16 @@ module Camille
       if endpoint = camille_endpoint
         render_options = args.last
         if value = render_options[:json]
-          error = endpoint.response_type.check(value)
+          error, transformed = endpoint.response_type.transform_and_check(value)
           if error
             string_io = StringIO.new
             Camille::TypeErrorPrinter.new(error).print(string_io)
             raise TypeError.new("\nType check failed for response.\n#{string_io.string}")
           else
-            if value.is_a? Hash
-              value.deep_transform_keys!{|k| k.to_s.camelize(:lower)}
+            if transformed.is_a? Hash
+              transformed.deep_transform_keys!{|k| k.to_s.camelize(:lower)}
             end
-            super(json: value)
+            super(json: transformed)
           end
         else
           raise ArgumentError.new("Expected key :json for `render` call.")

data/lib/camille/generators/install_generator.rb

@@ -10,8 +10,9 @@ module Camille
         copy_file "configuration.rb", "config/camille/configuration.rb"
       end
 
-      def create_types_folder
-        copy_file ".keep", "config/camille/types/.keep"
+      def create_date_time_and_decimal
+        copy_file "date_time.rb", "config/camille/types/date_time.rb"
+        copy_file "decimal.rb", "config/camille/types/decimal.rb"
       end
 
       def create_schemas_folder

data/lib/camille/generators/templates/date_time.rb

@@ -0,0 +1,12 @@
+using Camille::Syntax
+
+class Camille::Types::DateTime < Camille::Type
+  include Camille::Types
+
+  alias_of(String)
+
+  # transforms a DateTime into a String of ISO 8601 format
+  def transform value
+    value.as_json
+  end
+end

data/lib/camille/generators/templates/decimal.rb

@@ -0,0 +1,16 @@
+using Camille::Syntax
+
+class Camille::Types::Decimal < Camille::Type
+  include Camille::Types
+
+  alias_of(Number)
+
+  # transforms a BigDecimal into a Float so it fits in Number type
+  def transform value
+    if value.is_a? BigDecimal
+      value.to_f
+    else
+      value
+    end
+  end
+end

data/lib/camille/type.rb

@@ -21,6 +21,11 @@ module Camille
       @underlying.check value
     end
 
+    def transform_and_check value
+      transformed = transform value
+      @underlying.transform_and_check transformed
+    end
+
     def self.klass_name
       name.gsub(/^Camille::Types::/, '')
     end

data/lib/camille/types/array.rb

@@ -7,14 +7,23 @@ module Camille
         @content = Camille::Type.instance content
       end
 
-      def check value
+      def transform_and_check value
         if value.is_a? ::Array
-          errors = value.map.with_index{|e, i| ["array[#{i}]", @content.check(e)]}.select{|x| x[1]}
-          unless errors.empty?
-            Camille::TypeError.new(**errors.to_h)
+          transform_and_check_results = value.map.with_index do |element, index|
+            [index, @content.transform_and_check(element)]
+          end
+          errors = transform_and_check_results.map do |index, (error, transformed)|
+            ["array[#{index}]", error]
+          end.select{|x| x[1]}
+
+          if errors.empty?
+            transformed = transform_and_check_results.map{|_, (_, transformed)| transformed}
+            [nil, transformed]
+          else
+            [Camille::TypeError.new(**errors.to_h), nil]
           end
         else
-          Camille::TypeError.new("Expected array, got #{value.inspect}.")
+          [Camille::TypeError.new("Expected array, got #{value.inspect}."), nil]
         end
       end
 

data/lib/camille/types/object.rb

@@ -4,20 +4,35 @@ module Camille
       attr_reader :fields
 
       def initialize fields
+        @optional_keys = []
         @fields = normalize_fields fields
       end
 
-      def check value
+      def transform_and_check value
         if value.is_a? Hash
-          errors = @fields.map do |key, type|
-            [key.to_s, type.check(value[key])]
+          transform_and_check_results = @fields.map do |key, type|
+            error, transformed = type.transform_and_check(value[key])
+            if @optional_keys.include?(key) && !error && transformed.nil?
+              nil
+            else
+              [key, type.transform_and_check(value[key])]
+            end
+          end.compact
+
+          errors = transform_and_check_results.map do |key, (error, transformed)|
+            [key.to_s, error]
           end.select{|x| x[1]}
 
-          unless errors.empty?
-            Camille::TypeError.new(**errors.to_h)
+          if errors.empty?
+            transformed = transform_and_check_results.map do |key, (error, transformed)|
+              [key, transformed]
+            end.to_h
+            [nil, transformed]
+          else
+            [Camille::TypeError.new(**errors.to_h), nil]
           end
         else
-          Camille::TypeError.new("Expected hash, got #{value.inspect}.")
+          [Camille::TypeError.new("Expected hash, got #{value.inspect}."), nil]
         end
       end
 
@@ -31,6 +46,7 @@ module Camille
             type = Camille::Type.instance(value)
             if key.end_with?('?')
               new_key = remove_question_mark(key)
+              @optional_keys << new_key
               [new_key, type | Camille::Types::Undefined.new]
             else
               [key, type]

data/lib/camille/types/omit.rb

@@ -1,8 +1,8 @@
 module Camille
   module Types
     class Omit < PickAndOmit
-      def check value
-        processed_object.check(value)
+      def transform_and_check value
+        processed_object.transform_and_check(value)
       end
 
       private

data/lib/camille/types/pick.rb

@@ -1,8 +1,8 @@
 module Camille
   module Types
     class Pick < PickAndOmit
-      def check value
-        processed_object.check(value)
+      def transform_and_check value
+        processed_object.transform_and_check(value)
       end
 
       private

data/lib/camille/types/tuple.rb

@@ -7,17 +7,24 @@ module Camille
         @elements = elements.map{|e| Camille::Type.instance e}
       end
 
-      def check value
+      def transform_and_check value
         if value.is_a? ::Array
-          errors = @elements.map.with_index do |type, index|
-            ["tuple[#{index}]", type.check(value[index])]
+          transform_and_check_results = @elements.map.with_index do |type, index|
+            [index, type.transform_and_check(value[index])]
+          end
+
+          errors = transform_and_check_results.map do |index, (error, transformed)|
+            ["tuple[#{index}]", error]
           end.select{|x| x[1]}
 
-          unless errors.empty?
-            Camille::TypeError.new(**errors.to_h)
+          if errors.empty?
+            transformed = transform_and_check_results.map{|index, (error, transformed)| transformed}
+            [nil, transformed]
+          else
+            [Camille::TypeError.new(**errors.to_h), nil]
           end
         else
-          Camille::TypeError.new("Expected array, got #{value.inspect}.")
+          [Camille::TypeError.new("Expected array, got #{value.inspect}."), nil]
         end
       end
 

data/lib/camille/types/union.rb

@@ -8,16 +8,21 @@ module Camille
         @right = Camille::Type.instance right
       end
 
-      def check value
-        left_result = @left.check value
-        if left_result
-          right_result = @right.check value
-          if right_result
-            Camille::TypeError.new(
-              'union.left' => left_result,
-              'union.right' => right_result
+      def transform_and_check value
+        left_error, left_transformed = @left.transform_and_check value
+        if left_error
+          right_error, right_transformed = @right.transform_and_check value
+          if right_error
+            error = Camille::TypeError.new(
+              'union.left' => right_error,
+              'union.right' => right_error
             )
+            [error, nil]
+          else
+            [nil, right_transformed]
           end
+        else
+          [nil, left_transformed]
         end
       end
 

data/lib/camille/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camille
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.3
 platform: ruby
 authors:
 - 辻彩
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-17 00:00:00.000000000 Z
+date: 2023-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -57,6 +57,8 @@ files:
 - lib/camille/generators/schema_generator.rb
 - lib/camille/generators/templates/.keep
 - lib/camille/generators/templates/configuration.rb
+- lib/camille/generators/templates/date_time.rb
+- lib/camille/generators/templates/decimal.rb
 - lib/camille/generators/templates/schema_template.erb
 - lib/camille/generators/templates/type_template.erb
 - lib/camille/generators/type_generator.rb