camille 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82a091b46cd7266990fb540e54febefd78773260f780283d624fa88321090d81
-  data.tar.gz: 33a660f689f967f3be04e9bc70b15214fa28d36c74df223357f66dbe17bce7b1
+  metadata.gz: 5f58ec63581094cce8faf1d3f9dd3e1909ebe3fb188e8c7ed59c09a74645793b
+  data.tar.gz: badb42b9b2bb52426060ba9c62544ac6660334784b458360e82594d09ea785d5
 SHA512:
-  metadata.gz: 32442ecdc91cd62092d3d49ce67c6cfe2ccedaeb1a285a1e6f44615792ce9408d8d245690cb96ff269853a72d3807080f1bdcb88639439b4e957a4d8ced726f4
-  data.tar.gz: 21398e4687f2a7e3f56b06b86ad1c86a80bbe8719c57227a413df09ad7251c28e86af89145b9656243d80c68b9eeb4a9dea412b1a6e67c6189cc6b55d2af943f
+  metadata.gz: fd2e3eb6d0f629cf9eaacb6c8c8f09c92bd9b77a9815a7025717913d2542a6f38451a6f1c16b3cfdecc5c09c22f2949ab6b9cb77b9f349cec88bd22cef7ee375
+  data.tar.gz: 99177b3fe5a775615b8bf01cb88e23a3e6100409fee7a1a0af486ad918adf6de4c0c52d8e9b7c660f08110825ecd1609a713f9a7dc739cdb4a6ae67a13753af3

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 1.4.0
+
+### Added
+
+* Added Camille::Controller::ParamsTypeError and Camille::Controller::ResponseTypeError to indicate source of TypeError.
+
+## 1.3.0
+
+### Added
+
+* Added option to check controller params type: `config.check_params`.
+
 ## 1.2.0
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    camille (1.1.0)
+    camille (1.3.0)
       rails (>= 6.1, < 8.1)
 
 GEM

data/lib/camille/basic_type.rb

@@ -41,6 +41,10 @@ module Camille
       raise NotImplementedError
     end
 
+    def check_params value
+      check value
+    end
+
     def self.| other
       Camille::Type.instance(self) | other
     end
@@ -53,6 +57,10 @@ module Camille
       Camille::Type.instance(self)[]
     end
 
+    def self.check_params value
+      Camille::Type.instance(self).check_params value
+    end
+
     def self.directly_instantiable?
       instance_method(:initialize).arity == 0
     end

data/lib/camille/configuration.rb

@@ -3,7 +3,7 @@ module Camille
   class Configuration
     class << self
       attr_reader :response_key_converter, :params_key_converter
-      attr_accessor :ts_header, :ts_location
+      attr_accessor :ts_header, :ts_location, :check_params
 
       def load_default_configurations
         self.response_key_converter = lambda do |string|
@@ -13,6 +13,8 @@ module Camille
         self.params_key_converter = lambda do |string|
           string.underscore
         end
+
+        self.check_params = false
       end
 
       def response_key_converter= lambda

data/lib/camille/controller.rb

@@ -1,6 +1,8 @@
 module Camille
   module Controller
     class TypeError < ::StandardError; end
+    class ParamsTypeError < TypeError; end
+    class ResponseTypeError < TypeError; end
     class ArgumentError < ::ArgumentError; end
     class MissingRenderError < ::StandardError; end
 
@@ -23,7 +25,7 @@ module Camille
             if result.type_error?
               string_io = StringIO.new
               Camille::TypeErrorPrinter.new(result).print(string_io)
-              raise TypeError.new("\nType check failed for response.\n#{string_io.string}")
+              raise ResponseTypeError.new("\nType check failed for response.\n#{string_io.string}")
             else
               rendered = result.render.json
               super(json: rendered)
@@ -43,7 +45,26 @@ module Camille
       Camille::Loader.check_and_raise_exception
       if endpoint = camille_endpoint
         begin
-          params.deep_transform_keys!{|key| Camille::Configuration.params_key_converter.call(key.to_s)}
+          if Camille::Configuration.check_params
+            # New way: check params against the endpoint's params_type if it exists
+            if endpoint.params_type
+              params_to_check = params.to_unsafe_h
+              check_result = endpoint.params_type.check_params(params_to_check)
+
+              if check_result.type_error?
+                string_io = StringIO.new
+                Camille::TypeErrorPrinter.new(check_result).print(string_io)
+                raise ParamsTypeError.new("\nType check failed for params.\n#{string_io.string}")
+              else
+                # Use the checked value which already has snake_case keys
+                self.params = ActionController::Parameters.new(check_result.value)
+              end
+            end
+          else
+            # Old way: just transform keys
+            params.deep_transform_keys!{|key| Camille::Configuration.params_key_converter.call(key.to_s)}
+          end
+
           result = super
           # When there's no `render` call, Rails will return status 204
           if response.status == 204

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

@@ -4,4 +4,9 @@ Camille.configure do |config|
     // DO NOT EDIT! This file is automatically generated.
     import request from './request'
   EOF
+
+  # Enable type checking for controller parameters.
+  # When enabled, params will be validated against the schema and automatically
+  # converted from camelCase to snake_case.
+  config.check_params = true
 end

data/lib/camille/type.rb

@@ -23,10 +23,18 @@ module Camille
       @underlying.check value
     end
 
+    def check_params value
+      @underlying.check_params value
+    end
+
     def self.check value
       new.check value
     end
 
+    def self.check_params value
+      new.check_params value
+    end
+
     def self.klass_name
       name.gsub(/^Camille::Types::/, '')
     end

data/lib/camille/types/array.rb

@@ -9,32 +9,41 @@ module Camille
       end
 
       def check value
-        if value.is_a? ::Array
-          results = value.map.with_index do |element, index|
-            [index, @content.check(element)]
-          end
-
-          errors = results.map do |index, result|
-            if result.type_error?
-              ["array[#{index}]", result]
-            else
-              nil
-            end
-          end.compact
+        check_with_method(value, :check)
+      end
 
-          if errors.empty?
-            Camille::Checked.new(fingerprint, results.map{|_, checked| checked.value})
-          else
-            Camille::TypeError.new(**errors.to_h)
-          end
-        else
-          Camille::TypeError.new("Expected array, got #{value.inspect}.")
-        end
+      def check_params value
+        check_with_method(value, :check_params)
       end
 
       def literal
         "#{@content.literal}[]"
       end
+
+      private
+        def check_with_method value, method_name
+          if value.is_a? ::Array
+            results = value.map.with_index do |element, index|
+              [index, @content.public_send(method_name, element)]
+            end
+
+            errors = results.map do |index, result|
+              if result.type_error?
+                ["array[#{index}]", result]
+              else
+                nil
+              end
+            end.compact
+
+            if errors.empty?
+              Camille::Checked.new(fingerprint, results.map{|_, checked| checked.value})
+            else
+              Camille::TypeError.new(**errors.to_h)
+            end
+          else
+            Camille::TypeError.new("Expected array, got #{value.inspect}.")
+          end
+        end
     end
   end
 end

data/lib/camille/types/intersection.rb

@@ -12,27 +12,36 @@ module Camille
       end
 
       def check value
-        left_result = @left.check value
-        if left_result.type_error?
-          Camille::TypeError.new(
-            'intersection.left' => left_result
-          )
-        else
-          right_result = @right.check left_result.value
-          if right_result.type_error?
-            Camille::TypeError.new(
-              'intersection.right' => right_result
-            )
-          else
-            Camille::Checked.new(fingerprint, right_result.value)
-          end
-        end
+        check_with_method(value, :check)
+      end
+
+      def check_params value
+        check_with_method(value, :check_params)
       end
 
       def literal
         "(#{@left.literal} & #{@right.literal})"
       end
 
+      private
+        def check_with_method value, method_name
+          left_result = @left.public_send(method_name, value)
+          if left_result.type_error?
+            Camille::TypeError.new(
+              'intersection.left' => left_result
+            )
+          else
+            right_result = @right.public_send(method_name, left_result.value)
+            if right_result.type_error?
+              Camille::TypeError.new(
+                'intersection.right' => right_result
+              )
+            else
+              Camille::Checked.new(fingerprint, right_result.value)
+            end
+          end
+        end
+
     end
   end
 end

data/lib/camille/types/object.rb

@@ -47,6 +47,52 @@ module Camille
         end
       end
 
+      def check_params value
+        if value.is_a? Hash
+          # Convert camelCase keys to snake_case
+          converted_value = value.transform_keys do |key|
+            Camille::KeyConverter.convert_params_key(key.to_s)
+          end
+
+          fields_with_string_keys = @fields.transform_keys(&:to_s)
+          optional_keys_as_strings = @optional_keys.map(&:to_s)
+
+          # Now check using the regular check method which expects snake_case
+          keys = (fields_with_string_keys.keys + converted_value.keys).uniq
+          keys_to_check, keys_to_skip = keys.partition{|key| fields_with_string_keys[key]}
+
+          results = keys_to_check.map do |key|
+            type = fields_with_string_keys[key]
+            if optional_keys_as_strings.include?(key) && converted_value[key].nil?
+              nil
+            else
+              [key, type.check_params(converted_value[key])]
+            end
+          end.compact
+
+          errors = results.map do |key, result|
+            if result.type_error?
+              [key.to_s, result]
+            else
+              nil
+            end
+          end.compact
+
+          skipped_pairs = keys_to_skip.map do |key|
+            [key, converted_value[key]]
+          end
+
+          if errors.empty?
+            object = Hash[results.map{|key, checked| [key, checked.value]}.concat(skipped_pairs).to_h]
+            Camille::Checked.new(fingerprint, object)
+          else
+            Camille::TypeError.new(**errors.to_h)
+          end
+        else
+          Camille::TypeError.new("Expected hash, got #{value.inspect}.")
+        end
+      end
+
       def literal
         "{#{@fields.map{|k,v| "#{literal_key k}: #{v.literal}"}.join(', ')}}"
       end

data/lib/camille/types/tuple.rb

@@ -9,32 +9,41 @@ module Camille
       end
 
       def check value
-        if value.is_a?(::Array) && value.size == @elements.size
-          results = @elements.map.with_index do |type, index|
-            [index, type.check(value[index])]
-          end
-
-          errors = results.map do |index, result|
-            if result.type_error?
-              ["tuple[#{index}]", result]
-            else
-              nil
-            end
-          end.compact
+        check_with_method(value, :check)
+      end
 
-          if errors.empty?
-            Camille::Checked.new(fingerprint, results.map{|_, checked| checked.value})
-          else
-            Camille::TypeError.new(**errors.to_h)
-          end
-        else
-          Camille::TypeError.new("Expected array of size #{@elements.size}, got #{value.inspect}.")
-        end
+      def check_params value
+        check_with_method(value, :check_params)
       end
 
       def literal
         "[#{elements.map(&:literal).join(', ')}]"
       end
+
+      private
+        def check_with_method value, method_name
+          if value.is_a?(::Array) && value.size == @elements.size
+            results = @elements.map.with_index do |type, index|
+              [index, type.public_send(method_name, value[index])]
+            end
+
+            errors = results.map do |index, result|
+              if result.type_error?
+                ["tuple[#{index}]", result]
+              else
+                nil
+              end
+            end.compact
+
+            if errors.empty?
+              Camille::Checked.new(fingerprint, results.map{|_, checked| checked.value})
+            else
+              Camille::TypeError.new(**errors.to_h)
+            end
+          else
+            Camille::TypeError.new("Expected array of size #{@elements.size}, got #{value.inspect}.")
+          end
+        end
     end
   end
 end

data/lib/camille/types/union.rb

@@ -10,25 +10,34 @@ module Camille
       end
 
       def check value
-        left_result = @left.check value
-        if left_result.type_error?
-          right_result = @right.check value
-          if right_result.type_error?
-            Camille::TypeError.new(
-              'union.left' => left_result,
-              'union.right' => right_result
-            )
-          else
-            Camille::Checked.new(fingerprint, right_result.value)
-          end
-        else
-          Camille::Checked.new(fingerprint, left_result.value)
-        end
+        check_with_method(value, :check)
+      end
+
+      def check_params value
+        check_with_method(value, :check_params)
       end
 
       def literal
         "(#{@left.literal} | #{@right.literal})"
       end
+
+      private
+        def check_with_method value, method_name
+          left_result = @left.public_send(method_name, value)
+          if left_result.type_error?
+            right_result = @right.public_send(method_name, value)
+            if right_result.type_error?
+              Camille::TypeError.new(
+                'union.left' => left_result,
+                'union.right' => right_result
+              )
+            else
+              Camille::Checked.new(fingerprint, right_result.value)
+            end
+          else
+            Camille::Checked.new(fingerprint, left_result.value)
+          end
+        end
     end
   end
 end

data/lib/camille/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: camille
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - merely