decidim-cleaner 3.1.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dda43559128f10de066d98d4ffc56eb53c6b46e3a49d4d49373cf62e054fcb3
-  data.tar.gz: a22f580ae6fde675ca5c572005b224ac17d9546c861b343432ee919e67400420
+  metadata.gz: ac1fce1219b0b742c8b61a04692d5347c52143dbfdf68ad79bc7c482828327b9
+  data.tar.gz: 6d2f34f4cefa57d317ac26b025ddf74a86de35f59d0cd036c825644ffc7bdad7
 SHA512:
-  metadata.gz: 746f6a5f4048779b2fa841a8911c7d8596c5a1c6363472f3bb0ede9b648d555f09d3069f22ee1fad1c514aef8409a5cf86447a7f25b6ab6684843dd9cf6b82c1
-  data.tar.gz: 6a1fd5e673054d0ffad860b6bb1441c4d5a91986bff9f2611d7d45d24d0df0e8b1d68db0ca0024774e322f4e7fb7a1da35351e9cb4e07742a900d812c2264656
+  metadata.gz: ea06df0a3a5e974bb1d2ed5ddc9ec871a123b1bbedf7a1e096b4d5f18339c90123c0b6ded17e5320687277d711215c01d7db4cd488e86bd8956b4c1b1685c412
+  data.tar.gz: 6d286d5dae2c41de0a6f7e8d12c031c3b45c6a00bc25907e27c60e294b3dc23a32c4e29f24eab57dfb339f9ad667d856b444b6ecfafac008c59ed4177ef26547

data/README.md

@@ -22,19 +22,6 @@ bundle exec rails decidim_cleaner:install:migrations
 bundle exec rails db:migrate
 ```
 
-You can then modify the default values of the cleaner in your .ENV with the following variables:
-
-```bash
-# Delay until a user is considered inactive and receive a warning email (in days)
-DECIDIM_CLEANER_INACTIVE_USERS_MAIL=
-
-# Delay until a user is deleted after receiving an email (in days)
-DECIDIM_CLEANER_DELETE_INACTIVE_USERS=
-
-# Delay until an admin log is deleted (in days)
-DECIDIM_CLEANER_DELETE_ADMIN_LOGS=
-```
-
 ### Sidekiq Scheduler
 [Further documentation](https://github.com/sidekiq-scheduler/sidekiq-scheduler)
 

data/app/jobs/decidim/cleaner/clean_admin_logs_job.rb

@@ -9,17 +9,11 @@ module Decidim
         Decidim::Organization.find_each do |organization|
           next unless organization.delete_admin_logs?
 
-          Decidim::ActionLog.where(organization: organization)
-                            .where("created_at < ?", delete_admin_logs_before_date(organization))
+          Decidim::ActionLog.where(organization:)
+                            .where("created_at < ?", Time.zone.now - (organization.delete_admin_logs_after || 365).days)
                             .delete_all
         end
       end
-
-      private
-
-      def delete_admin_logs_before_date(organization)
-        Time.zone.now - (organization.delete_admin_logs_after || Decidim::Cleaner.delete_admin_logs_after).days
-      end
     end
   end
 end

data/app/jobs/decidim/cleaner/clean_inactive_users_job.rb

@@ -9,34 +9,28 @@ module Decidim
         Decidim::Organization.find_each do |organization|
           next unless organization.delete_inactive_users?
 
-          send_warning(Decidim::User.where(organization: organization)
+          send_warning(Decidim::User.where(organization:)
                                     .not_deleted
                                     .where.not(email: "")
-                                    .where("last_sign_in_at < ?", email_inactive_before_date(organization)))
-          delete_user_and_send_email(Decidim::User.where(organization: organization)
+                                    .where("last_sign_in_at < ?", Time.zone.now - (organization.delete_inactive_users_email_after || 365).days)
+                                    .where("last_sign_in_at > ?", Time.zone.now - (organization.delete_inactive_users_email_after || 365).days - 1.day))
+
+          delete_user_and_send_email(Decidim::User.where(organization:)
                                                   .not_deleted
                                                   .where.not(email: "")
-                                                  .where("warning_date < ?", delete_inactive_before_date(organization)))
+                                                  .where("last_sign_in_at < ?", Time.zone.now - (organization.delete_inactive_users_after || 390).days))
         end
       end
 
       def send_warning(users)
         users.find_each do |user|
-          next if user.warning_date.present?
-
-          user.update!(warning_date: Time.zone.now) if InactiveUsersMailer.warning_inactive(user).deliver_now
+          InactiveUsersMailer.warning_inactive(user).deliver_now
           Rails.logger.info "Inactive warning sent to #{user.email}"
         end
       end
 
       def delete_user_and_send_email(users)
         users.find_each do |user|
-          if user.last_sign_in_at > user.warning_date
-            user.update!(warning_date: nil)
-            Rails.logger.info "User with id #{user.id} has logged in again, warning date reset"
-            next
-          end
-
           InactiveUsersMailer.warning_deletion(user).deliver_now
           Rails.logger.info "Deletion warning sent to #{user.email}"
 
@@ -44,16 +38,6 @@ module Decidim
           Rails.logger.info "User with id #{user.id} destroyed"
         end
       end
-
-      private
-
-      def email_inactive_before_date(organization)
-        Time.zone.now - (organization.delete_inactive_users_email_after || Decidim::Cleaner.delete_inactive_users_email_after).days
-      end
-
-      def delete_inactive_before_date(organization)
-        Time.zone.now - (organization.delete_inactive_users_after || Decidim::Cleaner.delete_inactive_users_after).days
-      end
     end
   end
 end

data/app/mailers/decidim/cleaner/inactive_users_mailer.rb

@@ -5,7 +5,6 @@ module Decidim
     # A custom mailer for Decidim so we can notify users
     # when their account was blocked
     class InactiveUsersMailer < Decidim::ApplicationMailer
-      helper Decidim::Cleaner::DelaysHelper
       def warning_inactive(user)
         with_user(user) do
           @user = user
@@ -14,7 +13,7 @@ module Decidim
             "decidim.cleaner.inactive_users_mailer.warning_inactive.subject",
             organization_name: @organization.name
           )
-          mail(to: user.email, subject: subject)
+          mail(to: user.email, subject:)
         end
       end
 
@@ -26,7 +25,7 @@ module Decidim
             "decidim.cleaner.inactive_users_mailer.warning_deletion.subject",
             organization_name: @organization.name
           )
-          mail(to: user.email, subject: subject)
+          mail(to: user.email, subject:)
         end
       end
     end

data/app/views/decidim/cleaner/inactive_users_mailer/warning_deletion.html.erb

@@ -1,6 +1,6 @@
 <p class="email-greeting"><%= t ".hello" %></p>
 
-<p class="email-instructions"><%= t(".body_1", organization_name: h(@organization.name), organization_url: decidim.root_url(host: @organization.host), days: email_inactive_after(@organization) + delete_inactive_after(@organization)).html_safe %></p>
+<p class="email-instructions"><%= t(".body_1", organization_name: h(@organization.name), organization_url: decidim.root_url(host: @organization.host), days: @organization.delete_inactive_users_after||390).html_safe %></p>
 
 <p class="email-instructions"><%= t ".body_2" %></p>
 

data/app/views/decidim/cleaner/inactive_users_mailer/warning_inactive.html.erb

@@ -1,7 +1,7 @@
 <p class="email-greeting"><%= t ".hello" %></p>
 
-<p class="email-instructions"><%= t ".body_1", organization_name: h(@organization.name), days: email_inactive_after(@organization) %></p>
+<p class="email-instructions"><%= t ".body_1", organization_name: h(@organization.name), days: @organization.delete_inactive_users_email_after %></p>
 
-<p class="email-instructions"><%= t(".body_2", remaining_days: delete_inactive_after(@organization), organization_url: decidim.root_url(host: @organization.host)).html_safe %></p>
+<p class="email-instructions"><%= t(".body_2", remaining_days: (@organization.delete_inactive_users_after||390) - (@organization.delete_inactive_users_email_after||365), organization_url: decidim.root_url(host: @organization.host)).html_safe %></p>
 
 <p class="email-closing"><%= t(".greetings", organization_name: h(@organization.name), organization_url: decidim.root_url(host: @organization.host)).html_safe %></p>

data/config/locales/en.yml

@@ -6,8 +6,7 @@ en:
         delete_admin_logs: Enable admin logs deletion
         delete_admin_logs_after: Delete admin logs after (days, default 365)
         delete_inactive_users: Enable inactive users deletion
-        delete_inactive_users_after: Delete inactive users x days after the mail(days,
-          default 30)
+        delete_inactive_users_after: Delete inactive users after (days, default 390)
         delete_inactive_users_email_after: Send email to inactive users before deletion
           (days, default 365)
   decidim:

data/config/locales/fr.yml

@@ -7,8 +7,8 @@ fr:
         delete_admin_logs_after: Supprimer l'historique d'administration après (jours,
           par défaut 365)
         delete_inactive_users: Activer la suppression des utilisateurs inactifs
-        delete_inactive_users_after: Supprimer les utilisateurs inactifs au bout de
-          x jours après le courriel (jours, par défaut 30)
+        delete_inactive_users_after: Supprimer les utilisateurs inactifs après (jours,
+          par défaut 390)
         delete_inactive_users_email_after: Envoyer un courriel aux utilisateurs inactifs
           avant la suppression (jours, par défaut 365)
   decidim:

data/lib/decidim/cleaner/version.rb

@@ -5,11 +5,11 @@ module Decidim
   # This holds the decidim-meetings version.
   module Cleaner
     def self.version
-      "3.1.0"
+      "4.0.0"
     end
 
     def self.compatible_decidim_version
-      "0.27.0"
+      "0.28.dev"
     end
   end
 end

data/lib/decidim/cleaner.rb

@@ -7,18 +7,5 @@ require "decidim/cleaner/admin_engine"
 module Decidim
   # This namespace holds the logic of the `Cleaner` module.
   module Cleaner
-    include ActiveSupport::Configurable
-
-    config_accessor :delete_admin_logs_after do
-      ENV.fetch("DECIDIM_CLEANER_DELETE_ADMIN_LOGS", "365").to_i
-    end
-
-    config_accessor :delete_inactive_users_after do
-      ENV.fetch("DECIDIM_CLEANER_DELETE_INACTIVE_USERS", "30").to_i
-    end
-
-    config_accessor :delete_inactive_users_email_after do
-      ENV.fetch("DECIDIM_CLEANER_INACTIVE_USERS_MAIL", "365").to_i
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decidim-cleaner
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Quentinchampenois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-19 00:00:00.000000000 Z
+date: 2023-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decidim-core
@@ -16,42 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.27.0
+        version: 0.28.dev
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.27.0
-- !ruby/object:Gem::Dependency
-  name: decidim-dev
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.27.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.27.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-faker
-  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'
+        version: 0.28.dev
 description: Clean outdated data in Decidim's database.
 email:
 - 26109239+Quentinchampenois@users.noreply.github.com
@@ -66,7 +38,6 @@ files:
 - app/controllers/decidim/cleaner/admin/application_controller.rb
 - app/controllers/decidim/cleaner/admin/organization_cleaner_controller.rb
 - app/forms/decidim/cleaner/admin/organization_cleaner_form.rb
-- app/helpers/decidim/cleaner/delays_helper.rb
 - app/jobs/decidim/cleaner/clean_admin_logs_job.rb
 - app/jobs/decidim/cleaner/clean_inactive_users_job.rb
 - app/mailers/decidim/cleaner/inactive_users_mailer.rb
@@ -81,7 +52,6 @@ files:
 - config/routes.rb
 - db/migrate/20230106105014_add_delete_admin_logs_to_organization.rb
 - db/migrate/20230110150032_add_delete_inactive_users_to_organization.rb
-- db/migrate/20230328094652_add_warning_date_to_users.rb
 - lib/decidim/cleaner.rb
 - lib/decidim/cleaner/admin.rb
 - lib/decidim/cleaner/admin_engine.rb

data/app/helpers/decidim/cleaner/delays_helper.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Decidim
-  module Cleaner
-    module DelaysHelper
-      def email_inactive_after(organization)
-        organization.delete_inactive_users_email_after || Decidim::Cleaner.delete_inactive_users_email_after
-      end
-
-      def delete_inactive_after(organization)
-        organization.delete_inactive_users_after || Decidim::Cleaner.delete_inactive_users_after
-      end
-    end
-  end
-end

data/db/migrate/20230328094652_add_warning_date_to_users.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-class AddWarningDateToUsers < ActiveRecord::Migration[6.1]
-  def change
-    add_column :decidim_users, :warning_date, :datetime
-  end
-end