taro 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4f35df13466f65caaf120945539ca21fcd2562dc3e79145817c66f75f58c016
-  data.tar.gz: c3f2af6555b7a3c9f6e81a6ba69f5fceea0663ed6b93c22cfe584f478a2a4b24
+  metadata.gz: d73348290387aeef3de0558f6557af6572326043dff427ee295386a12e8bf6a6
+  data.tar.gz: 89b0a6c8efae50665d43385b0b4182fba6b07e5f97e933d3add5d0e1ba19f421
 SHA512:
-  metadata.gz: c3c7de4bb79a0f78f1060ea32bf65e1da9bf597f09790d95f5c0e09a0fdc175de973aebdc28c39a1aa994dbd0fd41e6be3097508ddfad57474ad774603aac933
-  data.tar.gz: aad75b1177ff07d1e95415e720076d85734de7ebd185e2503e4fa80fdf8ffba4e2f2cf4df735582ed6e69599cfba413ce901abcd043f178efcf1ec6ef9072054
+  metadata.gz: 67a0d0a5d2464c7ec6954143c95311b92b1a4a78041b298449815b1e57340de7091ac89235fd9e674ee1d3e99ed531049e99207ec62498fa94687b7c91956edd
+  data.tar.gz: '0768d75380ee9b18de093bebf1952b4eeac1e7965fea8c3a0cb5fbec3ef84ec6a27d5e141a837bf6a0f9d698e5b2ceff9ba2e30a33143edd434ebd25812a933a'

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [2.2.0] - 2025-02-22
+
+### Added
+
+- error message when incorrectly chaining `with_cache`
+
 ## [2.1.0] - 2025-02-21
 
 ### Added

data/README.md

@@ -244,6 +244,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,30 +365,6 @@ 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)

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/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/rendering.rb

@@ -5,7 +5,7 @@ module Taro::Types::Shared::Rendering
     result = Taro::Cache.call(object, **cache_attrs) do
       new(object).cached_coerce_response
     end
-    self.last_render = [self.without_cache || self, result.__id__]
+    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.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: taro
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.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-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -117,6 +117,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 +144,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.