alarmable 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6a03aef2beace3ad258301e0913b514d5b2adf3c6884c68d6fa948ab4d7b955
-  data.tar.gz: a43392e2e3524bbc1fa6d72ef38c87718db40131795915d955cc4b6e4e7f433a
+  metadata.gz: '079b8b2c656b50417dde03ebcccbb4d7b55dc249d90cee9974b1eed7f5089415'
+  data.tar.gz: 476c6acbe31bda140cf04b3840e7db36328ad57f05734a95f43a9683986ee180
 SHA512:
-  metadata.gz: da7fc0886f83b21bcae6aca9511e92f0ffaf1ead0772c1a7f6c8f0e5ed1e216ad9f43c89f1f16ea928460fa555f2b08785704a98ef1dd0f6a144508fd18cfc10
-  data.tar.gz: 7831985c4a56d674e6541b2187f301d6e02819f8278cb7d37508cbc7a101317f31ec1dcb060b117912ce04e24456322e87ebee2848e9e83073d5c6402e228530
+  metadata.gz: 540427e743f6a1fff246966b2ddb29c12a86de7f0e537d62bc8be3d0b6d8ac1c21830949577b238a3b509acaa2b26f886bc931fe41f550757381752840351e16
+  data.tar.gz: 1fd04a3f3effb30f4db9fd2d2b47d0bd00fcd0bbbfcf82cc6da0466c9b90b4d6853807f8b8fcd10e360b7ebbfe0e3551c9152db0dbaa488b1cae52b5e93c414f

data/.github/workflows/documentation.yml

@@ -0,0 +1,39 @@
+name: Build Documentation
+on:
+  repository_dispatch:
+    types: [documentation]
+
+concurrency:
+  group: 'docs'
+
+jobs:
+  docs:
+    name: Build gem documentation
+    runs-on: ubuntu-22.04
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install the correct Ruby version
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.5
+          bundler-cache: true
+          rubygems: '3.3.26'
+
+      - name: Prepare the virtual environment
+        uses: hausgold/actions/ci@master
+        with:
+          clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings: '${{ github.repository }}'
+          target: ci/gem-test
+
+      - name: Build gem documentation
+        run: make docs
+
+      - name: Upload the code coverage report
+        run: coverage
+
+      - name: Add this job to the commit status
+        run: commit-status '${{ job.status }}'
+        if: always()

data/.github/workflows/test.yml

@@ -0,0 +1,72 @@
+name: Test
+on:
+  push:
+    branches:
+      - '**'
+  schedule:
+    - cron: '0 0 * * MON'
+
+concurrency:
+  group: '${{ github.ref }}'
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: 'Test the gem (Ruby ${{ matrix.ruby }}, Rails ${{ matrix.rails }})'
+    runs-on: ubuntu-22.04
+    timeout-minutes: 5
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.5', '2.7']
+        rails: ['5.2']
+    env:
+      BUNDLE_GEMFILE: 'gemfiles/rails_${{ matrix.rails }}.gemfile'
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install the correct Ruby version
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+          rubygems: '3.3.26'
+
+      - name: Prepare the virtual environment
+        uses: hausgold/actions/ci@master
+        with:
+          clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings: '${{ github.repository }}'
+          target: ci/gem-test
+
+      - name: Setup mDNS
+        run: setup-mdns
+
+      - name: Start the dependent services
+        run: docker-compose up -d db
+
+      - name: Wait for database to be ready
+        run: await-tcp-open 'db.alarmable.local' '5432'
+
+      - name: Run the gem tests
+        run: make test
+
+      - name: Upload the code coverage report
+        run: coverage
+
+  trigger-docs:
+    name: Trigger the documentation upload
+    runs-on: ubuntu-22.04
+    timeout-minutes: 2
+    needs: test
+    if: github.ref == 'refs/heads/master'
+    steps:
+      - name: Prepare the virtual environment
+        uses: hausgold/actions/ci@master
+        with:
+          clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings: '${{ github.repository }}'
+          target: ci/noop
+
+      - name: Trigger the documentation upload
+        run: workflow documentation

data/.gitignore

@@ -3,7 +3,7 @@
 /Gemfile.lock
 /_yardoc/
 /coverage/
-/doc/
+/doc/api/
 /pkg/
 /spec/reports/
 /tmp/

data/.rspec

@@ -1,2 +1,3 @@
+--backtrace
+--force-color
 --format documentation
---color

data/.rubocop.yml

@@ -1,27 +1,83 @@
-require: rubocop-rspec
+require:
+  - rubocop-rspec
+  - rubocop-rails
 
 Rails:
   Enabled: true
 
-Documentation:
+Style/Documentation:
   Enabled: true
 
 AllCops:
+  NewCops: enable
+  SuggestExtensions: false
   DisplayCopNames: true
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.5
+  TargetRailsVersion: 5.2
+  Exclude:
+    - bin/**/*
+    - vendor/**/*
+    - build/**/*
+    - gemfiles/**/*
 
 Metrics/BlockLength:
   Exclude:
     - Rakefile
+    - '*.gemspec'
     - spec/**/*.rb
     - '**/*.rake'
+    - doc/**/*.rb
+
+# MFA is not yet enabled for our gems yet.
+Gemspec/RequireMFA:
+  Enabled: false
 
 # Document all the things.
 Style/DocumentationMethod:
   Enabled: true
   RequireForNonPublicMethods: true
 
+# It's a deliberate idiom in RSpec.
+# See: https://github.com/bbatsov/rubocop/issues/4222
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*"
+
 # Because +expect_any_instance_of().to have_received()+ is not
 # supported with the +with(hash_including)+ matchers
 RSpec/MessageSpies:
   EnforcedStyle: receive
+
+# We stay with the original Ruby Style Guide recommendation.
+Layout/LineLength:
+  Max: 80
+
+# Because nesting makes sense here to group the feature tests
+# more effective. This increases maintainability.
+RSpec/NestedGroups:
+  Max: 4
+
+# Disable regular Rails spec paths.
+RSpec/FilePath:
+  Enabled: false
+
+# Because we just implemented the ActiveRecord API.
+Rails/SkipsModelValidations:
+  Enabled: false
+
+# We do not have a full Rails application here.
+Rails/ApplicationRecord:
+  Enabled: false
+
+# We do not have a full Rails application here.
+Rails/ApplicationJob:
+  Enabled: false
+
+# Because +enqueued_jobs+ is a method not a memoized variable,
+# so when first evaluated it won't change.
+RSpec/ExpectChange:
+  Enabled: false
+
+# We highly depend on memoized helpers across the specs.
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false

data/.simplecov

@@ -1,3 +1,15 @@
+# frozen_string_literal: true
+
+require 'simplecov-html'
+require 'simplecov_json_formatter'
+
+SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new(
+  [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::JSONFormatter
+  ]
+)
+
 SimpleCov.start 'test_frameworks' do
   add_filter '/vendor/bundle/'
 end

data/.yardopts

@@ -0,0 +1,6 @@
+--output-dir=doc/api
+--plugin activesupport-concern
+--markup=rdoc
+-
+README.md
+lib/**/*.rb

data/Appraisals

@@ -1,23 +1,7 @@
-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
+# frozen_string_literal: true
 
 appraise 'rails-5.2' do
-  gem 'activejob', '5.2.0'
-  gem 'activerecord', '5.2.0'
-  gem 'activesupport', '5.2.0'
+  gem 'activejob', '~> 5.2.0'
+  gem 'activerecord', '~> 5.2.0'
+  gem 'activesupport', '~> 5.2.0'
 end

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+### 1.0.0
+
+* Bundler >= 2.3 is from now on required as minimal version (#4)
+* Dropped support for Ruby < 2.5 (#4)
+* Dropped support for Rails < 5.2 (#4)
+* Updated all development/runtime gems to their latest
+  Ruby 2.5 compatible version (#4)
+
+### 0.1.2
+
+* Migrated to Github Actions
+* Migrated to our own coverage reporting
+
 ### 0.1.1
 
 * Added test coverage reports

data/Dockerfile

@@ -0,0 +1,28 @@
+FROM hausgold/ruby:2.5
+MAINTAINER Hermann Mayer <hermann.mayer@hausgold.de>
+
+# Update system gem
+RUN gem update --system '3.3.26'
+
+# Install system packages and the latest bundler
+RUN apt-get update -yqqq && \
+  apt-get install -y \
+    build-essential locales sudo vim \
+    ca-certificates \
+    bash-completion inotify-tools && \
+  echo 'en_US.UTF-8 UTF-8' >> /etc/locale.gen && /usr/sbin/locale-gen && \
+  gem install bundler -v '~> 2.3.0' --no-document --no-prerelease
+
+# Add new web user
+RUN mkdir /app && \
+  adduser web --home /home/web --shell /bin/bash \
+    --disabled-password --gecos ""
+COPY config/docker/* /home/web/
+RUN chown web:web -R /app /home/web /usr/local/bundle && \
+  mkdir -p /home/web/.ssh
+
+# Set the root password and grant root access to web
+RUN echo 'root:root' | chpasswd
+RUN echo 'web ALL=(ALL) NOPASSWD: ALL' >> /etc/sudoers
+
+WORKDIR /app

data/Envfile

@@ -0,0 +1,3 @@
+LANG=en_US.UTF-8
+LANGUAGE=en_US.UTF-8
+LC_ALL=en_US.UTF-8

data/Guardfile

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+(directories %w[lib spec]).select do |d|
+  if Dir.exist?(d)
+    d
+  else
+    UI.warning("Directory #{d} does not exist")
+  end
+end
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# NOTE: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch('spec/spec_helper.rb') { 'spec' }
+  watch(%r{^lib/alarmable.rb}) { 'spec' }
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/alarmable/([^\\]+)\.rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+  watch(%r{^lib/alarmable/([^\\]+)/(.*)\.rb$}) do |m|
+    "spec/#{m[1]}/#{m[2]}_spec.rb"
+  end
+end

data/{LICENSE.txt → LICENSE}

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Hausgold
+Copyright (c) 2023 HAUSGOLD | talocasa GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Makefile

@@ -9,6 +9,7 @@ SHELL := bash
 # Environment switches
 MAKE_ENV ?= docker
 COMPOSE_RUN_SHELL_FLAGS ?= --rm
+BASH_RUN_SHELL_FLAGS ?=
 
 # Directories
 VENDOR_DIR ?= vendor/bundle
@@ -22,9 +23,13 @@ MKDIR ?= mkdir
 RM ?= rm
 
 # Container binaries
-BUNDLE ?= bundle
 APPRAISAL ?= appraisal
+BUNDLE ?= bundle
+GUARD ?= guard
 RAKE ?= rake
+RSPEC ?= rspec
+RUBOCOP ?= rubocop
+YARD ?= yard
 
 # Files
 GEMFILES ?= $(subst _,-,$(patsubst $(GEMFILES_DIR)/%.gemfile,%,\
@@ -37,8 +42,9 @@ 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)'
+		-e HOME=/home/web -e BUNDLE_APP_CONFIG=/app/.bundle \
+		-u `$(ID) -u` test \
+		bash $(BASH_RUN_SHELL_FLAGS) -c 'sleep 0.1; echo; $(1)'
 endef
 else ifeq ($(MAKE_ENV),baremetal)
 define run-shell
@@ -50,30 +56,67 @@ all:
 	# Alarmable
 	#
 	# install            Install the dependencies
-	# test               Run the whole test suite
+	# update             Update the local Gemset dependencies
 	# clean              Clean the dependencies
 	#
+	# test               Run the whole test suite
+	# test-style         Test the code styles
+	# watch              Watch for code changes and rerun the test suite
+	#
+	# docs               Generate the Ruby documentation of the library
+	# stats              Print the code statistics (library and test suite)
+	# notes              Print all the notes from the code
+	# release            Release a new Gem version (maintainers only)
+	#
 	# shell              Run an interactive shell on the container
 	# shell-irb          Run an interactive IRB shell on the container
 
+.interactive:
+	@$(eval BASH_RUN_SHELL_FLAGS = --login)
+
 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
+update:
+	# Install the dependencies
+	@$(MKDIR) -p $(VENDOR_DIR)
+	@$(call run-shell,$(BUNDLE) update)
+	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) update)
+
+watch: install .interactive
+	# Watch for code changes and rerun the test suite
+	@$(call run-shell,$(BUNDLE) exec $(GUARD))
+
+test: \
+	test-specs \
+	test-style
+
+test-specs:
 	# Run the whole test suite
-	@$(call run-shell,$(BUNDLE) exec $(RAKE))
+	@$(call run-shell,$(BUNDLE) exec $(RAKE) stats spec)
 
 $(TEST_GEMFILES): GEMFILE=$(@:test-%=%)
 $(TEST_GEMFILES):
 	# Run the whole test suite ($(GEMFILE))
-	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) $(GEMFILE) $(RAKE))
+	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) $(GEMFILE) $(RSPEC))
+
+test-style: \
+	test-style-ruby
+
+test-style-ruby:
+	# Run the static code analyzer (rubocop)
+	@$(call run-shell,$(BUNDLE) exec $(RUBOCOP) -a)
 
 clean:
 	# Clean the dependencies
 	@$(RM) -rf $(VENDOR_DIR)
+	@$(RM) -rf $(GEMFILES_DIR)/vendor
+	@$(RM) -rf $(GEMFILES_DIR)/*.lock
+	@$(RM) -rf .bundle .yardoc coverage pkg Gemfile.lock doc/api \
+		.rspec_status
 
 clean-containers:
 	# Clean running containers
@@ -81,16 +124,38 @@ ifeq ($(MAKE_ENV),docker)
 	@$(COMPOSE) down
 endif
 
-distclean: clean clean-containers
+clean-images:
+	# Clean build images
+
+ifeq ($(MAKE_ENV),docker)
+	@-$(DOCKER) images | $(GREP) $(shell basename "`pwd`") \
+		| $(AWK) '{ print $$3 }' \
+		| $(XARGS) -rn1 $(DOCKER) rmi -f
+endif
+
+distclean: clean clean-containers clean-images
 
-shell: install
+shell:
 	# Run an interactive shell on the container
 	@$(call run-shell,$(BASH) -i)
 
-shell-irb: install
+shell-irb:
 	# Run an interactive IRB shell on the container
 	@$(call run-shell,bin/console)
 
+docs:
+	# Build the API documentation
+	@$(call run-shell,$(BUNDLE) exec $(YARD) -q && \
+		$(BUNDLE) exec $(YARD) stats --list-undoc --compact)
+
+notes:
+	# Print the code statistics (library and test suite)
+	@$(call run-shell,$(BUNDLE) exec $(RAKE) notes)
+
+stats:
+	# Print all the notes from the code
+	@$(call run-shell,$(BUNDLE) exec $(RAKE) stats)
+
 release:
 	# Release a new gem version
 	@$(BUNDLE) exec $(RAKE) release

data/README.md

@@ -1,10 +1,10 @@
 ![Alarmable](doc/assets/project.svg)
 
-[![Build Status](https://travis-ci.com/hausgold/alarmable.svg?branch=master)](https://travis-ci.com/hausgold/alarmable)
+[![Continuous Integration](https://github.com/hausgold/alarmable/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/hausgold/alarmable/actions/workflows/test.yml)
 [![Gem Version](https://badge.fury.io/rb/alarmable.svg)](https://badge.fury.io/rb/alarmable)
-[![Maintainability](https://api.codeclimate.com/v1/badges/4181ffca902206ff7648/maintainability)](https://codeclimate.com/repos/5cac8b574719e676d50060ee/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/4181ffca902206ff7648/test_coverage)](https://codeclimate.com/repos/5cac8b574719e676d50060ee/test_coverage)
-[![API docs](https://img.shields.io/badge/docs-API-blue.svg)](https://www.rubydoc.info/gems/alarmable)
+[![Test Coverage](https://automate-api.hausgold.de/v1/coverage_reports/alarmable/coverage.svg)](https://knowledge.hausgold.de/coverage)
+[![Test Ratio](https://automate-api.hausgold.de/v1/coverage_reports/alarmable/ratio.svg)](https://knowledge.hausgold.de/coverage)
+[![API docs](https://automate-api.hausgold.de/v1/coverage_reports/alarmable/documentation.svg)](https://www.rubydoc.info/gems/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

data/Rakefile

@@ -2,7 +2,18 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'countless/rake_tasks'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+# Configure all code statistics directories
+Countless.configure do |config|
+  config.stats_base_directories = [
+    { name: 'Top-levels', dir: 'lib',
+      pattern: %r{/lib(/alarmable)?/[^/]+\.rb$} },
+    { name: 'Top-levels specs', test: true, dir: 'spec',
+      pattern: %r{/spec(/alarmable)?/[^/]+_spec\.rb$} }
+  ]
+end

data/alarmable.gemspec

@@ -1,41 +1,59 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $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.name = 'alarmable'
+  spec.version = Alarmable::VERSION
+  spec.authors = ['Hermann Mayer']
+  spec.email = ['hermann.mayer92@gmail.com']
 
-  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.license = 'MIT'
+  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'
+  base_uri = "https://github.com/hausgold/#{spec.name}"
+  spec.metadata = {
+    'homepage_uri' => base_uri,
+    'source_code_uri' => base_uri,
+    'changelog_uri' => "#{base_uri}/blob/master/CHANGELOG.md",
+    'bug_tracker_uri' => "#{base_uri}/issues",
+    'documentation_uri' => "https://www.rubydoc.info/gems/#{spec.name}"
+  }
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  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.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activejob', '>=3', '<6'
+  spec.required_ruby_version = '>= 2.5'
+
+  spec.add_dependency 'activejob', '>= 5.2'
   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.16', '< 3'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'pg', '~> 0.18'
-  spec.add_development_dependency 'simplecov', '~> 0.15'
+  spec.add_dependency 'activerecord', '>= 5.2'
+  spec.add_dependency 'activesupport', '>= 5.2'
+  spec.add_dependency 'hashdiff', '~> 1.0'
+
+  spec.add_development_dependency 'appraisal', '~> 2.4'
+  spec.add_development_dependency 'bundler', '~> 2.3'
+  spec.add_development_dependency 'countless', '~> 1.1'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'pg', '~> 1.4'
+  spec.add_development_dependency 'railties', '>= 5.2'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.12'
+  spec.add_development_dependency 'rubocop', '~> 1.28'
+  spec.add_development_dependency 'rubocop-rails', '~> 2.14'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.10'
+  spec.add_development_dependency 'simplecov', '>= 0.22'
+  spec.add_development_dependency 'yard', '>= 0.9.28'
+  spec.add_development_dependency 'yard-activesupport-concern', '>= 0.0.1'
 end

data/config/docker/.bash_profile

@@ -0,0 +1,3 @@
+if [ -f ~/.bashrc ]; then
+  . ~/.bashrc
+fi

data/config/docker/.bashrc

@@ -0,0 +1,48 @@
+# ~/.bashrc: executed by bash(1) for non-login shells.
+# see /usr/share/doc/bash/examples/startup-files (in the package bash-doc)
+# for examples
+
+_GEM_PATHS=$(ls -d1 ${HOME}/.gem/ruby/*/bin 2>/dev/null | paste -sd ':')
+_APP_PATHS=$(ls -d1 /app/vendor/bundle/ruby/*/bin 2>/dev/null | paste -sd ':')
+
+export PATH="${_GEM_PATHS}:${_APP_PATHS}:${PATH}"
+export PATH="/app/node_modules/.bin:${HOME}/.bin:/app/bin:${PATH}"
+export MAKE_ENV=baremetal
+
+# Disable the autostart of all supervisord units
+sudo sed -i 's/autostart=.*/autostart=false/g' /etc/supervisor/conf.d/*
+
+# Start the supervisord (empty, no units)
+sudo supervisord >/dev/null 2>&1 &
+
+# Wait for supervisord
+while ! supervisorctl status >/dev/null 2>&1; do sleep 1; done
+
+# Boot the mDNS stack
+echo '# Start the mDNS stack'
+sudo supervisorctl start dbus avahi
+echo
+
+function watch-make-test()
+{
+  while [ 1 ]; do
+    inotifywait --quiet -r `pwd` -e close_write --format '%e -> %w%f'
+    make test
+  done
+}
+
+function watch-make()
+{
+  while [ 1 ]; do
+    inotifywait --quiet -r `pwd` -e close_write --format '%e -> %w%f'
+    make $@
+  done
+}
+
+function watch-run()
+{
+  while [ 1 ]; do
+    inotifywait --quiet -r `pwd` -e close_write --format '%e -> %w%f'
+    bash -c "$@"
+  done
+}

data/config/docker/.inputrc

@@ -0,0 +1,17 @@
+# mappings for Ctrl-left-arrow and Ctrl-right-arrow for word moving
+"\e[1;5C": forward-word
+"\e[1;5D": backward-word
+"\e[5C": forward-word
+"\e[5D": backward-word
+"\e\e[C": forward-word
+"\e\e[D": backward-word
+
+# handle common Home/End escape codes
+"\e[1~": beginning-of-line
+"\e[4~": end-of-line
+"\e[7~": beginning-of-line
+"\e[8~": end-of-line
+"\eOH": beginning-of-line
+"\eOF": end-of-line
+"\e[H": beginning-of-line
+"\e[F": end-of-line

data/docker-compose.yml

@@ -1,7 +1,7 @@
 version: "3"
 services:
   db:
-    image: postgres:9.6
+    image: hausgold/postgres:14.4
     network_mode: bridge
     ports: ["5432"]
     volumes:
@@ -10,9 +10,11 @@ services:
       POSTGRES_USER: postgres
       POSTGRES_PASSWORD: postgres
       POSTGRES_DB: alarmable
+      MDNS_HOSTNAME: db.alarmable.local
 
   test:
-    image: ruby:2.3
+    build: .
+    env_file: Envfile
     network_mode: bridge
     working_dir: /app
     volumes:

data/gemfiles/rails_5.2.gemfile

@@ -2,8 +2,8 @@
 
 source "https://rubygems.org"
 
-gem "activejob", "5.2.0"
-gem "activerecord", "5.2.0"
-gem "activesupport", "5.2.0"
+gem "activejob", "~> 5.2.0"
+gem "activerecord", "~> 5.2.0"
+gem "activesupport", "~> 5.2.0"
 
 gemspec path: "../"

data/lib/alarmable/concern.rb

@@ -160,14 +160,13 @@ module Alarmable
       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]
+      { 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.
@@ -178,7 +177,7 @@ module Alarmable
       # 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 = Hashdiff.diff(alarm_jobs, new_alarm_jobs)
 
       diff.select { |prop| prop.first == '-' }.each do |prop|
         alarm_job.cancel(prop.last)
@@ -189,7 +188,6 @@ module Alarmable
       # 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

data/lib/alarmable/version.rb

@@ -1,5 +1,23 @@
 # frozen_string_literal: true
 
+# The gem version details.
 module Alarmable
-  VERSION = '0.1.1'
+  # The version of the +alarmable+ gem
+  VERSION = '1.0.0'
+
+  class << self
+    # Returns the version of gem as a string.
+    #
+    # @return [String] the gem version as string
+    def version
+      VERSION
+    end
+
+    # Returns the version of the gem as a +Gem::Version+.
+    #
+    # @return [Gem::Version] the gem version as object
+    def gem_version
+      Gem::Version.new VERSION
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alarmable
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Hermann Mayer
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-12 00:00:00.000000000 Z
+date: 2023-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -16,20 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: activejob-cancel
   requirement: !ruby/object:Gem::Requirement
@@ -50,182 +44,286 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: hashdiff
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.7
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.7
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: countless
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
-    - - "<"
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
-    - - "<"
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '1.28'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '1.28'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '2.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.28
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.28
+- !ruby/object:Gem::Dependency
+  name: yard-activesupport-concern
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.1
 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
+- hermann.mayer92@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/documentation.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".simplecov"
-- ".travis.yml"
+- ".yardopts"
 - Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- Dockerfile
+- Envfile
 - Gemfile
-- LICENSE.txt
+- Guardfile
+- LICENSE
 - Makefile
 - README.md
 - Rakefile
 - alarmable.gemspec
 - bin/console
 - bin/setup
+- config/docker/.bash_profile
+- config/docker/.bashrc
+- config/docker/.inputrc
 - doc/assets/project.svg
 - 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
+homepage:
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/hausgold/alarmable
+  source_code_uri: https://github.com/hausgold/alarmable
+  changelog_uri: https://github.com/hausgold/alarmable/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/hausgold/alarmable/issues
+  documentation_uri: https://www.rubydoc.info/gems/alarmable
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -234,14 +332,14 @@ 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: []
-rubygems_version: 3.2.16
+rubygems_version: 3.3.8
 signing_key:
 specification_version: 4
 summary: A reusable alarm extension to Active Record models

data/.travis.yml

@@ -1,36 +0,0 @@
-sudo: false
-
-env:
-  global:
-    - CC_TEST_REPORTER_ID=31e005b4d2d190f26dcb055d5ac3a9ccfd492da2c335e5abfafbd438488f8b08
-
-addons:
-  postgresql: "9.6"
-
-services:
-  - postgresql
-
-language: ruby
-rvm:
-  - 2.6
-  - 2.5
-  - 2.4
-  - 2.3
-
-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
-
-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
-script: bundle exec rake
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/gemfiles/rails_4.gemfile

@@ -1,9 +0,0 @@
-# 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

@@ -1,9 +0,0 @@
-# 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

@@ -1,9 +0,0 @@
-# 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: "../"