geoblacklight_admin 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f4725f14826124fd7393a3b7cbb37baa28b606d15cc1381186a122ef2f0a199
-  data.tar.gz: e7ba31886ae77990e504f108c8e5f9004853ee2f86266b5203490ca022dfc7ca
+  metadata.gz: fb7dfdea7cb8626ae4e65999624310642a89c81cea03a8d0e58a5649c080091b
+  data.tar.gz: e08e45d57f47e372d574e7cce41e1babd93697741a1261a22dcf816e07a0b74b
 SHA512:
-  metadata.gz: ecc2b6ce1188088007009498183016919b3b99a471a7b2746d8ec1bac4a5c0cf0aa221c38da2997fd223be68fa5a1275b3470938376131f90e92953409e8a0c2
-  data.tar.gz: 4a56d0949e659f6faf0595a56bed8e057ee2e194b651d0eb3957d0cff37419b441a799e620fe64af25a41a193fc1cbe715c25766b829a4404856260bf35ee1a1
+  metadata.gz: b7e2504e7f0fb46e55e0ba3359577a4d6e90842afa5c6be608e79a52d2b278ec39fe24812b68d8ca6d950ff2ef7842905550bb2a1354ba012f82f8b6349da154
+  data.tar.gz: d913fe08b848b6b9a2f2cd730570cecbb1f0e98157540b967306fc903ee7433bdae04a422b7d0b06c20678103bd30440bfaa939b04369c9b9f100bdd55611a65

data/README.md

@@ -8,9 +8,9 @@ GeoBlacklight Admin is a [GeoBlacklight](https://github.com/geoblacklight/geobla
 
 ## Requirements
 
-* Rails v7
+* Rails v7 (not v8)
 * Blacklight v7 (not v8)
-* GeoBlacklight v4.4+ (Vite.js)
+* GeoBlacklight v4 (not v5)
 * @geoblacklight/frontend v4 (NPM package)
 * Solr v8.4+
 * PostgreSQL (not MySQL-based DBs)
@@ -28,12 +28,19 @@ You need a PostgreSQL database to use this project.
 
 ### Install Template
 
-Use Ruby v3.3 and Rails v7.0.8.1 to bootstrap a new GeoBlacklight + GBL Admin application using the template script:
+#### 1. Create your geoblacklight_admin_development PostgreSQL database
 
 ```bash
-rails _7.0.8.1_ new gbl_admin -m https://raw.githubusercontent.com/geobtaa/geoblacklight_admin/develop/template.rb
+psql postgres
+CREATE DATABASE geoblacklight_admin_development;
+```
+
+#### 2. Bootstrap a new GeoBlacklight + GBL Admin application using the template script:
+
+```bash
+rails _7.2.2_ new gbl_admin -m https://raw.githubusercontent.com/geobtaa/geoblacklight_admin/develop/template.rb
 cd gbl_admin
-bundle exec rake gbl_admin:server
+bundle exec rake geoblacklight:server
 ```
 
 You have now generated the .internal_test_app and populated the Elements / FormElements tables for OMG Aardvark support.
@@ -44,7 +51,7 @@ You have now generated the .internal_test_app and populated the Elements / FormE
 2. Click on the "Sign in" link
 3. Enter email: admin@geoblacklight.org and password: 123456
 4. Click on the "GBL Admin" link
-5. Import some CSV (test/fixtures/files/btaa_sample_records.csv)
+5. Import some CSV data (test/fixtures/files/btaa_sample_records.csv)
 
 -----
 
@@ -55,9 +62,15 @@ For Developer documentation see [doc/developer.md](./docs/development.md)
 ## License
 The gem is available as open source under the terms of the [Apache 2.0 License](https://opensource.org/license/apache-2-0).
 
-
-## TODOs
+## TODOs / Roadmap
 * ~~Send GBLADMIN JavaScript pack to NPM like Blacklight~~
-* DRY up Engine routing
-* Remove legacy GEOMG / B1G everywhere...
-* Likely some more polish to be uncovered...
+* ~~Improve test coverage~~
+* ~~Fix CI test runner~~
+* ~~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~~
+* Migrate our GBL API controllers to just RSolr-based models
+* DRY up Gem dependencies and Engine routing
+* Gazetteer: Add GeoNames support
+* Gazetteer: Add Who's On First support
+* Remove any remaining GEOMG references

data/Rakefile

@@ -2,6 +2,7 @@
 
 require "rubygems"
 require "rails"
+require "database_cleaner/active_record"
 
 require "bundler/setup"
 
@@ -13,15 +14,12 @@ load "rails/tasks/statistics.rake"
 
 require "bundler/gem_tasks"
 
-require "solr_wrapper"
-
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 require "rubocop/rake_task"
 RuboCop::RakeTask.new(:rubocop)
 
-require "solr_wrapper/rake_task"
 require "engine_cart/rake_task"
 require "geoblacklight_admin/version"
 require "rake/testtask"
@@ -40,66 +38,104 @@ end
 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"
+task :ci do
+  # Reset the database if the test app exists
+  if File.exist? EngineCart.destination
+    within_test_app do
+      system "bundle exec rake db:reset"
+    end
   end
 
-  # Run RSpec tests with Coverage
-  Rake::Task["geoblacklight:coverage"].invoke
-end
+  # Start docker
+  Rake::Task["geoblacklight:admin:docker:start"].invoke
 
-namespace :geoblacklight do
-  desc "Run tests with coverage"
-  task :coverage do
-    ENV["COVERAGE"] = "true"
-    # Rake::Task["spec"].invoke
-    Rake::Task["test"].invoke
-  end
+  # Create the test rails app
+  Rake::Task["geoblacklight:admin:generate"].invoke
 
-  desc "Create the test rails app"
-  task generate: ["engine_cart:generate"] do
-    # Intentionally Empty Block
-  end
+  # Run Minitest tests with Coverage
+  Rake::Task["geoblacklight:admin:coverage"].invoke
 
-  namespace :internal do
-    task seed: ["engine_cart:generate"] do
-      within_test_app do
-        system "bundle exec rake db:seed"
-        system "bundle exec rake geoblacklight:downloads:mkdir"
-      end
-    end
-  end
+  # Stop docker
+  Rake::Task["geoblacklight:admin:docker:stop"].invoke
+end
 
-  desc "Run Solr and seed with sample data"
-  task :solr do
-    if File.exist? EngineCart.destination
-      within_test_app do
-        system "bundle update"
+namespace :geoblacklight do
+  namespace :admin do
+    desc "Run GeoBlacklight Admin and Solr with seed data for interactive development"
+    task :server, [:rails_server_args] do |_t, args|
+      if File.exist? EngineCart.destination
+        within_test_app do
+          system "bundle update"
+        end
+      else
+        Rake::Task["engine_cart:generate"].invoke
       end
-    else
-      Rake::Task["engine_cart:generate"].invoke
-    end
 
-    SolrWrapper.wrap(port: "8983") do |solr|
-      solr.with_collection(name: "blacklight-core",
-        dir: File.join(File.expand_path(".", File.dirname(__FILE__)),
-          "solr", "conf")) do
-        Rake::Task["geoblacklight:internal:seed"].invoke
+      system "docker compose up -d"
+      Rake::Task["geoblacklight:admin:internal:seed"].invoke
 
+      begin
         within_test_app do
-          puts "\nSolr server running: http://localhost:#{solr.port}/solr/#/blacklight-core"
-          puts "\n^C to stop"
+          puts "\nSolr server running: http://localhost:8983/solr/#/blacklight-core"
+          puts "\nPostgreSQL server running: http://localhost:5555"
           puts " "
           begin
-            sleep
+            system "bundle exec rails s #{args[:rails_server_args]}"
           rescue Interrupt
             puts "Shutting down..."
           end
         end
+      ensure
+        system "docker compose down"
+      end
+    end
+
+    desc "Run tests with coverage"
+    task :coverage do
+      ENV["COVERAGE"] = "true"
+      Rake::Task["test"].invoke
+    end
+
+    desc "Create the test rails app"
+    task generate: ["engine_cart:generate"] do
+      # system "bundle exec rake db:reset"
+    end
+
+    namespace :internal do
+      task seed: ["engine_cart:generate"] do
+        within_test_app do
+          system "Settings.reload!"
+          system "bundle exec rake db:reset"
+          system "bundle exec rake db:seed"
+          system "bundle exec rake geoblacklight:downloads:mkdir"
+        end
+      end
+    end
+
+    desc "Run Solr and seed with sample data"
+    task :solr do
+      if File.exist? EngineCart.destination
+        within_test_app do
+          system "bundle update"
+        end
+      else
+        Rake::Task["engine_cart:generate"].invoke
+      end
+    end
+
+    namespace :docker do
+      desc "Start docker and seed with sample data"
+      task :start do
+        system "docker compose up -d"
+        Rake::Task["geoblacklight:admin:internal:seed"].invoke
+        puts "\nSolr server running: http://localhost:8983/solr/#/blacklight-core"
+        puts "\nPostgreSQL server running: http://localhost:5555"
+        puts " "
+      end
+
+      desc "Stop docker"
+      task :stop do
+        system "docker compose down"
       end
     end
   end

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

@@ -1,4 +1,5 @@
 // VanillaJS Ready
+// @TODO: Replace with Tom Select
 document.addEventListener('DOMContentLoaded', function() {
   var elements = document.querySelectorAll('.chosen-select');
   Array.prototype.forEach.call(elements, function(el, i){

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

@@ -45,10 +45,34 @@ footer.gbl-admin {
   box-shadow: inset 0 0 0 50vw rgba(0, 0, 0, 0.8);
 }
 
+main#gbl-admin {
+  min-height: 75vh;
+  margin-top: 0rem;
+}
+
 main.container-fluid {
   margin-top: 5rem;
 }
 
 .navbar-brand.gbl-admin {
   background: none;
+}
+
+kbd {
+  background-color:aliceblue;
+}
+
+a.btn.btn-gbl-admin {
+  color: black;
+  border-color: #ffc107;
+  margin: 1rem 0;
+
+  &:visited {
+    color: black;
+    background-color: #ffc107;
+  }
+}
+
+div.dropdown-menu.show {
+  z-index: 2000;
 }

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

@@ -1,8 +1,3 @@
-// Keep Document Cancel and Update buttons visible
-.admin-header {
-  top:4rem;
-}
-
 // Keep View in Geoportal visible
 .make-me-sticky {
   top:8rem;

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

@@ -1,4 +1,4 @@
 th.header{
   position: sticky;
-  top: 55px;
+  top: 0.25rem;
 }

data/app/controllers/admin/admin_controller.rb

@@ -1,18 +1,34 @@
 # frozen_string_literal: true
 
+# The Admin module contains controllers for the admin section of the application.
 module Admin
+  # AdminController is the base controller for all admin-related controllers.
+  # It includes necessary modules and provides authentication for admin users.
   class AdminController < ApplicationController
+    # Includes Devise helpers for authentication.
     include Devise::Controllers::Helpers
+    # Includes Pagy for pagination.
     include ::Pagy::Backend
+    # Sets the layout for the admin section.
     layout "admin/layouts/application"
 
+    # Before any action, ensure the user is authenticated as an admin.
     before_action :authenticate_admin!
+    before_action :set_action_cable_identifier
 
     protected
 
+    # Authenticates the user and checks if they are an admin.
+    # Redirects to a specified location with a forbidden status if the user is not an admin.
     def authenticate_admin!
       authenticate_user!
       redirect_to :somewhere, status: :forbidden unless current_user.admin?
     end
+
+    private
+
+    def set_action_cable_identifier
+      cookies.encrypted[:user_id] = current_user&.id
+    end
   end
 end

data/app/controllers/admin/advanced_search_controller.rb

@@ -76,7 +76,7 @@ module Admin
       # config.index.record_display_type = 'format'
 
       config.index.title_field = Settings.FIELDS.TITLE
-      config.index.document_presenter_class = Geoblacklight::DocumentPresenter
+      config.index.document_presenter_class = ::Geoblacklight::DocumentPresenter
 
       # solr field configuration for document/show views
 
@@ -380,5 +380,11 @@ module Admin
         end
       end
     end
+
+    private
+
+    def advanced_search_params
+      params.permit(:advanced_search)
+    end
   end
 end

data/app/controllers/admin/assets_controller.rb

@@ -1,11 +1,33 @@
 # frozen_string_literal: true
 
 # Admin::AssetsController
+#
+# This controller handles the management of assets within the admin namespace.
+# It provides actions to list, show, edit, update, and destroy assets.
+# Additionally, it supports attaching files to assets.
+#
+# Actions:
+# - index: Lists all assets with optional search functionality.
+# - show: Displays a specific asset.
+# - edit: Provides a form to edit an asset.
+# - update: Updates an asset with new data.
+# - destroy: Deletes an asset.
+# - display_attach_form: Displays a form to attach files to an asset.
+# - attach_files: Attaches files to an asset based on provided JSON data.
+#
+# Private Methods:
+# - parent_id_via_friendly_id: Finds a document's ID using its friendlier_id.
+# - set_asset: Finds and sets an asset based on the provided ID.
+# - asset_params: Permits only trusted parameters for asset updates.
+# - date_check?: Checks if a value can be converted to a date.
 module Admin
   class AssetsController < Admin::AdminController
     before_action :set_asset, only: %i[show edit update destroy]
 
-    # GET /assets or /assets.json
+    # GET /admin/asset_files
+    #
+    # Lists all assets. Supports searching by ID, friendlier_id, title, or parent_id.
+    # If a date is provided as a search query, it filters assets created on that date.
     def index
       scope = Asset
       search_query = params[:q].strip if params[:q].present?
@@ -29,37 +51,24 @@ module Admin
     end
 
     # GET /assets/1 or /assets/1.json
+    #
+    # Displays a specific asset.
     def show
     end
 
-    # GET /assets/new
-    def new
-      @asset = Asset.new
-    end
-
     # GET /assets/1/edit
+    #
+    # Provides a form to edit an asset.
     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
+    #
+    # Updates an asset with new data. If successful, redirects to the asset's page.
+    # Otherwise, re-renders the edit form with errors.
     def update
       respond_to do |format|
-        if @asset.update(asset_params)
+        if @asset.update(asset_params.merge!(parent_id: parent_id_via_friendly_id(asset_params[:parent_id])))
           format.html { redirect_to admin_asset_url(@asset.id), notice: "Asset was successfully updated." }
           format.json { render :show, status: :ok, location: @asset }
         else
@@ -70,6 +79,8 @@ module Admin
     end
 
     # DELETE /assets/1 or /assets/1.json
+    #
+    # Deletes an asset and redirects to the assets list with a success notice.
     def destroy
       @asset.destroy
 
@@ -80,14 +91,16 @@ module Admin
     end
 
     # /assets/display_attach_form
+    #
+    # Displays a form to attach files to an asset.
     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
+    #
+    # Receives JSON hashes for direct uploaded files in params[:files],
+    # and id in params[:id] (friendlier_id). Creates filesets for them and attaches.
+    # Redirects to the assets list with a success notice.
     def attach_files
       # @parent = Document.find_by_friendlier_id!(params[:id])
 
@@ -116,23 +129,25 @@ module Admin
       redirect_to admin_assets_url, notice: "Files attached successfully."
     end
 
-    def sort
-      Asset.sort_assets(params[:id_list])
-      render body: nil
-    end
-
     private
 
+    # Finds a document's ID using its friendlier_id.
+    def parent_id_via_friendly_id(friendlier_id)
+      Document.find_by_friendlier_id(friendlier_id)&.id
+    end
+
     # Use callbacks to share common setup or constraints between actions.
+    # Finds and sets an asset based on the provided ID.
     def set_asset
       @asset = Asset.find(params[:id])
     end
 
     # Only allow a list of trusted parameters through.
     def asset_params
-      params.require(:asset)
+      params.require(:asset).permit(:parent_id, :thumbnail)
     end
 
+    # Checks if a value can be converted to a date.
     def date_check?(val)
       val.to_date
     rescue Date::Error

data/app/controllers/admin/bookmarks_controller.rb

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 
 # Admin::BookmarksController
+# This controller handles the management of bookmarks for the admin interface.
+# It allows for listing, creating, and destroying bookmarks associated with the current user.
 module Admin
   class BookmarksController < Admin::AdminController
-    before_action :set_document,
-      only: %i[create destroy]
+    before_action :set_document, only: %i[create destroy]
 
     # GET /bookmarks
     # GET /bookmarks.json
+    # Lists all bookmarks for the current user, filtered by document type "Kithe::Model".
+    # Responds with HTML or CSV format.
     def index
       @pagy, @bookmarks = pagy(current_user.bookmarks.where(document_type: "Kithe::Model"))
 
@@ -20,15 +23,18 @@ module Admin
 
     # POST /bookmarks
     # POST /bookmarks.json
+    # Creates a new bookmark for the current user and the specified document.
+    # If successful, redirects to the bookmarks index with a success notice.
+    # Otherwise, renders the index with an error status.
     def create
       @bookmark = Admin::Bookmark.find_or_create_by(user: current_user, document: @document)
 
       respond_to do |format|
         if @bookmark.save
-          format.html { redirect_to @bookmark, notice: "Bookmark was successfully created." }
+          format.html { redirect_to admin_bookmarks_url, notice: "Bookmark was successfully created." }
           format.js
         else
-          format.html { render :new }
+          format.html { render :index, status: :unprocessable_entity }
           format.json { render json: @bookmark.errors, status: :unprocessable_entity }
         end
       end
@@ -36,17 +42,20 @@ module Admin
 
     # DELETE /bookmarks/1
     # DELETE /bookmarks/1.json
+    # Destroys the bookmark for the current user and the specified document.
+    # Redirects to the bookmarks index with a success notice.
     def destroy
       Admin::Bookmark.destroy_by(user: current_user, document: @document)
 
       respond_to do |format|
-        format.html { redirect_to bookmarks_url, notice: "Bookmark was successfully destroyed." }
+        format.html { redirect_to admin_bookmarks_url, notice: "Bookmark was successfully destroyed." }
         format.js
       end
     end
 
     private
 
+    # Sets the document based on the friendlier_id parameter.
     def set_document
       @document = Document.find_by(friendlier_id: params["document"])
     end
@@ -56,6 +65,9 @@ module Admin
       params.fetch(:bookmark, {})
     end
 
+    # Collects bookmarks into a CSV format.
+    # @param bookmarks [Array<Bookmark>] the bookmarks to be converted to CSV
+    # @return [String] the generated CSV data
     def collect_csv(bookmarks)
       CSV.generate(headers: true) do |csv|
         csv << GeoblacklightAdmin::Schema.instance.importable_fields.map { |k, _v| k.to_s }

data/app/controllers/admin/bulk_actions_controller.rb

@@ -1,34 +1,52 @@
 # frozen_string_literal: true
 
 # Admin::BulkActionsController
+#
+# This controller manages bulk actions within the admin interface.
+# It provides actions to list, show, create, update, destroy, run, and revert bulk actions.
 module Admin
   class BulkActionsController < Admin::AdminController
     before_action :set_bulk_action, only: %i[show edit update destroy run revert]
 
     # GET /bulk_actions
     # GET /bulk_actions.json
+    #
+    # Lists all bulk actions, paginated.
+    # @return [Array<BulkAction>] List of bulk actions
     def index
       @pagy, @bulk_actions = pagy(BulkAction.all.order(created_at: :desc), items: 20)
     end
 
     # GET /bulk_actions/1
     # GET /bulk_actions/1.json
+    #
+    # Shows a specific bulk action and its associated documents.
+    # @return [BulkAction] The requested bulk action
     def show
       @pagy, @documents = pagy(@bulk_action.documents, items: 30)
       @bulk_action.check_run_state
     end
 
     # GET /bulk_actions/new
+    #
+    # Initializes a new bulk action with a given scope.
+    # @return [BulkAction] A new bulk action instance
     def new
       @bulk_action = BulkAction.new(scope: params[:scope])
     end
 
     # GET /bulk_actions/1/edit
+    #
+    # Prepares a bulk action for editing.
+    # @return [BulkAction] The bulk action to be edited
     def edit
     end
 
     # POST /bulk_actions
     # POST /bulk_actions.json
+    #
+    # Creates a new bulk action.
+    # @return [BulkAction] The created bulk action
     def create
       @bulk_action = BulkAction.new(bulk_action_params)
 
@@ -47,6 +65,9 @@ module Admin
 
     # PATCH/PUT /bulk_actions/1
     # PATCH/PUT /bulk_actions/1.json
+    #
+    # Updates an existing bulk action.
+    # @return [BulkAction] The updated bulk action
     def update
       respond_to do |format|
         if @bulk_action.update(bulk_action_params)
@@ -63,6 +84,9 @@ module Admin
 
     # DELETE /bulk_actions/1
     # DELETE /bulk_actions/1.json
+    #
+    # Deletes a bulk action.
+    # @return [void]
     def destroy
       @bulk_action.destroy
       respond_to do |format|
@@ -71,12 +95,16 @@ module Admin
       end
     end
 
+    # Runs a bulk action.
+    # @return [void]
     def run
       @bulk_action.run!
       # @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
 
+    # Reverts a bulk action.
+    # @return [void]
     def revert
       @bulk_action.revert!
       @bulk_action.state_machine.transition_to!(:queued)
@@ -87,13 +115,16 @@ module Admin
     private
 
     # Use callbacks to share common setup or constraints between actions.
+    # Finds and sets the bulk action based on the provided ID.
+    # @return [BulkAction] The found bulk action
     def set_bulk_action
       @bulk_action = BulkAction.find(params[:id])
     end
 
     # Only allow a list of trusted parameters through.
+    # @return [ActionController::Parameters] The permitted parameters
     def bulk_action_params
-      params.fetch(:bulk_action, {})
+      params.require(:bulk_action).permit(:name, :scope, :request, :field_name, :field_value)
     end
   end
 end