README.md in sidekiq_portal-0.1.1 vs README.md in sidekiq_portal-0.2.0
- old
+ new
@@ -52,22 +52,24 @@
require 'sidekiq_portal'
```
## Configuration
-- `default_timezone` (`UTC` by default) - global time zone for your jobs;
-- `retries_count` - Sidekiq's built-in retry mechanism simulation;
-- `scheduler_config` - `sidekiq-scheduler`-based scheduler configuration;;
+- `default_timezone` - global time zone for your jobs (`UTC` by default);
+- `retry_count` - Sidekiq's built-in retry mechanism simulation (`0` by default);
+- `retry_on` - retry only on a set of exceptions (`[StandardError]` by default);
+- `scheduler_config` - `sidekiq-scheduler`-based scheduler configuration (`{}` by default (non-configured));
- `Sidekiq::Portal.reload!(&configuration)` - reload portal configurations;
In your `spec_helper.rb`:
```ruby
# portal configuration
Sidekiq::Portal.setup! do |config|
- config.default_timezone = 'UTC'
- config.retries_count = 1
+ config.default_timezone = 'UTC' # 'UTC' by default
+ config.retry_count = 3 # 0 by default
+ config.retry_on = [StandardError] # [StandardError] by default
# pre-defined sidekiq-scheduler configs (Rails example)
config.scheduler_cofnig = Rails.application.config_for(:sidekiq)[:schedule]
# manual sidekiq-scheduler configs
@@ -144,18 +146,20 @@
## Roadmap
- `Sidekiq::Testing.portal!` test mode with support for `:inline` and `:fake`;
(`Sidekiq::Testing.inline!` and `Sidekiq::Testing.fake` respectively);
-- support for `ActiveSupport::Timezone` instances in `default_timezone` config;
-- support for retries;
+- support for `ActiveSupport::TimeZone` instances in `default_timezone` config;
- rspec matchers;
- `#reload!` should use previosly defined settings?;
- support for `Sidekiq::Worker` job backend;
- support for `Sidekiq::Cron` scheduler plans;
- more specs;
- documentation and examples for instance-based portals (`Sidekiq::Portal.new(&configuration)`);
- job execution randomization (for jobs which should be invoked at the same time);
+- configurable in-line invokations (with job list config);
+- configurable and conditional portal invokation (run over all specs or only over the one or etc)
+ (suitable for unit tests);
## License
Released under MIT License.