taro 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4f35df13466f65caaf120945539ca21fcd2562dc3e79145817c66f75f58c016
-  data.tar.gz: c3f2af6555b7a3c9f6e81a6ba69f5fceea0663ed6b93c22cfe584f478a2a4b24
+  metadata.gz: c96d6fd71ad22df31d5ab4cefb09389fd7ed5b41b5dd8821132fa2c5fa322837
+  data.tar.gz: f56362229e93f2f8c51a5490245d4a37e224015fecd42bb86a35926a01e8d776
 SHA512:
-  metadata.gz: c3c7de4bb79a0f78f1060ea32bf65e1da9bf597f09790d95f5c0e09a0fdc175de973aebdc28c39a1aa994dbd0fd41e6be3097508ddfad57474ad774603aac933
-  data.tar.gz: aad75b1177ff07d1e95415e720076d85734de7ebd185e2503e4fa80fdf8ffba4e2f2cf4df735582ed6e69599cfba413ce901abcd043f178efcf1ec6ef9072054
+  metadata.gz: 34ad2aedee3c3a21973420ca5e1185024c7d6b127ee9ca914b847134939bcd136e70f10130607b8392ce8044dfcb7c8014fa306d00d81b81266d68fcdad19b95
+  data.tar.gz: 1bec2fbada3a23267f87195323b2b112297c21e78c22281071bd2ec84a7359f78836ed250e85ae3f3d1765f428dd7ff1bdaaf92f5df2bd17883abed11b7a39eb

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [2.3.0] - 2025-02-24
+
+### Added
+
+- `Taro.config.raise_for_undeclared_params`
+
+## [2.2.0] - 2025-02-22
+
+### Added
+
+- error message when incorrectly chaining `with_cache`
+
 ## [2.1.0] - 2025-02-21
 
 ### Added

data/README.md

@@ -140,6 +140,14 @@ Requests are automatically validated to match the declared input schema, unless
 Taro.config.parse_params = false
 ```
 
+There is also an option to raise an error if any undeclared params are submitted:
+
+```ruby
+Taro.config.raise_for_undeclared_params = true
+```
+
+This option is similar to `action_on_unpermitted_parameters = :raise` in Rails and is most useful in dev and test environments. The railtie enables it automatically in these environments.
+
 #### Response validation
 
 Responses are automatically validated to have used the correct type for rendering, which guarantees that they match the declaration. This means you have to use the types to render complex responses, and manually building a Hash that conforms to the schema will raise an error. Primitive/scalar types are an exception, e.g. you *can* do:
@@ -244,6 +252,27 @@ class ErrorType < ObjectType
 end
 ```
 
+### Caching
+
+Taro provides support for caching. The cache instance can be configured by setting `Taro::Cache.cache_instance`. By default, the railtie will set it to `Rails.cache`.
+
+It supports configuring an ad hoc cache when using a render call, e.g.
+
+```ruby
+bike = Bike.find(params[:id])
+BikeType.with_cache(cache_key: bike.cache_key, expires_in: 3.minutes).render(bike)
+```
+
+Or by configuring the cache rule on a per type basis, e.g.
+
+```ruby
+class BikeType < ObjectType
+  self.cache_key = ->(bike) { bike.cache_key_with_version }
+  self.expires_in = 1.hour
+  # ...
+end
+```
+
 ## FAQ
 
 ### How do I render API docs?
@@ -344,33 +373,8 @@ class MyController < ApplicationController
 end
 ```
 
-## Caching
-
-Taro provides support for caching. The cache instance can be configured by setting `Taro::Cache.cache_instance`. By default, the railtie will set it to `Rails.cache`.
-
-It supports configuring an add hoc cache when using a render call, e.g.
-
-```ruby
-bike = Bike.find(params[:id])
-BikeType.with_cache(cache_key: bike.cache_key, expires_in: 3.minutes).render(bike)
-```
-
-Or by configuring the cache rule on a per type bases, e.g.
-
-```ruby
-class BikeType < ObjectType
-  # Optional description of BikeType (for the OpenAPI export)
-  self.desc = 'A bike and all relevant information about it'
-  self.cache_key = ->(bike) { bike.cache_key_with_version }
-  self.expires_in = 1.hour
-
-  ...
-end
-```
-
 ## Possible future features
 
-- warning/raising for undeclared input params (currently they are ignored)
 - usage without rails is possible but not convenient yet
 - rspec matchers for testing
 - sum types

data/lib/taro/config.rb

@@ -5,6 +5,7 @@ module Taro::Config
     :export_format,
     :export_path,
     :parse_params,
+    :raise_for_undeclared_params,
     :validate_response,
   )
 
@@ -14,6 +15,7 @@ module Taro::Config
   self.export_format = :yaml
   self.export_path = 'api.yml'
   self.parse_params = true
+  self.raise_for_undeclared_params = false # may be overridden by railtie
   self.validate_response = true
 end
 

data/lib/taro/declaration.rb

@@ -5,7 +5,7 @@ class Taro::Declaration
   attr_reader :desc, :summary, :params, :return_defs, :return_descriptions, :tags
 
   def initialize(for_klass = nil)
-    @params = Class.new(Taro::Types::InputType)
+    @params = Class.new(Taro::Types::RailsParamsType)
     @return_defs = {}
     @return_descriptions = {}
 

data/lib/taro/rails/railtie.rb

@@ -1,5 +1,7 @@
 class Taro::Rails::Railtie < ::Rails::Railtie
   initializer("taro") do |app|
+    Taro.config.raise_for_undeclared_params = %w[development test].include?(Rails.env)
+
     # The `:action_controller` hook fires for both ActionController::API
     # and ActionController::Base, executing the block in their context.
     ActiveSupport.on_load(:action_controller) do

data/lib/taro/types/base_type.rb

@@ -22,4 +22,5 @@ Taro::Types::BaseType = Struct.new(:object) do
   extend Taro::Types::Shared::Rendering
   include Taro::Types::Shared::Caching
   include Taro::Types::Shared::Errors
+  include Taro::Types::Shared::TypeClass
 end

data/lib/taro/types/field.rb

@@ -3,6 +3,7 @@ require_relative 'field_validation'
 Taro::Types::Field = Data.define(:name, :type, :null, :method, :default, :enum, :defined_at, :desc, :deprecated) do
   include Taro::Types::FieldValidation
   include Taro::Types::Shared::Errors
+  include Taro::Types::Shared::TypeClass
 
   def initialize(name:, type:, null:, method: name, default: Taro::None, enum: nil, defined_at: nil, desc: nil, deprecated: nil)
     enum = coerce_to_enum(enum)

data/lib/taro/types/rails_params_type.rb

@@ -0,0 +1,10 @@
+require_relative 'object_type'
+
+# Abstract base class for rails declaration params. Internal use only.
+class Taro::Types::RailsParamsType < Taro::Types::InputType
+  # Skip validation of base params because they contain rails "additions"
+  # like controller, action, routing-related stuff, de-nested values, etc.
+  def validate_no_undeclared_params?
+    false
+  end
+end

data/lib/taro/types/shared/caching.rb

@@ -7,7 +7,7 @@ module Taro::Types::Shared::Caching
 
   def self.included(klass)
     klass.extend(ClassMethods)
-    klass.singleton_class.attr_accessor :expires_in, :without_cache
+    klass.singleton_class.attr_accessor :expires_in
     klass.singleton_class.attr_reader :cache_key
   end
 
@@ -23,7 +23,8 @@ module Taro::Types::Shared::Caching
       klass = dup
       klass.cache_key = cache_key.is_a?(Proc) ? cache_key : ->(_) { cache_key }
       klass.expires_in = expires_in
-      klass.without_cache = self
+      this = self
+      klass.define_singleton_method(:type_class) { this }
       klass
     end
   end

data/lib/taro/types/shared/derived_types.rb

@@ -35,9 +35,11 @@ module Taro::Types::Shared::DerivedTypes
 
     root.define_singleton_method(method_name) do
       derived_types[type] ||= begin
-        type_class = Taro::Types::Coercion.call(type:)
-        new_type = Class.new(type_class)
-        new_type.define_name("#{self.name}.#{method_name}")
+        name || raise(Taro::ArgumentError, 'Cannot derive from anonymous type')
+
+        coerced_type = Taro::Types::Coercion.call(type:)
+        new_type = Class.new(coerced_type)
+        new_type.define_name("#{name}.#{method_name}")
         new_type.derive_from(self)
         new_type
       end

data/lib/taro/types/shared/object_coercion.rb

@@ -1,6 +1,7 @@
 # Provides input and response handling for types with fields.
 module Taro::Types::Shared::ObjectCoercion
   def coerce_input
+    validate_no_undeclared_params
     self.class.fields.transform_values do |field|
       field.value_for_input(object)
     end
@@ -13,4 +14,17 @@ module Taro::Types::Shared::ObjectCoercion
       field.value_for_response(object, context: self, object_is_hash:)
     end
   end
+
+  private
+
+  def validate_no_undeclared_params
+    return unless validate_no_undeclared_params?
+
+    undeclared = object.to_h.keys.map(&:to_sym) - self.class.send(:field_defs).keys
+    undeclared.any? && input_error("Undeclared params: #{undeclared.join(', ')}")
+  end
+
+  def validate_no_undeclared_params?
+    Taro.config.raise_for_undeclared_params
+  end
 end

data/lib/taro/types/shared/rendering.rb

@@ -1,11 +1,9 @@
 module Taro::Types::Shared::Rendering
   # The `::render` method is intended for use in controllers.
   # Overrides of this method must call super.
-  def render(object, cache_attrs = {})
-    result = Taro::Cache.call(object, **cache_attrs) do
-      new(object).cached_coerce_response
-    end
-    self.last_render = [self.without_cache || self, result.__id__]
+  def render(object)
+    result = new(object).cached_coerce_response
+    self.last_render = [type_class, result.__id__]
     result
   end
 

data/lib/taro/types/shared/type_class.rb

@@ -0,0 +1,12 @@
+# `type_class` is a convenience method to get the type class of types,
+# of with_cache-types, of type instances, and of fields in the same way.
+module Taro::Types::Shared::TypeClass
+  def self.included(klass)
+    if klass.instance_methods.include?(:type) # Field
+      klass.alias_method                 :type_class, :type
+    else # BaseType
+      klass.singleton_class.alias_method :type_class, :itself
+      klass.alias_method                 :type_class, :class
+    end
+  end
+end

data/lib/taro/version.rb

@@ -1,4 +1,4 @@
 # :nocov:
 module Taro
-  VERSION = "2.1.0"
+  VERSION = "2.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: taro
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Janosch Müller
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-21 00:00:00.000000000 Z
+date: 2025-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -89,6 +89,7 @@ files:
 - lib/taro/types/object_types/no_content_type.rb
 - lib/taro/types/object_types/page_info_type.rb
 - lib/taro/types/object_types/page_type.rb
+- lib/taro/types/rails_params_type.rb
 - lib/taro/types/response_type.rb
 - lib/taro/types/scalar/boolean_type.rb
 - lib/taro/types/scalar/float_type.rb
@@ -117,6 +118,7 @@ files:
 - lib/taro/types/shared/openapi_type.rb
 - lib/taro/types/shared/pattern.rb
 - lib/taro/types/shared/rendering.rb
+- lib/taro/types/shared/type_class.rb
 - lib/taro/version.rb
 - tasks/benchmark.rake
 - tasks/benchmark_1kb.json
@@ -143,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Typed Api using Ruby Objects.