sidekiq-cron-tasks 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0bebc8a18c90f14c7f7b6d2ace03c96daf76ca0
+  data.tar.gz: 10adc1c729afd1dd1a8fbd1f2b1b4a6586b73b81
+SHA512:
+  metadata.gz: 416113bdf08a72f514a807ea5c6ad8701d08484bf707e93da1cdb4b9e8c46c467c0ed1d76809b7133c53209ef79b817bd479aeb212007833b20b6be309c17345
+  data.tar.gz: 9438ab02e0ad0135aa0f74f90868c45112322effda90d5905524cf83bc31897f8c651c5787e5f71b253af674e0dfd7cd1cd8dcac91df735a27b299b5a150c63b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Bernardo Farah
+
+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,76 @@
+# Sidekiq::Cron::Tasks
+
+Adds `rake` and `cap` tasks for loading `Sidekiq::Cron::Job`s from a config
+file.
+
+## Usage
+
+#### Rake task
+
+You can run the rake task via:
+
+```sh
+bundle exec rake sidekiq_cron:load
+```
+
+It expects a configuration file at `config/sidekiq_cron.yml` in this format:
+
+```yml
+default: &defaults
+  rake task does stuff:
+    cron: "42 0 * * *"
+    class: "RakeTaskJob"
+    args:
+      - does:stuff
+
+development:
+  <<: *defaults
+
+staging:
+  <<: *defaults
+
+production:
+  <<: *defaults
+```
+
+You can configure the location of this file, as well as name prefixes for tasks:
+
+```rb
+Sidekiq::Cron::Tasks.configure do |config|
+  config.file = "/custom/file/path"
+  config.prefix = "notmyprefix"
+end
+```
+
+#### Capistrano
+
+You can enable this task for Capistrano deployment. It runs around the same time
+that Rails' db migrations do. To enable it:
+
+```rb
+# Capfile
+require 'capistrano/sidekiq-cron'
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-cron-tasks'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install sidekiq-cron-tasks
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Sidekiq::Cron::Tasks'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/capistrano/sidekiq-cron.rb

@@ -0,0 +1,2 @@
+require "capistrano/rails"
+load File.expand_path("../tasks/sidekiq_cron.rake", __FILE__)

data/lib/capistrano/sidekiq_cron.rb

@@ -0,0 +1 @@
+require_relative "sidekiq-cron"

data/lib/capistrano/tasks/sidekiq_cron.rake

@@ -0,0 +1,20 @@
+namespace :deploy do
+  desc "Updates Sidekiq::Cron jobs from configuration file"
+  task sidekiq_cron: [:set_rails_env] do
+    on fetch(:sidekiq_cron_servers) do
+      within release_path do
+        with rails_env: fetch(:rails_env) do
+          execute :rake, "sidekiq_cron:load"
+        end
+      end
+    end
+  end
+  after "deploy:updated", "deploy:sidekiq_cron"
+end
+
+namespace :load do
+  task :defaults do
+    set :sidekiq_cron_role, fetch(:sidekiq_cron_role, :app)
+    set :sidekiq_cron_servers, -> { primary(fetch(:sidekiq_cron_role)) }
+  end
+end

data/lib/sidekiq/cron/tasks/configuration.rb

@@ -0,0 +1,22 @@
+module Sidekiq
+  module Cron
+    module Tasks
+      class Configuration
+        attr_accessor :file, :prefix
+
+        def initialize
+          @file = ::Rails.root.join("config", "sidekiq_cron.yml")
+          @prefix = "sidekiq_cron"
+        end
+
+        def file
+          @file || @default_file.call
+        end
+
+        def schedule
+          @schedule ||= File.exist?(file) ? YAML.load_file(file).fetch(::Rails.env, {}) : {}
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/cron/tasks/railtie.rb

@@ -0,0 +1,11 @@
+module Sidekiq
+  module Cron
+    module Tasks
+      class Railtie < ::Rails::Railtie
+        rake_tasks do
+          load "tasks/sidekiq_cron/load.rake"
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/cron/tasks/version.rb

@@ -0,0 +1,7 @@
+module Sidekiq
+  module Cron
+    module Tasks
+      VERSION = '0.2.0'
+    end
+  end
+end

data/lib/sidekiq/cron/tasks.rb

@@ -0,0 +1,17 @@
+require "sidekiq-cron"
+require "sidekiq/cron/tasks/railtie"
+require "sidekiq/cron/tasks/configuration"
+
+module Sidekiq
+  module Cron
+    module Tasks
+      def self.config
+        @config ||= Configuration.new
+      end
+
+      def self.configure
+        yield config
+      end
+    end
+  end
+end

data/lib/sidekiq-cron-tasks.rb

@@ -0,0 +1 @@
+require "sidekiq/cron/tasks"

data/lib/sidekiq_cron_tasks.rb

@@ -0,0 +1 @@
+require_relative "sidekiq-cron-tasks"

data/lib/tasks/sidekiq_cron/load.rake

@@ -0,0 +1,16 @@
+namespace :sidekiq_cron do
+  desc "Load Sidekiq Cron entries from file"
+  task load: :environment do
+    config = Sidekiq::Cron::Tasks.config
+
+    next if config.schedule.empty?
+
+    prefixed_hash = config.schedule.each_with_object({}) do |(name, options), new_hash|
+      prefixed_name = name.sub(/\A(#{config.prefix} )?/, config.prefix + " ")
+      new_hash[prefixed_name] = options
+    end
+
+    Sidekiq::Cron::Job.all.select { |job| job.name =~ /\A#{config.prefix} / }.each(&:destroy)
+    Sidekiq::Cron::Job.load_from_hash prefixed_hash
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-cron-tasks
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Bernardo Farah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: capistrano-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: sidekiq-cron
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Adds tasks for Sidekiq Cron loading
+email:
+- ber@bernardo.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/capistrano/sidekiq-cron.rb
+- lib/capistrano/sidekiq_cron.rb
+- lib/capistrano/tasks/sidekiq_cron.rake
+- lib/sidekiq-cron-tasks.rb
+- lib/sidekiq/cron/tasks.rb
+- lib/sidekiq/cron/tasks/configuration.rb
+- lib/sidekiq/cron/tasks/railtie.rb
+- lib/sidekiq/cron/tasks/version.rb
+- lib/sidekiq_cron_tasks.rb
+- lib/tasks/sidekiq_cron/load.rake
+homepage: https://github.com/coverhound/sidekiq-cron-tasks
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Adds tasks for Sidekiq Cron loading
+test_files: []