foreman_expire_hosts 8.1.0 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74607c8b578a2549b16b8858c186dec33519fbec2f21c946e30d3b01b8c8ee13
-  data.tar.gz: d07c8068f7a85eb297d95c461abf65c1951409ba483c6bc5329c8abee318def5
+  metadata.gz: 278bb558393256952a91c75901f1776bdab5314e43d9b10218ed06f1ac765fc9
+  data.tar.gz: b80fd1acc8b31a12b8be1f2464dd67633364db992a1dd414d06e0d792ede6f57
 SHA512:
-  metadata.gz: 2c214dc0b884be13b4195ef443079db7a524839279aee288addace26dbd61e3d170e984f3468377dfba59cb89bb8521f4c18fa8667ad133bbb6b364e4514f1ab
-  data.tar.gz: 1e68621e1fb15baa5a94d40f080daecc55ad2fcbec4aedfd97b70fc5ec750c3198a3ff4e227743fe03e5cb95c603189dee628de2b265da8cb4d8ac7627643b07
+  metadata.gz: 10c0283b3ecc5974c9faed866002002eef7c2ace0caf6549f0c311161e869bae7bb76f2d99fd8b068a6c8093186981e529feade1ffe3218028faf949b10bc950
+  data.tar.gz: 5251612576cb29e79686379c33029b9594521d89d0fa513912fa9c41361a619d5095c1a08bbdda4adc56104b7731f68d29833109154f72860d626b6fe576cf98

data/README.md

@@ -20,6 +20,7 @@ This plugin will send two warning notifications before host expiry (see Settings
 | >= 1.18         | ~> 6.0         |
 | >= 1.24         | ~> 7.0         |
 | >= 3.0          | ~> 8.0         |
+| >= 3.13         | ~> 9.0         |
 
 # Screenshots
 ![Expiry date field in host form](https://raw.githubusercontent.com/ingenico-group/screenshots/master/foreman_host_expiry/expiry-date-field-in-host-form.png)

data/app/helpers/foreman_expire_hosts/hosts_helper.rb

@@ -12,5 +12,24 @@ module ForemanExpireHosts
       end
       actions
     end
+
+    def host_expiry_warning_message(host)
+      return nil unless host.expires?
+
+      if host.expired_past_grace_period?
+        message = _('This host has expired %s ago and needs to be deleted manually.') % time_ago_in_words(host.expired_on)
+      elsif host.expired?
+        message = _('This host has expired %{time_ago} ago and will be deleted on %{delete_date}.') % { :delete_date => l(host.expiration_grace_period_end_date), :time_ago => time_ago_in_words(host.expired_on) }
+      elsif host.expires_today?
+        message = _('This host will expire today.')
+      elsif host.pending_expiration?
+        message = _('This host will expire in %{distance_of_time} (on %{expire_date}).') % { :expire_date => l(host.expired_on), :distance_of_time => future_time_in_words(host.expired_on) }
+      end
+      message
+    end
+
+    def future_time_in_words(to_time, options = {})
+      distance_of_time_in_words(to_time, Time.current, options)
+    end
   end
 end

data/{lib → app/lib}/expire_hosts_notifications.rb

@@ -10,11 +10,12 @@ module ExpireHostsNotifications
       ForemanExpireHosts::Action::StopExpiredHosts.new.engage
     end
 
-    def deliver_expiry_warning_notification(num = 1) # notify1_days_before_expiry
+    # notify1_days_before_expiry
+    def deliver_expiry_warning_notification(num = 1)
       return unless [1, 2].include?(num)
 
       days_before_expiry = Setting["notify#{num}_days_before_host_expiry"].to_i
-      expiry_date        = (Date.today + days_before_expiry)
+      expiry_date        = (Time.zone.today + days_before_expiry)
       notifiable_hosts   = Host.with_expire_date(expiry_date).preload(:owner)
 
       ForemanExpireHosts::Notification::ExpiryWarning.new(

data/app/models/concerns/foreman_expire_hosts/host_ext.rb

@@ -55,20 +55,20 @@ module ForemanExpireHosts
     def expiration_grace_period_end_date
       return nil unless expires?
 
-      expired_on.to_date + Setting[:days_to_delete_after_host_expiration].to_i
+      expired_on.to_date + Setting[:days_to_delete_after_host_expiration].to_i.days
     end
 
     def expired_past_grace_period?
       return false unless expires?
 
-      expiration_grace_period_end_date <= Date.today
+      expiration_grace_period_end_date.to_date <= Date.today
     end
 
     def pending_expiration?
       return false unless expires?
       return false if expired?
 
-      expired_on - Setting['notify1_days_before_host_expiry'].to_i <= Date.today
+      expired_on.to_date - Setting['notify1_days_before_host_expiry'].to_i.days <= Date.today
     end
 
     def can_modify_expiry_date?

data/lib/foreman_expire_hosts/engine.rb

@@ -6,12 +6,6 @@ module ForemanExpireHosts
   class Engine < ::Rails::Engine
     engine_name 'foreman_expire_hosts'
 
-    config.autoload_paths += Dir["#{config.root}/lib"]
-    config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
-    config.autoload_paths += Dir["#{config.root}/app/controllers/concerns"]
-    config.autoload_paths += Dir["#{config.root}/app/helpers/concerns"]
-    config.autoload_paths += Dir["#{config.root}/app/services"]
-
     # Add any db migrations
     initializer 'foreman_plugin_template.load_app_instance_data' do |app|
       ForemanExpireHosts::Engine.paths['db/migrate'].existent.each do |path|
@@ -19,67 +13,69 @@ module ForemanExpireHosts
       end
     end
 
-    initializer 'foreman_expire_hosts.register_plugin', :before => :finisher_hook do |_app|
-      Foreman::Plugin.register :foreman_expire_hosts do
-        requires_foreman '>= 3.0.0'
-        register_custom_status HostStatus::ExpirationStatus
+    initializer 'foreman_expire_hosts.register_plugin', :before => :finisher_hook do |app|
+      app.reloader.to_prepare do
+        Foreman::Plugin.register :foreman_expire_hosts do
+          requires_foreman '>= 3.13.0'
+          register_custom_status HostStatus::ExpirationStatus
 
-        # strong parameters
-        parameter_filter Host::Managed, :expired_on
+          # strong parameters
+          parameter_filter Host::Managed, :expired_on
 
-        security_block :foreman_expire_hosts do
-          permission :edit_host_expiry,
-                     {},
-                     :resource_type => 'Host'
-        end
+          security_block :foreman_expire_hosts do
+            permission :edit_host_expiry,
+                       {},
+                       :resource_type => 'Host'
+          end
 
-        # Extend built in permissions
-        Foreman::AccessControl.permission(:edit_hosts).actions.concat [
-          'hosts/select_multiple_expiration',
-          'hosts/update_multiple_expiration'
-        ]
+          # Extend built in permissions
+          Foreman::AccessControl.permission(:edit_hosts).actions.concat [
+            'hosts/select_multiple_expiration',
+            'hosts/update_multiple_expiration'
+          ]
 
-        Setting::BLANK_ATTRS << 'host_expiry_email_recipients'
+          Setting::BLANK_ATTRS << 'host_expiry_email_recipients'
 
-        settings do
-          category(:expire_hosts, N_('Expire Hosts')) do
-            setting('is_host_expiry_date_mandatory',
-                    type: :boolean,
-                    description: N_('Make expiry date field mandatory on host creation/update'),
-                    default: false,
-                    full_name: N_('Require host expiry date'))
-            setting('can_owner_modify_host_expiry_date',
-                    type: :boolean,
-                    description: N_('Allow host owner to modify host expiry date field. If the field is false then admin only can edit expiry field'),
-                    default: false,
-                    full_name: N_('Host owner can modify host expiry date'))
-            setting('notify1_days_before_host_expiry',
-                    type: :integer,
-                    description: N_('Send first notification to owner of hosts about his hosts expiring in given days. Must be integer only'),
-                    default: 7,
-                    full_name: N_('First expiry notification'))
-            setting('notify2_days_before_host_expiry',
-                    type: :integer,
-                    description: N_('Send second notification to owner of hosts about his hosts expiring in given days. Must be integer only'),
-                    default: 1,
-                    full_name: N_('Second expiry notification'))
-            setting('days_to_delete_after_host_expiration',
-                    type: :integer,
-                    description: N_('Delete expired hosts after given days of hosts expiry date. Must be integer only'),
-                    default: 3,
-                    full_name: N_('Expiry grace period in days'))
-            setting('host_expiry_email_recipients',
-                    type: :string,
-                    description: N_('All notifications will be delivered to its owner. If any other users/admins need to receive those expiry warning notifications then those emails can be configured comma separated here.'),
-                    default: nil,
-                    full_name: N_('Expiry e-mail recipients'))
+          settings do
+            category(:expire_hosts, N_('Expire Hosts')) do
+              setting('is_host_expiry_date_mandatory',
+                      type: :boolean,
+                      description: N_('Make expiry date field mandatory on host creation/update'),
+                      default: false,
+                      full_name: N_('Require host expiry date'))
+              setting('can_owner_modify_host_expiry_date',
+                      type: :boolean,
+                      description: N_('Allow host owner to modify host expiry date field. If the field is false then admin only can edit expiry field'),
+                      default: false,
+                      full_name: N_('Host owner can modify host expiry date'))
+              setting('notify1_days_before_host_expiry',
+                      type: :integer,
+                      description: N_('Send first notification to owner of hosts about his hosts expiring in given days. Must be integer only'),
+                      default: 7,
+                      full_name: N_('First expiry notification'))
+              setting('notify2_days_before_host_expiry',
+                      type: :integer,
+                      description: N_('Send second notification to owner of hosts about his hosts expiring in given days. Must be integer only'),
+                      default: 1,
+                      full_name: N_('Second expiry notification'))
+              setting('days_to_delete_after_host_expiration',
+                      type: :integer,
+                      description: N_('Delete expired hosts after given days of hosts expiry date. Must be integer only'),
+                      default: 3,
+                      full_name: N_('Expiry grace period in days'))
+              setting('host_expiry_email_recipients',
+                      type: :string,
+                      description: N_('All notifications will be delivered to its owner. If any other users/admins need to receive those expiry warning notifications then those emails can be configured comma separated here.'), # rubocop:disable Layout/LineLength
+                      default: nil,
+                      full_name: N_('Expiry e-mail recipients'))
+            end
           end
-        end
 
-        extend_rabl_template 'api/v2/hosts/main', 'api/v2/hosts/expiration'
+          extend_rabl_template 'api/v2/hosts/main', 'api/v2/hosts/expiration'
 
-        describe_host do
-          multiple_actions_provider :expire_hosts_host_multiple_actions
+          describe_host do
+            multiple_actions_provider :expire_hosts_host_multiple_actions
+          end
         end
       end
     end
@@ -87,7 +83,6 @@ module ForemanExpireHosts
     config.to_prepare do
       begin
         ::Host::Managed.include ForemanExpireHosts::HostExt
-        ::HostsHelper.include ForemanExpireHosts::HostsHelperExtensions
         ::HostsController.prepend ForemanExpireHosts::HostControllerExtensions
         ::AuditsHelper.include ForemanExpireHosts::AuditsHelperExtensions
         ::Api::V2::HostsController.include ForemanExpireHosts::Api::V2::HostsControllerExtensions

data/lib/foreman_expire_hosts/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ForemanExpireHosts
-  VERSION = '8.1.0'
+  VERSION = '9.0.0'
 end

data/test/helpers/hosts_helper_test.rb

@@ -5,7 +5,11 @@ require 'test_plugin_helper'
 class HostsHelperTest < ActionView::TestCase
   include HostsHelper
   include HostDescriptionHelper
-  include PuppetRelatedHelper
+  # Foreman 3.7 dropped this via
+  # https://github.com/theforeman/foreman/commit/6cdb8c7a9ebd790537510213e43537a4a87189d6
+  # Foreman 3.9 bought it back via
+  # https://github.com/theforeman/foreman/commit/37a99c70ebd9e4d6f03af546dfe36e7678e2bcf3
+  include PuppetRelatedHelper if defined?(PuppetRelatedHelper)
   include ForemanExpireHosts::HostsHelper
   include ApplicationHelper
 

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foreman_expire_hosts
 version: !ruby/object:Gem::Version
-  version: 8.1.0
+  version: 9.0.0
 platform: ruby
 authors:
 - Nagarjuna Rachaneni
 - Timo Goebel
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-06 00:00:00.000000000 Z
+date: 2025-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -54,9 +53,9 @@ files:
 - app/controllers/concerns/foreman_expire_hosts/api/v2/hosts_controller_extensions.rb
 - app/controllers/concerns/foreman_expire_hosts/host_controller_extensions.rb
 - app/helpers/concerns/foreman_expire_hosts/audits_helper_extensions.rb
-- app/helpers/concerns/foreman_expire_hosts/hosts_helper_extensions.rb
 - app/helpers/expire_hosts_mailer_helper.rb
 - app/helpers/foreman_expire_hosts/hosts_helper.rb
+- app/lib/expire_hosts_notifications.rb
 - app/mailers/expire_hosts_mailer.rb
 - app/models/concerns/foreman_expire_hosts/host_ext.rb
 - app/models/host_status/expiration_status.rb
@@ -93,7 +92,6 @@ files:
 - db/migrate/20230112104438_change_expired_on_type.rb
 - db/seeds.d/80_expire_hosts_ui_notification.rb
 - extra/foreman_expire_hosts.cron
-- lib/expire_hosts_notifications.rb
 - lib/foreman_expire_hosts.rb
 - lib/foreman_expire_hosts/engine.rb
 - lib/foreman_expire_hosts/version.rb
@@ -113,7 +111,6 @@ homepage: https://github.com/theforeman/foreman_expire_hosts
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -128,8 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Foreman plugin for limiting host lifetime
 test_files:

data/app/helpers/concerns/foreman_expire_hosts/hosts_helper_extensions.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module ForemanExpireHosts
-  module HostsHelperExtensions
-    extend ActiveSupport::Concern
-
-    def host_expiry_warning_message(host)
-      return nil unless host.expires?
-
-      if host.expired_past_grace_period?
-        message = _('This host has expired %s ago and needs to be deleted manually.') % time_ago_in_words(host.expired_on)
-      elsif host.expired?
-        message = _('This host has expired %{time_ago} ago and will be deleted on %{delete_date}.') % { :delete_date => l(host.expiration_grace_period_end_date), :time_ago => time_ago_in_words(host.expired_on) }
-      elsif host.expires_today?
-        message = _('This host will expire today.')
-      elsif host.pending_expiration?
-        message = _('This host will expire in %{distance_of_time} (on %{expire_date}).') % { :expire_date => l(host.expired_on), :distance_of_time => future_time_in_words(host.expired_on) }
-      end
-      message
-    end
-
-    def future_time_in_words(to_time, options = {})
-      distance_of_time_in_words(to_time, Time.current, options)
-    end
-  end
-end