Merge branch 'release/v5.8.0'

Author: bolshakov

.github/workflows/ci.yml

@@ -9,6 +9,20 @@ permissions:  # added using https://github.com/step-security/secure-repo
   contents: read
 
 jobs:
+  steep:
+    name: Type Check 🔍
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@19a43a6a2428d455dbd1b85344698725179c9d8c # v1.289.0
+        with:
+          ruby-version: 4.0
+          bundler-cache: true
+      - run: |
+          bundle exec steep check --format=github
+
   rubocop:
     name: Standard 👮
     runs-on: ubuntu-latest
@@ -17,22 +31,24 @@ jobs:
       contents: read
     steps:
       - name: Harden the runner (Audit all outbound calls)
-        uses: step-security/harden-runner@df199fb7be9f65074067a9eb93f12bb4c5547cf2 # v2.13.3
+        uses: step-security/harden-runner@58077d3c7e43986b6b15fba718e8ea69e387dfcc # v2.15.1
         with:
           egress-policy: audit
 
       - name: Checkout code
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
       - name: Standard Ruby
         uses: standardrb/standard-ruby-action@eecb3f730879f5b8830705348c2961e5aa26de78 # v1.5.0
         with:
+          ruby-version: '4.0'
           autofix: false
 
   features:
-    name: Features (${{ matrix.data-store }} Data Store and ${{ matrix.data-store-image }} Data Store image) 🥒
+    name: Features (${{ matrix.data-store }} Data Store and ${{ matrix.data-store-image }} Data Store image using ${{matrix.light-creation}}) 🥒
     runs-on: ubuntu-latest
     strategy:
       matrix:
+        light-creation: [ 'Stoplight()', 'System#light' ]
         data-store: [ 'Redis' ]
         data-store-image:
           - 'redis:7.4'
@@ -41,6 +57,10 @@ jobs:
           # Memory does not depend on the Data Store so we only want to run its suite once
           - data-store: 'Memory'
             data-store-image: 'redis:7.4'
+            light-creation: 'Stoplight()'
+          - data-store: 'Memory'
+            data-store-image: 'redis:7.4'
+            light-creation: 'System#light'
     services:
       data-store:
         image: ${{ matrix.data-store-image }}
@@ -53,24 +73,25 @@ jobs:
           - 6379:6379
     steps:
       - name: Harden the runner (Audit all outbound calls)
-        uses: step-security/harden-runner@df199fb7be9f65074067a9eb93f12bb4c5547cf2 # v2.13.3
+        uses: step-security/harden-runner@58077d3c7e43986b6b15fba718e8ea69e387dfcc # v2.15.1
         with:
           egress-policy: audit
 
       - name: Checkout code
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Set up Ruby
-        uses: ruby/setup-ruby@8aeb6ff8030dd539317f8e1769a044873b56ea71 # v1.268.0
+        uses: ruby/setup-ruby@19a43a6a2428d455dbd1b85344698725179c9d8c # v1.289.0
         with:
-          ruby-version: 3.3.4
+          ruby-version: 4.0
           bundler-cache: true
 
       - name: Run Features
         run: bundle exec cucumber features/stoplight
         env:
           STOPLIGHT_REDIS_URL: 'redis://127.0.0.1:6379/0'
           STOPLIGHT_DATA_STORE: ${{ matrix.data-store }}
+          STOPLIGHT_LIGHT_CREATION: ${{ matrix.light-creation }}
           CUCUMBER_PUBLISH_ENABLED: true
 
   spec:
@@ -88,7 +109,7 @@ jobs:
           - 'redis:8.0'
           - 'valkey/valkey:7.2-alpine'
           - 'valkey/valkey:8.1-alpine'
-        ruby: [ '3.2', '3.3', '3.4' ]
+        ruby: [ '3.2', '3.3', '3.4', '4.0' ]
     services:
       data-store:
         image: ${{ matrix.data-store-image }}
@@ -101,15 +122,15 @@ jobs:
           - 6379:6379
     steps:
       - name: Harden the runner (Audit all outbound calls)
-        uses: step-security/harden-runner@df199fb7be9f65074067a9eb93f12bb4c5547cf2 # v2.13.3
+        uses: step-security/harden-runner@58077d3c7e43986b6b15fba718e8ea69e387dfcc # v2.15.1
         with:
           egress-policy: audit
 
       - name: Checkout code
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Set up Ruby
-        uses: ruby/setup-ruby@8aeb6ff8030dd539317f8e1769a044873b56ea71 # v1.268.0
+        uses: ruby/setup-ruby@19a43a6a2428d455dbd1b85344698725179c9d8c # v1.289.0
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
@@ -131,7 +152,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Harden the runner (Audit all outbound calls)
-        uses: step-security/harden-runner@df199fb7be9f65074067a9eb93f12bb4c5547cf2 # v2.13.3
+        uses: step-security/harden-runner@58077d3c7e43986b6b15fba718e8ea69e387dfcc # v2.15.1
         with:
           egress-policy: audit
 

.github/workflows/dependency-review.yml

@@ -17,11 +17,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Harden the runner (Audit all outbound calls)
-        uses: step-security/harden-runner@df199fb7be9f65074067a9eb93f12bb4c5547cf2 # v2.13.3
+        uses: step-security/harden-runner@58077d3c7e43986b6b15fba718e8ea69e387dfcc # v2.15.1
         with:
           egress-policy: audit
 
       - name: 'Checkout Repository'
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
       - name: 'Dependency Review'
-        uses: actions/dependency-review-action@3c4e3dcb1aa7874d2c16be7d79418e9b7efd6261 # v4.8.2
+        uses: actions/dependency-review-action@2031cfc080254a8a887f58cffee85186f0e49e48 # v4.9.0

.github/workflows/release.yml

@@ -18,15 +18,15 @@ jobs:
       version: ${{ steps.version.outputs.version }}
     steps:
       - name: Harden the runner (Audit all outbound calls)
-        uses: step-security/harden-runner@df199fb7be9f65074067a9eb93f12bb4c5547cf2 # v2.13.3
+        uses: step-security/harden-runner@58077d3c7e43986b6b15fba718e8ea69e387dfcc # v2.15.1
         with:
           egress-policy: audit
 
       - name: Checkout code
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Set up Ruby
-        uses: ruby/setup-ruby@8aeb6ff8030dd539317f8e1769a044873b56ea71 # v1.268.0
+        uses: ruby/setup-ruby@19a43a6a2428d455dbd1b85344698725179c9d8c # v1.289.0
         with:
           bundler-cache: true
           ruby-version: ruby
@@ -49,24 +49,24 @@ jobs:
       contents: read
     steps:
       - name: Harden the runner (Audit all outbound calls)
-        uses: step-security/harden-runner@df199fb7be9f65074067a9eb93f12bb4c5547cf2 # v2.13.3
+        uses: step-security/harden-runner@58077d3c7e43986b6b15fba718e8ea69e387dfcc # v2.15.1
         with:
           egress-policy: audit
 
       - name: Checkout Repository
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
-      - uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 # v3.11.1
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - uses: docker/setup-buildx-action@8d2750c68a42422c14e847fe6c8ac0403b4cbd6f # v3.12.0
       - name: Checkout release
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           ref: refs/tags/${{ needs.gem.outputs.version }}
       - name: Login to Docker Hub
-        uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0
+        uses: docker/login-action@b45d80f862d83dbcd57f89517bcf500b2ab88fb2 # v4.0.0
         with:
           username: ${{ vars.DOCKER_HUB_USERNAME }}
           password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
       - name: Build and push
-        uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6.18.0
+        uses: docker/build-push-action@d08e5c354a6adb9ed34480a06d141179aa583294 # v7.0.0
         with:
           push: true
           tags: |

.gitignore

@@ -10,6 +10,7 @@ tmp/
 profile_results
 /docker/Gemfile.lock
 *.log
+.gem_rbs_collection/
 
 # OS or Editor folders
 .DS_Store

CONTRIBUTING.md

@@ -58,8 +58,8 @@ Use test doubles for testing with abstract dependencies:
 
 ```ruby
 RSpec.describe Stoplight::Domain::Light do
-  let(:data_store) { instance_double(Stoplight::Domain::DataStore) }
-  let(:notifier) { instance_double(Stoplight::Domain::StateTransitionNotifier) }
+  let(:data_store) { instance_double(Stoplight::Domain::_DataStore) }
+  let(:notifier) { instance_double(NullNotifier) }
 
   # Test in isolation
   it "transitions to red after threshold" do
@@ -72,12 +72,12 @@ end
 Use real dependencies when testing infrastructure
 
 ```ruby
-RSpec.describe Stoplight::Infrastructure::DataStore::Redis do
+RSpec.describe Stoplight::Infrastructure::Redis::DataStore do
   let(:data_store) { described_class.new(redis) }
   let(:redis) { Redis.new(url: connection_string) } # connects to the real database
 
   it "transitions to red" do
-    data_store.transition_to_color(Stoplight::Domain::Color::RED)
+    data_store.transition_to_color(Stoplight::Color::RED)
     # ... test logic
   end
 end
@@ -91,7 +91,7 @@ it's tricky to use gherkin language for testing, you can opt out to using integr
 ```ruby
 RSpec.describe "Concurrency testing" do
   # Use real implementations
-  let(:data_store) { Stoplight::Infrastructure::DataStore::Redis.new }
+  let(:data_store) { Stoplight::Infrastructure::Redis::DataStore.new }
 
   it "persists state across instances" do
     # Test actual integration

Gemfile

@@ -28,5 +28,7 @@ group :development do
   gem "simplecov", "~> 0.22"
   gem "simplecov-lcov", "~> 0.9"
   gem "standard"
+  gem "steep", require: false
   gem "timecop", "~> 0.9"
+  gem "yard"
 end