geoblacklight_admin 0.5.0 → 0.6.0

data/app/controllers/admin/document_accesses_controller.rb

@@ -1,6 +1,31 @@
 # frozen_string_literal: true
 
 # Admin::DocumentAccessesController
+#
+# This controller manages the CRUD operations for DocumentAccess objects
+# within the admin namespace. It provides actions to list, show, create,
+# update, and destroy document access records. It also includes custom
+# actions for importing and destroying all document access links.
+#
+# Actions:
+# - index: Lists all document accesses, optionally filtered by document_id.
+# - show: Displays a specific document access.
+# - new: Renders a form for creating a new document access.
+# - edit: Renders a form for editing an existing document access.
+# - create: Creates a new document access.
+# - update: Updates an existing document access.
+# - destroy: Deletes a specific document access.
+# - destroy_all: Deletes all document access links provided in the params.
+# - import: Imports document access links from a file provided in the params.
+#
+# Before Actions:
+# - set_document: Sets the @document instance variable if document_id is present.
+# - set_document_access: Sets the @document_access instance variable for specific actions.
+#
+# Private Methods:
+# - set_document: Finds and sets the document based on the document_id parameter.
+# - set_document_access: Finds and sets the document access based on the id parameter.
+# - document_access_params: Permits only trusted parameters for document access.
 module Admin
   class DocumentAccessesController < Admin::AdminController
     before_action :set_document
@@ -8,6 +33,7 @@ module Admin
 
     # GET /documents/#id/access
     # GET /documents/#id/access.json
+    # Lists all document accesses, optionally filtered by document_id.
     def index
       if params[:document_id]
         @document_accesses = DocumentAccess.where(friendlier_id: @document.friendlier_id).order(institution_code: :asc)
@@ -18,20 +44,24 @@ module Admin
 
     # GET /document_accesses/1
     # GET /document_accesses/1.json
+    # Displays a specific document access.
     def show
     end
 
     # GET /document_accesses/new
+    # Renders a form for creating a new document access.
     def new
       @document_access = DocumentAccess.new
     end
 
     # GET /document_accesses/1/edit
+    # Renders a form for editing an existing document access.
     def edit
     end
 
     # POST /document_accesses
     # POST /document_accesses.json
+    # Creates a new document access.
     def create
       @document_access = DocumentAccess.new(document_access_params)
       logger.debug("DA Params: #{DocumentAccess.new(document_access_params).inspect}")
@@ -52,6 +82,7 @@ module Admin
 
     # PATCH/PUT /document_accesses/1
     # PATCH/PUT /document_accesses/1.json
+    # Updates an existing document access.
     def update
       respond_to do |format|
         if @document_access.update(document_access_params)
@@ -68,6 +99,7 @@ module Admin
 
     # DELETE /document_accesses/1
     # DELETE /document_accesses/1.json
+    # Deletes a specific document access.
     def destroy
       @document_access.destroy
       respond_to do |format|
@@ -78,6 +110,8 @@ module Admin
       end
     end
 
+    # DELETE /document_accesses/destroy_all
+    # Deletes all document access links provided in the params.
     def destroy_all
       logger.debug("Destroy Access Links")
       return unless params.dig(:document_access, :assets, :file)
@@ -95,6 +129,7 @@ module Admin
 
     # GET   /documents/#id/access/import
     # POST  /documents/#id/access/import
+    # Imports document access links from a file provided in the params.
     def import
       logger.debug("Import Action")
       return unless params.dig(:document_access, :assets, :file)
@@ -113,17 +148,20 @@ module Admin
     private
 
     # Use callbacks to share common setup or constraints between actions.
+    # Finds and sets the document based on the document_id parameter.
     def set_document
       return unless params[:document_id] # If not nested
 
       @document = Document.includes(:leaf_representative).find_by!(friendlier_id: params[:document_id])
     end
 
+    # Finds and sets the document access based on the id parameter.
     def set_document_access
       @document_access = DocumentAccess.find(params[:id])
     end
 
     # Only allow a list of trusted parameters through.
+    # Permits only trusted parameters for document access.
     def document_access_params
       params.require(:document_access).permit(:friendlier_id, :institution_code, :access_url)
     end

data/app/controllers/admin/document_assets_controller.rb

@@ -1,11 +1,23 @@
 # frozen_string_literal: true
 
 # Admin::DocumentAssetsController
+#
+# This controller manages the document assets within the admin namespace.
+# It provides actions to list, show, edit, update, destroy, and attach files
+# to document assets.
+#
+# Before Actions:
+# - set_document: Sets the document based on the document_id parameter.
+# - set_document_asset: Sets the document asset based on the id parameter for specific actions.
 module Admin
   class DocumentAssetsController < Admin::AdminController
     before_action :set_document
     before_action :set_document_asset, only: %i[show edit update destroy]
 
+    # GET /admin/document_assets
+    #
+    # Lists all document assets. If a document_id is provided, it filters
+    # the assets by the specified document.
     def index
       scope = Asset
 
@@ -21,6 +33,10 @@ module Admin
       @document_assets = scope
     end
 
+    # GET /admin/document_assets/:id
+    #
+    # Shows a specific document asset. If the asset is stored, it also
+    # retrieves the fixity checks associated with the asset.
     def show
       @asset = Asset.find_by_friendlier_id!(params[:id])
 
@@ -31,17 +47,23 @@ module Admin
       @earliest_check = @checks.first
     end
 
+    # GET /admin/document_assets/:id/edit
+    #
+    # Renders the edit form for a specific document asset.
     def edit
     end
 
-    # PATCH/PUT /works/1
-    # PATCH/PUT /works/1.json
+    # PATCH/PUT /admin/document_assets/:id
+    #
+    # Updates a specific document asset. If successful, redirects to the
+    # document assets index with a success notice. Otherwise, re-renders
+    # the edit form with errors.
     def update
-      @document_asset = DocumentAsset.find_by_friendlier_id!(params[:id])
+      @document_asset = Asset.find_by_friendlier_id!(params[:id])
 
       respond_to do |format|
         if @document_asset.update(document_asset_params)
-          format.html { redirect_to admin_document_document_assets_path(@document, @document_asset.parent), notice: "Asset was successfully updated." }
+          format.html { redirect_to admin_document_document_assets_path(@document), notice: "Asset was successfully updated." }
           format.json { render :show, status: :ok, location: @document_asset }
         else
           format.html { render :edit }
@@ -50,6 +72,10 @@ module Admin
       end
     end
 
+    # DELETE /admin/document_assets/:id
+    #
+    # Destroys a specific document asset. Redirects to the document assets
+    # index with a success notice.
     def destroy
       @asset = Asset.find_by_friendlier_id!(params[:id])
       @asset.destroy
@@ -63,25 +89,17 @@ module Admin
       end
     end
 
-    def check_fixity
-      @asset = Asset.find_by_friendlier_id!(params[:asset_id])
-      SingleAssetCheckerJob.perform_later(@asset)
-      redirect_to admin_asset_url(@asset), notice: "This file will be checked shortly."
-    end
-
-    def fixity_report
-      @fixity_report = FixityReport.new
-    end
-
+    # GET /admin/document_assets/display_attach_form
+    #
+    # Displays the form to attach files to a document.
     def display_attach_form
       @document = Document.find_by_friendlier_id!(params[:document_id])
     end
 
-    # Receives json hashes for direct uploaded files in params[:files],
-    # and id in params[:id] (friendlier_id)
-    # creates filesets for them and attach.
-    #
     # POST /document/:id/ingest
+    #
+    # Attaches files to a document. Receives JSON hashes for direct uploaded
+    # files in params[:files] and creates filesets for them.
     def attach_files
       @parent = Document.find_by_friendlier_id!(params[:id])
 
@@ -114,77 +132,11 @@ module Admin
       redirect_to admin_document_document_assets_path(@parent.friendlier_id, anchor: "nav-members")
     end
 
-    def convert_to_child_work
-      @asset = Asset.find_by_friendlier_id!(params[:id])
-
-      parent = @asset.parent
-
-      new_child = Work.new(title: @asset.title)
-
-      # Asking for permission to create a new Work,
-      # which is arguably the main thing going on in this method.
-      # authorize! :create, Work as the first line of the method
-      # would be better, but we currently aren't allowed to do that
-      # see (https://github.com/chaps-io/access-granted/pull/56).
-      authorize! :create, new_child
-
-      new_child.parent = parent
-      # collections
-      new_child.contained_by = parent.contained_by
-      new_child.position = @asset.position
-      new_child.representative = @asset
-      # we can copy _all_ the non-title metadata like this...
-      new_child.json_attributes = parent.json_attributes
-
-      @asset.parent = new_child
-
-      Kithe::Model.transaction do
-        new_child.save!
-        @asset.save! # to get new parent
-
-        if parent.representative_id == @asset.id
-          parent.representative = new_child
-          parent.save!
-        end
-      end
-
-      redirect_to edit_admin_work_path(new_child), notice: "Asset promoted to child work #{new_child.title}"
-    end
-
-    # requires params[:active_encode_status_id]
-    def refresh_active_encode_status
-      status = ActiveEncodeStatus.find(params[:active_encode_status_id])
-
-      RefreshActiveEncodeStatusJob.perform_later(status)
-
-      redirect_to admin_asset_url(status.asset),
-        notice: "Started refresh for ActiveEncode job #{status.active_encode_id}"
-    end
-
-    def work_is_oral_history?
-      (@asset.parent.is_a? Work) && @asset.parent.genre && @asset.parent.genre.include?("Oral histories")
-    end
-    helper_method :work_is_oral_history?
-
-    def asset_is_collection_thumbnail?
-      @asset.parent.is_a? Collection
-    end
-    helper_method :asset_is_collection_thumbnail?
-
-    def edit_path(asset)
-      asset.parent.is_a? Collection ? edit_admin_collection_path(asset.parent) : edit_admin_asset_path(asset)
-    end
-    helper_method :edit_path
-
-    def parent_path(asset)
-      return nil if asset.parent.nil?
-
-      asset.parent.is_a? Collection ? collection_path(asset.parent) : admin_work_path(asset.parent)
-    end
-    helper_method :parent_path
-
     private
 
+    # Strong parameters for asset.
+    #
+    # Returns a list of permitted parameters for asset creation and update.
     def asset_params
       allowed_params = [:title, :derivative_storage_type, :alt_text, :caption,
         :transcription, :english_translation,
@@ -193,19 +145,25 @@ module Admin
       params.require(:asset).permit(*allowed_params)
     end
 
+    # Sets the document based on the document_id parameter.
+    #
+    # If the document_id is not present, 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 asset based on the id parameter.
     def set_document_asset
       @document_asset = DocumentAsset.find_by_friendlier_id(params[:id])
     end
 
-    # Only allow a list of trusted parameters through.
+    # Strong parameters for document asset.
+    #
+    # Returns a list of permitted parameters for document asset update.
     def document_asset_params
-      params.require(:asset).permit(:title, :label, :dct_references_uri_key)
+      params.require(:asset).permit(:parent_id, :title, :label, :dct_references_uri_key, :thumbnail)
     end
   end
 end

data/app/controllers/admin/document_distributions_controller.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+# Admin::DocumentDistributionsController
+#
+# This controller manages the CRUD operations for Document Distributions within the Admin namespace.
+# It includes actions for listing, showing, creating, updating, and deleting document distributions.
+# Additionally, it provides functionality for importing and destroying all distributions.
+module Admin
+  class DocumentDistributionsController < Admin::AdminController
+    before_action :set_document
+    before_action :set_document_distribution, only: %i[show edit update destroy]
+
+    # GET /admin/document_distributions or /admin/document_distributions.json
+    #
+    # Lists all document distributions. If a document_id is provided, it lists distributions
+    # associated with that document, ordered by position. Otherwise, it paginates all
+    # document distributions.
+    def index
+      @document_distributions = DocumentDistribution.all
+      if params[:document_id]
+        @document_distributions = DocumentDistribution.where(friendlier_id: @document.friendlier_id).order(position: :asc)
+      else
+        @pagy, @document_distributions = pagy(DocumentDistribution.all.order(friendlier_id: :asc, updated_at: :desc), items: 20)
+      end
+    end
+
+    # GET /admin/document_distributions/1 or /admin/document_distributions/1.json
+    #
+    # Shows a specific document distribution.
+    def show
+    end
+
+    # GET /admin/document_references/new
+    #
+    # Initializes a new document distribution.
+    def new
+      @document_distribution = DocumentDistribution.new
+    end
+
+    # GET /admin/document_distributions/1/edit
+    #
+    # Edits an existing document distribution.
+    def edit
+    end
+
+    # POST /admin/document_distributions or /admin/document_distributions.json
+    #
+    # Creates a new document distribution. If successful, redirects to the document distributions
+    # list with a success notice. Otherwise, renders the new form with errors.
+    def create
+      @document_distribution = DocumentDistribution.new(document_distribution_params)
+
+      respond_to do |format|
+        if @document_distribution.save
+          format.html { redirect_to admin_document_document_distributions_path(@document), notice: "Document distribution was successfully created." }
+          format.json { render :show, status: :created, location: @document_distribution }
+        else
+          format.html { render :new, status: :unprocessable_entity }
+          format.json { render json: @document_distribution.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    # PATCH/PUT /admin/document_distributions/1 or /admin/document_distributions/1.json
+    #
+    # Updates an existing document distribution. If successful, redirects to the document distribution
+    # with a success notice. Otherwise, renders the edit form with errors.
+    def update
+      respond_to do |format|
+        if @document_distribution.update(document_distribution_params)
+          format.html { redirect_to admin_document_document_distributions_path(@document), notice: "Document distribution was successfully updated." }
+          format.json { render :show, status: :ok, location: @document_distribution }
+        else
+          format.html { render :edit, status: :unprocessable_entity }
+          format.json { render json: @document_distribution.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    # DELETE /admin/document_distributions/1 or /admin/document_distributions/1.json
+    #
+    # Deletes a document distribution. Redirects to the document distributions list with a success notice.
+    def destroy
+      @document_distribution.destroy!
+
+      respond_to do |format|
+        format.html { redirect_to admin_document_document_distributions_path(@document), status: :see_other, notice: "Document distribution was successfully destroyed." }
+        format.json { head :no_content }
+      end
+    end
+
+    # DELETE /admin/document_distributions/destroy_all
+    #
+    # Destroys all document distributions 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 Distributions")
+      unless params.dig(:document_distribution, :distributions, :file)
+        raise ArgumentError, "File does not exist or is invalid."
+      end
+
+      respond_to do |format|
+        if DocumentDistribution.destroy_all(params.dig(:document_distribution, :distributions, :file))
+          format.html { redirect_to admin_document_distributions_path, notice: "Distributions were destroyed." }
+        else
+          format.html { redirect_to admin_document_distributions_path, notice: "Distributions could not be destroyed." }
+        end
+      rescue => e
+        format.html { redirect_to admin_document_distributions_path, notice: "Distributions could not be destroyed. #{e}" }
+      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
+
+      if DocumentDistribution.import(params.dig(:document_distribution, :distributions, :file))
+        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_document_distributions_path, notice: "Distributions were created successfully."
+        end
+      else
+        logger.debug("Distributions could not be created.")
+        if params[:document_id]
+          redirect_to admin_document_document_distributions_path(@document), warning: "Distributions could not be created."
+        else
+          redirect_to admin_document_document_distributions_path, warning: "Distributions could not be created."
+        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_document_distributions_path, notice: "Distributions could not be created. #{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 distribution based on the id parameter.
+    def set_document_distribution
+      @document_distribution = DocumentDistribution.find(params[:id])
+    end
+
+    # Permits only the trusted parameters for document distributions.
+    def document_distribution_params
+      params.require(:document_distribution).permit(:friendlier_id, :reference_type_id, :url, :label, :position)
+    end
+  end
+end