camille 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f58ec63581094cce8faf1d3f9dd3e1909ebe3fb188e8c7ed59c09a74645793b
-  data.tar.gz: badb42b9b2bb52426060ba9c62544ac6660334784b458360e82594d09ea785d5
+  metadata.gz: a6293de3ef709101a5410b308f140bd654e38e81905eefff034eaff831da03d7
+  data.tar.gz: d8224fc21dd1c63e7f5a93a65ff6452d841da44c12ef7eccb2a9b713d34211cb
 SHA512:
-  metadata.gz: fd2e3eb6d0f629cf9eaacb6c8c8f09c92bd9b77a9815a7025717913d2542a6f38451a6f1c16b3cfdecc5c09c22f2949ab6b9cb77b9f349cec88bd22cef7ee375
-  data.tar.gz: 99177b3fe5a775615b8bf01cb88e23a3e6100409fee7a1a0af486ad918adf6de4c0c52d8e9b7c660f08110825ecd1609a713f9a7dc739cdb4a6ae67a13753af3
+  metadata.gz: ca46b44d6ee87b156d066e1d9e3736fb74b9c0b1ed2df4634a62bbc879fc23aaa9fb42b4dd6857eda5a47a4968fe8c157b384044da1cda65fd20a45b4071bbc2
+  data.tar.gz: 1e52c60928f864586e7361ec0a63419d6763f3f8b6339395157750ffd78a2cd672179aa9028d83db26be79351e68625243c052c6001b1f07f3acac6dc4fbb728

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 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
+
+* Allow Camille::Controller::ParamsTypeError to be rescued by `rescue_from` in controllers.
+
 ## 1.4.0
 
 ### Added

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,72 +1,71 @@
 PATH
   remote: .
   specs:
-    camille (1.3.0)
+    camille (1.6.0)
       rails (>= 6.1, < 8.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.2.2.1)
-      actionpack (= 7.2.2.1)
-      activesupport (= 7.2.2.1)
+    actioncable (8.0.4)
+      actionpack (= 8.0.4)
+      activesupport (= 8.0.4)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
       zeitwerk (~> 2.6)
-    actionmailbox (7.2.2.1)
-      actionpack (= 7.2.2.1)
-      activejob (= 7.2.2.1)
-      activerecord (= 7.2.2.1)
-      activestorage (= 7.2.2.1)
-      activesupport (= 7.2.2.1)
+    actionmailbox (8.0.4)
+      actionpack (= 8.0.4)
+      activejob (= 8.0.4)
+      activerecord (= 8.0.4)
+      activestorage (= 8.0.4)
+      activesupport (= 8.0.4)
       mail (>= 2.8.0)
-    actionmailer (7.2.2.1)
-      actionpack (= 7.2.2.1)
-      actionview (= 7.2.2.1)
-      activejob (= 7.2.2.1)
-      activesupport (= 7.2.2.1)
+    actionmailer (8.0.4)
+      actionpack (= 8.0.4)
+      actionview (= 8.0.4)
+      activejob (= 8.0.4)
+      activesupport (= 8.0.4)
       mail (>= 2.8.0)
       rails-dom-testing (~> 2.2)
-    actionpack (7.2.2.1)
-      actionview (= 7.2.2.1)
-      activesupport (= 7.2.2.1)
+    actionpack (8.0.4)
+      actionview (= 8.0.4)
+      activesupport (= 8.0.4)
       nokogiri (>= 1.8.5)
-      racc
-      rack (>= 2.2.4, < 3.2)
+      rack (>= 2.2.4)
       rack-session (>= 1.0.1)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
       useragent (~> 0.16)
-    actiontext (7.2.2.1)
-      actionpack (= 7.2.2.1)
-      activerecord (= 7.2.2.1)
-      activestorage (= 7.2.2.1)
-      activesupport (= 7.2.2.1)
+    actiontext (8.0.4)
+      actionpack (= 8.0.4)
+      activerecord (= 8.0.4)
+      activestorage (= 8.0.4)
+      activesupport (= 8.0.4)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.2.2.1)
-      activesupport (= 7.2.2.1)
+    actionview (8.0.4)
+      activesupport (= 8.0.4)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activejob (7.2.2.1)
-      activesupport (= 7.2.2.1)
+    activejob (8.0.4)
+      activesupport (= 8.0.4)
       globalid (>= 0.3.6)
-    activemodel (7.2.2.1)
-      activesupport (= 7.2.2.1)
-    activerecord (7.2.2.1)
-      activemodel (= 7.2.2.1)
-      activesupport (= 7.2.2.1)
+    activemodel (8.0.4)
+      activesupport (= 8.0.4)
+    activerecord (8.0.4)
+      activemodel (= 8.0.4)
+      activesupport (= 8.0.4)
       timeout (>= 0.4.0)
-    activestorage (7.2.2.1)
-      actionpack (= 7.2.2.1)
-      activejob (= 7.2.2.1)
-      activerecord (= 7.2.2.1)
-      activesupport (= 7.2.2.1)
+    activestorage (8.0.4)
+      actionpack (= 8.0.4)
+      activejob (= 8.0.4)
+      activerecord (= 8.0.4)
+      activesupport (= 8.0.4)
       marcel (~> 1.0)
-    activesupport (7.2.2.1)
+    activesupport (8.0.4)
       base64
       benchmark (>= 0.3)
       bigdecimal
@@ -78,39 +77,43 @@ GEM
       minitest (>= 5.1)
       securerandom (>= 0.3)
       tzinfo (~> 2.0, >= 2.0.5)
-    base64 (0.2.0)
-    benchmark (0.4.0)
-    bigdecimal (3.1.8)
+      uri (>= 0.13.1)
+    base64 (0.3.0)
+    benchmark (0.5.0)
+    bigdecimal (4.0.1)
     builder (3.3.0)
-    concurrent-ruby (1.3.4)
-    connection_pool (2.4.1)
+    concurrent-ruby (1.3.6)
+    connection_pool (3.0.2)
     crass (1.0.6)
-    date (3.4.1)
+    date (3.5.1)
     diff-lcs (1.5.1)
-    drb (2.2.1)
-    erubi (1.13.0)
-    globalid (1.2.1)
+    drb (2.2.3)
+    erb (6.0.1)
+    erubi (1.13.1)
+    globalid (1.3.0)
       activesupport (>= 6.1)
-    i18n (1.14.6)
+    i18n (1.14.8)
       concurrent-ruby (~> 1.0)
-    io-console (0.8.0)
-    irb (1.14.2)
+    io-console (0.8.2)
+    irb (1.16.0)
+      pp (>= 0.6.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    logger (1.6.3)
-    loofah (2.23.1)
+    logger (1.7.0)
+    loofah (2.25.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
-    mail (2.8.1)
+    mail (2.9.0)
+      logger
       mini_mime (>= 0.1.1)
       net-imap
       net-pop
       net-smtp
-    marcel (1.0.4)
+    marcel (1.1.0)
     mini_mime (1.1.5)
-    mini_portile2 (2.8.9)
-    minitest (5.25.4)
-    net-imap (0.5.6)
+    minitest (6.0.1)
+      prism (~> 1.5)
+    net-imap (0.6.2)
       date
       net-protocol
     net-pop (0.1.2)
@@ -119,56 +122,61 @@ GEM
       timeout
     net-smtp (0.5.1)
       net-protocol
-    nio4r (2.7.4)
-    nokogiri (1.17.2)
-      mini_portile2 (~> 2.8.2)
+    nio4r (2.7.5)
+    nokogiri (1.19.0-x86_64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.17.2-x86_64-linux)
-      racc (~> 1.4)
-    psych (5.2.1)
+    pp (0.6.3)
+      prettyprint
+    prettyprint (0.2.0)
+    prism (1.9.0)
+    psych (5.3.1)
       date
       stringio
     racc (1.8.1)
-    rack (3.1.8)
-    rack-session (2.0.0)
+    rack (3.2.4)
+    rack-session (2.1.1)
+      base64 (>= 0.1.0)
       rack (>= 3.0.0)
-    rack-test (2.1.0)
+    rack-test (2.2.0)
       rack (>= 1.3)
-    rackup (2.2.1)
+    rackup (2.3.1)
       rack (>= 3)
-    rails (7.2.2.1)
-      actioncable (= 7.2.2.1)
-      actionmailbox (= 7.2.2.1)
-      actionmailer (= 7.2.2.1)
-      actionpack (= 7.2.2.1)
-      actiontext (= 7.2.2.1)
-      actionview (= 7.2.2.1)
-      activejob (= 7.2.2.1)
-      activemodel (= 7.2.2.1)
-      activerecord (= 7.2.2.1)
-      activestorage (= 7.2.2.1)
-      activesupport (= 7.2.2.1)
+    rails (8.0.4)
+      actioncable (= 8.0.4)
+      actionmailbox (= 8.0.4)
+      actionmailer (= 8.0.4)
+      actionpack (= 8.0.4)
+      actiontext (= 8.0.4)
+      actionview (= 8.0.4)
+      activejob (= 8.0.4)
+      activemodel (= 8.0.4)
+      activerecord (= 8.0.4)
+      activestorage (= 8.0.4)
+      activesupport (= 8.0.4)
       bundler (>= 1.15.0)
-      railties (= 7.2.2.1)
-    rails-dom-testing (2.2.0)
+      railties (= 8.0.4)
+    rails-dom-testing (2.3.0)
       activesupport (>= 5.0.0)
       minitest
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.6.2)
       loofah (~> 2.21)
       nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
-    railties (7.2.2.1)
-      actionpack (= 7.2.2.1)
-      activesupport (= 7.2.2.1)
+    railties (8.0.4)
+      actionpack (= 8.0.4)
+      activesupport (= 8.0.4)
       irb (~> 1.13)
       rackup (>= 1.0.0)
       rake (>= 12.2)
       thor (~> 1.0, >= 1.2.2)
+      tsort (>= 0.2)
       zeitwerk (~> 2.6)
-    rake (13.2.1)
-    rdoc (6.9.0)
+    rake (13.3.1)
+    rdoc (7.1.0)
+      erb
       psych (>= 4.0.0)
-    reline (0.5.12)
+      tsort
+    reline (0.6.3)
       io-console (~> 0.5)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
@@ -191,18 +199,20 @@ GEM
       rspec-mocks (~> 3.13)
       rspec-support (~> 3.13)
     rspec-support (3.13.2)
-    securerandom (0.4.0)
-    stringio (3.1.2)
-    thor (1.3.2)
-    timeout (0.4.3)
+    securerandom (0.4.1)
+    stringio (3.2.0)
+    thor (1.5.0)
+    timeout (0.6.0)
+    tsort (0.2.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
+    uri (1.1.1)
     useragent (0.16.11)
-    websocket-driver (0.7.7)
+    websocket-driver (0.8.0)
       base64
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.7.1)
+    zeitwerk (2.7.4)
 
 PLATFORMS
   x86_64-linux

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

@@ -71,6 +71,8 @@ module Camille
             raise_missing_render_error
           end
           result
+        rescue ParamsTypeError => e
+          rescue_with_handler(e) || raise
         rescue ActionController::MissingExactTemplate
           raise_missing_render_error
         end

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.4.0"
+  VERSION = "1.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: camille
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.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
@@ -122,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Typed API schema for Rails with TypeScript codegen
 test_files: []