schked 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9032b965f197305414b29d447cdacb639dccbe6ccb2c880e42eb659f9be19e16
-  data.tar.gz: 5b87c0acd0067a46ceaaf08439acd9b384eac0fa0ab793b0cf11326ffd9c88b6
+  metadata.gz: d8543c91732ed3147359b2b6c5c8ebef8ddb2f467766a8c143072ac403341647
+  data.tar.gz: d85da0ba7c7f001d9682c9423a59bb35a8ff4c3581583fbf1ed31cc11650c866
 SHA512:
-  metadata.gz: dc849c6d11a7fa8e5262b5678b9998b3d3c2e08014d03a66ddb39c6d0291ecface28631c12cd496647094ad3ef24b548e14c6ecef480626cbcf2793a6d4a1263
-  data.tar.gz: 0220e6572ce4badf7566449f6006c78c1d97529330d3920f3491c9009182ee8a9c7a6ab89060ecf82898a7ad1dbb15babd93e0f699f5fa630327e8816ae34032
+  metadata.gz: 4e87e77de1530b23d680660806edafba03eb191c72da03d8b37b2b0a3845916ce700924e9d51806a20fbba58d8c1c9403e2a9c8d7c33103ab0eb4ceeaa76cdd1
+  data.tar.gz: 4408c7dfb6b03b73018d2d80cd005e52b6ddfc28635fd6eca972c670f17add271e2e89501452220dec116d48c529cb4d5f43761cc7416ddd6a247a3444ee713d

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Michael Merkushin
+
+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,140 @@
+[![Gem Version](https://badge.fury.io/rb/schked.svg)](https://badge.fury.io/rb/schked)
+[![Build Status](https://travis-ci.org/bibendi/schked.svg?branch=master)](https://travis-ci.org/bibendi/schked)
+
+# Schked
+
+Framework agnostic [Rufus-scheduler](https://github.com/jmettraux/rufus-scheduler) wrapper to run recurring jobs.
+
+<a href="https://evilmartians.com/?utm_source=schked">
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "schked"
+```
+
+And then execute:
+
+```sh
+bundle
+```
+
+Or install it yourself as:
+
+```sh
+gem install schked
+```
+
+## Usage
+
+### Ruby on Rails
+
+.schked
+
+```
+--require config/environment.rb
+```
+
+config/schedule.rb
+
+```ruby
+cron "*/30 * * * *", as: "CleanOrphanAttachmentsJob" do
+  CleanOrphanAttachmentsJob.perform_later
+end
+```
+
+If you have a Rails engine with own schedule:
+
+engine-path/lib/foo/engine.rb
+
+```ruby
+module Foo
+  class Engine < ::Rails::Engine
+    initializer "foo" do |app|
+      Schked.config.paths << root.join("config", "schedule.rb")
+    end
+  end
+end
+```
+
+And run Schked:
+
+```sh
+bundle exec schked start
+```
+
+To show schedule:
+
+```sh
+bundle exec schked show
+```
+
+### Callbacks
+
+Also, you can define callbacks for errors handling:
+
+config/initializers/schked.rb
+
+```ruby
+Schked.config.register_callback(:on_error) do |job, error|
+  Raven.capture_exception(error) if defined?(Raven)
+end
+```
+
+There are `:before_start` and `:after_finish` callbacks as well.
+
+### Logging
+
+By default Schked writes logs into stdout. In Rails environment Schked is using application logger. You can change it like this:
+
+config/initializers/schked.rb
+
+```ruby
+Schked.config.logger = Logger.new(Rails.root.join("log", "schked.log"))
+```
+
+### Monitoring
+
+[Yabeda::Schked](https://github.com/yabeda-rb/yabeda-schked) - built-in metrics for monitoring Schked recurring jobs out of the box! Part of the [yabeda](https://github.com/yabeda-rb/yabeda) suite.
+
+### Testing
+
+```ruby
+describe Schked do
+  let(:worker) { described_class.worker.tap(&:pause) }
+
+  around do |ex|
+    Time.use_zone("UTC") { Timecop.travel(start_time, &ex) }
+  end
+
+  describe "CleanOrphanAttachmentsJob" do
+    let(:start_time) { Time.zone.local(2008, 9, 1, 10, 42, 21) }
+    let(:job) { worker.job("CleanOrphanAttachmentsJob") }
+
+    specify do
+      expect(job.next_time.to_local_time)
+        .to eq Time.zone.local(2008, 9, 1, 11, 0, 0)
+    end
+
+    it "enqueues job" do
+      expect { job.call(false) }
+        .to have_enqueued_job(CleanOrphanAttachmentsJob)
+    end
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bibendi/schked. 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 Schked project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/schked/blob/master/CODE_OF_CONDUCT.md).

data/exe/schked

@@ -4,4 +4,13 @@
 require "bundler/setup"
 require "schked/cli"
 
-Schked::CLI.start(ARGV)
+# rubocop:disable Lint/RescueException
+begin
+  Schked::CLI.start(ARGV)
+rescue Exception => e
+  warn "Schked exited with error"
+  warn(e.message) if e.respond_to?(:message)
+  warn(e.backtrace.join("\n")) if e.respond_to?(:backtrace) && e.backtrace.respond_to?(:join)
+  exit 1
+end
+# rubocop:enable Lint/RescueException

data/lib/schked/config.rb

@@ -4,7 +4,8 @@ require "logger"
 
 module Schked
   class Config
-    attr_writer :logger
+    attr_writer :logger,
+      :do_not_load_root_schedule
 
     def paths
       @paths ||= []
@@ -15,7 +16,11 @@ module Schked
     end
 
     def logger
-      @logger ||= Logger.new(STDOUT).tap { |l| l.level = Logger::INFO }
+      @logger ||= Logger.new($stdout).tap { |l| l.level = Logger::INFO }
+    end
+
+    def do_not_load_root_schedule?
+      !!@do_not_load_root_schedule
     end
 
     def register_callback(name, &block)

data/lib/schked/railtie.rb

@@ -6,7 +6,10 @@ module Schked
   class Railtie < Rails::Railtie
     class PathsConfig
       def self.call(app)
-        if (root_schedule = app.root.join("config", "schedule.rb")).exist?
+        return if Schked.config.do_not_load_root_schedule?
+
+        root_schedule = app.root.join("config", "schedule.rb")
+        if root_schedule.exist?
           path = root_schedule.to_s
           Schked.config.paths << path unless Schked.config.paths.include?(path)
         end

data/lib/schked/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Schked
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schked
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
-- bibendi@evilmartians.com
-autorequire: 
+- Misha Merkushin
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-07 00:00:00.000000000 Z
+date: 2022-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rufus-scheduler
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -114,64 +114,38 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.60'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.60'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  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'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.4'
 description: Rufus-scheduler wrapper to run recurring jobs
-email: 
+email:
+- merkushin.m.s@gmail.com
 executables:
 - schked
 extensions: []
 extra_rdoc_files: []
 files:
-- Rakefile
+- LICENSE.txt
+- README.md
 - exe/schked
 - lib/schked.rb
 - lib/schked/cli.rb
@@ -179,27 +153,28 @@ files:
 - lib/schked/railtie.rb
 - lib/schked/version.rb
 - lib/schked/worker.rb
-homepage: 
-licenses: []
-metadata: {}
-post_install_message: 
+homepage: https://github.com/bibendi/schked
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Ruby Scheduler
 test_files: []

data/Rakefile

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"