Merge branch 'feature/mock'

Author: Verseth

.github/workflows/ci_ruby.yml

@@ -20,7 +20,7 @@ jobs:
       CI: true
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0', '3.1', '3.2']
+        ruby-version: ['3.2', '3.3', '3.4']
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
@@ -31,3 +31,19 @@ jobs:
           bundler-cache: true # runs 'bundle install' and caches installed gems automatically
       - name: Run unit tests
         run: bundle exec rake test
+  typecheck_and_lint:
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install Ruby and gems
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Lint
+        run: bundle exec rubocop --parallel --color
+      - name: Typecheck
+        run: bundle exec srb tc

.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.byebug_history

.rubocop.yml

@@ -1,5 +1,5 @@
 inherit_gem:
-  rubocop-espago: rubocop.yml
+  rubocop-espago: sorbet.yml
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.2

.ruby-version

@@ -1 +1 @@
-3.2.0
+3.4.2

Gemfile

@@ -5,11 +5,14 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in data_plane_api.gemspec
 gemspec
 
+gem 'byebug', '~> 12.0' # debugger
 gem 'minitest', '~> 5.0' # Tests framework
 gem 'rake', '~> 13.0' # Ruby automation tasks
 gem 'rubocop', '~> 1.21' # Ruby linter
 gem 'rubocop-espago', '~> 1.0' # Custom Ruby linter config
-gem 'solargraph' # Ruby language server
+gem 'rubocop-sorbet', '~> 0.10.0' # Rubocop config for sorbet
 gem 'shoulda-context', '~> 2.0' # Testing utilities
-gem 'vcr' # Save HTTP interactions to files during tests
-gem 'webmock' # Mock network interactions
+gem 'sorbet', '~> 0.5' # static typechecker
+gem 'tapioca', '~> 0.16.11', require: false # RBI generator
+gem 'vcr', '~> 6.3.1' # Save HTTP interactions to files during tests
+gem 'webmock', '~> 3.25.1' # Mock network interactions

Gemfile.lock

@@ -2,105 +2,134 @@ PATH
   remote: .
   specs:
     data_plane_api (0.1.2)
+      booleans (~> 0.1.3)
       faraday (> 1, < 3)
+      sorbet-runtime (~> 0.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.1)
-      public_suffix (>= 2.0.2, < 6.0)
-    ast (2.4.2)
-    backport (1.2.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.3)
+    base64 (0.2.0)
     benchmark (0.2.1)
-    crack (0.4.5)
+    bigdecimal (3.1.9)
+    booleans (0.1.3)
+      sorbet-runtime (>= 0.5)
+    byebug (12.0.0)
+    crack (1.0.0)
+      bigdecimal
       rexml
-    diff-lcs (1.5.0)
-    e2mmap (0.1.0)
+    erubi (1.13.1)
     faraday (2.7.2)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
-    hashdiff (1.0.1)
-    jaro_winkler (1.5.4)
-    json (2.6.3)
-    kramdown (2.4.0)
-      rexml
-    kramdown-parser-gfm (1.1.0)
-      kramdown (~> 2.0)
-    mini_portile2 (2.8.1)
-    minitest (5.16.3)
-    nokogiri (1.13.10)
-      mini_portile2 (~> 2.8.0)
-      racc (~> 1.4)
-    parallel (1.22.1)
-    parser (3.1.3.0)
+    hashdiff (1.1.2)
+    json (2.10.2)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    minitest (5.25.5)
+    netrc (0.11.0)
+    parallel (1.26.3)
+    parser (3.3.7.4)
       ast (~> 2.4.1)
-    public_suffix (5.0.1)
-    racc (1.6.1)
+      racc
+    prism (1.4.0)
+    public_suffix (6.0.1)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.1)
-    reverse_markdown (2.1.1)
-      nokogiri
-    rexml (3.2.5)
-    rubocop (1.41.1)
+    rbi (0.3.1)
+      prism (~> 1.0)
+      rbs (>= 3.4.4)
+      sorbet-runtime (>= 0.5.9204)
+    rbs (3.9.2)
+      logger
+    regexp_parser (2.10.0)
+    rexml (3.4.1)
+    rubocop (1.75.2)
       json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.23.0, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.24.0)
-      parser (>= 3.1.1.0)
-    rubocop-espago (1.0.2)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.44.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-espago (1.1.8)
       rubocop
-    ruby-progressbar (1.11.0)
+    rubocop-sorbet (0.10.0)
+      rubocop (>= 1)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     shoulda-context (2.0.0)
-    solargraph (0.48.0)
-      backport (~> 1.2)
+    sorbet (0.5.12003)
+      sorbet-static (= 0.5.12003)
+    sorbet-runtime (0.5.12003)
+    sorbet-static (0.5.12003-universal-darwin)
+    sorbet-static (0.5.12003-x86_64-linux)
+    sorbet-static-and-runtime (0.5.12003)
+      sorbet (= 0.5.12003)
+      sorbet-runtime (= 0.5.12003)
+    spoom (1.6.1)
+      erubi (>= 1.10.0)
+      prism (>= 0.28.0)
+      rbi (>= 0.2.3)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      thor (>= 0.19.2)
+    tapioca (0.16.11)
       benchmark
-      bundler (>= 1.17.2)
-      diff-lcs (~> 1.4)
-      e2mmap
-      jaro_winkler (~> 1.5)
-      kramdown (~> 2.3)
-      kramdown-parser-gfm (~> 1.1)
-      parser (~> 3.0)
-      reverse_markdown (>= 1.0.5, < 3)
-      rubocop (>= 0.52)
-      thor (~> 1.0)
-      tilt (~> 2.0)
-      yard (~> 0.9, >= 0.9.24)
+      bundler (>= 2.2.25)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (~> 0.2)
+      sorbet-static-and-runtime (>= 0.5.11087)
+      spoom (>= 1.2.0)
+      thor (>= 1.2.0)
+      yard-sorbet
     thor (1.2.1)
-    tilt (2.0.11)
-    unicode-display_width (2.3.0)
-    vcr (6.1.0)
-    webmock (3.18.1)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    vcr (6.3.1)
+      base64
+    webmock (3.25.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     webrick (1.7.0)
     yard (0.9.28)
       webrick (~> 1.7.0)
+    yard-sorbet (0.9.0)
+      sorbet-runtime
+      yard
 
 PLATFORMS
   arm64-darwin-20
+  arm64-darwin-23
   x86_64-linux
 
 DEPENDENCIES
+  byebug (~> 12.0)
   data_plane_api!
   minitest (~> 5.0)
   rake (~> 13.0)
   rubocop (~> 1.21)
   rubocop-espago (~> 1.0)
+  rubocop-sorbet (~> 0.10.0)
   shoulda-context (~> 2.0)
-  solargraph
-  vcr
-  webmock
+  sorbet (~> 0.5)
+  tapioca (~> 0.16.11)
+  vcr (~> 6.3.1)
+  webmock (~> 3.25.1)
 
 BUNDLED WITH
-   2.4.1
+   2.6.7

bin/export-rbi

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+bundle exec spoom srb sigs export

bin/tapioca

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'tapioca' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("tapioca", "tapioca")

bin/test

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+bundle exec rake test

bin/types

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle exec tapioca annotations
+bundle exec tapioca gems $@
+bundle exec tapioca dsl $@