geoblacklight_admin 0.4.1 → 0.5.0

data/lib/generators/geoblacklight_admin/config_generator.rb

@@ -11,16 +11,29 @@ module GeoblacklightAdmin
        1. Copies GBL Admin initializer files to host config
        2. Copies database.yml connection to host config
        3. Copies sidekiq.yml connection to host config
-       4. Copies settings.yml to host config
        5. Copies .env.development and .env.test to host
+       4. Copies settings.yml to host config
+       create_solr_yml
        6. Copies JSON Schema to host
        7. Copies solr/* to host
        8. Sets Routes
-       9. Sets Gems
+       set_development_mailer_host
        11.Sets DB Seeds
-       11.Sets ActiveStorage
        12.Sets Pagy Backend
-
+       11.Sets ActiveStorage
+       add_api_controller
+       add_user_util_links
+       copy_catalog_index_view
+       add_show_sidebar
+       copy_app_javascript
+       copy_app_images
+       add_package_json
+       add_assets_initialier
+       add_kithe_bulk_loading_service
+       add_kithe_model_to_solr_document
+       add_search_builder_publication_state_concern
+       add_import_id_facet
+       add_vite_rails_config
     DESCRIPTION
 
     def create_gbl_admin_initializer_files
@@ -88,6 +101,21 @@ module GeoblacklightAdmin
           # Root
           root to: "documents#index"
 
+          # Assets
+          # Note "assets" is Rails reserved word for routing, oops. So we use
+          # asset_files.
+          resources :assets, path: "asset_files" do
+            collection do
+              get "display_attach_form"
+              post "attach_files"
+
+              get "destroy_all"
+              post "destroy_all"
+            end
+
+            post :sort, on: :collection
+          end
+
           # Bulk Actions
           resources :bulk_actions do
             patch :run, on: :member
@@ -143,6 +171,7 @@ module GeoblacklightAdmin
 
           # Documents
           resources :documents do
+            get "admin"
             get "versions"
 
             # DocumentAccesses
@@ -216,8 +245,15 @@ module GeoblacklightAdmin
             end
           end
 
+          # Assets
+          get "/asset_files/ingest", to: "assets#display_attach_form", as: "assets_ingest"
+          post "/asset_files/ingest", to: "assets#attach_files"
+          
+          # DocumentAssets
           get "/documents/:id/ingest", to: "document_assets#display_attach_form", as: "asset_ingest"
           post "/documents/:id/ingest", to: "document_assets#attach_files"
+          
+          # Asset Direct Upload
           mount Kithe::AssetUploader.upload_endpoint(:cache) => "/direct_upload", :as => :direct_app_upload
 
           resources :collections, except: [:show]
@@ -264,9 +300,9 @@ module GeoblacklightAdmin
     def add_activestorage
       append_to_file "app/assets/javascripts/application.js" do
         "
-
 // Required by GBL Admin
-//= require activestorage"
+//= require activestorage
+//= require geoblacklight_admin"
       end
     end
 
@@ -286,14 +322,6 @@ module GeoblacklightAdmin
       copy_file "_show_sidebar.html.erb", "app/views/catalog/_show_sidebar.html.erb"
     end
 
-    # @TODO
-    # I'm certain this is not the best way to inject our JS behaviors into the root app
-    # But for now, this will do...
-    # Long term I hope to avoid webpack here altogether.
-    def copy_app_javascript
-      directory "javascript", "app/javascript", force: true
-    end
-
     def copy_app_images
       copy_file "images/bookmark-regular.svg", "app/assets/images/bookmark-regular.svg"
       copy_file "images/bookmark-solid.svg", "app/assets/images/bookmark-solid.svg"
@@ -303,13 +331,18 @@ module GeoblacklightAdmin
       copy_file "package.json", "package.json", force: true
     end
 
+    def copy_rake_tasks
+      append_to_file "Rakefile", "require \"geoblacklight_admin/rake_task\"\n"
+    end
+
     def add_assets_initialier
       append_to_file "config/initializers/assets.rb" do
         "
         # GBL ADMIN
         Rails.application.config.assets.paths << Rails.root.join('node_modules')
         Rails.application.config.assets.precompile += %w( geoblacklight_admin.js )
-        Rails.application.config.assets.precompile += %w[application.js]"
+        Rails.application.config.assets.precompile += %w[application.js]
+        Rails.application.config.assets.precompile += %w[application.css]"
       end
     end
 
@@ -340,5 +373,20 @@ module GeoblacklightAdmin
         "\nconfig.add_facet_field Settings.FIELDS.B1G_IMPORT_ID, label: 'Import ID', show: false\n"
       end
     end
+
+    def add_vite_rails_config
+      copy_file "base.html.erb", "app/views/layouts/blacklight/base.html.erb", force: true
+      copy_file "vite.config.ts", "vite.config.ts", force: true
+      copy_file "config/vite.json", "config/vite.json", force: true
+      copy_file "frontend/entrypoints/application.js", "app/javascript/entrypoints/application.js", force: true
+    end
+
+    # Run bundle with vite install
+    def bundle_install
+      Bundler.with_clean_env do
+        run "bundle install"
+        run "bundle exec vite install"
+      end
+    end
   end
 end

data/lib/generators/geoblacklight_admin/install_generator.rb

@@ -45,6 +45,7 @@ module GeoblacklightAdmin
     end
 
     def install_yarn
+      run "yarn add @geoblacklight/frontend@^4.4.6"
       run "yarn install"
     end
   end

data/lib/generators/geoblacklight_admin/templates/api_controller.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "blacklight/catalog"
-
 # Admin::ApiController
 module Admin
   class ApiController < ApplicationController

data/lib/generators/geoblacklight_admin/templates/base.html.erb

@@ -0,0 +1,53 @@
+<!DOCTYPE html>
+<%= content_tag :html, class: 'no-js', **html_tag_attributes do %>
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <meta name="geoblacklight-version" content="<%= Geoblacklight::VERSION %>">
+
+    <!-- Internet Explorer use the highest version available -->
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+
+    <title><%= render_page_title %></title>
+    <script>
+      document.querySelector('html').classList.remove('no-js');
+    </script>
+    <%= opensearch_description_tag application_name, opensearch_catalog_url(format: 'xml') %>
+    <%= favicon_link_tag %>
+    <%= stylesheet_link_tag "application", media: "all", "data-turbo-track": "reload" %>
+    <%= javascript_include_tag "application", "data-turbo-track": "reload" %>    
+
+    <%= vite_client_tag %>
+    <%= vite_javascript_tag 'application' %>
+    <% if openlayers_container? %>
+      <%= vite_javascript_tag 'ol' %>
+    <% elsif iiif_manifest_container? %>
+      <%= vite_javascript_tag 'clover' %>
+    <% end %>
+
+    <%= csrf_meta_tags %>
+    <%= content_for(:head) %>
+  </head>
+  <body class="<%= render_body_class %>">
+    <nav id="skip-link" role="navigation" aria-label="<%= t('blacklight.skip_links.label') %>">
+      <%= link_to t('blacklight.skip_links.search_field'), '#search_field', class: 'element-invisible element-focusable rounded-bottom py-2 px-3', data: { turbolinks: 'false' } %>
+      <%= link_to t('blacklight.skip_links.main_content'), '#main-container', class: 'element-invisible element-focusable rounded-bottom py-2 px-3', data: { turbolinks: 'false' } %>
+      <%= content_for(:skip_links) %>
+    </nav>
+    <%= render partial: 'shared/header_navbar' %>
+
+    <main id="main-container" class="<%= container_classes %>" role="main" aria-label="<%= t('blacklight.main.aria.main_container') %>">
+      <%= content_for(:container_header) %>
+
+      <%= render partial: 'shared/flash_msg', layout: 'shared/flash_messages' %>
+
+      <div class="row">
+        <%= content_for?(:content) ? yield(:content) : yield %>
+      </div>
+    </main>
+
+    <%= render partial: 'shared/footer' %>
+    <%= render partial: 'shared/modal' %>
+  </body>
+<% end %>

data/lib/generators/geoblacklight_admin/templates/config/initializers/kithe.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "simple_form"
 require "kithe"
 
 traject_logger = ActiveSupport::Logger.new("#{Rails.root}/log/traject.log")

data/lib/generators/geoblacklight_admin/templates/config/settings.yml

@@ -125,6 +125,8 @@ WEBSERVICES_SHOWN:
   - 'tiled_map_layer'
   - 'dynamic_map_layer'
   - 'image_map_layer'
+  - 'cog'
+  - 'pmtiles'
 
 # Display Notes to display / Non-prefixed default bootstrap class is alert-secondary
 DISPLAY_NOTES_SHOWN:
@@ -287,10 +289,22 @@ HELP_TEXT:
       - 'wms'
       - 'tms'
       - 'oembed'
+      - 'cog'
+      - 'pmtiles'
+
 
 # Enable catalog#show sidebar static map for items with the following viewer protocols
 SIDEBAR_STATIC_MAP:
   - 'iiif'
   - 'iiif_manifest'
 
-GBLSI_THUMBNAIL_FIELD: 'b1g_image_ss'
+GBLSI_THUMBNAIL_FIELD: 'b1g_image_ss'
+
+#########
+# GBL ADMIN SETTINGS
+
+# Used to generate derivatives in app/uploaders/asset_uploader.rb
+# Hash of thumbnail sizes
+GBL_ADMIN_THUMBNAIL_WIDTHS:
+  mini: 50
+  standard: 200

data/lib/generators/geoblacklight_admin/templates/config/vite.json

@@ -0,0 +1,16 @@
+{
+  "all": {
+    "sourceCodeDir": "app/javascript",
+    "watchAdditionalPaths": []
+  },
+  "development": {
+    "autoBuild": true,
+    "publicOutputDir": "vite-dev",
+    "port": 3036
+  },
+  "test": {
+    "autoBuild": true,
+    "publicOutputDir": "vite-test",
+    "port": 3037
+  }
+}

data/lib/generators/geoblacklight_admin/templates/frontend/entrypoints/application.js

@@ -0,0 +1,30 @@
+// To see this message, add the following to the `<head>` section in your
+// views/layouts/application.html.erb
+//
+//    <%= vite_client_tag %>
+//    <%= vite_javascript_tag 'application' %>
+console.log('Vite ⚡️ Rails - Local')
+
+// If using a TypeScript entrypoint file:
+//     <%= vite_typescript_tag 'application' %>
+//
+// If you want to use .jsx or .tsx, add the extension:
+//     <%= vite_javascript_tag 'application.jsx' %>
+
+// console.log('Visit the guide for more information: ', 'https://vite-ruby.netlify.app/guide/rails')
+
+// Example: Load Rails libraries in Vite.
+//
+// import * as Turbo from '@hotwired/turbo'
+// Turbo.start()
+//
+// import ActiveStorage from '@rails/activestorage'
+// ActiveStorage.start()
+//
+// // Import all channels.
+// const channels = import.meta.globEager('./**/*_channel.js')
+
+// Example: Import a stylesheet in app/frontend/index.css
+// import '~/index.css'
+
+import '@geoblacklight/admin'

data/lib/generators/geoblacklight_admin/templates/package-test.json

@@ -0,0 +1,10 @@
+{
+  "devDependencies": {
+    "vite": "^5.1.5",
+    "vite-plugin-ruby": "^5.0.0",
+    "vite-plugin-rails": "^0.5.0"
+  },
+  "scripts": {
+    "postinstall": "yarn link @geoblacklight/admin"
+  }
+}

data/lib/generators/geoblacklight_admin/templates/package.json

@@ -1,35 +1,11 @@
 {
-  "name": "internal",
-  "private": true,
   "dependencies": {
-    "@babel/plugin-proposal-private-methods": "^7.18.6",
-    "@babel/plugin-proposal-private-property-in-object": "^7.20.0",
-    "@nathanvda/cocoon": "^1.2.14",
-    "@rails/actioncable": "^6.0.0",
-    "@rails/activestorage": "^6.0.0",
-    "@rails/ujs": "^6.0.0",
-    "@rails/webpacker": "5.4.3",
-    "bootstrap": "^4.5.0",
-    "bootstrap-datepicker": "^1.9.0",
-    "chosen-jquery": "^0.1.1",
-    "devbridge-autocomplete": "^1.4.10",
-    "highcharts": "^9.3.2",
-    "i18n": "^0.15.1",
-    "inputmask": "^5.0.3",
-    "moment": "^2.29.4",
-    "node-forge": "^1.0.0",
-    "popper.js": "^1.16.1",
-    "serialize-javascript": "^3.1.0",
-    "shave": "^2.5.10",
-    "stimulus": "^1.1.1",
-    "stimulus-scroll-to": "^2.0.1",
-    "turbolinks": "^5.2.0",
-    "webpack": "^4.46.0",
-    "webpack-cli": "^3.3.12",
-    "yargs-parser": "^13.1.2"
+    "@geoblacklight/frontend": "^4.4",
+    "@geoblacklight/admin": "^0.4"
   },
-  "version": "0.1.0",
   "devDependencies": {
-    "webpack-dev-server": "^3"
+    "vite": "^5.1.5",
+    "vite-plugin-ruby": "^5.0.0",
+    "vite-plugin-rails": "^0.5.0"
   }
 }

data/lib/generators/geoblacklight_admin/templates/vite.config.ts

@@ -0,0 +1,8 @@
+import { defineConfig } from 'vite'
+import rails from 'vite-plugin-rails'
+
+export default defineConfig({
+  plugins: [
+    rails(),
+  ]
+})

data/lib/geoblacklight_admin/engine.rb

@@ -9,6 +9,7 @@ module GeoblacklightAdmin
     initializer "geoblacklight_admin.helpers" do
       config.after_initialize do
         ActionView::Base.include GeoblacklightAdminHelper
+        ActionView::Base.include AssetHelper
         ActionView::Base.include BulkActionsHelper
         ActionView::Base.include DocumentHelper
         ActionView::Base.include FormInputHelper

data/lib/geoblacklight_admin/rake_task.rb

@@ -0,0 +1,5 @@
+module GeoblacklightAdmin
+  module RakeTask
+    Dir[File.expand_path(File.join(File.dirname(__FILE__), "tasks/*.rake"))].each { |ext| load ext } if defined?(Rake)
+  end
+end

data/lib/geoblacklight_admin/tasks/images.rake

@@ -0,0 +1,33 @@
+require "csv"
+
+namespace :geoblacklight_admin do
+  namespace :images do
+    desc "Harvest image for specific document - priority queue"
+    task harvest_doc_id: :environment do
+      GeoblacklightAdmin::StoreImageJob.perform_later(ENV["DOC_ID"], nil, :priority)
+    end
+
+    desc "Harvest all images - uses low priority queue"
+    task harvest_all: [:environment] do
+      cursor_mark = "*"
+      loop do
+        response = Blacklight.default_index.connection.get(
+          "select", params: {
+            q: "*:*", # all docs
+            fl: "geomg_id_s, id",
+            cursorMark: cursor_mark, # use the cursor mark to handle paging
+            rows: 1000,
+            sort: "geomg_id_s asc" # must sort by id to use the cursor mark
+          }
+        )
+
+        response["response"]["docs"].each do |doc|
+          GeoblacklightAdmin::StoreImageJob.perform_later(doc["id"], nil, :low_priority)
+        end
+
+        break if response["nextCursorMark"] == cursor_mark # this means the result set is finished
+        cursor_mark = response["nextCursorMark"]
+      end
+    end
+  end
+end

data/lib/geoblacklight_admin/tasks/solr.rake

@@ -0,0 +1,11 @@
+require "csv"
+
+namespace :geoblacklight_admin do
+  namespace :solr do
+    desc "Delete orphans from Solr"
+    task delete_orphans: :environment do
+      deleted_orphans = GeoblacklightAdmin::SolrUtils.delete_solr_orphans(batch_size: 1000)
+      puts "Deleted: #{deleted_orphans.inspect}"
+    end
+  end
+end

data/lib/geoblacklight_admin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GeoblacklightAdmin
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end