alarmable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 81a2cd3c46bf9ce21ece16a46bdf2ccf1f78e38e
+  data.tar.gz: 9ebb03c91daec2ae494f8305268bd0ebeb3e7c60
+SHA512:
+  metadata.gz: 6307267d20f76d4b0b19cd119d5e986b55f830ad9bb6b50d5371a06e9b1594d704f60f77417f5352856b0903bebe657a8584af72f31287ab2c61c001531b7ba5
+  data.tar.gz: 9d58b4e684b1dc04a5b976cbb2dda175f07509c1ca1eb0725e85e65e067cfca3f609768be726933983253ffa6b129f962cc5f82eacd24ecb09c8b8cdda361f25

data/.editorconfig

@@ -0,0 +1,30 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = true
+
+[*.json]
+indent_style = space
+indent_size = 2
+
+[*.yml]
+indent_style = space
+indent_size = 2
+
+[Makefile]
+trim_trailing_whitespace = true
+indent_style = tab
+indent_size = 4
+
+[*.sh]
+indent_style = space
+indent_size = 2

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+/gemfiles/vendor/
+*.gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,27 @@
+require: rubocop-rspec
+
+Rails:
+  Enabled: true
+
+Documentation:
+  Enabled: true
+
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+
+Metrics/BlockLength:
+  Exclude:
+    - Rakefile
+    - spec/**/*.rb
+    - '**/*.rake'
+
+# Document all the things.
+Style/DocumentationMethod:
+  Enabled: true
+  RequireForNonPublicMethods: true
+
+# Because +expect_any_instance_of().to have_received()+ is not
+# supported with the +with(hash_including)+ matchers
+RSpec/MessageSpies:
+  EnforcedStyle: receive

data/.travis.yml

@@ -0,0 +1,25 @@
+sudo: false
+
+addons:
+  postgresql: "9.6"
+
+services:
+  - postgresql
+
+language: ruby
+rvm:
+  - 2.4
+  - 2.3
+  - 2.2
+
+gemfile:
+  - gemfiles/rails_4.gemfile
+  - gemfiles/rails_5.0.gemfile
+  - gemfiles/rails_5.1.gemfile
+  - gemfiles/rails_5.2.gemfile
+
+before_install:
+  - gem install bundler
+  - psql -c 'create database alarmable;' -U postgres
+
+script: bundle exec rake

data/Appraisals

@@ -0,0 +1,23 @@
+appraise 'rails-4' do
+  gem 'activejob', '4.2.10'
+  gem 'activerecord', '4.2.10'
+  gem 'activesupport', '4.2.10'
+end
+
+appraise 'rails-5.0' do
+  gem 'activejob', '5.0.6'
+  gem 'activerecord', '5.0.6'
+  gem 'activesupport', '5.0.6'
+end
+
+appraise 'rails-5.1' do
+  gem 'activejob', '5.1.4'
+  gem 'activerecord', '5.1.4'
+  gem 'activesupport', '5.1.4'
+end
+
+appraise 'rails-5.2' do
+  gem 'activejob', '5.2.0.beta2'
+  gem 'activerecord', '5.2.0.beta2'
+  gem 'activesupport', '5.2.0.beta2'
+end

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hermann.mayer92@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in alarmable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Hausgold
+
+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/Makefile

@@ -0,0 +1,96 @@
+MAKEFLAGS += --warn-undefined-variables -j1
+SHELL := bash
+.SHELLFLAGS := -eu -o pipefail -c
+.DEFAULT_GOAL := all
+.DELETE_ON_ERROR:
+.SUFFIXES:
+.PHONY:
+
+# Environment switches
+MAKE_ENV ?= docker
+COMPOSE_RUN_SHELL_FLAGS ?= --rm
+
+# Directories
+VENDOR_DIR ?= vendor/bundle
+GEMFILES_DIR ?= gemfiles
+
+# Host binaries
+BASH ?= bash
+COMPOSE ?= docker-compose
+ID ?= id
+MKDIR ?= mkdir
+RM ?= rm
+
+# Container binaries
+BUNDLE ?= bundle
+APPRAISAL ?= appraisal
+RAKE ?= rake
+
+# Files
+GEMFILES ?= $(subst _,-,$(patsubst $(GEMFILES_DIR)/%.gemfile,%,\
+	$(wildcard $(GEMFILES_DIR)/*.gemfile)))
+TEST_GEMFILES := $(GEMFILES:%=test-%)
+
+# Define a generic shell run wrapper
+# $1 - The command to run
+ifeq ($(MAKE_ENV),docker)
+define run-shell
+	$(COMPOSE) run $(COMPOSE_RUN_SHELL_FLAGS) \
+		-e LANG=en_US.UTF-8 -e LANGUAGE=en_US.UTF-8 -e LC_ALL=en_US.UTF-8 \
+		-e HOME=/tmp -e BUNDLE_APP_CONFIG=/app/.bundle \
+		-u `$(ID) -u` test bash -c 'sleep 0.1; echo; $(1)'
+endef
+else ifeq ($(MAKE_ENV),baremetal)
+define run-shell
+	$(1)
+endef
+endif
+
+all:
+	# Alarmable
+	#
+	# install            Install the dependencies
+	# test               Run the whole test suite
+	# clean              Clean the dependencies
+	#
+	# shell              Run an interactive shell on the container
+	# shell-irb          Run an interactive IRB shell on the container
+
+install:
+	# Install the dependencies
+	@$(MKDIR) -p $(VENDOR_DIR)
+	@$(call run-shell,$(BUNDLE) check || $(BUNDLE) install --path $(VENDOR_DIR))
+	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) install)
+
+test: install
+	# Run the whole test suite
+	@$(call run-shell,$(BUNDLE) exec $(RAKE))
+
+$(TEST_GEMFILES): GEMFILE=$(@:test-%=%)
+$(TEST_GEMFILES):
+	# Run the whole test suite ($(GEMFILE))
+	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) $(GEMFILE) $(RAKE))
+
+clean:
+	# Clean the dependencies
+	@$(RM) -rf $(VENDOR_DIR)
+
+clean-containers:
+	# Clean running containers
+ifeq ($(MAKE_ENV),docker)
+	@$(COMPOSE) down
+endif
+
+distclean: clean clean-containers
+
+shell: install
+	# Run an interactive shell on the container
+	@$(call run-shell,$(BASH) -i)
+
+shell-irb: install
+	# Run an interactive IRB shell on the container
+	@$(call run-shell,bin/console)
+
+release:
+	# Release a new gem version
+	@$(RAKE) release

data/README.md

@@ -0,0 +1,121 @@
+![Alarmable](doc/assets/project.png)
+
+[![Build Status](https://api.travis-ci.org/hausgold/alarmable.svg?branch=master)](https://travis-ci.org/hausgold/alarmable)
+
+This is a reusable alarm concern for Active Record models. It adds support for
+the automatic maintenance of Active Job's which are scheduled for the given
+alarms. On alarm updates the jobs will be canceled and rescheduled. This is
+supported only for Sidekiq, Delayed Job, resque and the Active Job TestAdapter.
+(See [ActiveJob::Cancel](https://github.com/y-yagi/activejob-cancel) for the
+list of supported adapters)
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Database migration](#database-migration)
+  - [Active Record Model](#active-record-model)
+  - [Active Job](#active-job)
+- [Development](#development)
+- [Contributing](#contributing)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alarmable'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install alarmable
+```
+
+## Usage
+
+### Database migration
+
+This concern requires the persistence (and availability) of two properties.
+
+* The first is the JSONB array which holds the alarms. (`alarms`)
+* The seconds is the JSONB array which holds the ids of the
+  scheduled alarm jobs. (`alarm_jobs`)
+
+```bash
+$ rails generate migration AddAlarmsAndAlarmJobsToEntity \
+  alarms:jsonb alarm_jobs:jsonb
+```
+
+### Active Record Model
+
+Furthermore a Active Record model which uses this concern must define the
+Active Job class which will be scheduled. (`alarm_job`) The user must also
+define the base date property of the owning side.
+(`alarm_base_date_property`) This base date is mandatory to calculate the
+correct alarm date/time. When the base date is not set (`nil`) no new
+notification job will be enqueued. When the base date is unset on an update,
+the previously enqueued job will be canceled.
+
+```ruby
+# Your Active Record Model
+class Entity < ApplicationRecord
+  include Alarmable
+  self.alarm_job = NotificationJob
+  self.alarm_base_date_property = :start_at
+end
+```
+
+The alarms hash needs to be an array in the following format:
+
+```ruby
+[
+  {
+    "channel": "email",   # email, push, web_notification, etc..
+    "before_minutes": 15  # start_at - before_minutes, >= 1
+
+    # [..] you can add custom properties if you like
+  }
+]
+```
+
+### Active Job
+
+The given alarm job class will be scheduled with the following two arguments.
+
+* id - The class/instance id of the record which owns the alarm
+* alarm - The alarm hash itself (see the format above)
+
+A suitable alarm job perform method should look like this:
+
+```ruby
+# Your notification job
+class NotificationJob < ApplicationJob
+  # @param id [String] The entity id
+  # @param alarm [Hash] The alarm object
+  def perform(id, alarm)
+    # Do something special for `alarm.channel` ..
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `make install` to install dependencies. Then,
+run `make test` to run the tests. You can also run `make shell-irb` for an
+interactive prompt that will allow you to experiment.
+
+To release a new version, update the version number in `version.rb`, and then
+run `make 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/hausgold/alarmable.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/alarmable.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'alarmable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'alarmable'
+  spec.version       = Alarmable::VERSION
+  spec.authors       = ['Hermann Mayer']
+  spec.email         = ['hermann.mayer@hausgold.de']
+
+  spec.summary       = 'A reusable alarm extension to Active Record models'
+  spec.description   = 'This is a reusable alarm concern for Active Record' \
+                       'models. It adds support for the automatic maintenance' \
+                       'of Active Job\'s which are scheduled for the given' \
+                       'alarms.'
+
+  spec.homepage      = 'https://github.com/hausgold/alarmable'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activejob', '>=3', '<6'
+  spec.add_dependency 'activejob-cancel', '~> 0.3'
+  spec.add_dependency 'activerecord', '>=3', '<6'
+  spec.add_dependency 'activesupport', '>=3', '<6'
+  spec.add_dependency 'hashdiff', '~> 0.3.7'
+
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pg', '~> 0.18'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'alarmable'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker-compose.yml

@@ -0,0 +1,21 @@
+version: "3"
+services:
+  db:
+    image: postgres:9.6
+    network_mode: bridge
+    ports: ["5432"]
+    volumes:
+      - .:/app
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: alarmable
+
+  test:
+    image: ruby:2.3
+    network_mode: bridge
+    working_dir: /app
+    volumes:
+      - .:/app
+    links:
+      - db

data/gemfiles/rails_4.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activejob", "4.2.10"
+gem "activerecord", "4.2.10"
+gem "activesupport", "4.2.10"
+
+gemspec path: "../"

data/gemfiles/rails_5.0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activejob", "5.0.6"
+gem "activerecord", "5.0.6"
+gem "activesupport", "5.0.6"
+
+gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activejob", "5.1.4"
+gem "activerecord", "5.1.4"
+gem "activesupport", "5.1.4"
+
+gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activejob", "5.2.0.beta2"
+gem "activerecord", "5.2.0.beta2"
+gem "activesupport", "5.2.0.beta2"
+
+gemspec path: "../"

data/lib/alarmable.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_record'
+require 'active_job'
+require 'active_job/cancel'
+require 'hashdiff'
+
+require 'alarmable/version'
+require 'alarmable/concern'

data/lib/alarmable/concern.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+# A reusable alarm extension to Active Record models. It adds support for the
+# maintenance of Active Job's (create, update (cancel)) which are schedules for
+# the given alarms.  We check for changes on the alarms hash and perform
+# updates accordingly.
+#
+# This concern requires the persistence (and availability) of two properties.
+#
+# * The first is the JSONB array which holds the alarms. (+alarms+)
+# * The seconds is the JSONB array which holds the ids of
+#   scheduled alarm jobs. (+alarm_jobs+)
+#
+#     rails generate migration AddAlarmsAndAlarmJobsToEntity \
+#       alarms:jsonb alarm_jobs:jsonb
+#
+# Furthermore a Active Record model which uses this concern must define the
+# Active Job class which will be scheduled. (+alarm_job+) The user must also
+# define the base date property of the owning side.
+# (+alarm_base_date_property+) This base date is mandatory to calculate the
+# correct alarm date/time. When the base date is not set (+nil+) no new
+# notification job will be enqueued. When the base date is unset on an update,
+# the previously enqueued job will be canceled.
+#
+# The alarms hash needs to be an array in the following format:
+#
+#   [
+#     {
+#       "channel": "email",   # email, push, web_notification, etc..
+#       "before_minutes": 15  # start_at - before_minutes, >= 1
+#     }
+#   ]
+#
+# The given alarm job class will be scheduled with the following two arguments.
+#
+# * id - The class/instance id of the record which owns the alarm
+# * alarm - The alarm hash itself (see the format above)
+#
+# A suitable alarm job perform method should look like this:
+#
+#   # @param id [String] The entity id
+#   # @param alarm [Hash] The alarm object
+#   def perform(id, alarm)
+#     # Do something special for +alarm.channel+ ..
+#   end
+module Alarmable
+  extend ActiveSupport::Concern
+
+  class_methods do
+    # Getter/Setter
+    #
+    # :reek:Attribute because thats what this thing is about
+    attr_accessor :alarm_job, :alarm_base_date_property
+  end
+
+  # rubocop:disable Metrics/BlockLength because Active Support like it
+  included do
+    # Hooks
+    after_initialize :validate_alarm_settings, :alarm_defaults
+
+    # Here comes a little cheat sheet when and what action is performed
+    # on the alarm jobs.
+    #
+    # create  |              [            time check, reschedule]
+    # update  | dirty check, [cancel job, time check, reschedule]
+    # destroy |              [cancel job                        ]
+    after_create :reschedule_alarm_jobs
+    before_update :alarms_update_callback
+    before_destroy :alarms_destroy_callback
+
+    # Getter for the alarm job class.
+    #
+    # @return [Class] The alarm job class
+    def alarm_job
+      self.class.alarm_job
+    end
+
+    # Getter for the alarm base date property.
+    #
+    # @return [Symbol] The user defined base date property
+    def alarm_base_date_property
+      self.class.alarm_base_date_property
+    end
+
+    # Set some defaults on the relevant alarm properties.
+    def alarm_defaults
+      self.alarms ||= []
+      self.alarm_jobs ||= {}
+    end
+
+    # Validate the presence of the +alarm_job+ property and the accessibility
+    # of the specified class. Also validate the +alarm_base_date_property+
+    # setting.
+    #
+    # rubocop:disable Style/GuardClause because its fine like this
+    # :reek:NilCheck because we validate concern usage
+    def validate_alarm_settings
+      raise 'Alarmable +alarm_job+ is not configured' if alarm_job.nil?
+      unless alarm_job.is_a? Class
+        raise 'Alarmable +alarm_job+ is not instantiable'
+      end
+      if alarm_base_date_property.nil?
+        raise 'Alarmable +alarm_base_date_property+ is not configured'
+      end
+      unless has_attribute? alarm_base_date_property
+        raise 'Alarmable +alarm_base_date_property+ is not usable'
+      end
+    end
+    # rubocop:enable Style/GuardClause
+
+    # Generate a unique and recalculatable identifier for a given alarm object.
+    # We build a hash of the primary keys (before_minutes and channel) to
+    # achive this.  Afterwards, this alarm id is used to reference dedicated
+    # scheduled jobs and track their updates. (Or cancel them accordingly)
+    #
+    # @param channel [String] The alarm channel
+    # @param before_minutes [Integer] The minutes before the alarm starts
+    # @return [String] The unique alarm id
+    #
+    # :reek:UtilityFunction because its a utility, for sure
+    def alarm_id(channel, before_minutes)
+      (Digest::MD5.new << "#{channel}#{before_minutes}").to_s
+    end
+
+    # Schedule a new Active Job for the alarm notification. This method takes
+    # care of the notification time (+date) and will not touch anything when
+    # the desired time already passed.  It cancels the correct job for the
+    # given combination, when it is present. In the end it schedules a new
+    # (renewed) job for the given alarm settings.
+    #
+    # @param alarm [Hash] The alarm object
+    # @return [Object] The new alarm_jobs instance (partial)
+    #   Example: { "alarm id": "job id" }
+    #
+    # rubocop:disable Metrics/AbcSize because its already broken down
+    # :reek:TooManyStatements because see above
+    # :reek:NilCheck because we dont want to cancel 'nil' job id
+    # :reek:DuplicateMethodCall because hash access is fast
+    def reschedule_alarm_job(alarm)
+      # Symbolize the hash keys (just to be sure).
+      alarm = alarm.symbolize_keys
+
+      # Calculate the alarm id for job canceling and cancel a found job.
+      id = alarm_id(alarm[:channel], alarm[:before_minutes])
+      previous_job_id = alarm_jobs.try(:[], id)
+      alarm_job.cancel(previous_job_id) unless previous_job_id.nil?
+
+      base_date = self[alarm_base_date_property]
+
+      # When the base date is not set, we schedule not a new notification job.
+      return {} if base_date.nil?
+
+      # Calculate the time when the job should run.
+      notify_at = base_date - alarm[:before_minutes].minutes
+
+      # Do nothing when the notification date already passed.
+      return {} if Time.current >= notify_at
+
+      # Put a new job to the queue with the new (current) job execution date.
+      job = alarm_job.set(wait_until: notify_at).perform_later(self.id, alarm)
+
+      # Construct a new alarm_jobs partial instance for this job
+      Hash[id, job.job_id]
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    # Initiate a reschedule for each alarm in the alarm settings and
+    # cancel all left-overs.
+    #
+    # rubocop:disable Rails/SkipsModelValidations because we need to skip them
+    # :reek:TooManyStatements because its already broken down
+    def reschedule_alarm_jobs
+      # Perform the reschedule of all the current alarms.
+      new_alarm_jobs = alarms.each_with_object({}) do |alarm, memo|
+        memo.merge!(reschedule_alarm_job(alarm))
+      end
+
+      # Detect the differences from the original alarm_jobs hash to the new
+      # built (by partials) alarm_jobs hash. The jobs from negative differences
+      # must be canceled.
+      diff = HashDiff.diff(alarm_jobs, new_alarm_jobs)
+
+      diff.select { |prop| prop.first == '-' }.each do |prop|
+        alarm_job.cancel(prop.last)
+      end
+
+      # Update the alarm_jobs reference pool with our fresh hash.  Bypass the
+      # regular validation and callbacks here, this is required to not stuck in
+      # endless create-update loops.
+      update_columns(alarm_jobs: new_alarm_jobs)
+    end
+    # rubocop:enable Rails/SkipsModelValidations
+
+    # Reschedule only on updates when the alarm settings are changed.
+    def alarms_update_callback
+      reschedule_alarm_jobs if alarms_changed?
+    end
+
+    # Cancel all alarm notification jobs on parent destroy.
+    def alarms_destroy_callback
+      alarm_jobs.each_value { |job_id| alarm_job.cancel(job_id) }
+    end
+  end
+  # rubocop:enable Metrics/BlockLength
+end

data/lib/alarmable/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Alarmable
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,229 @@
+--- !ruby/object:Gem::Specification
+name: alarmable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hermann Mayer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: activejob-cancel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: hashdiff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.7
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    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: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+description: This is a reusable alarm concern for Active Recordmodels. It adds support
+  for the automatic maintenanceof Active Job's which are scheduled for the givenalarms.
+email:
+- hermann.mayer@hausgold.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Appraisals
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- alarmable.gemspec
+- bin/console
+- bin/setup
+- doc/assets/logo.png
+- doc/assets/project.png
+- doc/assets/project.xcf
+- docker-compose.yml
+- gemfiles/rails_4.gemfile
+- gemfiles/rails_5.0.gemfile
+- gemfiles/rails_5.1.gemfile
+- gemfiles/rails_5.2.gemfile
+- lib/alarmable.rb
+- lib/alarmable/concern.rb
+- lib/alarmable/version.rb
+homepage: https://github.com/hausgold/alarmable
+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.6.14
+signing_key: 
+specification_version: 4
+summary: A reusable alarm extension to Active Record models
+test_files: []