camille 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c6d8ec2d346e2ff02811be47d900bee304a82f5a96e213cbf5e1c9f96f3fe61
-  data.tar.gz: 1a67d813067334b228caa09c9cc10411fa4a3b56eab57610b415c129616a4533
+  metadata.gz: acda60cf2aee3c70aadf0aa040f5b79832aa8fe44c8d92f8e305715a0edf7e36
+  data.tar.gz: 9c1b5c69c2638336c8341a2f9182d097f8276b8df21506365e69846aa71596f7
 SHA512:
-  metadata.gz: 0d977978049f5c5589731135c24c360145c3145d3ded0be2d158ea67546eece82d8af7c07674e1895d03a3071418adc9b1a6a597e5246b22b96d0c7abb2123d3
-  data.tar.gz: b4fd67e56fdd11db3c00d1e1ddee3a775c8e3d87ba2423cbe652729ed3dfb3460591d658a89bd1192385c45f0507fbeae5172a03acac65fcb3ad0880fe3b1aa7
+  metadata.gz: 4772765b95039fc3309e4eddd9a406cd0c1c94e9fca0c31e8dc283677ee9cc42620ba3acefbcc946818a44e1e78945eba798109e51bcf0ceccf6c858eff336a9
+  data.tar.gz: b90680ff5e4646237c856c26bc6c54bbccb3c2c38d69a670d95c81b7232d466ab95d27ffdd362829da985e204d648b9d81b7cfb83f51e989019324321fad4c9f

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.5.0
+
+### Changed
+
+* Pick and Omit now use a new syntax, so it can handle snake to camel case conversion correctly
+
+## 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

data/Gemfile.lock

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

data/README.md

@@ -158,9 +158,9 @@ params(
   string_literal: 'hello',
   # a custom type we defined above
   product: Product,
-  # Pick and Omit use [] to enclose parameters instead of <>
-  pick: Pick[{a: 1, b: 2}, 'a' | 'b'],
-  omit: Omit[Product, 'id']
+  # Pick and Omit accepts a type and an array of symbols
+  pick: Pick[{a: 1, b: 2}, [:a, :b]],
+  omit: Omit[Product, [:id]]
 )
 ```
 
@@ -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/pick_and_omit.rb

@@ -14,24 +14,14 @@ module Camille
         raise ArgumentError.new("Currently onle an object type or an alias of object type is supported in #{klass_name}. Got #{type.inspect}.")
       end
 
-      @keys = Camille::Type.instance(keys)
-      case
-      when @keys.is_a?(Camille::Types::StringLiteral)
-        @keys_array = [@keys.value].map(&:to_sym)
-      when @keys.is_a?(Camille::Types::Union)
-        unfolded = unfold_union(@keys).flatten
-        if unfolded.all?{|x| x.is_a?(Camille::Types::StringLiteral)}
-          @keys_array = unfolded.map(&:value).map(&:to_sym)
-        else
-          raise ArgumentError.new("The second argument of #{klass_name} has to be a string literal or an union of string literals. Got #{keys.inspect}.")
-        end
-      else
-        raise ArgumentError.new("The second argument of #{klass_name} has to be a string literal or an union of string literals. Got #{keys.inspect}.")
+      unless keys.is_a?(::Array) && !keys.empty? && keys.all?{|x| x.is_a? Symbol}
+        raise ArgumentError.new("The second argument of #{klass_name} has to be an array of symbols. Got #{keys.inspect}.")
       end
+      @keys = keys
     end
 
     def literal
-      "#{klass_name}<#{@type.literal}, #{@keys.literal}>"
+      "#{klass_name}<#{@type.literal}, #{keys_in_literal}>"
     end
 
     def self.[] type, keys
@@ -39,12 +29,8 @@ module Camille
     end
 
     private
-      def unfold_union type
-        if type.is_a?(Camille::Types::Union)
-          [unfold_union(type.left), unfold_union(type.right)]
-        else
-          [type]
-        end
+      def keys_in_literal
+        @keys.map{|k| "\"#{k.to_s.camelize(:lower)}\""}.join(' | ')
       end
 
   end

data/lib/camille/types/array.rb

@@ -7,22 +7,26 @@ 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
 
-      def transform_and_check value
-        transformed = value.map{|x| @content.transform x}
-        [check(transformed), transformed]
-      end
-
       def literal
         "#{@content.literal}[]"
       end

data/lib/camille/types/object.rb

@@ -4,28 +4,20 @@ module Camille
       attr_reader :fields
 
       def initialize fields
+        @optional_keys = []
         @fields = normalize_fields fields
       end
 
-      def check value
-        if value.is_a? Hash
-          errors = @fields.map do |key, type|
-            [key.to_s, type.check(value[key])]
-          end.select{|x| x[1]}
-
-          unless errors.empty?
-            Camille::TypeError.new(**errors.to_h)
-          end
-        else
-          Camille::TypeError.new("Expected hash, got #{value.inspect}.")
-        end
-      end
-
       def transform_and_check value
         if value.is_a? Hash
           transform_and_check_results = @fields.map do |key, type|
-            [key, type.transform_and_check(value[key])]
-          end
+            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]
@@ -37,10 +29,10 @@ module Camille
             end.to_h
             [nil, transformed]
           else
-            Camille::TypeError.new(**errors.to_h)
+            [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
 
@@ -54,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,10 +1,6 @@
 module Camille
   module Types
     class Omit < PickAndOmit
-      def check value
-        processed_object.check(value)
-      end
-
       def transform_and_check value
         processed_object.transform_and_check(value)
       end
@@ -15,7 +11,7 @@ module Camille
         end
 
         def processed_object
-          fields = @target_object.fields.reject{|k, _| @keys_array.include?(k)}
+          fields = @target_object.fields.reject{|k, _| @keys.include?(k)}
           Camille::Types::Object.new(fields)
         end
 

data/lib/camille/types/pick.rb

@@ -1,10 +1,6 @@
 module Camille
   module Types
     class Pick < PickAndOmit
-      def check value
-        processed_object.check(value)
-      end
-
       def transform_and_check value
         processed_object.transform_and_check(value)
       end
@@ -15,7 +11,7 @@ module Camille
         end
 
         def processed_object
-          fields = @target_object.fields.select{|k, _| @keys_array.include?(k)}
+          fields = @target_object.fields.select{|k, _| @keys.include?(k)}
           Camille::Types::Object.new(fields)
         end
 

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,29 +8,14 @@ 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
-            )
-          end
-        end
-      end
-
       def transform_and_check value
-        left_transformed = @left.transform value
-        left_result = @left.check left_transformed
-        if left_result
-          right_transformed = @right.transform value
-          right_result = @right.check right_transformed
-          if right_result
+        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' => left_result,
-              'union.right' => right_result
+              'union.left' => right_error,
+              'union.right' => right_error
             )
             [error, nil]
           else

data/lib/camille/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camille
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - 辻彩
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-18 00:00:00.000000000 Z
+date: 2023-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,7 +52,6 @@ files:
 - lib/camille/code_generator.rb
 - lib/camille/configuration.rb
 - lib/camille/controller_extension.rb
-- lib/camille/custom_types/date.rb
 - lib/camille/endpoint.rb
 - lib/camille/generators/install_generator.rb
 - lib/camille/generators/schema_generator.rb
@@ -111,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: Typed API schema for Rails with TypeScript codegen

data/lib/camille/custom_types/date.rb

@@ -1,31 +0,0 @@
-require 'date'
-
-# This type is only for testing, to simulate the usage of transform.
-module Camille
-  module CustomTypes
-    class Date < Camille::Type
-      include Camille::Types
-
-      alias_of(
-        type: 'Date',
-        value: Number
-      )
-
-      def transform value
-        case value
-        when ::Date
-          timestamp = value.to_time.to_i
-        when ::Time
-          timestamp = value.to_i
-        end
-        {
-          type: 'Date',
-          value: timestamp.to_i * 1000
-        }
-      end
-
-    end
-  end
-end
-
-Camille::Loader.loaded_types.delete(Camille::CustomTypes::Date)