tomo-plugin-cron 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8ce0e8e3cee317a6f7e4d6d4f004f096a3e11ddc2187cf83b52f1dce14c690eb
+  data.tar.gz: b12c9fb55f60b54b805eaba56aea2f1587763d49b10c547eee44e4f46993594b
+SHA512:
+  metadata.gz: 5b4b8387407daf654e28b6740f01c48bdcaf5b10fc2588b9c13842f377b347bf245b1439c4dfcb24b43196d6262f2cc513fc4fda66f01c65fa8917a672c2b617
+  data.tar.gz: 619d83c42272b5a539f783a795a8350e1b91fa17fa2d0839cac8ab2ed03d9e9f5e3676d91db1a73b95c7eea59ba73fb142dee5efd0d5cc65c66fa0be8359b396

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Muhammad Usman
+
+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,82 @@
+# tomo-plugin-cron
+
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/uxxman/tomo-plugin-cron/CI)](https://github.com/uxxman/tomo-plugin-cron/actions?query=workflow%3ACI)
+[![Code Climate coverage](https://img.shields.io/codeclimate/coverage/uxxman/tomo-plugin-cron)](https://codeclimate.com/github/uxxman/tomo-plugin-cron)
+[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/uxxman/tomo-plugin-cron)](https://codeclimate.com/github/uxxman/tomo-plugin-cron)
+[![Gem](https://img.shields.io/gem/v/tomo-plugin-cron)](https://rubygems.org/gems/tomo-plugin-cron)
+
+This is a [tomo](https://github.com/mattbrictson/tomo) plugin that provides tasks for managing cron jobs using ruby DSL provided by the awesome [whenever](https://github.com/javan/whenever) gem.
+
+## Installation
+
+Run:
+
+```
+$ gem install tomo-plugin-cron
+```
+
+Or add it to your Gemfile:
+
+```ruby
+gem "tomo-plugin-cron"
+```
+
+Then add the following to `.tomo/config.rb`:
+
+```ruby
+plugin "cron"
+```
+
+Now, create a file **schedule.rb** alongside your tomo config file and start writing cron jobs in ruby.
+
+```ruby
+# .tomo/schedule.rb
+
+every 3.hours do
+  rake "my:rake:task"
+  runner "MyModel.some_process"
+  command "/usr/bin/my_great_command"
+end
+
+every 1.day, at: '4:30 am' do
+  runner "MyModel.task_to_run_at_four_thirty_in_the_morning"
+end
+```
+For more examples, checkout out [whenever](https://github.com/javan/whenever#example-schedulerb-file) gem readme.
+
+
+## Settings
+
+| Name                  | Required | Purpose | Default |
+| --------------------- | -------- | ------- | ------- |
+| `cron_schedule_path`  | No       | Schedule file location | `.tomo/schedule.rb`   |
+
+## Tasks
+
+### cron:show
+
+Print out current content of crontab.
+
+### cron:install
+
+Translate schedules defined inside your **schedule.rb** file into cron syntax and write them to your host's crontab.
+
+### cron:uninstall
+
+Delete host's crontab.
+
+## Support
+
+If you want to report a bug, or have ideas, feedback or questions about the gem, [let me know via GitHub issues](https://github.com/uxxman/tomo-plugin-cron/issues/new) and I will do my best to provide a helpful answer. Happy hacking!
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
+
+## Code of conduct
+
+Everyone interacting in this project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+
+## Contribution guide
+
+Pull requests are welcome!

data/lib/tomo/plugin/cron.rb

@@ -0,0 +1,15 @@
+require "tomo"
+require_relative "cron/tasks"
+require_relative "cron/version"
+
+module Tomo
+  module Plugin
+    module Cron
+      extend Tomo::PluginDSL
+
+      defaults cron_schedule_path: ".tomo/schedule.rb"
+
+      tasks Tomo::Plugin::Cron::Tasks
+    end
+  end
+end

data/lib/tomo/plugin/cron/tasks.rb

@@ -0,0 +1,31 @@
+require "whenever"
+
+module Tomo::Plugin::Cron
+  class Tasks < Tomo::TaskLibrary
+    def show
+      remote.run "crontab -l", raise_on_error: false
+    end
+
+    def install
+      require_setting :cron_schedule_path
+
+      crontab = Whenever.cron(whenever_options)
+
+      remote.run "echo #{crontab.shellescape} | crontab -"
+    end
+
+    def uninstall
+      remote.run "crontab -r"
+    end
+
+    private
+
+    def whenever_options
+      {}.tap do |options|
+        options[:file] = settings[:cron_schedule_path]
+        options[:set]  = "path=#{paths.current}"
+        options[:set] += "&environment=#{settings.dig(:env_vars, :RAILS_ENV) || 'production'}"
+      end
+    end
+  end
+end

data/lib/tomo/plugin/cron/version.rb

@@ -0,0 +1,7 @@
+module Tomo
+  module Plugin
+    module Cron
+      VERSION = "0.1.0".freeze
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: tomo-plugin-cron
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Muhammad Usman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tomo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: whenever
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
+email:
+- uxman.sherwani@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/tomo/plugin/cron.rb
+- lib/tomo/plugin/cron/tasks.rb
+- lib/tomo/plugin/cron/version.rb
+homepage: https://github.com/uxxman/tomo-plugin-cron
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/uxxman/tomo-plugin-cron/issues
+  changelog_uri: https://github.com/uxxman/tomo-plugin-cron/releases
+  source_code_uri: https://github.com/uxxman/tomo-plugin-cron
+  homepage_uri: https://github.com/uxxman/tomo-plugin-cron
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: cron tasks for tomo
+test_files: []