Amélioration des vérifications d'intégrité de migration (#3691)

* wip

* wip

* working

* yes!

* syntax

* dry

* fix

* .with_deleted

Author: arnaudlevy

app/controllers/api/osuny/application_controller.rb

@@ -15,10 +15,6 @@ def verify_app_token
     render_unauthorized unless @app
   end
 
-  def render_on_missing_migration_identifier
-    render json: { error: 'Missing migration identifier.' }, status: :bad_request
-  end
-
   # Set API messages to English
   def switch_locale(&action)
     I18n.with_locale(:en, &action)

app/controllers/api/osuny/communication/websites/agenda/categories_controller.rb

@@ -1,6 +1,6 @@
 class Api::Osuny::Communication::Websites::Agenda::CategoriesController < Api::Osuny::Communication::Websites::ApplicationController
-  before_action :build_category, only: :create
-  before_action :load_category, only: [:show, :update, :destroy]
+  include Api::Osuny::HasResource
+  include Api::Osuny::HasMigrationIdentifier
 
   def index
     @categories = paginate(website.agenda_categories.includes(:localizations))
@@ -10,6 +10,8 @@ def show
   end
 
   def create
+    @category = website.agenda_categories.build
+    @category.assign_attributes(category_params)
     if @category.save
       render :show, status: :created
     else
@@ -31,7 +33,7 @@ def upsert
       category_params[:migration_identifier].present?
     }
     unless every_category_has_migration_identifier
-      render_on_missing_migration_identifier
+      render_missing_migration_identifier
       return
     end
 
@@ -70,32 +72,14 @@ def destroy
 
   protected
 
-  def build_category
-    @category = website.agenda_categories.build
-    @category.assign_attributes(category_params)
+  def integrity_checker
+    @integrity_checker ||= Osuny::Api::MigrationIdentifierIntegrityChecker.new(@category, category_params, website.agenda_categories)
   end
 
-  def load_category
+  def load_resource
     @category = website.agenda_categories.find(params[:id])
   end
 
-  def load_migration_identifier
-    @migration_identifier = category_params[:migration_identifier]
-    render_on_missing_migration_identifier unless @migration_identifier.present?
-  end
-
-  def ensure_same_migration_identifier
-    if @category.migration_identifier != @migration_identifier
-      render json: { error: 'Migration identifier does not match' }, status: :unprocessable_content
-    end
-  end
-
-  def ensure_migration_identifier_is_available
-    if website.agenda_categories.where(migration_identifier: @migration_identifier).any?
-      render json: { error: 'Migration identifier already used' }, status: :unprocessable_content
-    end
-  end
-
   def l10n_permitted_keys
     [
       :migration_identifier, :language, :name, :meta_description,

app/controllers/api/osuny/communication/websites/agenda/events_controller.rb

@@ -1,6 +1,6 @@
 class Api::Osuny::Communication::Websites::Agenda::EventsController < Api::Osuny::Communication::Websites::ApplicationController
-  before_action :build_event, only: :create
-  before_action :load_event, only: [:show, :update, :destroy]
+  include Api::Osuny::HasResource
+  include Api::Osuny::HasMigrationIdentifier
 
   def index
     @events = paginate(website.events.includes(:localizations))
@@ -10,6 +10,8 @@ def show
   end
 
   def create
+    @event = website.events.build
+    @event.assign_attributes(event_params)
     if @event.save
       render :show, status: :created
     else
@@ -31,7 +33,7 @@ def upsert
       event_params[:migration_identifier].present?
     }
     unless every_event_has_migration_identifier
-      render_on_missing_migration_identifier
+      render_missing_migration_identifier
       return
     end
 
@@ -70,32 +72,14 @@ def destroy
 
   protected
 
-  def build_event
-    @event = website.events.build
-    @event.assign_attributes(event_params)
+  def integrity_checker
+    @integrity_checker ||= Osuny::Api::MigrationIdentifierIntegrityChecker.new(@event, event_params, website.events.with_deleted)
   end
 
-  def load_event
+  def load_resource
     @event = website.events.find(params[:id])
   end
 
-  def load_migration_identifier
-    @migration_identifier = event_params[:migration_identifier]
-    render_on_missing_migration_identifier unless @migration_identifier.present?
-  end
-
-  def ensure_same_migration_identifier
-    if @event.migration_identifier != @migration_identifier
-      render json: { error: 'Migration identifier does not match' }, status: :unprocessable_content
-    end
-  end
-
-  def ensure_migration_identifier_is_available
-    if website.events.with_deleted.where(migration_identifier: @migration_identifier).any?
-      render json: { error: 'Migration identifier already used' }, status: :unprocessable_content
-    end
-  end
-
   def l10n_permitted_keys
     [
       :migration_identifier, :language, :title, :meta_description,

app/controllers/api/osuny/communication/websites/application_controller.rb

@@ -1,10 +1,6 @@
 class Api::Osuny::Communication::Websites::ApplicationController < Api::Osuny::ApplicationController
   before_action :load_website
 
-  before_action :load_migration_identifier, only: [:create, :update]
-  before_action :ensure_migration_identifier_is_available, only: :create
-  before_action :ensure_same_migration_identifier, only: :update
-
   protected
 
   def load_website
@@ -15,16 +11,4 @@ def website
     @website
   end
 
-  def load_migration_identifier
-    raise NoMethodError, "You must implement the `load_migration_identifier` method in #{self.class.name}"
-  end
-
-  def ensure_migration_identifier_is_available
-    raise NoMethodError, "You must implement the `ensure_migration_identifier_is_available` method in #{self.class.name}"
-  end
-
-  def ensure_same_migration_identifier
-    raise NoMethodError, "You must implement the `ensure_same_migration_identifier` method in #{self.class.name}"
-  end
-
 end

app/controllers/api/osuny/communication/websites/pages/categories_controller.rb

@@ -1,6 +1,6 @@
 class Api::Osuny::Communication::Websites::Pages::CategoriesController < Api::Osuny::Communication::Websites::ApplicationController
-  before_action :build_category, only: :create
-  before_action :load_category, only: [:show, :update, :destroy]
+  include Api::Osuny::HasResource
+  include Api::Osuny::HasMigrationIdentifier
 
   def index
     @categories = paginate(website.page_categories.includes(:localizations))
@@ -10,6 +10,8 @@ def show
   end
 
   def create
+    @category = website.page_categories.build
+    @category.assign_attributes(category_params)
     if @category.save
       render :show, status: :created
     else
@@ -31,7 +33,7 @@ def upsert
       category_params[:migration_identifier].present?
     }
     unless every_category_has_migration_identifier
-      render_on_missing_migration_identifier
+      render_missing_migration_identifier
       return
     end
 
@@ -70,32 +72,14 @@ def destroy
 
   protected
 
-  def build_category
-    @category = website.page_categories.build
-    @category.assign_attributes(category_params)
+  def integrity_checker
+    @integrity_checker ||= Osuny::Api::MigrationIdentifierIntegrityChecker.new(@category, category_params, website.page_categories)
   end
 
-  def load_category
+  def load_resource
     @category = website.page_categories.find(params[:id])
   end
 
-  def load_migration_identifier
-    @migration_identifier = category_params[:migration_identifier]
-    render_on_missing_migration_identifier unless @migration_identifier.present?
-  end
-
-  def ensure_same_migration_identifier
-    if @category.migration_identifier != @migration_identifier
-      render json: { error: 'Migration identifier does not match' }, status: :unprocessable_content
-    end
-  end
-
-  def ensure_migration_identifier_is_available
-    if website.page_categories.where(migration_identifier: @migration_identifier).any?
-      render json: { error: 'Migration identifier already used' }, status: :unprocessable_content
-    end
-  end
-
   def l10n_permitted_keys
     [
       :migration_identifier, :language, :name, :meta_description,

app/controllers/api/osuny/communication/websites/pages_controller.rb

@@ -1,6 +1,6 @@
 class Api::Osuny::Communication::Websites::PagesController < Api::Osuny::Communication::Websites::ApplicationController
-  before_action :build_page, only: :create
-  before_action :load_page, only: [:show, :update, :destroy]
+  include Api::Osuny::HasResource
+  include Api::Osuny::HasMigrationIdentifier
 
   def index
     @pages = paginate(website.pages.includes(:localizations))
@@ -10,6 +10,8 @@ def show
   end
 
   def create
+    @page = website.pages.build
+    @page.assign_attributes(page_params)
     if @page.save
       render :show, status: :created
     else
@@ -31,7 +33,7 @@ def upsert
       page_params[:migration_identifier].present?
     }
     unless every_page_has_migration_identifier
-      render_on_missing_migration_identifier
+      render_missing_migration_identifier
       return
     end
 
@@ -70,32 +72,14 @@ def destroy
 
   protected
 
-  def build_page
-    @page = website.pages.build
-    @page.assign_attributes(page_params)
+  def integrity_checker
+    @integrity_checker ||= Osuny::Api::MigrationIdentifierIntegrityChecker.new(@page, page_params, website.pages.with_deleted)
   end
 
-  def load_page
+  def load_resource
     @page = website.pages.find(params[:id])
   end
 
-  def load_migration_identifier
-    @migration_identifier = page_params[:migration_identifier]
-    render_on_missing_migration_identifier unless @migration_identifier.present?
-  end
-
-  def ensure_same_migration_identifier
-    if @page.migration_identifier != @migration_identifier
-      render json: { error: 'Migration identifier does not match' }, status: :unprocessable_content
-    end
-  end
-
-  def ensure_migration_identifier_is_available
-    if website.pages.with_deleted.where(migration_identifier: @migration_identifier).any?
-      render json: { error: 'Migration identifier already used' }, status: :unprocessable_content
-    end
-  end
-
   def l10n_permitted_keys
     [
       :migration_identifier, :language, :title, :breadcrumb_title, :meta_description,

app/controllers/api/osuny/communication/websites/portfolio/categories_controller.rb

@@ -1,6 +1,6 @@
 class Api::Osuny::Communication::Websites::Portfolio::CategoriesController < Api::Osuny::Communication::Websites::ApplicationController
-  before_action :build_category, only: :create
-  before_action :load_category, only: [:show, :update, :destroy]
+  include Api::Osuny::HasResource
+  include Api::Osuny::HasMigrationIdentifier
 
   def index
     @categories = paginate(website.portfolio_categories.includes(:localizations))
@@ -10,6 +10,8 @@ def show
   end
 
   def create
+    @category = website.portfolio_categories.build
+    @category.assign_attributes(category_params)
     if @category.save
       render :show, status: :created
     else
@@ -31,7 +33,7 @@ def upsert
       category_params[:migration_identifier].present?
     }
     unless every_category_has_migration_identifier
-      render_on_missing_migration_identifier
+      render_missing_migration_identifier
       return
     end
 
@@ -70,32 +72,14 @@ def destroy
 
   protected
 
-  def build_category
-    @category = website.portfolio_categories.build
-    @category.assign_attributes(category_params)
+  def integrity_checker
+    @integrity_checker ||= Osuny::Api::MigrationIdentifierIntegrityChecker.new(@category, category_params, website.portfolio_categories)
   end
 
-  def load_category
+  def load_resource
     @category = website.portfolio_categories.find(params[:id])
   end
 
-  def load_migration_identifier
-    @migration_identifier = category_params[:migration_identifier]
-    render_on_missing_migration_identifier unless @migration_identifier.present?
-  end
-
-  def ensure_same_migration_identifier
-    if @category.migration_identifier != @migration_identifier
-      render json: { error: 'Migration identifier does not match' }, status: :unprocessable_content
-    end
-  end
-
-  def ensure_migration_identifier_is_available
-    if website.portfolio_categories.where(migration_identifier: @migration_identifier).any?
-      render json: { error: 'Migration identifier already used' }, status: :unprocessable_content
-    end
-  end
-
   def l10n_permitted_keys
     [
       :migration_identifier, :language, :name, :meta_description,