sidekiq-clockwork 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: af8027348723cdf52c0658fe5080249da7d5ed879ab161b7358f6d32b31f8e05
+  data.tar.gz: bc139a66b2b59a4d7170dba2a4a11ebb8bfa78e40c582073eac160a939161bef
+SHA512:
+  metadata.gz: b992a00c587e5cb3aeced5d46bfc4440eb2c175f54bccbc53efb75a7bab08957e3cdfb6f932c2c346fe7e74cf35e15846e3f59a8412ffcc0e9ac0744dd1cf61c
+  data.tar.gz: a9f2ac0950f2b615b25f0989ff8ef4ba6e497eae372d1fa8b14caee028cc6d8443c57f804d3406fcaff6677af7e4ad0fc00a5f8617ec4dd078bfb263a8c4bb38

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.4

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 fnando.vieira@gmail.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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sidekiq-clockwork.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    sidekiq-clockwork (0.1.0)
+      sidekiq
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    connection_pool (2.2.2)
+    minitest (5.11.3)
+    minitest-utils (0.4.4)
+      minitest
+    rack (2.0.5)
+    rack-protection (2.0.4)
+      rack
+    rake (12.3.1)
+    redis (4.0.2)
+    sidekiq (5.2.2)
+      connection_pool (~> 2.2, >= 2.2.2)
+      rack-protection (>= 1.5.0)
+      redis (>= 3.3.5, < 5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  minitest-utils
+  rake
+  sidekiq-clockwork!
+
+BUNDLED WITH
+   1.16.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Nando Vieira
+
+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,69 @@
+# Sidekiq::Clockwork
+
+Sidekiq::Clockwork is a simplistic implementation of a job scheduler based on Clockwork, but without having to run a separated process.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "sidekiq-clockwork"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-clockwork
+
+## Usage
+
+Create your job scheduler and make sure that it's loaded by Sidekiq's server (when you run the `sidekiq` command).
+
+```ruby
+Sidekiq::Clockwork.run do
+  # This is the default timeout
+  # sleep_timeout 0.1
+
+  # By default, it comes with a error handler like the following:
+  # error_handler do |error|
+  #   $stderr << "[CLOCKWORK] #{error.class}: #{error.message}"
+  #   $stderr << " (" << error.backtrace_locations.first << ")\n"
+  # end
+  #
+  # You can clean up error handlers with:
+  # error_handlers.clear
+  #
+  # You may want to use an exception tracker like Rollbar:
+  # error_handler do |error|
+  #   Rollbar.error(error)
+  # end
+  #
+
+  # You can schedule jobs by using `every`, which receives
+  # an interval in seconds.
+  every(30.seconds) { SomeWorker.perform_async }
+end
+```
+
+Sidekiq::Clockwork is single-threaded and sequencial by design, so make sure your scheduler only enqueue jobs without doing any processing (tl;dr make it as fast as you can).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fnando/sidekiq-clockwork. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sidekiq::Clockwork project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fnando/sidekiq-clockwork/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq/clockwork"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/sidekiq/clockwork/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  class Clockwork
+    VERSION = "0.1.0"
+  end
+end

data/lib/sidekiq/clockwork.rb

@@ -0,0 +1,105 @@
+require "sidekiq/clockwork/version"
+
+module Sidekiq
+  class Clockwork
+    SIGNALS = %w[INT TERM HUP].freeze
+
+    def self.run(&block)
+      return unless Sidekiq.server?
+
+      clockwork = new
+      clockwork.instance_eval(&block)
+      clockwork.run
+      clockwork
+    end
+
+    attr_reader :error_handlers
+
+    def initialize
+      @error_handlers = []
+      @sleep_timeout = 0.1
+      @interrupt = false
+
+      use_default_error_handler
+    end
+
+    def jobs
+      @jobs ||= []
+    end
+
+    def sleep_timeout(timeout = nil)
+      @sleep_timeout = timeout if timeout
+      @sleep_timeout
+    end
+
+    def every(interval, &block)
+      run_at = Time.now + interval
+      jobs << {run_at: run_at, interval: interval, block: block}
+    end
+
+    def error_handler(&block)
+      error_handlers << block
+    end
+
+    def run_error_handlers(error)
+      error_handlers.each do |handler|
+        handler.call(error)
+      rescue StandardError => handler_error
+        $stderr << error_message(handler_error, "Error handler raised exception. ")
+      end
+    end
+
+    def error_message(error, prefix = nil)
+      "[SIDEKIQ:CLOCKWORK] #{prefix}#{error.class}: #{error.message} (#{error.backtrace_locations.first})\n"
+    end
+
+    def use_default_error_handler
+      error_handler do |error|
+        $stderr << error_message(error)
+      end
+    end
+
+    def run_job(job)
+      now = Time.now
+      return if now < job[:run_at]
+      job[:run_at] = now + job[:interval]
+      job[:block].call
+    rescue StandardError => error
+      run_error_handlers(error)
+    end
+
+    def interrupt?
+      @interrupt
+    end
+
+    def interrupt!
+      @interrupt = true
+    end
+
+    def trap_signals
+      SIGNALS.each do |signal|
+        trap(signal) do
+          interrupt!
+        end
+      end
+    end
+
+    def run
+      trap_signals
+
+      Thread.new do
+        loop do
+          jobs.each do |job|
+            run_job(job)
+          end
+
+          if interrupt?
+            break
+          else
+            sleep(sleep_timeout)
+          end
+        end
+      end
+    end
+  end
+end

data/sidekiq-clockwork.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sidekiq/clockwork/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-clockwork"
+  spec.version       = Sidekiq::Clockwork::VERSION
+  spec.authors       = ["Nando Vieira"]
+  spec.email         = ["fnando.vieira@gmail.com"]
+
+  spec.summary       = "Sidekiq::Clockwork is a simplistic implementation of a job scheduler based on Clockwork, but without having to run a separated process."
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/fnando/sidekiq-clockwork"
+  spec.license       = "MIT"
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sidekiq"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest-utils"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-clockwork
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nando Vieira
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sidekiq::Clockwork is a simplistic implementation of a job scheduler
+  based on Clockwork, but without having to run a separated process.
+email:
+- fnando.vieira@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sidekiq/clockwork.rb
+- lib/sidekiq/clockwork/version.rb
+- sidekiq-clockwork.gemspec
+homepage: https://github.com/fnando/sidekiq-clockwork
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Sidekiq::Clockwork is a simplistic implementation of a job scheduler based
+  on Clockwork, but without having to run a separated process.
+test_files: []