bolshakov / stoplight / 14442780381

100%

push

github

🔧 Configuration API for Stoplight (#295)

Implements a modernized configuration API to make it more maintainable and Ruby-idiomatic. This PR introduces a new configuration system while maintaining backward compatibility.

## What's New?

The biggest change is a new block-based configuration API:

```ruby
Stoplight.configure do |config|
  config.data_store = Stoplight::DataStore::Redis.new(redis)
  config.notifiers = [Stoplight::Notifier::Logger.new(Rails.logger)]
  config.cool_off_time = 30
  config.threshold = 5
  config.window_size = 60
  config.tracked_errors = [NetworkError, TimeoutError]
  config.skipped_errors = [ActiveRecord::RecordNotFound]
end
```

This is much cleaner than the old approach.

## Under the Hood

* Created a configuration provider that properly merges settings from different sources
* Implemented a clear precedence order for settings:
  * Per-light settings (highest priority)
  * User default settings
  * Library default settings

## Deprecation Notice ⚠️

The following methods are now deprecated (they still work but will show deprecation warning):

* `Stoplight.default_data_store = my_data_store`
* `Stoplight.default_notifiers = my_notifiers`
* `Stoplight.default_error_notifier = my_error_handler`

Instead, use the new configuration API shown above.

### Example Usage with Redis

Before:

```ruby
redis = Redis.new
data_store = Stoplight::DataStore::Redis.new(redis)
Stoplight.default_data_store = data_store
Stoplight.default_notifiers += [Stoplight::Notifier::Logger.new(Rails.logger)]
```

After:

```ruby
redis = Redis.new
Stoplight.configure do |config|
  config.data_store = Stoplight::DataStore::Redis.new(redis)
  config.notifiers += [Stoplight::Notifier::Logger.new(Rails.logger)]
end
```

## Why This Change?

* **Single configuration point** - The old API allowed changing Stoplight from many different places in your code, leading to unpredictable behavior. The new block-based approach configures the library as a whole in one... (continued)

108 of 108 new or added lines in 7 files covered. (100.0%)

511 of 511 relevant lines covered (100.0%)

245.85 hits per line