geoblacklight_admin 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5514d1f3dfc7ba946eb58f955e9c3cfc76b073aeafcc86d0f62e3807bf013aba
-  data.tar.gz: 34c448fd3cb662cabf2f3f6cfd2f82b3b5166f681d7e4c0c3ef542ecad575893
+  metadata.gz: 1f4725f14826124fd7393a3b7cbb37baa28b606d15cc1381186a122ef2f0a199
+  data.tar.gz: e7ba31886ae77990e504f108c8e5f9004853ee2f86266b5203490ca022dfc7ca
 SHA512:
-  metadata.gz: 2dcfb661be04c25e22a1941471c06b1dabcf6ee14744fe2faf815172e32b2a00b06639a808fb35f5bb05fef8ef8b0ddde038c8a786b45d38f5aff3aa856c648a
-  data.tar.gz: 38a23540721636da43ee97a2068f10ed127a85b380ecb6d84f1c1ee0045848295b100d781f48762b0204d738530cccdfbd3578ef1927ff87bbe8f6c55349c61a
+  metadata.gz: ecc2b6ce1188088007009498183016919b3b99a471a7b2746d8ec1bac4a5c0cf0aa221c38da2997fd223be68fa5a1275b3470938376131f90e92953409e8a0c2
+  data.tar.gz: 4a56d0949e659f6faf0595a56bed8e057ee2e194b651d0eb3957d0cff37419b441a799e620fe64af25a41a193fc1cbe715c25766b829a4404856260bf35ee1a1

data/README.md

@@ -8,9 +8,10 @@ GeoBlacklight Admin is a [GeoBlacklight](https://github.com/geoblacklight/geobla
 
 ## Requirements
 
-* Rails v6.1 (not v7 yet)
+* Rails v7
 * Blacklight v7 (not v8)
-* GeoBlacklight v4 (not v3)
+* GeoBlacklight v4.4+ (Vite.js)
+* @geoblacklight/frontend v4 (NPM package)
 * Solr v8.4+
 * PostgreSQL (not MySQL-based DBs)
 * Redis (for Sidekiq)
@@ -27,10 +28,10 @@ You need a PostgreSQL database to use this project.
 
 ### Install Template
 
-Use Ruby v3.2 and Rails v6.1.7.4 to bootstrap a new GeoBlacklight + GBL Admin application using the template script:
+Use Ruby v3.3 and Rails v7.0.8.1 to bootstrap a new GeoBlacklight + GBL Admin application using the template script:
 
 ```bash
-rails _6.1.7.4_ new gbl_admin -m https://raw.githubusercontent.com/geobtaa/geoblacklight_admin/develop/template.rb
+rails _7.0.8.1_ new gbl_admin -m https://raw.githubusercontent.com/geobtaa/geoblacklight_admin/develop/template.rb
 cd gbl_admin
 bundle exec rake gbl_admin:server
 ```
@@ -47,62 +48,16 @@ You have now generated the .internal_test_app and populated the Elements / FormE
 
 -----
 
-## Run Project for Local Development
-Drop and recreate databases (or engine_cart:generate will fail)
+## Contributing
 
-### Drop/Create application PG database
-```bash
-psql postgres
-DROP DATABASE geoblacklight_development;
-CREATE DATABASE geoblacklight_development;
-```
-
-```bash
-cd project root
-bundle install
-bundle exec rake engine_cart:regenerate
-```
+For Developer documentation see [doc/developer.md](./docs/development.md)
 
-### Run Solr
-```bash
-bin/rails geoblacklight:solr
-```
+## License
+The gem is available as open source under the terms of the [Apache 2.0 License](https://opensource.org/license/apache-2-0).
 
-### Run App
-```bash
-cd .internal_test_app
-bundle exec rails server
-```
-
-### Lint App
-```bash
-standardrb .
-standardrb --fix
-```
-
-### Test App
-```bash
-RAILS_ENV=test bundle exec rails test
-```
 
 ## TODOs
-* ~~SolrWrapper - Add persist option~~
-* ~~BlacklightApi returns not auth'd message (not requiring auth for now (not sensitive data))~~
-* ~~Facet links need /admin nesting~~
-* ~~Imports#new -- undefined method `imports_path'~~
-* ~~Elements#index -- undefined method `element_path'~~
-* ~~Imports#new -- cannot upload files~~
-* ~~Import#run -- doesn't fire~~
-* ~~Documents - JS actions not working~~
-* ~~GBL needs to honor publication state~~
-* ~~Add GBL Admin link to nav~~
-* ~~Routes - Get devise user~~
-* ~~No route matches [GET] "/users/sign_out"~~
-* ~~Bookmarks need to be Admin::Bookmarks~~
-* ~~GitHub Actions / CI integration~~
-* ~~Port the GEOMG test suite~~
-* ~~Project gem dependency injection redundancy...~~
+* ~~Send GBLADMIN JavaScript pack to NPM like Blacklight~~
 * DRY up Engine routing
 * Remove legacy GEOMG / B1G everywhere...
-* Send GBLADMIN JavaScript pack to NPM like Blacklight
 * Likely some more polish to be uncovered...

data/Rakefile

@@ -25,6 +25,8 @@ require "solr_wrapper/rake_task"
 require "engine_cart/rake_task"
 require "geoblacklight_admin/version"
 require "rake/testtask"
+require "geoblacklight_admin/rake_task"
+require "simple_form"
 
 # Searches for files ending in _test.rb in the test directory
 Rake::TestTask.new do |t|
@@ -40,6 +42,7 @@ task default: :test
 desc "Run test suite"
 task ci: ["geoblacklight:generate"] do
   within_test_app do
+    require "simple_form"
     system "RAILS_ENV=test bin/rails db:migrate"
     system "RAILS_ENV=test rake db:seed"
     system "RAILS_ENV=test rails webpacker:compile"

data/app/assets/javascripts/geoblacklight_admin/chosen.js

@@ -1,4 +1,8 @@
-// jQuery Ready
-$(document).on('ready turbolinks:load', function() {
-  $('.chosen-select').chosen();
+// VanillaJS Ready
+document.addEventListener('DOMContentLoaded', function() {
+  var elements = document.querySelectorAll('.chosen-select');
+  Array.prototype.forEach.call(elements, function(el, i){
+    console.log("Vanilla JS Chosen Select");
+    $('.chosen-select').chosen();
+  });
 });

data/app/assets/javascripts/geoblacklight_admin/datepicker.js

@@ -1,5 +1,5 @@
-// jQuery Ready
-$(document).on('ready turbolinks:load', function() {
+// VanillaJS Ready
+document.addEventListener('DOMContentLoaded', function() {
   // Datepickers - YYYY-MM-DD
   if($("input[data-js='datepicker']").length > 0) {
     $("input[data-js='datepicker']").datepicker({

data/app/assets/javascripts/geoblacklight_admin/inputmask.js

@@ -1,4 +1,4 @@
-// jQuery Ready
-$(document).on('ready turbolinks:load', function() {
+// VanillaJS Ready
+document.addEventListener('DOMContentLoaded', function() {
   $("input[data-inputmask]").inputmask();
 });

data/app/assets/javascripts/geoblacklight_admin/truncate.js

@@ -1,4 +1,4 @@
-// jQuery Ready
-$(document).on('ready turbolinks:load', function() {
+// VanillaJS Ready
+document.addEventListener('DOMContentLoaded', function() {
   $('.js-truncate').shave(32);
 });

data/app/assets/javascripts/geoblacklight_admin.js

@@ -11,12 +11,9 @@
 // about supported directives.
 //
 
-//= require jquery3
-//= require rails-ujs
+// VENDOR
 //= require @nathanvda/cocoon/cocoon.js
 //= require chosen-jquery/lib/chosen.jquery.js
-
-// VENDOR
 //= require bootstrap-datepicker/js/bootstrap-datepicker.js
 //= require inputmask/dist/jquery.inputmask
 //= require shave/dist/jquery.shave.js

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

@@ -25,7 +25,9 @@
 @import "modules/elements";
 @import "modules/forms";
 @import "modules/icons";
+@import "modules/images";
 @import "modules/nav";
+@import "modules/results";
 @import "modules/tables";
 @import "modules/toasts";
 @import "modules/visibility";
@@ -43,7 +45,7 @@ footer.gbl-admin {
   box-shadow: inset 0 0 0 50vw rgba(0, 0, 0, 0.8);
 }
 
-div.container-fluid {
+main.container-fluid {
   margin-top: 5rem;
 }
 

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

@@ -0,0 +1,4 @@
+.thumbnail {
+  max-height: 65px;
+  max-width: 65px;
+}

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

@@ -7,3 +7,7 @@
 .make-me-sticky {
   top:8rem;
 }
+
+.navbar a {
+  text-decoration: none;
+}

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

@@ -0,0 +1,5 @@
+ol#results {
+  li {
+    margin-bottom: 1rem;
+  }
+}

data/app/controllers/admin/admin_controller.rb

@@ -3,7 +3,7 @@
 module Admin
   class AdminController < ApplicationController
     include Devise::Controllers::Helpers
-    include Pagy::Backend
+    include ::Pagy::Backend
     layout "admin/layouts/application"
 
     before_action :authenticate_admin!

data/app/controllers/admin/advanced_search_controller.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "blacklight/catalog"
 require "blacklight_range_limit/controller_override"
 
 module Admin

data/app/controllers/admin/assets_controller.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+# Admin::AssetsController
+module Admin
+  class AssetsController < Admin::AdminController
+    before_action :set_asset, only: %i[show edit update destroy]
+
+    # GET /assets or /assets.json
+    def index
+      scope = Asset
+      search_query = params[:q].strip if params[:q].present?
+
+      # Basic search functionality
+      if search_query.present?
+        scope = if date_check?(search_query)
+          Asset.where("created_at BETWEEN ? AND ?", search_query.to_date.beginning_of_day, search_query.to_date.end_of_day)
+        else
+          scope.where(id: search_query).or(
+            Asset.where(friendlier_id: search_query)
+          ).or(
+            Asset.where("title like ?", "%" + Asset.sanitize_sql_like(search_query) + "%")
+          ).or(
+            Asset.where(parent_id: search_query)
+          )
+        end
+      end
+
+      @pagy, @assets = pagy(scope, items: 20)
+    end
+
+    # GET /assets/1 or /assets/1.json
+    def show
+    end
+
+    # GET /assets/new
+    def new
+      @asset = Asset.new
+    end
+
+    # GET /assets/1/edit
+    def edit
+    end
+
+    # POST /assets or /assets.json
+    def create
+      @asset = Asset.new(asset_params)
+
+      respond_to do |format|
+        if @asset.save
+          format.html { redirect_to admin_asset_url(@asset), notice: "Asset was successfully created." }
+          format.json { render :show, status: :created, location: @asset }
+        else
+          format.html { render :new, status: :unprocessable_entity }
+          format.json { render json: @asset.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    # PATCH/PUT /assets/1 or /assets/1.json
+    def update
+      respond_to do |format|
+        if @asset.update(asset_params)
+          format.html { redirect_to admin_asset_url(@asset.id), notice: "Asset was successfully updated." }
+          format.json { render :show, status: :ok, location: @asset }
+        else
+          format.html { render :edit, status: :unprocessable_entity }
+          format.json { render json: @asset.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    # DELETE /assets/1 or /assets/1.json
+    def destroy
+      @asset.destroy
+
+      respond_to do |format|
+        format.html { redirect_to admin_assets_url, notice: "Asset was successfully destroyed." }
+        format.json { head :no_content }
+      end
+    end
+
+    # /assets/display_attach_form
+    def display_attach_form
+    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 /assets/ingest
+    def attach_files
+      # @parent = Document.find_by_friendlier_id!(params[:id])
+
+      # current_position = @parent.members.maximum(:position) || 0
+
+      files_params = (params[:cached_files] || [])
+        .collect { |s| JSON.parse(s) }
+        .sort_by { |h| h&.dig("metadata", "filename") }
+
+      files_params.each do |file_data|
+        asset = Asset.new
+
+        # if derivative_storage_type = params.dig(:storage_type_for, file_data["id"])
+        #  asset.derivative_storage_type = derivative_storage_type
+        # end
+
+        # asset.position = (current_position += 1)
+        # asset.parent_id = @parent.id
+        asset.file = file_data
+        asset.title = (asset.file&.original_filename || "Untitled")
+        asset.save!
+      end
+
+      # @parent.update(representative: @parent.members.order(:position).first) if @parent.representative_id.nil?
+
+      redirect_to admin_assets_url, notice: "Files attached successfully."
+    end
+
+    def sort
+      Asset.sort_assets(params[:id_list])
+      render body: nil
+    end
+
+    private
+
+    # Use callbacks to share common setup or constraints between actions.
+    def set_asset
+      @asset = Asset.find(params[:id])
+    end
+
+    # Only allow a list of trusted parameters through.
+    def asset_params
+      params.require(:asset)
+    end
+
+    def date_check?(val)
+      val.to_date
+    rescue Date::Error
+      false
+    end
+  end
+end

data/app/controllers/admin/bulk_actions_controller.rb

@@ -73,7 +73,7 @@ module Admin
 
     def run
       @bulk_action.run!
-      @bulk_action.state_machine.transition_to!(:queued)
+      # @bulk_action.state_machine.transition_to!(:queued)
       redirect_to admin_bulk_action_url(@bulk_action), notice: "Bulk action is running. Check back soon for results."
     end
 

data/app/controllers/admin/document_accesses_controller.rb

@@ -84,12 +84,12 @@ module Admin
 
       respond_to do |format|
         if DocumentAccess.destroy_all(params.dig(:document_access, :assets, :file))
-          format.html { redirect_to document_accesses_path, notice: "Document Access Links were created destroyed." }
+          format.html { redirect_to admin_document_accesses_path, notice: "Document Access Links were created destroyed." }
         else
-          format.html { redirect_to document_accesses_path, notice: "Document Access Links could not be destroyed." }
+          format.html { redirect_to admin_document_accesses_path, notice: "Document Access Links could not be destroyed." }
         end
       rescue => e
-        format.html { redirect_to document_accesses_path, notice: "Document Access Links could not be destroyed. #{e}" }
+        format.html { redirect_to admin_document_accesses_path, notice: "Document Access Links could not be destroyed. #{e}" }
       end
     end
 

data/app/controllers/admin/document_assets_controller.rb

@@ -4,9 +4,10 @@
 module Admin
   class DocumentAssetsController < Admin::AdminController
     before_action :set_document
+    before_action :set_document_asset, only: %i[show edit update destroy]
 
     def index
-      scope = Kithe::Asset
+      scope = Asset
 
       # simple simple search on a few simple attributes with OR combo.
       if params[:document_id].present?
@@ -21,8 +22,7 @@ module Admin
     end
 
     def show
-      @asset = Kithe::Asset.find_by_friendlier_id!(params[:id])
-      authorize! :read, @asset
+      @asset = Asset.find_by_friendlier_id!(params[:id])
 
       return unless @asset.stored?
 
@@ -32,34 +32,31 @@ module Admin
     end
 
     def edit
-      @asset = Kithe::Asset.find_by_friendlier_id!(params[:id])
-      authorize! :update, @asset
     end
 
     # PATCH/PUT /works/1
     # PATCH/PUT /works/1.json
     def update
-      @asset = Kithe::Asset.find_by_friendlier_id!(params[:id])
-      authorize! :update, @asset
+      @document_asset = DocumentAsset.find_by_friendlier_id!(params[:id])
 
       respond_to do |format|
-        if @asset.update(asset_params)
-          format.html { redirect_to admin_asset_url(@asset), notice: "Asset was successfully updated." }
-          format.json { render :show, status: :ok, location: @asset }
+        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.json { render :show, status: :ok, location: @document_asset }
         else
           format.html { render :edit }
-          format.json { render json: @asset.errors, status: :unprocessable_entity }
+          format.json { render json: @document_asset.errors, status: :unprocessable_entity }
         end
       end
     end
 
     def destroy
-      @asset = Kithe::Asset.find_by_friendlier_id!(params[:id])
+      @asset = Asset.find_by_friendlier_id!(params[:id])
       @asset.destroy
 
       respond_to do |format|
         format.html do
-          redirect_to document_document_assets_path(@document),
+          redirect_to admin_document_document_assets_path(@document),
             notice: "Asset '#{@asset.title}' was successfully destroyed."
         end
         format.json { head :no_content }
@@ -67,7 +64,7 @@ module Admin
     end
 
     def check_fixity
-      @asset = Kithe::Asset.find_by_friendlier_id!(params[:asset_id])
+      @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
@@ -95,12 +92,16 @@ module Admin
         .sort_by { |h| h&.dig("metadata", "filename") }
 
       files_params.each do |file_data|
-        asset = Kithe::Asset.new
+        asset = Asset.new
 
         # if derivative_storage_type = params.dig(:storage_type_for, file_data["id"])
         #  asset.derivative_storage_type = derivative_storage_type
         # end
 
+        # References
+        references = params.dig(:dct_references_for, file_data["id"])
+        asset.dct_references_uri_key = references if references
+
         asset.position = (current_position += 1)
         asset.parent_id = @parent.id
         asset.file = file_data
@@ -110,11 +111,11 @@ module Admin
 
       @parent.update(representative: @parent.members.order(:position).first) if @parent.representative_id.nil?
 
-      redirect_to admin_document_path(@parent.friendlier_id, anchor: "nav-members")
+      redirect_to admin_document_document_assets_path(@parent.friendlier_id, anchor: "nav-members")
     end
 
     def convert_to_child_work
-      @asset = Kithe::Asset.find_by_friendlier_id!(params[:id])
+      @asset = Asset.find_by_friendlier_id!(params[:id])
 
       parent = @asset.parent
 
@@ -184,18 +185,27 @@ module Admin
 
     private
 
+    def asset_params
+      allowed_params = [:title, :derivative_storage_type, :alt_text, :caption,
+        :transcription, :english_translation,
+        :role, {admin_note_attributes: []}, :dct_references_for]
+      allowed_params << :published if can?(:publish, @asset)
+      params.require(:asset).permit(*allowed_params)
+    end
+
     def set_document
       return unless params[:document_id] # If not nested
 
       @document = Document.includes(:leaf_representative).find_by!(friendlier_id: params[:document_id])
     end
 
-    def asset_params
-      allowed_params = [:title, :derivative_storage_type, :alt_text, :caption,
-        :transcription, :english_translation,
-        :role, {admin_note_attributes: []}]
-      allowed_params << :published if can?(:publish, @asset)
-      params.require(:asset).permit(*allowed_params)
+    def set_document_asset
+      @document_asset = DocumentAsset.find_by_friendlier_id(params[:id])
+    end
+
+    # Only allow a list of trusted parameters through.
+    def document_asset_params
+      params.require(:asset).permit(:title, :label, :dct_references_uri_key)
     end
   end
 end

data/app/controllers/admin/documents_controller.rb

@@ -5,7 +5,7 @@ module Admin
   class DocumentsController < Admin::AdminController
     ActionController::Parameters.permit_all_parameters = true
     before_action :set_document,
-      only: %i[show edit update destroy versions]
+      only: %i[show edit update destroy admin versions]
 
     # GET /documents
     # GET /documents.json
@@ -134,6 +134,10 @@ module Admin
     def edit
     end
 
+    # GET /documents/1/admin
+    def admin
+    end
+
     # GET /documents/1/versions
     def versions
     end
@@ -145,7 +149,7 @@ module Admin
       @document.friendlier_id = @document.send(GeoblacklightAdmin::Schema.instance.solr_fields[:id])
       respond_to do |format|
         if @document.save
-          format.html { redirect_to admin_documents_path, notice: "Document was successfully created." }
+          format.html { redirect_to edit_admin_document_path(@document), notice: "Document was successfully created." }
           format.json { render :show, status: :created, location: @document }
         else
           format.html { render :edit }

data/app/controllers/admin/ids_controller.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "blacklight/catalog"
 require "blacklight_range_limit/controller_override"
 
 # Admin::IdsController

data/app/controllers/admin/imports_controller.rb

@@ -14,8 +14,8 @@ module Admin
     # GET /imports/1
     # GET /imports/1.json
     def show
-      @pagy_failed, @import_failed_documents = pagy(@import.import_documents.not_in_state(:success), items: 50)
-      @pagy_success, @import_success_documents = pagy(@import.import_documents.in_state(:success), items: 50)
+      @pagy_failed, @import_failed_documents = pagy(@import.import_documents.not_in_state(:success), items: 50, page_param: :failed_page)
+      @pagy_success, @import_success_documents = pagy(@import.import_documents.in_state(:success), items: 50, page_param: :success_page)
     end
 
     # GET /imports/new

data/app/helpers/asset_helper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# AssetHelper
+module AssetHelper
+  def asset_thumb_to_render?(asset)
+    asset&.file_url&.present? && asset&.file_derivatives&.present?
+  end
+end

data/app/helpers/document_helper.rb

@@ -57,4 +57,8 @@ module DocumentHelper
   def blacklight_link(document)
     "#{BLACKLIGHT_URL}/catalog/#{document.friendlier_id}"
   end
+
+  def thumb_to_render?(document)
+    document&.thumbnail&.file_url&.present? && document&.thumbnail&.file_derivatives&.present?
+  end
 end

data/app/helpers/geoblacklight_admin_helper.rb

@@ -53,10 +53,16 @@ module GeoblacklightAdminHelper
       "11" => "The Ohio State University",
       "12" => "University of Chicago",
       "13" => "University of Nebraska-Lincoln",
-      "14" => "Rutgers University-New Brunswick"
+      "14" => "Rutgers University-New Brunswick",
+      "15" => "Northwestern University"
     }
   end
 
+  def bookmarks_badge
+    bookmarks_classes = ["badge", "badge-dark"]
+    "<span class='#{bookmarks_classes.join(" ")}' id='bookmarks-count'>#{current_user.bookmarks.size}</span>"
+  end
+
   def notifications_badge
     notifications_classes = ["badge"]
     notifications_classes << "badge-dark" if current_user.notifications.unread.empty?
@@ -145,4 +151,8 @@ module GeoblacklightAdminHelper
 
     link_to(label, path)
   end
+
+  def assets_dct_references_options
+    escape_javascript(options_for_select(I18n.t("activemodel.enum_values.document/reference.category").invert.sort.insert(0, ["Choose Reference Type", nil]))).to_s
+  end
 end