taro 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c7750f1403fa65519d22915908d5aeb6cf5bbeec5497d68369bf5a4e37fb0e8
-  data.tar.gz: 0b6d6b440c1f4fcdb965af8fb1aaf2d26f2ca3a9d2a2fb924bfe9456cb811090
+  metadata.gz: d8f629d8573ed34c2d60303a387e99cae4cc9fcb0b14901d7080def1e27d0d90
+  data.tar.gz: 40c3ae606ade65922c5b69f9dd86353f2740d061b6d7094f61abe906e5f9198f
 SHA512:
-  metadata.gz: 1f37ffe80f9f14ef49bd3131f0a64f5254219c4851de19ec6523143d508440cb263741c2ca56858eeff917cf0a4d1002b642b4e6f87498e47b62b3ffc5fbc4c8
-  data.tar.gz: 59fbfef1126825880c2d5b64b1d2a3799c25502d094f9758fa9181d7e1e3fa44b2b2504ccbf24c1d18925a5e53ceef1e1ca309cd8980f8950d385d1f3197aadb
+  metadata.gz: 34b8e8d9ef5c2f016f56a887b674fa243ae6074fc59e4d29a1cb1873c4dfc3e87d8c24a37dd93a461ad71fc0fd38849462360bed7f6f9a1cca89e37fb3ad192b
+  data.tar.gz: d99f3bdc2e40e555a1a0b54dcac6a62d5774b6ae2c7c0d5e05c5ee0f1457864af696b37949173d8189769b03b5d9ce589eb1f49d855209c5c2bccadf32b51d84

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [2.5.0] - 2025-04-16
+
+### Added
+
+- Support for setting `openapi_format` for types and during export
+
 ## [2.4.0] - 2025-03-11
 
 ### Added

data/README.md

@@ -410,7 +410,6 @@ end
   - mixed arrays
   - mixed enums
   - nullable enums
-  - string format specifications (e.g. binary, int64, password ...)
   - string minLength and maxLength (substitute: `self.pattern = /\A.{3,5}\z/`)
   - number minimum, exclusiveMinimum, maximum, multipleOf
   - readOnly, writeOnly

data/lib/taro/export/open_api_v3.rb

@@ -129,7 +129,7 @@ class Taro::Export::OpenAPIv3 < Taro::Export::Base # rubocop:disable Metrics/Cla
 
   def export_type(type)
     if type < Taro::Types::ScalarType && !custom_scalar_type?(type)
-      { type: type.openapi_type }
+      { type: type.openapi_type, format: type.openapi_format }.compact
     else
       extract_component_ref(type)
     end
@@ -148,7 +148,7 @@ class Taro::Export::OpenAPIv3 < Taro::Export::Base # rubocop:disable Metrics/Cla
   end
 
   def export_scalar_field(field)
-    base = { type: field.openapi_type }
+    base = { type: field.openapi_type, format: field.openapi_format }.compact
     # Using oneOf seems more correct than an array of types
     # as it puts props like format together with the main type.
     # https://github.com/OAI/OpenAPI-Specification/issues/3148

data/lib/taro/types/base_type.rb

@@ -17,6 +17,7 @@ Taro::Types::BaseType = Struct.new(:object) do
   extend Taro::Types::Shared::Description
   extend Taro::Types::Shared::Equivalence
   extend Taro::Types::Shared::Name
+  extend Taro::Types::Shared::OpenAPIFormat
   extend Taro::Types::Shared::OpenAPIName
   extend Taro::Types::Shared::OpenAPIType
   extend Taro::Types::Shared::Rendering

data/lib/taro/types/field.rb

@@ -30,6 +30,10 @@ Taro::Types::Field = Data.define(:name, :type, :null, :method, :default, :enum,
     type.openapi_type
   end
 
+  def openapi_format
+    type.openapi_format
+  end
+
   private
 
   def coerce_to_enum(arg)

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

@@ -0,0 +1,61 @@
+# Provides a setter and getter for type classes' `openapi_format`,
+# for use in the OpenAPI export.
+module Taro::Types::Shared::OpenAPIFormat
+  OPENAPI_STRING_FORMATS = %i[
+    date
+    date-time
+    password
+    byte
+    binary
+    email
+    uuid
+    uri
+    hostname
+    ipv4
+    ipv6
+  ].freeze
+
+  OPENAPI_INTEGER_FORMATS = %i[
+    int32
+    int64
+  ].freeze
+
+  OPENAPI_NUMBER_FORMATS = %i[
+    float
+    double
+  ].freeze
+
+  def openapi_format
+    return unless @openapi_format
+
+    unless valid_formats_for_openapi_type.include?(@openapi_format)
+      raise(Taro::ArgumentError, "openapi_format #{@openapi_format.inspect} is invalid for openapi_type #{@openapi_type.inspect}, must be one for #{valid_formats_for_openapi_type}")
+    end
+
+    @openapi_format
+  end
+
+  def openapi_format=(arg)
+    @openapi_format = arg
+  end
+
+  def inherited(subclass)
+    subclass.instance_variable_set(:@openapi_format, @openapi_format)
+    super
+  end
+
+  private
+
+  def valid_formats_for_openapi_type
+    case @openapi_type
+    when :string
+      OPENAPI_STRING_FORMATS
+    when :integer
+      OPENAPI_INTEGER_FORMATS
+    when :number
+      OPENAPI_NUMBER_FORMATS
+    else
+      []
+    end
+  end
+end

data/lib/taro/version.rb

@@ -1,4 +1,4 @@
 # :nocov:
 module Taro
-  VERSION = "2.4.0"
+  VERSION = "2.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: taro
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Janosch Müller
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-11 00:00:00.000000000 Z
+date: 2025-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -115,6 +115,7 @@ files:
 - lib/taro/types/shared/item_type.rb
 - lib/taro/types/shared/name.rb
 - lib/taro/types/shared/object_coercion.rb
+- lib/taro/types/shared/openapi_format.rb
 - lib/taro/types/shared/openapi_name.rb
 - lib/taro/types/shared/openapi_type.rb
 - lib/taro/types/shared/pattern.rb
@@ -146,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Typed Api using Ruby Objects.