active_job_cron_scheduler 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e7898345b0e7487fc694451880c70fdbf3aa360f5256afda892cc4442a655666
+  data.tar.gz: b3ab66183892a1ae5820d7478efea3d8496fd46564e5d3de1bc31fe9ce64cb74
+SHA512:
+  metadata.gz: 505087e528cb2b77ef1146e6a534720c60e88f2e896f7facdc621a6e06a9c9c83cca6a66c0478e21821034135103606c5c2efdb697c31a335fbb0e73316fa2a7
+  data.tar.gz: 0b3f671f18fe5ef9b82689855a9e3746d87c14e10b6411d74312c82d7a6ad044e17305fbe6f919762a7df415cfa4468f330bf6f48f620440f12eb558801812a6

data/.github/workflows/gem-push.yml

@@ -0,0 +1,36 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby 3.3.x
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.3.4
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -0,0 +1,57 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+.idea

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Anatoly Zelenin
+
+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,126 @@
+# ActiveJobCronScheduler
+
+ActiveJobCronScheduler is a Ruby on Rails gem that provides a simple and efficient way to schedule recurring jobs in your Rails application. It leverages ActiveJob and provides a clean DSL for defining job schedules.
+
+## Features
+
+- Simple DSL for scheduling recurring jobs
+- Built on top of ActiveJob for seamless integration with Rails
+- Prevents parallel execution of the same job
+- Stores execution history for debugging purposes
+- No external dependencies (like Redis) required
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_job_cron_scheduler'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+After installing the gem, run the installation generator:
+
+```
+$ rails generate active_job_cron_scheduler:install
+```
+
+This will create a migration file. Run the migration to create the necessary database table:
+
+```
+$ rails db:migrate
+```
+
+## Usage
+
+### Defining a Job
+
+To create a job that runs on a schedule, simply include the `ActiveJobCronScheduler::ActiveJobCronScheduler` module in your job class and use the `schedule_each` method to define the schedule:
+
+```ruby
+class HourlyJob < ApplicationJob
+  include ActiveJobCronScheduler::ActiveJobCronScheduler
+
+  schedule_each 1.hour
+
+  def perform(*ignore)
+    # Your code here
+    puts "Performing hourly job at #{Time.current}"
+  end
+end
+```
+
+### Schedule Options
+
+You can schedule jobs with different intervals:
+
+```ruby
+
+class DailyJob < ApplicationJob
+  include ActiveJobCronScheduler::ActiveJobCronScheduler
+
+  schedule_each 1.day, at: "02:00"
+
+  def perform(*ignore)
+    # This job will run every day at 2:00 AM
+  end
+end
+
+class WeeklyJob < ApplicationJob
+  include ActiveJobCronScheduler::ActiveJobCronScheduler
+
+  schedule_each 1.week, on: :monday, at: "09:00"
+
+  def perform(*ignore)
+    # This job will run every Monday at 9:00 AM
+  end
+end
+
+class MonthlyJob < ApplicationJob
+  include ActiveJobCronScheduler::ActiveJobCronScheduler
+
+  schedule_each 1.month, on: 1, at: "00:00"
+
+  def perform(*ignore)
+    # This job will run on the first day of every month at midnight
+  end
+end
+```
+
+### Job Execution
+
+Jobs are automatically scheduled when your Rails application starts. The `ActiveJobCronScheduler::Scheduler` takes care of scheduling all defined jobs.
+
+### Debugging
+
+You can check the `active_job_cron_schedulers` table in your database for information about job executions:
+
+```ruby
+ActiveJobCronScheduler::JobRecord.all.each do |record|
+  puts "Job: #{record.job}"
+  puts "Last execution: #{record.last_execution}"
+  puts "---"
+end
+```
+
+## Configuration
+
+By default, ActiveJobCronScheduler uses your application's default ActiveJob queue adapter. If you want to use a specific adapter for scheduled jobs, you can configure it in an initializer:
+
+```ruby
+# config/initializers/active_job_cron_scheduler.rb
+Rails.application.config.active_job.queue_adapter = :sidekiq
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yourusername/active_job_cron_scheduler.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/active_job_cron_scheduler.gemspec

@@ -0,0 +1,31 @@
+require_relative "lib/active_job_cron_scheduler/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "active_job_cron_scheduler"
+  spec.version     = ActiveJobCronScheduler::VERSION
+  spec.authors     = ["Anatoly Zelenin"]
+  spec.email       = ["anatoly@zelenin.de"]
+
+  spec.summary     = "A simple and efficient cron-like job scheduler for Ruby on Rails"
+  spec.description = "ActiveJobCronScheduler provides a clean DSL for defining recurring jobs in Rails applications, leveraging ActiveJob for seamless integration."
+  spec.homepage    = "https://github.com/itadventurer/active_job_cron_scheduler"
+  spec.license     = "MIT"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/itadventurer/active_job_cron_scheduler"
+  #spec.metadata["changelog_uri"] = "https://github.com/itadventurer/active_job_cron_scheduler/blob/master/CHANGELOG.md"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", ">= 5.2"
+  spec.add_dependency "activejob", ">= 5.2"
+
+  spec.add_development_dependency "rake", "~> 13.0"
+end

data/lib/active_job_cron_scheduler/active_job_cron_scheduler.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module ActiveJobCronScheduler
+  module ActiveJobCronScheduler
+    extend ActiveSupport::Concern
+
+    included do
+      before_perform do |job|
+        self.class.check_singleton_token(job.arguments.first[:singleton_token])
+      end
+      after_perform do |job|
+        self.class.schedule_next
+      end
+    end
+
+    class_methods do
+      def schedule_each(interval, options = {})
+        @interval = interval
+        @schedule_options = options
+      end
+
+      def schedule_next
+        job_record = find_or_create_job_record
+        job_record.update(last_execution: Time.current)
+        next_run = calculate_next_run(job_record)
+        set(wait_until: next_run).perform_later(singleton_token: job_record.singleton_token)
+      end
+
+      def override_and_schedule
+        job_record = find_or_create_job_record
+        job_record.update(singleton_token: SecureRandom.uuid)
+        next_run = calculate_next_run(job_record)
+        set(wait_until: next_run).perform_later(singleton_token: job_record.singleton_token)
+      end
+
+      def find_or_create_job_record
+        JobRecord.find_or_create_by(job: name) do |record|
+          record.singleton_token = SecureRandom.uuid
+        end
+      end
+
+      def check_singleton_token(singleton_token)
+        job_record = find_or_create_job_record
+        if job_record.singleton_token != singleton_token
+          logger.info "Job #{self.class.name} skipped: mismatched singleton token"
+          throw :abort
+        end
+      end
+
+      private
+
+      def calculate_next_run(job_record)
+        case @interval
+        when ActiveSupport::Duration
+          if job_record.last_execution.nil?
+            Time.current
+          else
+            job_record.last_execution + @interval
+          end
+        else
+          raise ArgumentError, "Unsupported interval type"
+        end
+      end
+
+    end
+  end
+end

data/lib/active_job_cron_scheduler/job_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveJobCronScheduler
+  class JobRecord < ActiveRecord::Base
+    self.table_name = 'active_job_schedules'
+  end
+end

data/lib/active_job_cron_scheduler/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ActiveJobCronScheduler
+  class Railtie < Rails::Railtie
+    initializer 'active_job_cron_scheduler.initialize' do
+      Rails.application.config.after_initialize do
+        if Rails.env.development? || Rails.env.production?
+          if defined?(Rails::Server)
+            Scheduler.schedule_all
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_job_cron_scheduler/scheduler.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require_relative 'active_job_cron_scheduler'
+require_relative 'job_record'
+
+module ActiveJobCronScheduler
+  class Scheduler
+    def self.schedule_all
+      Dir[Rails.root.join('app', 'jobs', '**', '*.rb')].each { |file| require_dependency file }
+      ActiveJob::Base.descendants.each do |job_class|
+        if job_class.include?(ActiveJobCronScheduler)
+          # Log as info
+          Rails.logger.info "Scheduling ActiveJobCronScheduler #{job_class}"
+          job_class.override_and_schedule
+        end
+      end
+    end
+  end
+end

data/lib/active_job_cron_scheduler/version.rb

@@ -0,0 +1,3 @@
+module ActiveJobCronScheduler
+  VERSION = "0.1.1"
+end

data/lib/active_job_cron_scheduler.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require 'active_job_cron_scheduler/railtie' if defined?(Rails)
+require 'active_job_cron_scheduler/active_job_cron_scheduler'
+require 'active_job_cron_scheduler/scheduler'
+require 'active_job_cron_scheduler/job_record'
+
+module ActiveJobCronScheduler
+  class Error < StandardError; end
+end
+

data/lib/generators/active_job_cron_scheduler/install_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module ActiveJobCronScheduler
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('templates', __dir__)
+
+      def self.next_migration_number(dirname)
+        next_migration_number = current_migration_number(dirname) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      def create_migration_file
+        migration_template 'create_active_job_schedules.rb', 'db/migrate/create_active_job_schedules.rb'
+      end
+    end
+  end
+end

data/lib/generators/active_job_cron_scheduler/templates/create_active_job_schedules.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class CreateActiveJobSchedules < ActiveRecord::Migration[6.1]
+  def change
+    create_table :active_job_schedules, id: false do |t|
+      t.string :job, null: false, primary_key: true
+      t.datetime :last_execution
+      t.string :singleton_token
+
+      t.timestamps
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: active_job_cron_scheduler
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Anatoly Zelenin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: ActiveJobCronScheduler provides a clean DSL for defining recurring jobs
+  in Rails applications, leveraging ActiveJob for seamless integration.
+email:
+- anatoly@zelenin.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem-push.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- active_job_cron_scheduler.gemspec
+- lib/active_job_cron_scheduler.rb
+- lib/active_job_cron_scheduler/active_job_cron_scheduler.rb
+- lib/active_job_cron_scheduler/job_record.rb
+- lib/active_job_cron_scheduler/railtie.rb
+- lib/active_job_cron_scheduler/scheduler.rb
+- lib/active_job_cron_scheduler/version.rb
+- lib/generators/active_job_cron_scheduler/install_generator.rb
+- lib/generators/active_job_cron_scheduler/templates/create_active_job_schedules.rb
+homepage: https://github.com/itadventurer/active_job_cron_scheduler
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/itadventurer/active_job_cron_scheduler
+  source_code_uri: https://github.com/itadventurer/active_job_cron_scheduler
+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.5.11
+signing_key: 
+specification_version: 4
+summary: A simple and efficient cron-like job scheduler for Ruby on Rails
+test_files: []