Merge pull request #558 from OneBusAway/release-please--branches--main--changes--next

release: 1.0.3

Author: Ahmedhossamdev

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.0.2"
+  ".": "1.0.3"
 }

CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 1.0.3 (2025-05-28)
+
+Full Changelog: [v1.0.2...v1.0.3](https://github.com/OneBusAway/ruby-sdk/compare/v1.0.2...v1.0.3)
+
+### Bug Fixes
+
+* correctly instantiate sorbet type aliases for enums and unions ([c3220da](https://github.com/OneBusAway/ruby-sdk/commit/c3220da9c8dd308037e8713b34a9925c3b2305c9))
+* prevent rubocop from mangling `===` to `is_a?` check ([4cc7c41](https://github.com/OneBusAway/ruby-sdk/commit/4cc7c41e75e9bc5589998af5b40398632242bd08))
+* sorbet types for enums, and make tapioca detection ignore `tapioca dsl` ([457b3f7](https://github.com/OneBusAway/ruby-sdk/commit/457b3f74152c42720d9daa4d2050a3a93bd8a6ce))
+
+
+### Chores
+
+* **docs:** grammar improvements ([fb664c1](https://github.com/OneBusAway/ruby-sdk/commit/fb664c14ed7536ceb8f8e0a3981466572b9924b3))
+* force utf-8 locale via `RUBYOPT` when formatting ([40072fa](https://github.com/OneBusAway/ruby-sdk/commit/40072fa08f936bb71c630cbab264def3d5f68fca))
+* **internal:** version bump ([736a6f9](https://github.com/OneBusAway/ruby-sdk/commit/736a6f9a6f1536797d992536102ec93ff1c80984))
+* refine Yard and Sorbet types and ensure linting is turned on for examples ([4491574](https://github.com/OneBusAway/ruby-sdk/commit/44915748e1ed515f15805d3f7a2f5e73d9d4e8f7))
+* use fully qualified names for yard annotations and rbs aliases ([836f0a6](https://github.com/OneBusAway/ruby-sdk/commit/836f0a68ded83ff27a8dcf0c28e07bd1f29f8cba))
+* whitespaces ([6588d9a](https://github.com/OneBusAway/ruby-sdk/commit/6588d9a87f890cdedbe288172f074332e34a48ff))
+
 ## 1.0.2 (2025-05-20)
 
 Full Changelog: [v1.0.1...v1.0.2](https://github.com/OneBusAway/ruby-sdk/compare/v1.0.1...v1.0.2)

Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    onebusaway-sdk (1.0.1)
+    onebusaway-sdk (1.0.2)
       connection_pool
 
 GEM

README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "onebusaway-sdk", "~> 1.0.2"
+gem "onebusaway-sdk", "~> 1.0.3"
 ```
 
 <!-- x-release-please-end -->
@@ -144,7 +144,7 @@ puts(current_time[:my_undocumented_property])
 
 #### Undocumented request params
 
-If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request as seen in examples above.
+If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.
 
 #### Undocumented endpoints
 
@@ -162,7 +162,7 @@ response = client.request(
 
 ### Concurrency & connection pooling
 
-The `OnebusawaySDK::Client` instances are threadsafe, but only are fork-safe when there are no in-flight HTTP requests.
+The `OnebusawaySDK::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
 
 Each instance of `OnebusawaySDK::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.
 
@@ -212,7 +212,7 @@ onebusaway_sdk.report_problem_with_stop.retrieve(
   # …
 )
 
-# Literal values is also permissible:
+# Literal values are also permissible:
 onebusaway_sdk.report_problem_with_stop.retrieve(
   code: :stop_name_wrong,
   # …

Rakefile

@@ -9,6 +9,7 @@ require "rake/clean"
 require "rubocop/rake_task"
 
 tapioca = "sorbet/tapioca"
+examples = "examples"
 ignore_file = ".ignore"
 
 CLEAN.push(*%w[.idea/ .ruby-lsp/ .yardoc/ doc/], *FileList["*.gem"], ignore_file)
@@ -35,11 +36,11 @@ multitask(:test) do
 end
 
 xargs = %w[xargs --no-run-if-empty --null --max-procs=0 --max-args=300 --]
-locale = {"LC_ALL" => "C.UTF-8"}
+ruby_opt = {"RUBYOPT" => [ENV["RUBYOPT"], "--encoding=UTF-8"].compact.join(" ")}
 
 desc("Lint `*.rb(i)`")
 multitask(:"lint:rubocop") do
-  find = %w[find ./lib ./test ./rbi -type f -and ( -name *.rb -or -name *.rbi ) -print0]
+  find = %w[find ./lib ./test ./rbi ./examples -type f -and ( -name *.rb -or -name *.rbi ) -print0]
 
   rubocop = %w[rubocop]
   rubocop += %w[--format github] if ENV.key?("CI")
@@ -54,7 +55,7 @@ end
 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]
+  find = %w[find ./lib ./test ./examples -type f -and -name *.rb -print0]
   fmt = xargs + %w[rubocop --fail-level F --autocorrect --format simple --]
   sh("#{find.shelljoin} | #{fmt.shelljoin}")
 end
@@ -63,7 +64,7 @@ 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}")
+  sh(ruby_opt, "#{find.shelljoin} | #{fmt.shelljoin}")
 end
 
 desc("Format `*.rbs`")
@@ -99,7 +100,7 @@ multitask(:"format:rbs") 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(locale, "#{find.shelljoin} | #{fmt.shelljoin}") do
+  sh(ruby_opt, "#{find.shelljoin} | #{fmt.shelljoin}") do
     success = _1
   end
   # transform type aliases back to class aliases
@@ -117,12 +118,14 @@ multitask(:"typecheck:steep") do
   sh(*%w[steep check])
 end
 
+directory(examples)
+
 desc("Typecheck `*.rbi`")
-multitask(:"typecheck:sorbet") do
-  sh(*%w[srb typecheck])
+multitask("typecheck:sorbet": examples) do
+  sh(*%w[srb typecheck --dir], examples)
 end
 
-file(tapioca) do
+directory(tapioca) do
   sh(*%w[tapioca init])
 end
 

SECURITY.md

@@ -16,11 +16,11 @@ before making any information public.
 ## Reporting Non-SDK Related Security Issues
 
 If you encounter security issues that are not directly related to SDKs but pertain to the services
-or products provided by Onebusaway SDK please follow the respective company's security reporting guidelines.
+or products provided by Onebusaway SDK, please follow the respective company's security reporting guidelines.
 
 ### Onebusaway SDK Terms and Policies
 
-Please contact [email protected] for any questions or concerns regarding security of our services.
+Please contact [email protected] for any questions or concerns regarding the security of our services.
 
 ---
 

Steepfile

@@ -7,7 +7,7 @@ target(:lib) do
 
   signature("sig")
 
-  YAML.safe_load_file("./manifest.yaml", symbolize_names: true) => { dependencies: }
+  YAML.safe_load_file("./manifest.yaml", symbolize_names: true) => {dependencies:}
   # currently these libraries lack the `*.rbs` annotations required by `steep`
   stdlibs = dependencies - %w[English etc net/http rbconfig set stringio]
 

lib/onebusaway_sdk.rb

@@ -20,7 +20,9 @@
 
 # We already ship the preferred sorbet manifests in the package itself.
 # `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
-if Object.const_defined?(:Tapioca) && caller.chain([$PROGRAM_NAME]).chain(ARGV).grep(/tapioca/)
+if Object.const_defined?(:Tapioca) &&
+   caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
+   ARGV.none?(/dsl/)
   return
 end
 

lib/onebusaway_sdk/internal.rb

@@ -13,5 +13,8 @@ module Internal
     define_sorbet_constant!(:AnyHash) do
       T.type_alias { T::Hash[Symbol, T.anything] }
     end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, OnebusawaySDK::FilePart) }
+    end
   end
 end

lib/onebusaway_sdk/internal/type/array_of.rb

@@ -12,6 +12,7 @@ module Type
       # Array of items of a given type.
       class ArrayOf
         include OnebusawaySDK::Internal::Type::Converter
+        include OnebusawaySDK::Internal::Util::SorbetRuntimeSupport
 
         private_class_method :new
 
@@ -110,6 +111,13 @@ def dump(value, state:)
           end
         end
 
+        # @api private
+        #
+        # @return [Object]
+        def to_sorbet_type
+          T::Array[OnebusawaySDK::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(item_type)]
+        end
+
         # @api private
         #
         # @return [generic<Elem>]