openfeature-sdk 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4aa61c48f017d3311bfce9022a5e08d023ee1e2c09eb8799ff0e0a8424cf9fe3
-  data.tar.gz: 8c559636076a0ec01911e9057d57cde4e430a7bc4b2543835dcd90527e0f0c0e
+  metadata.gz: 70a393d81225d8b8b546f985dffee74d8b12451e1b9c18d348e6ac3d6a7781e6
+  data.tar.gz: 960f7f7ba3e704965b1dcb1d38c800d162874a9abf423ce0dc09695e8e7b7372
 SHA512:
-  metadata.gz: 0f683b0d315b225259e540fb9f7d86f60a7e334c1501b7f05d45d677d1e7ee6cfb951b463514c05d9c64b5b413935d1bdf95cd684aa5f05136ed87a6cf2ba122
-  data.tar.gz: 618dcac7749c461bb77b92f7f7b68e2071b4b71825d05330bb18a08df3a929019ef0fa8d12d79b117fdd3fce431d48f5e15d2f90aa884fa4f28b1226229f9db0
+  metadata.gz: e166c0c2698e277129734166ec0e0ed33d38329e090fa2760f720d653df93037e599ce83ba14eea803c99bb3be5b7c301e2e522dc99cc47f6299ce41699be451
+  data.tar.gz: f74b128a0a376b5f934940226d5a96906b21500373afbce98d52267580a69fab59cc5b0b043f90546bfbf7ed3393ae5033d510e80c50f5abc57a77f10d5a93c7

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.6.4"
+  ".": "0.6.5"
 }

data/.ruby-version

@@ -1 +1 @@
-4.0.1
+4.0.2

data/.simplecov

@@ -4,6 +4,7 @@ require "simplecov-cobertura"
 
 SimpleCov.start do
   add_filter "/spec/"
+  minimum_coverage 90
   if ENV["CI"] == "true"
     formatter SimpleCov::Formatter::CoberturaFormatter
   else

data/.tool-versions

@@ -1 +1 @@
-ruby 4.0.1
+ruby 4.0.2

data/.yardopts

@@ -0,0 +1,5 @@
+--markup markdown
+--output-dir doc
+lib/**/*.rb
+- README.md
+- CHANGELOG.md

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.6.5](https://github.com/open-feature/ruby-sdk/compare/v0.6.4...v0.6.5) (2026-03-18)
+
+
+### Features
+
+* add RBS type signatures with Steep type checking ([#251](https://github.com/open-feature/ruby-sdk/issues/251)) ([506e999](https://github.com/open-feature/ruby-sdk/commit/506e9992e6c8b7222b2ae2eb3b1c2fb3d5d148a6))
+
 ## [0.6.4](https://github.com/open-feature/ruby-sdk/compare/v0.6.3...v0.6.4) (2026-03-07)
 
 

data/CLAUDE.md

@@ -8,11 +8,13 @@ This is the official OpenFeature SDK for Ruby — an implementation of the [Open
 
 ## Commands
 
+- **Install dependencies:** `bundle install`
 - **Run all tests:** `bundle exec rspec`
 - **Run a single test file:** `bundle exec rspec spec/open_feature/sdk/client_spec.rb`
 - **Run a specific test by line:** `bundle exec rspec spec/open_feature/sdk/client_spec.rb:43`
 - **Lint:** `bundle exec standardrb`
 - **Lint with autofix:** `bundle exec standardrb --fix`
+- **Type check:** `bundle exec steep check`
 - **Default rake (tests + lint):** `bundle exec rake`
 
 Note: Linting uses [Standard Ruby](https://github.com/standardrb/standard) (configured via the `standard` gem), which enforces double-quoted strings and its own opinionated style. There is no `.rubocop.yml` — Standard manages RuboCop configuration internally. Do not use `bundle exec rubocop` directly as a stale RuboCop server may apply different rules; always use `bundle exec standardrb`.
@@ -47,5 +49,6 @@ Providers can be registered for specific domains. `Configuration#provider(domain
 
 - All `.rb` files must have `# frozen_string_literal: true` as the first line.
 - Tests live under `spec/` and mirror the `lib/` structure. `spec/specification/` contains tests mapped to OpenFeature spec requirements.
+- RBS type signatures live under `sig/` and mirror the `lib/` structure. When changing any file under `lib/`, always update the corresponding `.rbs` file under `sig/` to reflect the new or modified method signatures, constants, or class structure. Run `bundle exec steep check` to verify type correctness after changes.
 - Always sign git commits using the `-S` flag.
 - Always include DCO sign-off in commits using the `-s` flag (i.e., `git commit -s -S`). This adds a `Signed-off-by` trailer required by the project's CI.

data/CONTRIBUTING.md

@@ -7,7 +7,7 @@ You can contribute to this project from a Windows, macOS or Linux machine.
 On all platforms, the minimum requirements are:
 
 * Git client and command line tools.
-* Ruby 3.0 or higher
+* Ruby 3.4 or higher
 
 ## Pull Request
 
@@ -50,6 +50,20 @@ To run unit tests and other checks:
 bundle exec rake
 ```
 
+#### Spec conformance tests (Gherkin)
+
+The project includes Gherkin-based conformance tests that verify compliance with the OpenFeature specification:
+
+```bash
+bundle exec cucumber
+```
+
+#### Linting
+
+This project uses [Standard Ruby](https://github.com/standardrb/standard) for code style enforcement.
+Run `bundle exec standardrb` to check, or `bundle exec standardrb --fix` to auto-fix.
+Do not run `bundle exec rubocop` directly, as a stale RuboCop server may apply different rules.
+
 ### How to Receive Comments
 
 * If the PR is not ready for review, please mark it as

data/Gemfile

@@ -5,5 +5,20 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in openfeature-sdk.gemspec
 gemspec
 
-gem "cucumber", "~> 10.0", group: :test
-gem "logger", group: :test
+group :development, :test do
+  gem "debug"
+  gem "markly"
+  gem "rake", "~> 13.0"
+  gem "rspec", "~> 3.13.0"
+  gem "standard"
+  gem "standard-performance"
+  gem "simplecov", "~> 0.22.0"
+  gem "simplecov-cobertura", "~> 3.0"
+  gem "steep", "~> 1.9"
+  gem "timecop", "~> 0.9.10"
+end
+
+group :test do
+  gem "cucumber", "~> 10.0"
+  gem "logger"
+end

data/Gemfile.lock

@@ -1,15 +1,31 @@
 PATH
   remote: .
   specs:
-    openfeature-sdk (0.6.4)
+    openfeature-sdk (0.6.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (8.1.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
     ast (2.4.3)
     base64 (0.3.0)
     bigdecimal (4.0.1)
     builder (3.3.0)
+    concurrent-ruby (1.3.6)
+    connection_pool (3.0.2)
+    csv (3.3.5)
     cucumber (10.2.0)
       base64 (~> 0.2)
       builder (~> 3.2)
@@ -41,8 +57,12 @@ GEM
       reline (>= 0.3.8)
     diff-lcs (1.6.2)
     docile (1.4.1)
+    drb (2.2.3)
     erb (6.0.2)
     ffi (1.17.3)
+    fileutils (1.8.0)
+    i18n (1.14.8)
+      concurrent-ruby (~> 1.0)
     io-console (0.8.2)
     irb (1.17.0)
       pp (>= 0.6.0)
@@ -52,11 +72,19 @@ GEM
     json (2.18.1)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
+    listen (3.10.0)
+      logger
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
     logger (1.7.0)
     markly (0.15.2)
     memoist3 (1.0.0)
     mini_mime (1.1.5)
+    minitest (6.0.2)
+      drb (~> 2.0)
+      prism (~> 1.5)
     multi_test (1.1.0)
+    mutex_m (0.3.0)
     parallel (1.27.0)
     parser (3.3.10.2)
       ast (~> 2.4.1)
@@ -71,6 +99,12 @@ GEM
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.3.1)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    rbs (3.10.3)
+      logger
+      tsort
     rdoc (7.2.0)
       erb
       psych (>= 4.0.0)
@@ -79,19 +113,19 @@ GEM
     reline (0.6.3)
       io-console (~> 0.5)
     rexml (3.4.4)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.3)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.4)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.7)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.8)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.2)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.7)
     rubocop (1.84.2)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
@@ -111,6 +145,7 @@ GEM
       rubocop (>= 1.75.0, < 2.0)
       rubocop-ast (>= 1.47.1, < 2.0)
     ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -132,15 +167,38 @@ GEM
     standard-performance (1.9.0)
       lint_roller (~> 1.1)
       rubocop-performance (~> 1.26.0)
+    steep (1.10.0)
+      activesupport (>= 5.1)
+      concurrent-ruby (>= 1.1.10)
+      csv (>= 3.0.9)
+      fileutils (>= 1.1.0)
+      json (>= 2.1.0)
+      language_server-protocol (>= 3.17.0.4, < 4.0)
+      listen (~> 3.0)
+      logger (>= 1.3.0)
+      mutex_m (>= 0.3.0)
+      parser (>= 3.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (~> 3.9)
+      securerandom (>= 0.1)
+      strscan (>= 1.0.0)
+      terminal-table (>= 2, < 5)
+      uri (>= 0.12.0)
     stringio (3.2.0)
+    strscan (3.1.7)
     sys-uname (1.5.0)
       ffi (~> 1.1)
       memoist3 (~> 1.0.0)
+    terminal-table (4.0.0)
+      unicode-display_width (>= 1.1.1, < 4)
     timecop (0.9.10)
     tsort (0.2.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (3.2.0)
       unicode-emoji (~> 4.1)
     unicode-emoji (4.2.0)
+    uri (1.1.1)
 
 PLATFORMS
   arm64-darwin-21
@@ -162,11 +220,12 @@ DEPENDENCIES
   markly
   openfeature-sdk!
   rake (~> 13.0)
-  rspec (~> 3.12.0)
+  rspec (~> 3.13.0)
   simplecov (~> 0.22.0)
   simplecov-cobertura (~> 3.0)
   standard
   standard-performance
+  steep (~> 1.9)
   timecop (~> 0.9.10)
 
 BUNDLED WITH

data/README.md

@@ -17,11 +17,20 @@
   </a>
   <!-- x-release-please-start-version -->
 
-  <a href="https://github.com/open-feature/ruby-sdk/releases/tag/v0.6.4">
-    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.6.4&color=blue&style=for-the-badge" />
+  <a href="https://github.com/open-feature/ruby-sdk/releases/tag/v0.6.5">
+    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.6.5&color=blue&style=for-the-badge" />
   </a>
 
   <!-- x-release-please-end -->
+  <a href="https://github.com/open-feature/ruby-sdk/actions/workflows/main.yml">
+    <img alt="Build" src="https://img.shields.io/github/actions/workflow/status/open-feature/ruby-sdk/main.yml?style=for-the-badge" />
+  </a>
+  <a href="https://rubygems.org/gems/openfeature-sdk">
+    <img alt="Gem Version" src="https://img.shields.io/gem/v/openfeature-sdk?style=for-the-badge&color=red" />
+  </a>
+  <a href="https://codecov.io/gh/open-feature/ruby-sdk">
+    <img alt="Code Coverage" src="https://img.shields.io/codecov/c/github/open-feature/ruby-sdk?style=for-the-badge" />
+  </a>
   <br/>
   <a href="https://bestpractices.coreinfrastructure.org/projects/9337">
     <img alt="CII Best Practices" src="https://bestpractices.coreinfrastructure.org/projects/9337/badge" />
@@ -41,6 +50,8 @@
 | Ruby 3.4.x   | Windows, MacOS, Linux |
 | Ruby 4.0.x   | Windows, MacOS, Linux |
 
+This project supports all Ruby versions in active maintenance per the [Ruby maintenance schedule](https://www.ruby-lang.org/en/downloads/branches/).
+
 ### Install
 
 Install the gem and add to the application's Gemfile by executing:
@@ -115,6 +126,7 @@ object = client.fetch_object_value(flag_key: 'object_value', default_value: { na
 
 [Providers](https://openfeature.dev/docs/reference/concepts/provider) are an abstraction between a flag management system and the OpenFeature SDK.
 Look [here](https://openfeature.dev/ecosystem?instant_search%5BrefinementList%5D%5Btype%5D%5B0%5D=Provider&instant_search%5BrefinementList%5D%5Btechnology%5D%5B0%5D=Ruby) for a complete list of available providers.
+
 If the provider you're looking for hasn't been created yet, see the [develop a provider](#develop-a-provider) section to learn how to build it yourself.
 
 Once you've added a provider as a dependency, it can be registered with OpenFeature like this:

data/Rakefile

@@ -7,9 +7,23 @@ RSpec::Core::RakeTask.new(:spec)
 
 require "standard/rake"
 
+begin
+  require "yard"
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  # YARD not available
+end
+
 desc "Run Cucumber Gherkin feature tests"
 task :cucumber do
   sh "bundle exec cucumber"
 end
 
+begin
+  require "steep/rake_task"
+  Steep::RakeTask.new
+rescue LoadError
+  # Steep not available
+end
+
 task default: %i[spec standard]

data/SECURITY.md

@@ -0,0 +1,10 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability, please report it responsibly.
+Do NOT open a public GitHub issue.
+
+Please email security concerns to: cncf-openfeature-contributors@lists.cncf.io
+
+We will acknowledge receipt within 48 hours and provide a timeline for a fix.

data/Steepfile

@@ -0,0 +1,7 @@
+D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+  check "lib"
+  configure_code_diagnostics(D::Ruby.lenient)
+end

data/examples/basic_usage.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "open_feature/sdk"
+
+# Configure OpenFeature with the in-memory provider for demonstration
+OpenFeature::SDK.configure do |config|
+  config.set_provider(OpenFeature::SDK::Provider::InMemoryProvider.new(
+    "v2_enabled" => true,
+    "welcome_message" => "Hello, OpenFeature!",
+    "item_limit" => 42,
+    "theme" => {"color" => "blue", "mode" => "dark"}
+  ))
+end
+
+# Create a client
+client = OpenFeature::SDK.build_client
+
+# Evaluate different flag types
+puts client.fetch_boolean_value(flag_key: "v2_enabled", default_value: false)
+puts client.fetch_string_value(flag_key: "welcome_message", default_value: "default")
+puts client.fetch_number_value(flag_key: "item_limit", default_value: 10)
+puts client.fetch_object_value(flag_key: "theme", default_value: {})

data/examples/custom_provider.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "open_feature/sdk"
+
+# A minimal custom provider demonstrating the duck type interface.
+# Any object implementing the fetch_*_value methods works as a provider.
+class MyProvider
+  def metadata
+    OpenFeature::SDK::Provider::ProviderMetadata.new(name: "my-provider")
+  end
+
+  def init(evaluation_context = nil)
+    # Perform setup (connect to flag service, load config, etc.)
+  end
+
+  def shutdown
+    # Clean up resources
+  end
+
+  def fetch_boolean_value(flag_key:, default_value:, evaluation_context: nil)
+    OpenFeature::SDK::Provider::ResolutionDetails.new(
+      value: true,
+      reason: "STATIC",
+      variant: "on"
+    )
+  end
+
+  # The remaining methods return the default value for brevity.
+  # A real provider would look up each flag_key in its flag management system.
+  def fetch_string_value(flag_key:, default_value:, evaluation_context: nil)
+    OpenFeature::SDK::Provider::ResolutionDetails.new(value: default_value)
+  end
+
+  def fetch_number_value(flag_key:, default_value:, evaluation_context: nil)
+    OpenFeature::SDK::Provider::ResolutionDetails.new(value: default_value)
+  end
+
+  def fetch_integer_value(flag_key:, default_value:, evaluation_context: nil)
+    OpenFeature::SDK::Provider::ResolutionDetails.new(value: default_value)
+  end
+
+  def fetch_float_value(flag_key:, default_value:, evaluation_context: nil)
+    OpenFeature::SDK::Provider::ResolutionDetails.new(value: default_value)
+  end
+
+  def fetch_object_value(flag_key:, default_value:, evaluation_context: nil)
+    OpenFeature::SDK::Provider::ResolutionDetails.new(value: default_value)
+  end
+end
+
+OpenFeature::SDK.configure do |config|
+  config.set_provider(MyProvider.new)
+end
+
+client = OpenFeature::SDK.build_client
+puts client.fetch_boolean_value(flag_key: "any_flag", default_value: false)

data/examples/rails_integration.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Example: OpenFeature integration with Ruby on Rails
+#
+# This file demonstrates how you might integrate OpenFeature into a Rails app.
+# It is not runnable standalone — it shows patterns for use in a Rails context.
+
+# config/initializers/openfeature.rb
+#
+# OpenFeature::SDK.configure do |config|
+#   config.set_provider(YourProvider.new)
+#
+#   # Set global context with server-level info
+#   config.evaluation_context = OpenFeature::SDK::EvaluationContext.new(
+#     "environment" => Rails.env,
+#     "service" => "my-rails-app"
+#   )
+#
+#   # Use thread-local transaction context for per-request data
+#   config.set_transaction_context_propagator(
+#     OpenFeature::SDK::ThreadLocalTransactionContextPropagator.new
+#   )
+# end
+
+# app/middleware/openfeature_context_middleware.rb
+#
+# class OpenFeatureContextMiddleware
+#   def initialize(app)
+#     @app = app
+#   end
+#
+#   def call(env)
+#     request = ActionDispatch::Request.new(env)
+#     OpenFeature::SDK.set_transaction_context(
+#       OpenFeature::SDK::EvaluationContext.new(
+#         targeting_key: request.session[:user_id]&.to_s,
+#         "ip" => request.remote_ip,
+#         "user_agent" => request.user_agent
+#       )
+#     )
+#     @app.call(env)
+#   ensure
+#     # Clear context to prevent leakage in threaded servers (e.g. Puma)
+#     OpenFeature::SDK.set_transaction_context(nil)
+#   end
+# end
+
+# app/controllers/application_controller.rb
+#
+# class ApplicationController < ActionController::Base
+#   private
+#
+#   def feature_client
+#     @feature_client ||= OpenFeature::SDK.build_client(domain: "web")
+#   end
+#
+#   def feature_enabled?(flag_key)
+#     feature_client.fetch_boolean_value(flag_key: flag_key, default_value: false)
+#   end
+# end

data/lib/open_feature/sdk/version.rb

@@ -2,6 +2,6 @@
 
 module OpenFeature
   module SDK
-    VERSION = "0.6.4"
+    VERSION = "0.6.5"
   end
 end

data/openfeature-sdk.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/open_feature/sdk/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "openfeature-sdk"
+  spec.version = OpenFeature::SDK::VERSION
+  spec.authors = ["OpenFeature Authors"]
+  spec.email = ["cncf-openfeature-contributors@lists.cncf.io"]
+
+  spec.summary = "OpenFeature SDK for Ruby"
+  spec.description = "Ruby SDK for the OpenFeature specification, an open standard for feature flag management"
+  spec.homepage = "https://github.com/open-feature/ruby-sdk"
+  spec.license = "Apache-2.0"
+  spec.required_ruby_version = ">= 3.4"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/open-feature/ruby-sdk"
+  spec.metadata["changelog_uri"] = "https://github.com/open-feature/ruby-sdk/blob/main/CHANGELOG.md"
+  spec.metadata["bug_tracker_uri"] = "https://github.com/open-feature/ruby-sdk/issues"
+  spec.metadata["documentation_uri"] = "https://github.com/open-feature/ruby-sdk#readme"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end