bulkrax 9.3.5 → 9.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7205ae1ec1e6287a3afe95e94df9e3f7afcdb72ad0d6e934cca44004b28e8a4
-  data.tar.gz: bae60650dc0ad54df42c9aa7da87829039462f6159c25b296a029c28f99006e8
+  metadata.gz: 05440b3212ae1571e13cd9ee789c0222b8113a2cf717e4fc84a14f3c2aa2627a
+  data.tar.gz: 99d843e51cb362be57e279246fc63937b0772429368142a5a383e7b0a1ccfa4a
 SHA512:
-  metadata.gz: 7b81763a20e21c294bf0fa56479cafc506fdc589f31c11d3bbd0383b28fda247734f3abe4d0797e5601abd64815aa457ea8d908bfbf427a03fa5e500bbfe60d2
-  data.tar.gz: e34566bafe813523345aaa41b2ad9fc2921e78be118250dfa911453fba185ea25cea6f74440fa6d5ddbb1dbcc699aca1f4ca5d3eb139c3dae65d27953de5f45d
+  metadata.gz: 7c8d2bd4ec608ceea8b567ebf39972c3e14b300731b8202d133e9a541e29995e69ed6f1dc1528ed5d0c877e38664f05260a60147985da08b65a8c3630cb80ebb
+  data.tar.gz: b4a1956d149a23c0bfc299ef3235a36c1d680784283957cb8fe56b06a3745f94d810318a58c9b791a193a76cd218f78129d8e8773b0ff78f8c73bb38d9e6975f

data/README.md

@@ -195,6 +195,16 @@ Once your the exporter has run, a download icon will appear on the exporters men
 * Ruby 2.7 or newer is required
 * Hyrax 2.3 or newer is required
 
+## Translations
+
+The [i18n-tasks gem](https://github.com/glebm/i18n-tasks) is a static analysis tool that helps manage Rails locale files. It scans the codebase for calls to `t()` and `I18n.t()` and creates a list of all the translation keys then compares that list against what actually exists in the locale files.
+
+Useful commands:
+- `bundle exec i18n-tasks` - a list of all tasks
+- `i18n-tasks health` - check for unused keys and files that need formatting
+- `i18n-tasks normalize` - sort and auto-format
+- `i18n-tasks translate-missing` - creates missing translations; **NOTE**: requires a service such as Google Translate
+
 ## Contributing
 If you're working on a PR for this project, create a feature branch off of `main`.
 
@@ -204,7 +214,7 @@ See
 [CONTRIBUTING.md](https://github.com/samvera/bulkrax/blob/main/CONTRIBUTING.md)
 for contributing guidelines.
 
-We encourage everyone to help improve this project.  Bug reports and pull requests are welcome on GitHub at https://github.com/samvera/bulkrax.
+We encourage everyone to help improve this project.  Bug reports and pull requests are welcome on GitHub at https://github.com/samvera/bulkrax. For guided import bugs, use the [Guided import bug report](https://github.com/samvera/bulkrax/issues/new?template=guided_import_bug_report.md) template.
 
 This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://contributor-covenant.org) code of conduct.
 

data/app/assets/javascripts/bulkrax/application.js

@@ -10,5 +10,6 @@
 // Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
 // about supported directives.
 //
-
+// IMPORTANT: bulkrax_utils must load first as other files depend on it
+//= require bulkrax/bulkrax_utils
 //= require_tree .

data/app/assets/javascripts/bulkrax/bulkrax.js

@@ -1,16 +1,16 @@
 // Global JS file for Bulkrax
 
-$(document).on('turbolinks:load ready', function() {
+function setupGlobalListeners() {
   // Apply to Importer and Exporter views
   $('button#err_toggle').click(function() {
     $('#error_trace').toggle();
   });
-  
+
   $('button#fm_toggle').click(function() {
     $('#field_mapping').toggle();
   });
 
-  $('#bulkraxItemModal').on('show.bs.modal', function (event) {
+  $('#bulkraxItemModal').on('show.bs.modal', function(event) {
     var button = $(event.relatedTarget); // Button that triggered the modal
     var recipient = button.data('entry-id'); // Extract info from data-* attributes
     // If necessary, you could initiate an AJAX request here (and then do the updating in a callback).
@@ -21,4 +21,13 @@ $(document).on('turbolinks:load ready', function() {
     });
     return true;
   });
-});
+}
+
+// Use Turbolinks if available, fallback to Turbo if available, fallback to vanilla JS if needed.
+if (typeof Turbolinks !== 'undefined' && Turbolinks !== null) {
+  $(document).on('turbolinks:load ready', setupGlobalListeners);
+} else if (typeof Turbo !== 'undefined') {
+  $(document).on('turbo:load ready', setupGlobalListeners);
+} else {
+  $(document).on('ready', setupGlobalListeners);
+}

data/app/assets/javascripts/bulkrax/bulkrax_utils.js

@@ -0,0 +1,96 @@
+// Bulkrax Utilities - Reusable helper functions
+// Used across Bulkrax JavaScript modules
+
+; (function () {
+  'use strict'
+
+  // Create namespace
+  window.BulkraxUtils = window.BulkraxUtils || {}
+
+  // ============================================================================
+  // HTML & STRING UTILITIES
+  // ============================================================================
+
+  /**
+   * Escape HTML to prevent XSS attacks
+   * @param {string} unsafe - Untrusted user input
+   * @returns {string} HTML-safe string
+   */
+  function escapeHtml(unsafe) {
+    if (!unsafe) return ''
+    return unsafe
+      .toString()
+      .replace(/&/g, '&')
+      .replace(/</g, '&lt;')
+      .replace(/>/g, '&gt;')
+      .replace(/"/g, '&quot;')
+      .replace(/'/g, '&#039;')
+  }
+
+  // ============================================================================
+  // FILE UTILITIES
+  // ============================================================================
+
+  /**
+   * Format file size in human-readable format
+   * @param {number} bytes - File size in bytes
+   * @returns {string} Formatted size (e.g., "1.5 MB")
+   */
+  function formatFileSize(bytes) {
+    if (bytes === 0) return '0 Bytes'
+    var k = 1024
+    var sizes = ['Bytes', 'KB', 'MB', 'GB']
+    var i = Math.floor(Math.log(bytes) / Math.log(k))
+    return Math.round((bytes / Math.pow(k, i)) * 100) / 100 + ' ' + sizes[i]
+  }
+
+  // ============================================================================
+  // DATA NORMALIZATION
+  // ============================================================================
+
+  /**
+   * Normalize boolean or string boolean to actual boolean
+   * Handles both boolean types and string representations
+   * @param {boolean|string} value - Value to normalize
+   * @returns {boolean|null} true, false, or null if indeterminate
+   */
+  function normalizeBoolean(value) {
+    if (value === true || value === 'true') return true
+    if (value === false || value === 'false') return false
+    return null
+  }
+
+  // ============================================================================
+  // INTERNATIONALIZATION
+  // ============================================================================
+
+  /**
+   * Look up a translation key from BulkraxI18n and interpolate variables.
+   * Falls back to the key name if not found.
+   * @param {string} key - Translation key (e.g. 'file_upload_error')
+   * @param {Object} [vars] - Interpolation variables (e.g. {count: 5})
+   * @returns {string} Translated and interpolated string
+   */
+  function t(key, vars) {
+    var translations = window.BulkraxI18n || {}
+    var text = translations[key]
+    if (text == null) return key
+    if (vars) {
+      Object.keys(vars).forEach(function (k) {
+        text = text.replace(new RegExp('%\\{' + k + '\\}', 'g'), vars[k])
+      })
+    }
+    return text
+  }
+
+  // ============================================================================
+  // PUBLIC API
+  // ============================================================================
+
+  window.BulkraxUtils = {
+    escapeHtml: escapeHtml,
+    formatFileSize: formatFileSize,
+    normalizeBoolean: normalizeBoolean,
+    t: t
+  }
+})()

data/app/assets/javascripts/bulkrax/datatables.js

@@ -45,6 +45,7 @@ Blacklight.onLoad(function() {
       "ajax": window.location.href.replace(/(\/importers)/, "$1/importer_table.json"),
       "pageLength": 30,
       "lengthMenu": [[30, 100, 200], [30, 100, 200]],
+      "order": [[2, 'desc']],
       "columns": [
         { "data": "name" },
         { "data": "status_message" },

data/app/assets/javascripts/bulkrax/entries.js

@@ -1,15 +1,22 @@
-$( document ).on('turbolinks:load ready', function() {
-  
-  $( "button#entry_error" ).click(function() {
-    $( "#error_trace" ).toggle();
+function setupButtonToggles() {
+  $("button#entry_error").click(function() {
+    $("#error_trace").toggle();
   });
 
-  $( "button#raw_button" ).click(function() {
-    $( "#raw_metadata" ).toggle();
+  $("button#raw_button").click(function() {
+    $("#raw_metadata").toggle();
   });
 
-  $( "button#parsed_button" ).click(function() {
-    $( "#parsed_metadata" ).toggle();
+  $("button#parsed_button").click(function() {
+    $("#parsed_metadata").toggle();
   });
-  
-})
+}
+
+// Use Turbolinks if available, fallback to Turbo if available, fallback to vanilla JS if needed.
+if (typeof Turbolinks !== 'undefined' && Turbolinks !== null) {
+  $(document).on('turbolinks:load ready', setupButtonToggles());
+} else if (typeof Turbo !== 'undefined') {
+  $(document).on('turbo:load ready', setupButtonToggles());
+} else {
+  $(document).on('DOMContentLoaded', setupButtonToggles());
+}

data/app/assets/javascripts/bulkrax/importers.js.erb

@@ -3,7 +3,7 @@
 
 function prepBulkrax(event) {
   if($('form#new_importer, form.edit_importer').length < 1) {
-    return true;
+    return;
   }
 
   var refresh_button = $('.refresh-set-source');
@@ -247,4 +247,11 @@ function setError(selector, error) {
   selector.attr('disabled', true);
 }
 
-$(document).on({'ready': prepBulkrax, 'turbolinks:load': prepBulkrax});
+// Use Turbolinks if available, fallback to Turbo if available, fallback to jQuery if needed.
+if (typeof Turbolinks !== 'undefined' && Turbolinks !== null) {
+  $(document).on('turbolinks:load', prepBulkrax);
+} else if (typeof Turbo !== 'undefined') {
+  $(document).on('turbo:load', prepBulkrax);
+} else {
+  $(document).ready(prepBulkrax);
+}