taro 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41f14035882a39e03a7bae9c799a42c9fa63414e4201fbbab7f876d54d8d214b
-  data.tar.gz: 768b505506f8ad58792d0d86b6152f1aa60da98419aef111b9fc187ee74eab42
+  metadata.gz: d30f413c950e02e52f99ed96d234acdba122c92ec4e39dd2d35e87c899ed8a13
+  data.tar.gz: 5ed455623397ce6fbcb19412710bf98bc7ca2b6898db193a2cf858104a149327
 SHA512:
-  metadata.gz: 27607c95ed9c5a7ab2c4d579dec41357657f24c694f43eac06b15677a82e491fd5986c5cad8b7bf999ee23ee456d75cc2c90debee47e93d02cdc901b4e45f498
-  data.tar.gz: f99bfdfe66f7a09ac1746c23e2671bcec7f20cfee23e980db76561f14e1ea082bc2fcc59e4650af8732d7e608a8b7c012473dc0f862bb15ff9d89501a641c825
+  metadata.gz: ba99529dd914238371708a80b5f3f6497a4884a042a0e11ec7e9b557107379d0bfa2232b6a71137623658651e5d920f8ad47ab683119ae5ce105261fa627b980
+  data.tar.gz: 26b2652184c485aa7970707373cfe4ebfdecd3141fc7e995066060b5a0a5452b1e749d6e16fdc3d99e34a199434ed9edc7400d89fe8f8ed32df442d764d06175

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [1.4.0] - 2024-11-27
+
+### Added
+
+- added operationId to OpenAPI export
+
+### Fixed
+
+- fixed potential ref name clashes in OpenAPI export
+  - e.g. `FooBar::BazController` & `Foo::BarBazController`
+
 ## [1.3.0] - 2024-11-25
 
 ### Added

data/lib/taro/export/open_api_v3.rb

@@ -31,9 +31,10 @@ class Taro::Export::OpenAPIv3 < Taro::Export::Base # rubocop:disable Metrics/Cla
         description: declaration.desc,
         summary: declaration.summary,
         tags: declaration.tags,
+        operationId: route.openapi_operation_id,
         parameters: route_parameters(declaration, route),
         requestBody: request_body(declaration, route),
-        responses: responses(declaration),
+        responses: responses(declaration, route),
       }.compact,
     }
   end
@@ -91,7 +92,7 @@ class Taro::Export::OpenAPIv3 < Taro::Export::Base # rubocop:disable Metrics/Cla
 
     body_input_type = Class.new(params)
     body_input_type.fields.replace(body_param_fields)
-    body_input_type.openapi_name = params.openapi_name
+    body_input_type.openapi_name = "#{route.openapi_operation_id}_Input"
 
     # For polymorphic routes (more than one for the same declaration),
     # we can't use refs because their request body might differ:
@@ -109,7 +110,9 @@ class Taro::Export::OpenAPIv3 < Taro::Export::Base # rubocop:disable Metrics/Cla
     end
   end
 
-  def responses(declaration)
+  def responses(declaration, route)
+    name_anonymous_return_types(declaration, route)
+
     declaration.returns.sort.to_h do |code, type|
       [
         code.to_s,
@@ -121,6 +124,14 @@ class Taro::Export::OpenAPIv3 < Taro::Export::Base # rubocop:disable Metrics/Cla
     end
   end
 
+  def name_anonymous_return_types(declaration, route)
+    declaration.returns.each do |code, type|
+      next if type.openapi_name?
+
+      type.openapi_name = "#{route.openapi_operation_id}_#{code}_Response"
+    end
+  end
+
   def export_type(type)
     if type < Taro::Types::ScalarType && !custom_scalar_type?(type)
       { type: type.openapi_type }

data/lib/taro/rails/declaration.rb

@@ -53,11 +53,6 @@ class Taro::Rails::Declaration
   end
 
   def finalize(controller_class:, action_name:)
-    add_routes(controller_class:, action_name:)
-    add_openapi_names(controller_class:, action_name:)
-  end
-
-  def add_routes(controller_class:, action_name:)
     routes = Taro::Rails::RouteFinder.call(controller_class:, action_name:)
     routes.any? || raise_missing_route(controller_class, action_name)
     self.routes = routes
@@ -72,21 +67,6 @@ class Taro::Rails::Declaration
     routes.size > 1
   end
 
-  # TODO: these change when the controller class is renamed.
-  # We might need a way to set `base`. Perhaps as a kwarg to `::api`?
-  def add_openapi_names(controller_class:, action_name:)
-    base = "#{controller_class.name.chomp('Controller').gsub('::', '_')}_#{action_name}"
-    params.openapi_name = "#{base}_Input"
-    params.define_singleton_method(:name) { openapi_name }
-
-    returns.each do |status, return_type|
-      next if return_type.openapi_name? # only set for ad-hoc / nested return types
-
-      return_type.openapi_name = "#{base}_#{status}_Response"
-      return_type.define_singleton_method(:name) { openapi_name }
-    end
-  end
-
   require 'rack'
   def self.coerce_status_to_int(status)
     # support using http status numbers directly
@@ -137,6 +117,6 @@ class Taro::Rails::Declaration
   end
 
   def <=>(other)
-    params.openapi_name <=> other.params.openapi_name
+    routes.first.openapi_operation_id <=> other.routes.first.openapi_operation_id
   end
 end

data/lib/taro/rails/normalized_route.rb

@@ -18,15 +18,26 @@ Taro::Rails::NormalizedRoute = Data.define(:rails_route) do
     rails_route.path.spec.to_s.gsub('(.:format)', '').gsub(/:(\w+)/, '{\1}')
   end
 
+  def openapi_operation_id
+    "#{verb}_#{action}_#{controller.gsub('/', '__')}"
+  end
+
   def path_params
     openapi_path.scan(/{(\w+)}/).flatten.map(&:to_sym)
   end
 
   def endpoint
-    controller, action = rails_route.requirements.values_at(:controller, :action)
     "#{controller}##{action}"
   end
 
+  def action
+    rails_route.requirements[:action]
+  end
+
+  def controller
+    rails_route.requirements[:controller]
+  end
+
   def can_have_request_body?
     %w[patch post put].include?(verb)
   end
@@ -34,4 +45,5 @@ Taro::Rails::NormalizedRoute = Data.define(:rails_route) do
   def inspect
     %(#<#{self.class} "#{verb} #{openapi_path}">)
   end
+  alias to_s inspect
 end

data/lib/taro/version.rb

@@ -1,4 +1,4 @@
 # :nocov:
 module Taro
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: taro
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Janosch Müller
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-25 00:00:00.000000000 Z
+date: 2024-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack