geoblacklight_admin 0.6.3 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: faa51021e7c742dbc13abb29e2114de5f917716955034cff20b433d6a3c275de
-  data.tar.gz: 71050ece81fb99a0377793467e09e4bb0d67fc892b6f49296a1c278ab4a00460
+  metadata.gz: 3206d757d63794d306ce29d80d7bcf7ea9e2afe7f94f21792885a71e3edc9ac6
+  data.tar.gz: 1916a1e90a1826bb509a497b6bab3c4f3253e44cac7f44f73e6f676638c78f91
 SHA512:
-  metadata.gz: 7fef4d2444d40f92f7731471f3647959b440e0a1ff9d74f5fb4973bff02701b626a6b0d83c7175e8bc0a0bb9bc7519edb3ef3f660d1584b0e4bbc22cb9f4df30
-  data.tar.gz: 3cc6ed9f3b4f25c67b30ba05a601a05022baab8ace7081d609db514f175746d43a5e91225c2889d8963eb74fbf96cca96f4cd112fae5066d65b455eb6cf3d72e
+  metadata.gz: '09f174737d687d2a9d60a9a5a6fb73d11eefaf160ec2862a2ff0d12e4b926ab8b0b91d534ae4b20d781319b1b50107dd05cb214c54ffdc6c531bb600ca139c5b'
+  data.tar.gz: af6d3f3e20943a2a8de0a1020d0a568e2870738c5c74d21ef9aad575fd9364360c620e78c2d16cead8261f77501c8a05c095ea94747801be4a63b81e3421af0e

data/README.md

@@ -69,7 +69,8 @@ The gem is available as open source under the terms of the [Apache 2.0 License](
 * ~~Debug Rails 7.2 support (remove devise_invitable, see [#915](https://github.com/scambra/devise_invitable/issues/915))~~
 * ~~Separate dct_references_s support into a separate model~~
 * ~~Import/Export dct_references_s outside of the main document model~~
-* Data Dictionary: Add support for `document_data_dictionary`
+* ~~Distributions: Move import to background queue~~
+* ~~Data Dictionary: Add support for `document_data_dictionary`~~
 * Gazetteer: Add GeoNames support
 * Gazetteer: Add Who's On First support
 * Gazetteer: Add Ollama support

data/app/assets/stylesheets/geoblacklight_admin/_core.scss

@@ -14,7 +14,7 @@
 @import "settings/variables";
 
 // Vendors
-@import 'bootstrap';
+@import "bootstrap";
 
 // Modules
 @import "modules/autocomplete";
@@ -27,6 +27,7 @@
 @import "modules/icons";
 @import "modules/images";
 @import "modules/nav";
+@import "modules/pagy";
 @import "modules/results";
 @import "modules/tables";
 @import "modules/toasts";

data/app/assets/stylesheets/geoblacklight_admin/modules/_icons.scss

@@ -13,3 +13,12 @@ svg.icon.baseline  {
   top: -0.125em;
   position: relative;
 }
+
+// Sidebar Action Icons
+#dataDictionariesLink {
+  margin-left:0rem;
+  padding-left: 1.5rem;
+  background-position: left center;
+  background-repeat:no-repeat;
+  background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' version='1.1' width='14' height='14' viewBox='0 0 512 512' aria-label='Table' role='img'%3E%3Ctitle%3ETable%3C/title%3E%3Cpath fill='%236c757d' d='M464 32H48C21.49 32 0 53.49 0 80v352c0 26.51 21.49 48 48 48h416c26.51 0 48-21.49 48-48V80c0-26.51-21.49-48-48-48zM48 80h416v64H48V80zm0 128h128v64H48v-64zm0 128h128v64H48v-64zm192 64v-64h128v64H240zm128-128H240v-64h128v64zm64 128v-64h128v64H432zm0-128h128v64H432v-64z'%3E%3C/path%3E%3C/svg%3E");
+}

data/app/assets/stylesheets/geoblacklight_admin/modules/_pagy.scss

@@ -0,0 +1,7 @@
+.pagy {
+  a:not(.gap) {
+    &:not([href]) { /* disabled links */
+      margin-top: 0.4rem;
+    }
+  }
+}

data/app/controllers/admin/document_data_dictionaries_controller.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+# Admin::DocumentDataDictionariesController
+#
+# This controller manages the document data dictionaries within the admin namespace.
+# It provides actions to list, show, edit, update, and destroy data dictionaries.
+module Admin
+  class DocumentDataDictionariesController < Admin::AdminController
+    before_action :set_document
+    before_action :set_document_data_dictionary, only: %i[show edit update destroy]
+
+    # GET /document_data_dictionaries or /document_data_dictionaries.json
+    def index
+      @document_data_dictionaries = DocumentDataDictionary.all
+      if params[:document_id]
+        @document_data_dictionaries = DocumentDataDictionary.where(friendlier_id: @document.friendlier_id).order(position: :asc)
+      else
+        @pagy, @document_data_dictionaries = pagy(DocumentDataDictionary.all.order(friendlier_id: :asc, updated_at: :desc), items: 20)
+      end
+    end
+
+    # GET /document_data_dictionaries/1 or /document_data_dictionaries/1.json
+    def show
+      @pagy, @document_data_dictionary_entries = pagy(@document_data_dictionary.document_data_dictionary_entries.order(position: :asc), items: 100)
+    end
+
+    # GET /document_data_dictionaries/new
+    def new
+      @document_data_dictionary = DocumentDataDictionary.new
+    end
+
+    # GET /document_data_dictionaries/1/edit
+    def edit
+    end
+
+    # POST /document_data_dictionaries or /document_data_dictionaries.json
+    def create
+      @document_data_dictionary = DocumentDataDictionary.new(document_data_dictionary_params)
+
+      respond_to do |format|
+        if @document_data_dictionary.save
+          format.html { redirect_to admin_document_document_data_dictionaries_path(@document), notice: "Document data dictionary was successfully created." }
+          format.json { render :show, status: :created, location: @document_data_dictionary }
+        else
+          logger.debug("Document data dictionary could not be created. #{@document_data_dictionary.errors.full_messages}")
+          format.html { render :new, status: :unprocessable_entity }
+          format.json { render json: @document_data_dictionary.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    # PATCH/PUT /document_data_dictionaries/1 or /document_data_dictionaries/1.json
+    def update
+      respond_to do |format|
+        if @document_data_dictionary.update(document_data_dictionary_params)
+          format.html { redirect_to admin_document_document_data_dictionaries_path(@document), notice: "Document data dictionary was successfully updated." }
+          format.json { render :show, status: :ok, location: @document_data_dictionary }
+        else
+          format.html { render :edit, status: :unprocessable_entity }
+          format.json { render json: @document_data_dictionary.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    # DELETE /document_data_dictionaries/1 or /document_data_dictionaries/1.json
+    def destroy
+      @document_data_dictionary.destroy!
+
+      respond_to do |format|
+        format.html { redirect_to admin_document_document_data_dictionaries_path(@document), status: :see_other, notice: "Document data dictionary was successfully destroyed." }
+        format.json { head :no_content }
+      end
+    end
+
+    # DELETE /admin/document_data_dictionaries/destroy_all
+    #
+    # Destroys all document data dictionaries provided in the file parameter. If successful, redirects
+    # with a success notice. Otherwise, redirects with an error notice.
+    def destroy_all
+      return if request.get?
+
+      logger.debug("Destroy Data Dictionaries")
+      unless params.dig(:document_data_dictionary, :data_dictionaries, :file)
+        raise ArgumentError, "File does not exist or is invalid."
+      end
+
+      respond_to do |format|
+        if DocumentDataDictionary.destroy_all(params.dig(:document_data_dictionary, :data_dictionaries, :file))
+          format.html { redirect_to admin_document_document_data_dictionaries_path, notice: "Data dictionaries were destroyed." }
+        else
+          format.html { redirect_to admin_document_document_data_dictionaries_path, notice: "Data dictionaries could not be destroyed." }
+        end
+      rescue => e
+        format.html { redirect_to admin_document_document_data_dictionaries_path, notice: "Data dictionaries could not be destroyed. #{e}" }
+      end
+    end
+
+    private
+
+    # Sets the document based on the document_id parameter.
+    # If not nested, it does nothing.
+    def set_document
+      return unless params[:document_id] # If not nested
+
+      @document = Document.includes(:leaf_representative).find_by!(friendlier_id: params[:document_id])
+    end
+
+    # Sets the document data dictionary based on the id parameter.
+    def set_document_data_dictionary
+      @document_data_dictionary = DocumentDataDictionary.find(params[:id])
+    end
+
+    # Only allow a list of trusted parameters through.
+    def document_data_dictionary_params
+      params.require(:document_data_dictionary).permit(
+        :friendlier_id,
+        :name,
+        :description,
+        :staff_notes,
+        :tags,
+        :csv_file,
+        :position
+      )
+    end
+  end
+end

data/app/controllers/admin/document_data_dictionary_entries_controller.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+# Admin::DocumentDataDictionaryEntriesController
+#
+# This controller manages the document data dictionary entries within the admin namespace.
+# It provides actions to list, show, edit, update, destroy, and import data dictionaries.
+module Admin
+  class DocumentDataDictionaryEntriesController < Admin::AdminController
+    before_action :set_document
+    before_action :set_document_data_dictionary
+    before_action :set_document_data_dictionary_entry, only: %i[edit update destroy]
+
+    # GET /document_data_dictionaries/1/entries/new
+    def new
+      @document_data_dictionary_entry = DocumentDataDictionaryEntry.new
+    end
+
+    # GET /document_data_dictionaries/1/entries/1/edit
+    def edit
+    end
+
+    # POST /document_data_dictionaries/1/entries or /document_data_dictionaries/1/entries.json
+    def create
+      @document_data_dictionary_entry = DocumentDataDictionaryEntry.new(document_data_dictionary_entry_params)
+
+      respond_to do |format|
+        if @document_data_dictionary_entry.save
+          format.html { redirect_to admin_document_document_data_dictionary_path(@document, @document_data_dictionary), notice: "Document data dictionary entry was successfully created." }
+          format.json { render :show, status: :created, location: @document_data_dictionary_entry }
+        else
+          logger.debug("Document data dictionary entry could not be created. #{@document_data_dictionary_entry.errors.full_messages}")
+          format.html { render :new, status: :unprocessable_entity }
+          format.json { render json: @document_data_dictionary_entry.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    # PATCH/PUT /document_data_dictionaries/1/entries/1 or /document_data_dictionaries/1/entries/1.json
+    def update
+      respond_to do |format|
+        if @document_data_dictionary_entry.update(document_data_dictionary_entry_params)
+          format.html { redirect_to admin_document_document_data_dictionary_path(@document, @document_data_dictionary), notice: "Document data dictionary entry was successfully updated." }
+          format.json { render :show, status: :ok, location: @document_data_dictionary_entry }
+        else
+          logger.debug("Document data dictionary entry could not be updated. #{@document_data_dictionary_entry.errors.full_messages}")
+          format.html { render :edit, status: :unprocessable_entity }
+          format.json { render json: @document_data_dictionary_entry.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    # DELETE /document_data_dictionaries/1/entries/1 or /document_data_dictionaries/1/entries/1.json
+    def destroy
+      @document_data_dictionary_entry.destroy!
+
+      respond_to do |format|
+        format.html { redirect_to admin_document_document_data_dictionary_path(@document, @document_data_dictionary), status: :see_other, notice: "Document data dictionary entry was successfully destroyed." }
+        format.json { head :no_content }
+      end
+    end
+
+    # DELETE /admin/document_data_dictionaries/1/entries/destroy_all
+    #
+    # Destroys all document data dictionaries provided in the file parameter. If successful, redirects
+    # with a success notice. Otherwise, redirects with an error notice.
+    def destroy_all
+      return if request.get?
+
+      logger.debug("Destroy Data Dictionary Entries")
+
+      respond_to do |format|
+        if @document_data_dictionary.document_data_dictionary_entries.destroy_all
+          format.html { redirect_to admin_document_document_data_dictionary_document_data_dictionary_entries_path(@document_data_dictionary.friendlier_id, @document_data_dictionary), notice: "Data dictionary entries were destroyed." }
+        else
+          format.html { redirect_to admin_document_document_data_dictionary_document_data_dictionary_entries_path(@document_data_dictionary.friendlier_id, @document_data_dictionary), notice: "Data dictionary entries could not be destroyed." }
+        end
+      rescue => e
+        format.html { redirect_to admin_document_document_data_dictionary_document_data_dictionary_entries_path(@document_data_dictionary.friendlier_id, @document_data_dictionary), notice: "Data dictionary entries could not be destroyed. #{e}" }
+      end
+    end
+
+    # POST /document_data_dictionaries/1/entries/sort
+    # Sorts document data dictionary entries based on the provided list of IDs.
+    # Renders an empty response body.
+    def sort
+      DocumentDataDictionary.sort_entries(params[:id_list])
+      render body: nil
+    end
+
+    private
+
+    # Sets the document based on the document_id parameter.
+    # If not nested, it does nothing.
+    def set_document
+      return unless params[:document_id] # If not nested
+      @document = Document.includes(:leaf_representative).find_by!(friendlier_id: params[:document_id])
+    end
+
+    # Sets the document data dictionary based on the id parameter.
+    def set_document_data_dictionary
+      @document_data_dictionary = DocumentDataDictionary.find(params[:document_data_dictionary_id])
+    end
+
+    # Sets the document data dictionary entry based on the id parameter.
+    def set_document_data_dictionary_entry
+      @document_data_dictionary_entry = DocumentDataDictionaryEntry.find(params[:id])
+    end
+
+    # Only allow a list of trusted parameters through.
+    def document_data_dictionary_entry_params
+      params.require(:document_data_dictionary_entry).permit(
+        :friendlier_id,
+        :document_data_dictionary_id,
+        :field_name,
+        :field_type,
+        :values,
+        :definition,
+        :definition_source,
+        :parent_field_name,
+        :position
+      )
+    end
+  end
+end

data/app/controllers/admin/document_distributions_controller.rb

@@ -112,44 +112,6 @@ module Admin
       end
     end
 
-    # GET/POST /documents/1/distributions/import
-    #
-    # Imports document distributions from a file. If successful, redirects with a success notice.
-    # Otherwise, redirects with an error notice.
-    def import
-      return if request.get?
-
-      logger.debug("Import Distributions")
-
-      unless params.dig(:document_distribution, :distributions, :file)
-        raise ArgumentError, "File does not exist or is invalid."
-      end
-
-      success, errors = DocumentDistribution.import(params.dig(:document_distribution, :distributions, :file))
-      if success == true
-        logger.debug("Distributions were created successfully.")
-        if params[:document_id]
-          redirect_to admin_document_document_distributions_path(@document), notice: "Distributions were created successfully."
-        else
-          redirect_to admin_document_distributions_path, notice: "Distributions were created successfully."
-        end
-      else
-        logger.debug("Some distributions could not be created. #{errors.join(", ")}")
-        if params[:document_id]
-          redirect_to admin_document_document_distributions_path(@document), notice: "Some distributions could not be created. #{errors.join(", ")}"
-        else
-          redirect_to admin_document_distributions_path, notice: "Some distributions could not be created. #{errors.join(", ")}"
-        end
-      end
-    rescue => e
-      logger.debug("Distributions could not be created. #{e}")
-      if params[:document_id]
-        redirect_to admin_document_document_distributions_path(@document), notice: "Distributions could not be created. #{e}"
-      else
-        redirect_to admin_document_distributions_path, notice: "Distributions could not be created. #{e}"
-      end
-    end
-
     private
 
     # Sets the document based on the document_id parameter.

data/app/controllers/admin/import_distributions_controller.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+# Admin::ImportDistributionsController
+#
+# This controller handles the CRUD operations for ImportDistribution objects within the admin namespace.
+# It provides actions to list, show, create, update, and delete import distributions, as well as run an import distribution.
+#
+# Before Actions:
+# - set_import_distribution: Sets the @import_distribution instance variable for actions that require an import distribution ID.
+#
+# Actions:
+# - index: Lists all imports with pagination.
+# - show: Displays a specific import and its associated documents, with pagination for success and failed states.
+# - new: Initializes a new Import object.
+# - edit: Prepares an existing Import object for editing.
+# - create: Creates a new Import object and redirects to import mappings if successful.
+# - update: Updates an existing Import object and redirects to the import if successful.
+# - destroy: Deletes an Import object and redirects to the imports list.
+# - run: Executes the import process and redirects to the import show page.
+#
+# Private Methods:
+# - set_import: Finds and sets the import based on the provided ID.
+# - permittable_params: Returns an array of permitted parameters for import.
+# - import_params: Permits parameters for creating or updating an import, including nested attributes.
+module Admin
+  class ImportDistributionsController < Admin::AdminController
+    before_action :set_import_distribution, only: %i[show edit update destroy run]
+
+    # GET /import_distributions
+    # GET /import_distributions.json
+    # Lists all import distributions with pagination.
+    def index
+      @pagy, @import_distributions = pagy(ImportDistribution.all.order("created_at DESC"), items: 20)
+    end
+
+    # GET /import_distributions/1
+    # GET /import_distributions/1.json
+    # Displays a specific import distribution and its associated documents, with pagination for success and failed states.
+    def show
+      @pagy_failed, @import_failed_distributions = pagy(@import_distribution.import_document_distributions.not_in_state(:success), items: 50, page_param: :failed_page)
+      @pagy_success, @import_success_distributions = pagy(@import_distribution.import_document_distributions.in_state(:success), items: 50, page_param: :success_page)
+    end
+
+    # GET /import_distributions/new
+    # Initializes a new ImportDistribution object.
+    def new
+      @import_distribution = ImportDistribution.new
+    end
+
+    # GET /import_distributions/1/edit
+    # Prepares an existing ImportDistribution object for editing.
+    def edit
+    end
+
+    # POST /import_distributions
+    # POST /import_distributions.json
+    # Creates a new ImportDistribution object
+    def create
+      @import_distribution = ImportDistribution.new(import_distribution_params)
+
+      respond_to do |format|
+        if @import_distribution.save
+          format.html do
+            redirect_to admin_import_distribution_path(@import_distribution),
+              notice: "Import distribution was successful."
+          end
+          format.json { render :show, status: :created, location: @import_distribution }
+        else
+          format.html { render :new, status: :unprocessable_entity }
+          format.json { render json: @import_distribution.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    # PATCH/PUT /import_distributions/1
+    # PATCH/PUT /import_distributions/1.json
+    # Updates an existing ImportDistribution object and redirects to the import distribution if successful.
+    def update
+      respond_to do |format|
+        if @import_distribution.update(import_distribution_params)
+          format.html { redirect_to admin_import_distribution_path(@import_distribution), notice: "Import distribution was successfully updated." }
+          format.json { render :show, status: :ok, location: @import_distribution }
+        else
+          format.html { render :edit, status: :unprocessable_entity }
+          format.json { render json: @import_distribution.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    # DELETE /import_distributions/1
+    # DELETE /import_distributions/1.json
+    # Deletes an ImportDistribution object and redirects to the import distributions list.
+    def destroy
+      @import_distribution.destroy
+      respond_to do |format|
+        format.html { redirect_to admin_import_distributions_url, notice: "Import distribution was successfully destroyed." }
+        format.json { head :no_content }
+      end
+    end
+
+    # Runs the import process and redirects to the import show page.
+    def run
+      @import_distribution.run!
+      redirect_to admin_import_distribution_url(@import_distribution), notice: "Import distribution is running. Check back soon for results."
+    end
+
+    private
+
+    # Use callbacks to share common setup or constraints between actions.
+    # Finds and sets the import distribution based on the provided ID.
+    def set_import_distribution
+      @import_distribution = ImportDistribution.find(params[:id])
+    end
+
+    # Returns an array of permitted parameters for import distribution.
+    def permittable_params
+      %i[name filename source description row_count encoding content_type extension validity validation_result
+        csv_file run]
+    end
+
+    # Permits parameters for creating or updating an import distribution, including nested attributes.
+    def import_distribution_params
+      params.require(:import_distribution).permit(permittable_params)
+    end
+  end
+end