sidekiq_portal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4786c06610a30caf5b841f54ae358f2d8e03ddbfa0a4455e67d6bc54525881ee
+  data.tar.gz: 7b85cfb3ccfd8f4bf334a7c3b79203bccc12d043e570565e76d8c6be3da43ebb
+SHA512:
+  metadata.gz: 132e849038540986890f5d240beac2bf82141633825b5d5dd44a52f26e0f524b8727c9f939e321889134fbc4b6f8042a7183e01380eec5c324e3344aa5d950f9
+  data.tar.gz: 847dd5b9699d0c64ed686a7e8fa1cc151a94488357a8b345883185e23d0343d26cbf6f798eafbd36b20e3e9731a1d1cec72934dd339f7b101a0bf0d2ca30e277

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rspec_status
+Gemfile.lock
+/.idea
+.ruby-version
+/.vscode/
+/spec/artifacts/
+/gemfiles/*.gemfile.lock
+*.gem

data/.jrubyrc

@@ -0,0 +1 @@
+debug.fullTrace=true

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format progress
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,24 @@
+inherit_gem:
+  armitage-rubocop:
+    - lib/rubocop.general.yml
+    - lib/rubocop.rake.yml
+    - lib/rubocop.rspec.yml
+
+AllCops:
+  TargetRubyVersion: 2.6.5
+  Include:
+    - lib/**/*.rb
+    - spec/**/*.rb
+    - Gemfile
+    - Rakefile
+    - sidekiq_portal.gemspec
+    - bin/console
+    - bin/rspec
+
+# NOTE: support for old ruby versions
+Style/RedundantBegin:
+  Enabled: false
+
+# NOTE: too situative
+Metrics/ParameterLists:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,16 @@
+sudo: false
+language: ruby
+before_install: gem install bundler
+script: bundle exec rspec
+cache: bundler
+matrix:
+  fast_finish: true
+  include:
+  - rvm: 2.4.9
+  - rvm: 2.5.7
+  - rvm: 2.6.5
+  - rvm: ruby-head
+  - rvm: jruby-head
+  allow_failures:
+  - rvm: ruby-head
+  - rvm: jruby-head

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## [0.1.0] - 2019-12-24
+
+- Release 😈

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at iamdaiver@icloud.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Rustam Ibragimov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,163 @@
+# Sidekiq::Portal [![Gem Version](https://badge.fury.io/rb/sidekiq_portal.svg)](https://badge.fury.io/rb/sidekiq_portal) [![Build Status](https://travis-ci.org/0exp/sidekiq_portal.svg?branch=master)](https://travis-ci.org/0exp/sidekiq_portal)
+
+**Sidekiq::Portal** - scheduled jobs runner for your test environments,
+which execution process must occur during the `Timecop.travel(...)` operations according to the scheduler config.
+
+Each job starts at the time it was supposed to start according to the scheduler plan -
+the internal `Time.current` expression will give you exactly the scheduler-planned time.
+
+Supports **ActiveJob** backend (**Sidekiq::Worker** coming soon). Works with **sidekiq-scheduler**-based job configs (**sidekiq-cron** coming soon).
+
+Realized as an instance, but have a global-based implementation too.
+
+## Table of contents
+
+- [Installation](#installation)
+- [Configuration](#configuration)
+- [Example](#example)
+- [Roadmap](#roadmap)
+- [License](#license)
+- [Authors](#authors)
+
+## Installation
+
+- in your `Gemfile`
+
+```ruby
+gem 'sidekiq', '>= 5' # runtime dependency
+gem 'timecop', '~> 0.9' # runtime dependency
+
+group :test do
+  gem 'rspec'
+  gem 'sidekiq-portal'
+end
+```
+
+- run shell command:
+
+```shell
+bundle install
+```
+
+- `scec_helper.rb`:
+
+```ruby
+require 'timecop' # runtime dependency
+require 'sidekiq' # runtime dependency
+require 'sidekiq/api'
+require 'sidekiq/testing'
+
+require 'sidekiq_portal'
+```
+
+## Configuration
+
+- `default_timezone` (`UTC` by default) - global time zone for your jobs;
+- `retries_count` - recurring job simulation;
+- `scheduler_config` - `sidekiq-scheduler`-based scheduler configuration;;
+- `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
+
+  # pre-defined sidekiq-scheduler configs (Rails example)
+  config.scheduler_cofnig = Rails.application.config_for(:sidekiq)[:schedule]
+
+  # manual sidekiq-scheduler configs
+  config.schedluer_config = {
+    LoolJob: { every: '15m' },
+    kek_job: { cron: '0 * * * * *', class: :KekJob }
+  }
+end
+
+# global state clearing logic
+RSpec.configure do |config|
+  config.before { Sidekiq::Worker.clear_all }
+  config.after  { Timecop.return }
+  config.after  { Sidekiq::Portal.reload! }
+end
+```
+
+And in your tests:
+
+```ruby
+RSpec.describe 'Some spec' do
+  specify 'magic?' do
+    Timecop.travel(Time.current + 2.hours) # magic begins here 😈
+  end
+end
+```
+
+## Example
+
+- Job class:
+
+```ruby
+class HookExampleJob < ApplicationJob
+  def perform
+    GLOBAL_HOOK_INTERCEPTOR << Time.current # intercept current time
+  end
+end
+```
+
+- `Sidekiq::Scheduler` config:
+
+```yaml
+:schedule:
+  HookExample:
+    every: '15m'
+```
+
+- `HookExampleJob` spec:
+
+```ruby
+RSpec.describe 'HookExampleJob sheduler plan' do
+  specify 'scheduled?' do
+    stub_const('GLOBAL_HOOK_INTERCEPTOR', [])
+    expect(GLOBAL_HOOK_INTERCEPTOR.count).to eq(0) # => true
+
+    # do some magic 😈
+    Timecop.travel(Time.current + 2.hours)
+
+    expect(GLOBAL_HOOK_INTERCEPTOR.count).to eq(8) # => true (😈 magic)
+
+    puts GLOBAL_HOOK_INTERCEPTOR # 😈
+    # => outputs:
+    # 2019-12-24 03:05:39 +0300 (+15m) (Time.current from HookExampleJob#perform)
+    # 2019-12-24 03:20:39 +0300 (+15m)
+    # 2019-12-24 03:35:39 +0300 (+15m)
+    # 2019-12-24 03:50:39 +0300 (+15m)
+    # 2019-12-24 04:05:39 +0300 (+15m)
+    # 2019-12-24 04:20:39 +0300 (+15m)
+    # 2019-12-24 04:35:39 +0300 (+15m)
+    # 2019-12-24 04:50:39 +0300 (+15m)
+  end
+end
+```
+
+## 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;
+- 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);
+
+## License
+
+Released under MIT License.
+
+## Authors
+
+[Rustam Ibragimov](https://github.com/0exp)

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop'
+require 'rubocop/rake_task'
+require 'rubocop-performance'
+require 'rubocop-rspec'
+require 'rubocop-rake'
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  config_path = File.expand_path(File.join('.rubocop.yml'), __dir__)
+  t.options = ['--config', config_path]
+  t.requires << 'rubocop-rspec'
+  t.requires << 'rubocop-performance'
+  t.requires << 'rubocop-rake'
+end
+
+RSpec::Core::RakeTask.new(:rspec)
+
+task default: :rspec

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'sidekiq_portal'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/portal/config.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 0.1.0
+class Sidekiq::Portal::Config < Qonfig::DataSet
+  # @return [String]
+  #
+  # @api private
+  # @since 0.1.0
+  DEFAULT_TIMEZONE = 'UTC'
+
+  # @return [Hash]
+  #
+  # @api private
+  # @since 0.1.0
+  EMPTY_SCHEDULER_CONFIG = {}.freeze
+
+  # @return [Integer]
+  #
+  # @api private
+  # @since 0.1.0
+  DEFAUL_RETRIES_COUNT = 0
+
+  setting :default_timezone, DEFAULT_TIMEZONE
+  setting :retries_count, DEFAUL_RETRIES_COUNT
+  setting :scheduler_config, EMPTY_SCHEDULER_CONFIG
+
+  validate :default_timezone do |value|
+    value.is_a?(String) && !ActiveSupport::TimeZone[value].nil?
+  end
+
+  validate :retries_count, :integer, strict: true
+  validate :scheduler_config, :hash, strict: true
+end

data/lib/portal/core_extensions.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+module Sidekiq::Portal::CoreExtensions
+  require_relative 'core_extensions/timecop'
+  require_relative 'core_extensions/sidekiq_worker'
+  require_relative 'core_extensions/sidekiq_queue'
+
+  # @since 0.1.0
+  @extensions_load_lock = Mutex.new
+  # @since 0.1.0
+  @extensions_loaded = false
+
+  class << self
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def load!
+      @extensions_load_lock.synchronize do
+        unless @extensions_loaded
+          check_dependencies!
+          load_timecop_extension!
+          load_sidekiq_extension!
+          @extensions_loaded = true
+        end
+      end
+    end
+
+    private
+
+    # @return [void]
+    #
+    # @raise [Sidekiq::Portal::CoreDependencyNotFoundError]
+    # @raise [Sidekiq::Portal::UnsupportedCoreDependencyError]
+    #
+    # @api private
+    # @since 0.1.0
+    def check_dependencies!
+      unless defined?(::Timecop)
+        raise(Sidekiq::Portal::CoreDependencyNotFoundError, '::Timecop not found')
+      end
+
+      unless defined?(::Sidekiq)
+        raise(Sidekiq::Portal::CoreDependencyNotFoundError, 'Sidekiq not found')
+      end
+
+      unless Gem::Version.new(::Timecop::VERSION) >= Gem::Version.new('0.9')
+        raise(Sidekiq::Portal::UnsupportedCoreDependencyError, 'Supports timecop@>=0.9 only')
+      end
+
+      unless Gem::Version.new(::Sidekiq::VERSION) >= Gem::Version.new('5')
+        raise(Sidekiq::Portal::UnsupportedCoreDependencyError, 'Supports sidekiq@>=5 only')
+      end
+
+      unless defined?(::Sidekiq::Queue)
+        raise(Sidekiq::Portal::CoreDependencyNotFoundError, 'Sidekiq::Queue not found')
+      end
+
+      unless defined?(::Sidekiq::Worker)
+        raise(Sidekiq::Portal::CoreDependencyNotFoundError, 'Sidekiq::Worker not found')
+      end
+
+      unless defined?(::Sidekiq::Testing)
+        raise(Sidekiq::Portal::CoreDependencyNotFoundError, 'Sidekiq::Testing not found')
+      end
+    end
+
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def load_timecop_extension!
+      ::Timecop.prepend(Sidekiq::Portal::CoreExtensions::Timecop)
+    end
+
+    # @return [void]
+    #
+    # @api private
+    # @since 0.1.0
+    def load_sidekiq_extension!
+      ::Sidekiq::Queue.singleton_class.prepend(Sidekiq::Portal::CoreExtensions::SidekiqQueue)
+      ::Sidekiq::Worker.singleton_class.prepend(Sidekiq::Portal::CoreExtensions::SidekiqWorker)
+    end
+  end
+end