fix(internal): ensure formatting always uses c.utf-8 locale

Author: stainless-app[bot]

.rubocop.yml

@@ -63,6 +63,8 @@ Layout/MultilineMethodParameterLineBreaks:
 # Prefer compact hash literals.
 Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
+  Exclude:
+    - "**/*.rbi"
 
 Lint/BooleanSymbol:
   Enabled: false
@@ -90,6 +92,10 @@ Lint/MissingSuper:
   Exclude:
     - "**/*.rbi"
 
+Lint/SymbolConversion:
+  Exclude:
+    - "**/*.rbi"
+
 # Disabled for safety reasons, this option changes code semantics.
 Lint/UnusedMethodArgument:
   AutoCorrect: false
@@ -244,6 +250,10 @@ Style/RedundantInitialize:
   Exclude:
     - "**/*.rbi"
 
+Style/RedundantParentheses:
+  Exclude:
+    - "**/*.rbi"
+
 # Prefer slashes for regex literals.
 Style/RegexpLiteral:
   EnforcedStyle: slashes

README.md

@@ -48,7 +48,7 @@ When using sorbet, it is recommended to use model classes as below. This provide
 
 ```ruby
 openai.chat.completions.create(
-  messages: [OpenAI::Models::Chat::ChatCompletionUserMessageParam.new(role: "user", content: "Say this is a test")],
+  messages: [OpenAI::Chat::ChatCompletionUserMessageParam.new(role: "user", content: "Say this is a test")],
   model: :"gpt-4.1"
 )
 ```
@@ -189,7 +189,7 @@ In all places where a `BaseModel` type is specified, vanilla Ruby `Hash` can als
 ```ruby
 # This has tooling readability, for auto-completion, static analysis, and goto definition with supported language services
 params = OpenAI::Models::Chat::CompletionCreateParams.new(
-  messages: [OpenAI::Models::Chat::ChatCompletionUserMessageParam.new(role: "user", content: "Say this is a test")],
+  messages: [OpenAI::Chat::ChatCompletionUserMessageParam.new(role: "user", content: "Say this is a test")],
   model: :"gpt-4.1"
 )
 
@@ -245,9 +245,9 @@ Sorbet's typed enums require sub-classing of the [`T::Enum` class](https://sorbe
 Since this library does not depend on `sorbet-runtime`, it uses a [`T.all` intersection type](https://sorbet.org/docs/intersection-types) with a ruby primitive type to construct a "tagged alias" instead.
 
 ```ruby
-module OpenAI::Models::ChatModel
+module OpenAI::ChatModel
   # This alias aids language service driven navigation.
-  TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::Models::ChatModel) }
+  TaggedSymbol = T.type_alias { T.all(Symbol, OpenAI::ChatModel) }
 end
 ```
 
@@ -257,7 +257,7 @@ It is possible to pass a compatible model / parameter class to a method that exp
 
 ```ruby
 params = OpenAI::Models::Chat::CompletionCreateParams.new(
-  messages: [OpenAI::Models::Chat::ChatCompletionUserMessageParam.new(role: "user", content: "Say this is a test")],
+  messages: [OpenAI::Chat::ChatCompletionUserMessageParam.new(role: "user", content: "Say this is a test")],
   model: :"gpt-4.1"
 )
 openai.chat.completions.create(**params)

Rakefile

@@ -34,29 +34,40 @@ multitask(:test) do
   ruby(*%w[-w -e], rb, verbose: false) { fail unless _1 }
 end
 
-rubo_find = %w[find ./lib ./test ./rbi -type f -and ( -name *.rb -or -name *.rbi ) -print0]
 xargs = %w[xargs --no-run-if-empty --null --max-procs=0 --max-args=300 --]
+locale = {"LC_ALL" => "C.UTF-8"}
 
 desc("Lint `*.rb(i)`")
 multitask(:"lint:rubocop") do
+  find = %w[find ./lib ./test ./rbi -type f -and ( -name *.rb -or -name *.rbi ) -print0]
+
   rubocop = %w[rubocop --fail-level E]
   rubocop += %w[--format github] if ENV.key?("CI")
 
   # some lines cannot be shortened
   rubocop += %w[--except Lint/RedundantCopDisableDirective,Layout/LineLength]
 
   lint = xargs + rubocop
-  sh("#{rubo_find.shelljoin} | #{lint.shelljoin}")
+  sh("#{find.shelljoin} | #{lint.shelljoin}")
 end
 
-desc("Format `*.rb(i)`")
-multitask(:"format:rubocop") do
+desc("Format `*.rb`")
+multitask(:"format:rb") do
+  # while `syntax_tree` is much faster than `rubocop`, `rubocop` is the only formatter with full syntax support
+  find = %w[find ./lib ./test -type f -and -name *.rb -print0]
   fmt = xargs + %w[rubocop --fail-level F --autocorrect --format simple --]
-  sh("#{rubo_find.shelljoin} | #{fmt.shelljoin}")
+  sh("#{find.shelljoin} | #{fmt.shelljoin}")
+end
+
+desc("Format `*.rbi`")
+multitask(:"format:rbi") do
+  find = %w[find ./rbi -type f -and -name *.rbi -print0]
+  fmt = xargs + %w[stree write --]
+  sh(locale, "#{find.shelljoin} | #{fmt.shelljoin}")
 end
 
 desc("Format `*.rbs`")
-multitask(:"format:syntax_tree") do
+multitask(:"format:rbs") do
   find = %w[find ./sig -type f -name *.rbs -print0]
   inplace = /darwin|bsd/ =~ RUBY_PLATFORM ? ["-i", ""] : %w[-i]
   uuid = SecureRandom.uuid
@@ -88,7 +99,7 @@ multitask(:"format:syntax_tree") do
   # transform class aliases to type aliases, which syntax tree has no trouble with
   sh("#{find.shelljoin} | #{pre.shelljoin}")
   # run syntax tree to format `*.rbs` files
-  sh("#{find.shelljoin} | #{fmt.shelljoin}") do
+  sh(locale, "#{find.shelljoin} | #{fmt.shelljoin}") do
     success = _1
   end
   # transform type aliases back to class aliases
@@ -99,7 +110,7 @@ multitask(:"format:syntax_tree") do
 end
 
 desc("Format everything")
-multitask(format: [:"format:rubocop", :"format:syntax_tree"])
+multitask(format: [:"format:rb", :"format:rbi", :"format:rbs"])
 
 desc("Typecheck `*.rbs`")
 multitask(:"typecheck:steep") do

lib/openai.rb

@@ -428,6 +428,7 @@
 require_relative "openai/models/vector_store_search_params"
 require_relative "openai/models/vector_store_search_response"
 require_relative "openai/models/vector_store_update_params"
+require_relative "openai/models"
 require_relative "openai/resources/audio"
 require_relative "openai/resources/audio/speech"
 require_relative "openai/resources/audio/transcriptions"

lib/openai/file_part.rb

@@ -45,9 +45,9 @@ def initialize(content, filename: nil, content_type: nil)
       @filename =
         case content
         in Pathname
-          filename.nil? ? content.basename.to_path : File.basename(filename)
+          filename.nil? ? content.basename.to_path : ::File.basename(filename)
         else
-          filename.nil? ? nil : File.basename(filename)
+          filename.nil? ? nil : ::File.basename(filename)
         end
       @content_type = content_type
     end

lib/openai/internal/type/enum.rb

@@ -17,13 +17,13 @@ module Type
       # values safely.
       #
       # @example
-      #   # `chat_model` is a `OpenAI::Models::ChatModel`
+      #   # `chat_model` is a `OpenAI::ChatModel`
       #   case chat_model
-      #   when OpenAI::Models::ChatModel::GPT_4_1
+      #   when OpenAI::ChatModel::GPT_4_1
       #     # ...
-      #   when OpenAI::Models::ChatModel::GPT_4_1_MINI
+      #   when OpenAI::ChatModel::GPT_4_1_MINI
       #     # ...
-      #   when OpenAI::Models::ChatModel::GPT_4_1_NANO
+      #   when OpenAI::ChatModel::GPT_4_1_NANO
       #     # ...
       #   else
       #     puts(chat_model)

lib/openai/internal/type/request_parameters.rb

@@ -5,10 +5,10 @@ module Internal
     module Type
       # @api private
       module RequestParameters
-        # @!parse
-        #   # Options to specify HTTP behaviour for this request.
-        #   # @return [OpenAI::RequestOptions, Hash{Symbol=>Object}]
-        #   attr_accessor :request_options
+        # @!attribute request_options
+        # Options to specify HTTP behaviour for this request.
+        #
+        #   @return [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 
         # @param mod [Module]
         def self.included(mod)

lib/openai/internal/type/union.rb

@@ -6,13 +6,13 @@ module Type
       # @api private
       #
       # @example
-      #   # `chat_completion_content_part` is a `OpenAI::Models::Chat::ChatCompletionContentPart`
+      #   # `chat_completion_content_part` is a `OpenAI::Chat::ChatCompletionContentPart`
       #   case chat_completion_content_part
-      #   when OpenAI::Models::Chat::ChatCompletionContentPartText
+      #   when OpenAI::Chat::ChatCompletionContentPartText
       #     puts(chat_completion_content_part.text)
-      #   when OpenAI::Models::Chat::ChatCompletionContentPartImage
+      #   when OpenAI::Chat::ChatCompletionContentPartImage
       #     puts(chat_completion_content_part.image_url)
-      #   when OpenAI::Models::Chat::ChatCompletionContentPartInputAudio
+      #   when OpenAI::Chat::ChatCompletionContentPartInputAudio
       #     puts(chat_completion_content_part.input_audio)
       #   else
       #     puts(chat_completion_content_part)

lib/openai/internal/util.rb

@@ -535,7 +535,7 @@ class << self
             filename = ERB::Util.url_encode(val.filename)
             y << "; filename=\"#{filename}\""
           in Pathname | IO
-            filename = ERB::Util.url_encode(File.basename(val.to_path))
+            filename = ERB::Util.url_encode(::File.basename(val.to_path))
             y << "; filename=\"#{filename}\""
           else
           end

lib/openai/models/all_models.rb

@@ -7,9 +7,9 @@ module AllModels
 
       variant String
 
-      variant enum: -> { OpenAI::Models::ChatModel }
+      variant enum: -> { OpenAI::ChatModel }
 
-      variant enum: -> { OpenAI::Models::AllModels::ResponsesOnlyModel }
+      variant enum: -> { OpenAI::AllModels::ResponsesOnlyModel }
 
       module ResponsesOnlyModel
         extend OpenAI::Internal::Type::Enum
@@ -24,7 +24,7 @@ module ResponsesOnlyModel
       end
 
       # @!method self.variants
-      #   @return [Array(String, Symbol, OpenAI::Models::ChatModel, Symbol, OpenAI::Models::AllModels::ResponsesOnlyModel)]
+      #   @return [Array(String, Symbol, OpenAI::ChatModel, Symbol, OpenAI::AllModels::ResponsesOnlyModel)]
     end
   end
 end