camille 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 901863ce3680f14f101ac00cac0ef9f6b64b84413f483e52e90583149eb54d80
-  data.tar.gz: 309265868f68ea69fa5b5b3af60d43813ec8f8602abb8fc8f49c089c7c94fea1
+  metadata.gz: b7393e683a6c060b951c73b888a9e6723cf3333a6a2c1a338e525c95ba00050e
+  data.tar.gz: 86bd555f6ffdce50614ed180043bc9de94476e2b803896a3d0e15b3a84f90576
 SHA512:
-  metadata.gz: e6f3f740d1bbdd532760262e74594e19853b51950c47c9222bea76264b0bf6b4a6839cc0963a3b70778203f34ee867a5c77aa1685232719490c1a47ec939de39
-  data.tar.gz: 79655aa7f4adf210cd0884655f445e9d094f218624fd2be62fedea30e6a5a82fc900a222a4337d28c88c46034ef264d8cfdfb0b01f985a25d83068962f4807ae
+  metadata.gz: 3b9fa70ec2457f286d9627dc62f11d95d743f83b108f98b23f1f2446da9ca743216605f806fb129d12627792493b0a0328d6bcb582ecdb3ad24878bbcc58d8ad
+  data.tar.gz: 7d8d08956a4f43cde2bf7efc94955626efd983abbf98e2d8ae4c39d20a049f7e2055e08a800c4c67154f55d733109e45acf48545c35aa18deb1fd53eab178d9b

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 1.7.0
+
+### Fixed
+
+* Renamed `Camille::Controller::ArgumentError` to `Camille::Controller::InvalidRenderArgumentError` so it no longer shadows the built-in `ArgumentError` inside controllers that include `Camille::Controller`. (#11, thanks @SAY-5)
+
+## 1.6.0
+
+### Added
+
+* Added `response.data` test helper (require `'camille/testing'`). Validates the response body against the endpoint's response type and returns the snake_case body as a `HashWithIndifferentAccess`. Works with RSpec and Minitest integration / request tests.
+
 ## 1.5.0
 
 ### Fixed

data/CLAUDE.md

@@ -0,0 +1,3 @@
+# Testing
+
+Run the test suite with `bundle exec rake` (not `bundle exec rspec` directly).

data/Gemfile.lock

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

data/README.md

@@ -263,6 +263,25 @@ object:
 
 Everything in `config/camille/types` and `config/camille/schemas` will automatically reload after changes in development environment, just like other files in Rails.
 
+### Test helper
+
+Camille ships an optional `response.data` helper for Rails integration / request tests. It looks up the endpoint from the current request, validates `response.parsed_body` against the endpoint's response type, and returns the snake_case body as a `HashWithIndifferentAccess` so you can use either string or symbol keys in assertions.
+
+In your `rails_helper.rb` (RSpec) or `test_helper.rb` (Minitest):
+
+```ruby
+require 'camille/testing'
+```
+
+Then in a test:
+
+```ruby
+get '/products/data'
+expect(response.data[:product][:available_stock]).to eq(1)
+```
+
+If the response body fails the type check the helper raises `Camille::Testing::ResponseTypeError`. If the route has no Camille endpoint it raises `Camille::Testing::MissingEndpointError`.
+
 ## Versioning
 
 This project uses [Semantic Versioning](https://semver.org/).

data/lib/camille/controller.rb

@@ -3,7 +3,7 @@ module Camille
     class TypeError < ::StandardError; end
     class ParamsTypeError < TypeError; end
     class ResponseTypeError < TypeError; end
-    class ArgumentError < ::ArgumentError; end
+    class InvalidRenderArgumentError < ::ArgumentError; end
     class MissingRenderError < ::StandardError; end
 
     def camille_schema
@@ -31,7 +31,7 @@ module Camille
               super(json: rendered)
             end
           else
-            raise ArgumentError.new("Expected key :json for `render` call.")
+            raise InvalidRenderArgumentError.new("Expected key :json for `render` call.")
           end
         else
           super

data/lib/camille/testing.rb

@@ -0,0 +1,51 @@
+require 'action_dispatch'
+
+module Camille
+  module Testing
+    class ResponseTypeError < ::StandardError; end
+    class MissingEndpointError < ::StandardError; end
+
+    module ResponseExtension
+      def data
+        controller_path = request && request.path_parameters[:controller]
+        action          = request && request.path_parameters[:action]
+
+        unless controller_path && action
+          raise Camille::Testing::MissingEndpointError,
+            "No camille endpoint for this response (request did not match a controller action)."
+        end
+
+        controller_class_name = "#{controller_path.camelize}Controller"
+        schema   = Camille::Loader.controller_name_to_schema_map[controller_class_name]
+        endpoint = schema && schema.endpoints[action.to_sym]
+
+        unless endpoint
+          raise Camille::Testing::MissingEndpointError,
+            "No camille endpoint for #{controller_class_name}##{action}."
+        end
+
+        result = endpoint.response_type.check_params(parsed_body)
+        if result.type_error?
+          io = StringIO.new
+          Camille::TypeErrorPrinter.new(result).print(io)
+          raise Camille::Testing::ResponseTypeError,
+            "\nResponse type check failed.\n#{io.string}"
+        end
+
+        deep_indifferent(result.value)
+      end
+
+      private
+
+      def deep_indifferent value
+        case value
+        when Hash  then value.with_indifferent_access
+        when Array then value.map { |v| deep_indifferent(v) }
+        else value
+        end
+      end
+    end
+  end
+end
+
+ActionDispatch::TestResponse.prepend(Camille::Testing::ResponseExtension)

data/lib/camille/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: camille
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.7.0
 platform: ruby
 authors:
 - merely
@@ -38,6 +38,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - CHANGELOG.md
+- CLAUDE.md
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -79,6 +80,7 @@ files:
 - lib/camille/schema_literal_generator.rb
 - lib/camille/schemas.rb
 - lib/camille/syntax.rb
+- lib/camille/testing.rb
 - lib/camille/type.rb
 - lib/camille/type_error.rb
 - lib/camille/type_error_printer.rb