activejob-scheduler 0.0.1 → 1.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d82e4890ae35e31690712e645bf35ed17563f411
-  data.tar.gz: 22080545aa6fd5a349d583f974e19674ddbadc3e
+SHA256:
+  metadata.gz: 5249502825a6e087006bf9d2bd61499546bb8af8a3aff2b57eee5621cba496e0
+  data.tar.gz: be51136634feecf5881769d6ddc50a5b426f1024b840751dc3a134ee9c1cf673
 SHA512:
-  metadata.gz: 67873b9ceb54a39466f027030123de2e09d4015afb9ac9e6fbb3bfb89e89bff8b1926ae26f94e9b9a20aee55e44296166539c6740f8e2a96a2e27dd088c6f7a5
-  data.tar.gz: bbf7cb9b2dd1484d271e78ef6d8967c74cbc7194cc59d99853b84538c0c6517c124d197c5d1b8635a6395ffdc51250a4b328b17bdb1b47040abaa44549d07bd0
+  metadata.gz: ac63b3c8cb324a661441784c2bb1b839d2a7433eb3d5422f707f8c02f1674f11ac6f2ef6b3fcb708572057432c072a39798050b18f7c303ac0ecb4a8aa4dd834
+  data.tar.gz: 040a90dc42586f6447e9110445b5b71aba276afc3edae392f11f5ad5140df5bdba9381a23d52a78167bec4ca88a8c7d17e90bf39260e596f5c1b9a21a50611fd

data/.gitignore

@@ -1,17 +1,14 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+vendor/
 Gemfile.lock
-InstalledFiles
-_yardoc
+.env
+.yardoc
+doc
 coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  Exclude:
+    - vendor/**/*
+    - test/dummy/**/*
+    - bin/**/*
+
+Metrics/LineLength:
+  Exclude:
+    - activejob-scheduler.gemspec
+
+Metrics/MethodLength:
+  Exclude:
+    - lib/active_job/scheduler/event.rb
+
+Naming/FileName:
+  Exclude:
+    - lib/activejob-scheduler.rb

data/.travis.yml

@@ -0,0 +1,26 @@
+language: ruby
+rvm:
+- 2.5
+- 2.6
+- ruby-head
+matrix:
+  allow_failures:
+  - rvm: ruby-head
+before_install: gem install bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+deploy:
+  provider: rubygems
+  api_key:
+    secure: Pc0pTAFK72e7m47TnOg8f07MF8wrx5soR/D6K9VOT5+TWEPmYktVuoubsdNBc7Qf+MoTRdqbTeyvcqBI2BCuQUh98Ls8AC3pdmiz2WNNN8LFm3JYudLR/tRU2Fm6jsM5hE/Q6kdqCBEYgR1radwGv5IBBl9JjCs8amC2bVuJHBw=
+  gem: activejob-scheduler
+  on:
+    tags: true
+    repo: tubbo/activejob-scheduler
+env:
+  global:
+    secure: QvIDmtMATWuUuPvqujou8wgClT5JgXiVwHzqort0a+ssLQsi5kMNw+AAiNyfgKc0OOlxgKEJkJr1LSgZpyOiVhmpJ88cItaLI3ngSCHZIYT+LqU31wxcTTmTqXpdgZymrHMdHmeInxkIvtC1kzLatIUF8XODA+CnXWjEVBT/HXc=

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -1,4 +1,16 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in active_job-scheduler.gemspec
+# Declare your gem's dependencies in activejob_scheduler.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
 gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/LICENSE.txt

@@ -1,22 +1,21 @@
-Copyright (c) 2014 Tom Scott
+The MIT License (MIT)
 
-MIT License
+Copyright (c) 2016 Tom Scott
 
-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:
+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 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.
+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/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Tom Scott
+
+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

@@ -1,5 +1,10 @@
 # ActiveJob::Scheduler
 
+[![Current Gem Version](https://badge.fury.io/rb/activejob-scheduler.svg)](http://badge.fury.io/rb/activejob-scheduler)
+[![Build Status](https://travis-ci.org/tubbo/activejob-scheduler.svg?branch=master)](https://travis-ci.org/tubbo/activejob-scheduler)
+[![Maintainability](https://api.codeclimate.com/v1/badges/94b5d52c0059cc8a380b/maintainability)](https://codeclimate.com/github/tubbo/activejob-scheduler/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/94b5d52c0059cc8a380b/test_coverage)](https://codeclimate.com/github/tubbo/activejob-scheduler/test_coverage)
+
 An extension to [ActiveJob][aj] for running background jobs
 periodically, according to a schedule. Inspired by its predecessors,
 [resque-scheduler][resque] and [sidekiq-scheduler][sidekiq],
@@ -7,84 +12,168 @@ periodically, according to a schedule. Inspired by its predecessors,
 everyone's hands, by way of the pre-defined ActiveJob API which most
 popular queueing backend choices already support.
 
-Like its predecessors, `ActiveJob::Scheduler` is built with
-[Rufus::Scheduler][rufus], an immensely powerful task scheduling library
-to make sure your jobs get kicked off at *exactly* the right time.
+Like its predecessors, `ActiveJob::Scheduler` uses the same powerful
+syntax for describing when periodic jobs should run as
+[Rufus::Scheduler][rufus]. However, unlike its predecessors,
+`ActiveJob::Scheduler` does not require a separate process to be run.
+Instead, it uses an `after_perform` callback to re-enqueue the job after
+it has been performed.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'activejob-scheduler'
+```ruby
+gem 'activejob-scheduler'
+```
 
 And then execute:
 
     $ bundle
 
+Or install it yourself as:
+
+    $ gem install activejob-scheduler
+
 ## Usage
 
-Run the following command to generate a YAML-based schedule:
+To schedule your jobs, add the `repeat` macro to the job definition:
 
-```bash
-$ rails generate activejob:schedule
+```ruby
+class GenerateSitemapsJob < ApplicationJob
+  repeat 'every day at 2am'
+
+  def perform
+    SitemapGenerator.generate
+  end
+end
 ```
 
-Edit this YAML file the same way you would with resque-scheduler or
-sidekiq-scheduler (they define the same parameters). Then, it's your
-choice as to how you wish to run it, either by the binary:
+This macro can also be used to configure the job event, like its name or
+arguments:
+
+```ruby
+class GenerateSitemapsJob < ApplicationJob
+  repeat every: '1d', name: 'Sitemap Generator', arguments: %w(foo bar)
+
+  def perform(foo, bar)
+    SitemapGenerator.generate(foo, bar) # => foo == "foo", bar == "bar"
+  end
+end
+```
+
+The DSL also allows you to iterate over a collection and pass in a
+different argument for each item:
+
+```ruby
+class SyncOrdersJob < ApplicationJob
+  repeat 'every day at 11:30am', each: -> { Order.not_synced }
+
+  def perform(order)
+    ExternalSystem.create(order)
+  end
+end
+```
+
+This will trigger the event every day at 11:30am, but enqueue a job for
+each model in the collection, and pass it into the job arguments. You
+can specify static arguments here as well, they will be passed in prior
+to the item argument at the end.
+
+```ruby
+class SyncOrdersJob < ApplicationJob
+  repeat 'every day at 11:30am',
+    arguments: ['synced'],
+    each: -> { Order.not_synced }
+
+  def perform(type, order)
+    ExternalSystem.create(type: type, order: order) # type is "synced"
+  end
+end
+```
+
+Start the schedule by running this command:
 
 ```bash
-$ bundle exec ajs
+./bin/rails activejob:schedule
 ```
 
-Or, with a Rake task:
+### YAML Schedule
+
+Much like **resque-scheduler**, you can use a YAML schedule file with
+**activejob-scheduler** with a very similar syntax. To generate a new
+one, run:
 
 ```bash
-$ bundle exec rake activejob:schedule
+$ rails generate activejob:schedule
 ```
 
-The schedule must run as a separate process, but it's very light...it
-delegates all the real processing to your queue workers, and simply
-enqueues jobs as the specified time rolls around.
+Then, add your jobs into the YAML like so:
 
-## Development
+```yaml
+generate_sitemaps:
+  interval:
+    every: '1d'
+```
+
+This is entirely optional, however, and both DSL-based jobs and
+YAML-based jobs will be included in the schedule at runtime.
 
-Please use GitHub pull requests to contribute bug fixes or features, and
-make sure to include tests with all your work.
+### Mailers
 
-### License
+```ruby
+class AdminMailer < ApplicationMailer
+  repeat :daily_status, 'every day at 8am'
+  def daily_status
+    mail to: User.admins.pluck(:email)
+  end
+end
+```
+
+This will send the email every day at **8:00am**. You can also pass all
+the regular fields from `repeat` in the job DSL like arguments and the
+various fugit-parsed intervals.
 
-[University of Illinois/NCSA Open Source License][license]
+You can also send a different email for each recipient:
+
+```ruby
+class UserMailer < ApplicationMailer
+  repeat :status, 'every day at 8am', each: -> { User.receive_email }
+  def status(user)
+  end
+end
+```
+
+This lambda will be called when the event is enqueued, and individual
+mails will be sent out for each user in the collection.
+
+## Development
 
-    Copyright (c) 2014 Tom Scott
-    All rights reserved.
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake rspec` to run the tests. You can also run `bin/console`
+for an interactive prompt that will allow you to experiment.
 
-    Permission is hereby granted, free of charge, to any person obtaining
-    a copy of this software and associated documentation files (the "Software"),
-    to deal with 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:
+To install this gem onto your local machine, run `bin/rake install`. To
+release a new version, update the version number in `version.rb`, and
+then run `bin/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).
 
-    Redistributions of source code must retain the above copyright notice,
-    this list of conditions and the following disclaimers.
+## Contributing
 
-    Redistributions in binary form must reproduce the above copyright notice,
-    this list of conditions and the following disclaimers in the documentation
-    and/or other materials provided with the distribution.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/tubbo/activejob-scheduler. This project is intended
+to be a safe, welcoming space for collaboration, and contributors
+are expected to adhere to the
+[Contributor Covenant](contributor-covenant.org) code of conduct.
 
-    None of the names of its contributors may be used to endorse or promote
-    products derived from this Software without specific prior written permission.
+## License
 
-    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 CONTRIBUTORS 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 WITH THE SOFTWARE.
+The gem is available as open source under the terms of the [MIT
+License][mit].
 
-[aj]: https://github.com/rails/activejob
+[aj]: https://github.com/rails/rails/tree/master/activejob
 [resque]: https://github.com/resque/resque-scheduler
 [sidekiq]: https://github.com/Moove-it/sidekiq-scheduler
 [rufus]: https://github.com/jmettraux/rufus-scheduler
-[license]: http://opensource.org/licenses/NCSA
+[mit]: http://opensource.org/licenses/MIT

data/Rakefile

@@ -1,5 +1,28 @@
-require "bundler/setup"
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
 
-RSpec::Core::RakeTask.new :test
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yard'
+require 'travis/release/task'
+require 'rake/testtask'
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+RuboCop::RakeTask.new :lint
+
+YARD::Rake::YardocTask.new :doc
+
+Travis::Release::Task.new
+
+task default: %i[lint test build doc]

data/activejob-scheduler.gemspec

@@ -1,28 +1,38 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'active_job/scheduler/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "activejob-scheduler"
+  spec.name          = 'activejob-scheduler'
   spec.version       = ActiveJob::Scheduler::VERSION
-  spec.authors       = ["Tom Scott"]
-  spec.email         = ["tscott@telvue.com"]
-  spec.summary       = %q{A scheduling apparatus for ActiveJob based on Rufus.}
-  spec.description   = %q{A scheduling apparatus for ActiveJob based on Rufus. Resque::Scheduler for everyone!}
-  spec.homepage      = "http://github.com/tubbo/activejob-scheduler"
-  spec.license       = "MIT"
+  spec.authors       = ['Tom Scott']
+  spec.email         = ['tscott@weblinc.com']
+
+  spec.summary       = 'Scheduled jobs for ActiveJob.'
+  spec.description   = spec.summary.to_s
+  spec.homepage      = 'https://github.com/tubbo/activejob-scheduler'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(spec)/})
-  spec.require_paths = ["lib"]
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'bundler', '>= 1', '< 3'
+  spec.add_development_dependency 'mocha', '~> 1.9'
+  spec.add_development_dependency 'rails', '~> 6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'rubocop', '>= 0.49.0'
+  spec.add_development_dependency 'simplecov', '~> 0.17'
+  spec.add_development_dependency 'sqlite3', '~> 1.4'
+  spec.add_development_dependency 'yard', '>= 0.9.20'
 
-  spec.add_dependency 'activejob'
-  spec.add_dependency 'rufus-scheduler'
-  spec.add_dependency 'activemodel'
+  spec.add_dependency 'actionmailer', '> 5', '< 7'
+  spec.add_dependency 'activejob', '> 5', '< 7'
+  spec.add_dependency 'activesupport', '> 5', '< 7'
+  spec.add_dependency 'fugit', '~> 1.3'
+  spec.add_dependency 'travis-release', '~> 0'
 end