bulkrax 5.4.0 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56ac96f944d880492d7f7aa50870557ba81cf2ed23875751509b3ec23411644b
-  data.tar.gz: f18c9fa1d5a968d9214587476f2f949e04015e1402f6cb2ac516616669567c0e
+  metadata.gz: 5935f574678e9ff331fb1c3e637512e81aaf133acd44ac6ba413828b663c3cf1
+  data.tar.gz: d4a44f4fe47171d22c131bb836ec348091c88fcaa011a2e3a61b4234c8bb3be3
 SHA512:
-  metadata.gz: 0556a64e91eb41a27597b717fbf9e1de0682d666f116397e64a1b58a64fffaaadfd2dac645fbd256e3bd14ffb9065ce5f0ceaac920296f6623629199a6e130b5
-  data.tar.gz: dada612e0ee38d0b74ceacedc5c034cb39e26111edc90c39afd0d04338f77c1e0c0857a4d983bd7bd24fe8d7e601e2b8a6c32242e3142b2faad3a3369cbf82c1
+  metadata.gz: d14475603489ad27d29db6536e4e6d50e3d3393845724a7d85cf0c674804f3b42fbe1430ff9eea0d7e16d5f0482760ca1615e5a55b66a791ff5eab60f1950ea6
+  data.tar.gz: e593a46744c543b2d9e140010178272b470427f726d3f91504b2e6969a15632f5cf467abe375f588b10b2b9821bcdc3b23730ecccb071b5e0411bbc4e794eb9c

data/README.md

@@ -1,3 +1,5 @@
+![Test Suite](https://github.com/samvera/bulkrax/actions/workflows/test.yml/badge.svg)
+![Test Suite](https://github.com/samvera/bulkrax/actions/workflows/lint.yml/badge.svg)
 # Bulkrax
 Bulkrax is a batteries included importer for Samvera applications. It currently includes support for OAI-PMH (DC and Qualified DC) and CSV out of the box. It is also designed to be extensible, allowing you to easily add new importers in to your application or to include them with other gems. Bulkrax provides a full admin interface including creating, editing, scheduling and reviewing imports.
 
@@ -10,7 +12,7 @@ Add this line to your application's Gemfile:
 ```ruby
 gem 'bulkrax'
 # or if using from github
-gem 'bulkrax', git: 'https://github.com/samvera-labs/bulkrax.git', branch: 'main'
+gem 'bulkrax', git: 'https://github.com/samvera/bulkrax.git', branch: 'main'
 ```
 
 And then execute:
@@ -72,7 +74,7 @@ Bulkrax.setup do |config|
 end
 ```
 
-The [configuration guide](https://github.com/samvera-labs/bulkrax/wiki/Configuring-Bulkrax) provides detailed instructions on the various available configurations.
+The [configuration guide](https://github.com/samvera/bulkrax/wiki/Configuring-Bulkrax) provides detailed instructions on the various available configurations.
 
 Example:
 
@@ -122,7 +124,7 @@ It's unlikely that the incoming import data has fields that exactly match those
 
 By default, a mapping for the OAI parser has been added to map standard oai_dc fields to Hyrax basic_metadata. The other parsers have no default mapping, and will map any incoming fields to Hyrax properties with the same name. Configurations can be added in `config/initializers/bulkrax.rb`
 
-Configuring field mappings is documented in the [Bulkrax Configuration Guide](https://github.com/samvera-labs/bulkrax/wiki/Configuring-Bulkrax).
+Configuring field mappings is documented in the [Bulkrax Configuration Guide](https://github.com/samvera/bulkrax/wiki/Configuring-Bulkrax).
 
 ## Importing Files
 
@@ -153,7 +155,7 @@ end
 
 ## Customizing Bulkrax
 
-For further information on how to extend and customize Bulkrax, please see the [Bulkrax Customization Guide](https://github.com/samvera-labs/bulkrax/wiki/Customizing-Bulkrax).
+For further information on how to extend and customize Bulkrax, please see the [Bulkrax Customization Guide](https://github.com/samvera/bulkrax/wiki/Customizing-Bulkrax).
 
 ## How it Works
 Once you have Bulkrax installed, you will have access to an easy to use interface with which you are able to create, edit, delete, run, and re-run imports and exports.
@@ -180,16 +182,21 @@ To delete an importer or exporter, select the delete (x) icon.
 ### Downloading an export
 Once your the exporter has run, a download icon will appear on the exporters menu page.
 
+## Compatibility
+
+* Ruby 2.7 or newer is required
+* Hyrax 2.3 or newer is required
+
 ## Contributing
 If you're working on a PR for this project, create a feature branch off of `main`.
 
 This repository follows the [Samvera Community Code of Conduct](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405212316/Code+of+Conduct) and [language recommendations](https://github.com/samvera/maintenance/blob/master/templates/CONTRIBUTING.md#language).  Please ***do not*** create a branch called `master` for this repository or as part of your pull request; the branch will either need to be removed or renamed before it can be considered for inclusion in the code base and history of this repository.
 
 See
-[CONTRIBUTING.md](https://github.com/samvera-labs/bulkrax/blob/main/CONTRIBUTING.md)
+[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-labs/bulkrax.
+We encourage everyone to help improve this project.  Bug reports and pull requests are welcome on GitHub at https://github.com/samvera/bulkrax.
 
 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/exporters.js

@@ -14,7 +14,7 @@ function hideUnhide(field) {
   }
 };
 
-function addRequired(selectedSource) {  
+function addRequired(selectedSource) {
   selectedSource.addClass('required').attr('required', 'required');
   selectedSource.parent().addClass('required');
 }
@@ -26,14 +26,14 @@ function removeRequired(allSources) {
 
 // hide all export_source
 function hide(allSources) {
-  allSources.addClass('hidden');
-  allSources.find('#exporter_export_source').addClass('hidden').attr('type', 'hidden');
+  allSources.addClass('d-none');
+  allSources.find('#exporter_export_source').addClass('.d-none').attr('type', 'd-none');
 }
 
 // unhide selected export_source
 function unhideSelected(selectedSource) {
-  selectedSource.removeClass('hidden').removeAttr('type');
-  selectedSource.parent().removeClass('hidden').removeAttr('type');
+  selectedSource.removeClass('d-none').removeAttr('type');
+  selectedSource.parent().removeClass('d-none').removeAttr('type');
 };
 
 // add the autocomplete javascript

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

@@ -1,9 +1,26 @@
 <% unless defined?(::Hyku) %>
   // enables the tabs in the importers/exporters pages.
   $(document).ready(function() {
-    $('.nav-tabs a').click(function (e) {
+    $('.bulkrax-nav-tab-top-margin.nav-tabs a').click(function(e) {
       e.preventDefault();
-      $(this).tab('show');
+
+      // Remove active class from all tabs and hide all tab content
+      $('.bulkrax-nav-tab-top-margin.nav-tabs a').parent().removeClass('active');
+      $('.tab-content .tab-pane').removeClass('active');
+
+      // Add active class to clicked tab and show its content
+      $(this).parent().addClass('active');
+      $($(this).attr('href')).addClass('active');
     });
+
+    $('#full-errors-tab, #full-errors-tab a').click(function(e) {
+      $('#raw-errors-tab, #bulkrax-raw-toggle-1').removeClass('active');
+      $('#full-errors-tab, #bulkrax-full-toggle-1').addClass('active');
+    })
+
+    $('#raw-errors-tab, #raw-errors-tab a').click(function(e) {
+      $('#full-errors-tab, #bulkrax-full-toggle-1').removeClass('active');
+      $('#raw-errors-tab, #bulkrax-raw-toggle-1').addClass('active');
+    })
   });
 <% end %>

data/app/factories/bulkrax/object_factory.rb

@@ -103,7 +103,11 @@ module Bulkrax
     end
 
     def search_by_identifier
-      work_index = ::ActiveFedora.index_field_mapper.solr_name(work_identifier, :facetable)
+      # TODO(alishaevn): return the proper `work_index` value below
+      # ref: https://github.com/samvera-labs/bulkrax/issues/866
+      # ref:https://github.com/samvera-labs/bulkrax/issues/867
+      # work_index = ::ActiveFedora.index_field_mapper.solr_name(work_identifier, :facetable)
+      work_index = work_identifier
       query = { work_index =>
                 source_identifier_value }
       # Query can return partial matches (something6 matches both something6 and something68)
@@ -119,7 +123,7 @@ module Bulkrax
     def create
       attrs = transform_attributes
       @object = klass.new
-      object.reindex_extent = Hyrax::Adapters::NestingIndexAdapter::LIMITED_REINDEX if object.respond_to?(:reindex_extent)
+      object.reindex_extent = Hyrax::Adapters::NestingIndexAdapter::LIMITED_REINDEX if defined?(Hyrax::Adapters::NestingIndexAdapter) && object.respond_to?(:reindex_extent)
       run_callbacks :save do
         run_callbacks :create do
           if klass == Collection
@@ -249,7 +253,7 @@ module Bulkrax
     def collection_type(attrs)
       return attrs if attrs['collection_type_gid'].present?
 
-      attrs['collection_type_gid'] = Hyrax::CollectionType.find_or_create_default_collection_type.gid
+      attrs['collection_type_gid'] = Hyrax::CollectionType.find_or_create_default_collection_type.to_global_id.to_s
       attrs
     end
 

data/app/jobs/bulkrax/create_relationships_job.rb

@@ -98,7 +98,7 @@ module Bulkrax
 
       if errors.present?
         # rubocop:disable Rails/SkipsModelValidations
-        importer_run.increment!(:failed_relationships, number_of_failures)
+        ImporterRun.update_counters(importer_run_id, failed_relationships: number_of_failures)
         # rubocop:enable Rails/SkipsModelValidations
 
         parent_entry&.set_status_info(errors.last, importer_run)
@@ -108,7 +108,7 @@ module Bulkrax
         return false # stop current job from continuing to run after rescheduling
       else
         # rubocop:disable Rails/SkipsModelValidations
-        Bulkrax::ImporterRun.find(importer_run_id).increment!(:processed_relationships, number_of_successes)
+        ImporterRun.update_counters(importer_run_id, processed_relationships: number_of_successes)
         # rubocop:enable Rails/SkipsModelValidations
       end
     end
@@ -158,7 +158,8 @@ module Bulkrax
     end
 
     def add_to_collection(child_record, parent_record)
-      parent_record.try(:reindex_extent=, Hyrax::Adapters::NestingIndexAdapter::LIMITED_REINDEX)
+      parent_record.try(:reindex_extent=, Hyrax::Adapters::NestingIndexAdapter::LIMITED_REINDEX) if
+        defined?(Hyrax::Adapters::NestingIndexAdapter)
       child_record.member_of_collections << parent_record
       child_record.save!
     end

data/app/jobs/bulkrax/delete_job.rb

@@ -4,17 +4,17 @@ module Bulkrax
   class DeleteJob < ApplicationJob
     queue_as :import
 
-    # rubocop:disable Rails/SkipsModelValidations
     def perform(entry, importer_run)
       obj = entry.factory.find
       obj&.delete
-      ImporterRun.find(importer_run.id).increment!(:deleted_records)
-      ImporterRun.find(importer_run.id).decrement!(:enqueued_records)
+      # rubocop:disable Rails/SkipsModelValidations
+      ImporterRun.increment_counter(:deleted_records, importer_run.id)
+      ImporterRun.decrement_counter(:enqueued_records, importer_run.id)
+      # rubocop:enable Rails/SkipsModelValidations
       entry.save!
       entry.importer.current_run = ImporterRun.find(importer_run.id)
       entry.importer.record_status
       entry.set_status_info("Deleted", ImporterRun.find(importer_run.id))
     end
-    # rubocop:enable Rails/SkipsModelValidations
   end
 end

data/app/jobs/bulkrax/export_work_job.rb

@@ -12,17 +12,17 @@ module Bulkrax
         entry.save
       rescue StandardError
         # rubocop:disable Rails/SkipsModelValidations
-        exporter_run.increment!(:failed_records)
-        exporter_run.decrement!(:enqueued_records) unless exporter_run.enqueued_records <= 0
+        ExporterRun.increment_counter(:failed_records, args[1])
+        ExporterRun.decrement_counter(:enqueued_records, args[1]) unless exporter_run.reload.enqueued_records <= 0
         raise
       else
         if entry.failed?
-          exporter_run.increment!(:failed_records)
-          exporter_run.decrement!(:enqueued_records) unless exporter_run.enqueued_records <= 0
+          ExporterRun.increment_counter(:failed_records, args[1])
+          ExporterRun.decrement_counter(:enqueued_records, args[1]) unless exporter_run.reload.enqueued_records <= 0
           raise entry.reload.current_status.error_class.constantize
         else
-          exporter_run.increment!(:processed_records)
-          exporter_run.decrement!(:enqueued_records) unless exporter_run.enqueued_records <= 0
+          ExporterRun.increment_counter(:processed_records, args[1])
+          ExporterRun.decrement_counter(:enqueued_records, args[1]) unless exporter_run.reload.enqueued_records <= 0
         end
         # rubocop:enable Rails/SkipsModelValidations
       end

data/app/jobs/bulkrax/import_collection_job.rb

@@ -10,13 +10,13 @@ module Bulkrax
       begin
         entry.build
         entry.save!
-        ImporterRun.find(args[1]).increment!(:processed_records)
-        ImporterRun.find(args[1]).increment!(:processed_collections)
-        ImporterRun.find(args[1]).decrement!(:enqueued_records) unless ImporterRun.find(args[1]).enqueued_records <= 0 # rubocop:disable Style/IdenticalConditionalBranches
+        ImporterRun.increment_counter(:processed_records, args[1])
+        ImporterRun.increment_counter(:processed_collections, args[1])
+        ImporterRun.decrement_counter(:enqueued_records, args[1]) unless ImporterRun.find(args[1]).enqueued_records <= 0 # rubocop:disable Style/IdenticalConditionalBranches
       rescue => e
-        ImporterRun.find(args[1]).increment!(:failed_records)
-        ImporterRun.find(args[1]).increment!(:failed_collections)
-        ImporterRun.find(args[1]).decrement!(:enqueued_records) unless ImporterRun.find(args[1]).enqueued_records <= 0 # rubocop:disable Style/IdenticalConditionalBranches
+        ImporterRun.increment_counter(:failed_records, args[1])
+        ImporterRun.increment_counter(:failed_collections, args[1])
+        ImporterRun.decrement_counter(:enqueued_records, args[1]) unless ImporterRun.find(args[1]).enqueued_records <= 0 # rubocop:disable Style/IdenticalConditionalBranches
         raise e
       end
       entry.importer.current_run = ImporterRun.find(args[1])

data/app/jobs/bulkrax/import_file_set_job.rb

@@ -21,14 +21,14 @@ module Bulkrax
       entry.build
       if entry.succeeded?
         # rubocop:disable Rails/SkipsModelValidations
-        ImporterRun.find(importer_run_id).increment!(:processed_records)
-        ImporterRun.find(importer_run_id).increment!(:processed_file_sets)
+        ImporterRun.increment_counter(:processed_records, importer_run_id)
+        ImporterRun.increment_counter(:processed_file_sets, importer_run_id)
       else
-        ImporterRun.find(importer_run_id).increment!(:failed_records)
-        ImporterRun.find(importer_run_id).increment!(:failed_file_sets)
+        ImporterRun.increment_counter(:failed_records, importer_run_id)
+        ImporterRun.increment_counter(:failed_file_sets, importer_run_id)
         # rubocop:enable Rails/SkipsModelValidations
       end
-      ImporterRun.find(importer_run_id).decrement!(:enqueued_records) unless ImporterRun.find(importer_run_id).enqueued_records <= 0 # rubocop:disable Rails/SkipsModelValidations
+      ImporterRun.decrement_counter(:enqueued_records, importer_run_id) unless ImporterRun.find(importer_run_id).enqueued_records <= 0 # rubocop:disable Rails/SkipsModelValidations
       entry.save!
       entry.importer.current_run = ImporterRun.find(importer_run_id)
       entry.importer.record_status
@@ -40,7 +40,7 @@ module Bulkrax
       if entry.import_attempts < 5
         ImportFileSetJob.set(wait: (entry.import_attempts + 1).minutes).perform_later(entry_id, importer_run_id)
       else
-        ImporterRun.find(importer_run_id).decrement!(:enqueued_records) # rubocop:disable Rails/SkipsModelValidations
+        ImporterRun.decrement_counter(:enqueued_records, importer_run_id) # rubocop:disable Rails/SkipsModelValidations
         entry.set_status_info(e)
       end
     end

data/app/jobs/bulkrax/import_work_job.rb

@@ -23,16 +23,16 @@ module Bulkrax
       entry = Entry.find(entry_id)
       entry.build
       if entry.status == "Complete"
-        ImporterRun.find(run_id).increment!(:processed_records)
-        ImporterRun.find(run_id).increment!(:processed_works)
+        ImporterRun.increment_counter(:processed_records, run_id)
+        ImporterRun.increment_counter(:processed_works, run_id)
       else
         # do not retry here because whatever parse error kept you from creating a work will likely
         # keep preventing you from doing so.
-        ImporterRun.find(run_id).increment!(:failed_records)
-        ImporterRun.find(run_id).increment!(:failed_works)
+        ImporterRun.increment_counter(:failed_records, run_id)
+        ImporterRun.increment_counter(:failed_works, run_id)
       end
       # Regardless of completion or not, we want to decrement the enqueued records.
-      ImporterRun.find(run_id).decrement!(:enqueued_records) unless ImporterRun.find(run_id).enqueued_records <= 0
+      ImporterRun.decrement_counter(:enqueued_records, run_id) unless ImporterRun.find(run_id).enqueued_records <= 0
 
       entry.save!
       entry.importer.current_run = ImporterRun.find(run_id)

data/app/models/bulkrax/csv_collection_entry.rb

@@ -15,7 +15,7 @@ module Bulkrax
     def add_collection_type_gid
       return if self.parsed_metadata['collection_type_gid'].present?
 
-      self.parsed_metadata['collection_type_gid'] = ::Hyrax::CollectionType.find_or_create_default_collection_type.gid
+      self.parsed_metadata['collection_type_gid'] = ::Hyrax::CollectionType.find_or_create_default_collection_type.to_global_id.to_s
     end
   end
 end

data/app/models/bulkrax/csv_entry.rb

@@ -88,8 +88,10 @@ module Bulkrax
 
     def validate_record
       raise StandardError, 'Record not found' if record.nil?
-      raise StandardError, "Missing required elements, missing element(s) are: "\
-"#{importerexporter.parser.missing_elements(record).join(', ')}" unless importerexporter.parser.required_elements?(record)
+      unless importerexporter.parser.required_elements?(record)
+        raise StandardError, "Missing required elements, missing element(s) are: "\
+"#{importerexporter.parser.missing_elements(record).join(', ')}"
+      end
     end
 
     def add_identifier

data/app/parsers/bulkrax/application_parser.rb

@@ -270,8 +270,8 @@ module Bulkrax
       current_run.invalid_records ||= ""
       current_run.invalid_records += message
       current_run.save
-      ImporterRun.find(current_run.id).increment!(:failed_records)
-      ImporterRun.find(current_run.id).decrement!(:enqueued_records) unless ImporterRun.find(current_run.id).enqueued_records <= 0 # rubocop:disable Style/IdenticalConditionalBranches
+      ImporterRun.increment_counter(:failed_records, current_run.id)
+      ImporterRun.decrement_counter(:enqueued_records, current_run.id) unless ImporterRun.find(current_run.id).enqueued_records <= 0 # rubocop:disable Style/IdenticalConditionalBranches
     end
     # rubocop:enable Rails/SkipsModelValidations
 

data/app/parsers/bulkrax/csv_parser.rb

@@ -33,9 +33,10 @@ module Bulkrax
           model_field_mappings.map(&:to_sym).each do |model_mapping|
             next unless r.key?(model_mapping)
 
-            if r[model_mapping].strip.casecmp('collection').zero?
+            model = r[model_mapping].nil? ? "" : r[model_mapping].strip
+            if model.casecmp('collection').zero?
               @collections << r
-            elsif r[model_mapping].strip.casecmp('fileset').zero?
+            elsif model.casecmp('fileset').zero?
               @file_sets << r
             else
               @works << r

data/app/parsers/bulkrax/oai_dc_parser.rb

@@ -67,7 +67,7 @@ module Bulkrax
       metadata = {
         visibility: 'open'
       }
-      metadata[:collection_type_gid] = Hyrax::CollectionType.find_or_create_default_collection_type.gid if defined?(::Hyrax)
+      metadata[:collection_type_gid] = Hyrax::CollectionType.find_or_create_default_collection_type.to_global_id.to_s if defined?(::Hyrax)
 
       collections.each_with_index do |set, index|
         next unless collection_name == 'all' || collection_name == set.spec

data/app/services/bulkrax/remove_relationships_for_importer.rb

@@ -63,7 +63,8 @@ module Bulkrax
           remove_relationships_from_work(obj)
         end
 
-        obj.try(:reindex_extent=, Hyrax::Adapters::NestingIndexAdapter::LIMITED_REINDEX) if defined?(Hyrax)
+        obj.try(:reindex_extent=, Hyrax::Adapters::NestingIndexAdapter::LIMITED_REINDEX) if
+          defined?(Hyrax::Adapters::NestingIndexAdapter)
         obj.save!
       end
     end

data/app/views/bulkrax/exporters/_form.html.erb

@@ -33,8 +33,8 @@
     label: t('bulkrax.exporter.labels.importer'),
     required: true,
     prompt: 'Select from the list',
-    label_html: { class: 'importer export-source-option hidden' },
-    input_html: { class: 'importer export-source-option hidden form-control' },
+    label_html: { class: 'importer export-source-option d-none' },
+    input_html: { class: 'importer export-source-option d-none form-control' },
     collection:  form.object.importers_list.sort %>
 
   <%= form.input :export_source_collection,
@@ -42,9 +42,9 @@
     label: t('bulkrax.exporter.labels.collection'),
     required: true,
     placeholder: @collection&.title&.first,
-    label_html: { class: 'collection export-source-option hidden' },
+    label_html: { class: 'collection export-source-option d-none' },
     input_html: {
-      class: 'collection export-source-option hidden form-control',
+      class: 'collection export-source-option d-none form-control',
       data: {
         'autocomplete-url' => '/authorities/search/collections',
         'autocomplete' => 'collection'
@@ -56,8 +56,8 @@
     label: t('bulkrax.exporter.labels.worktype'),
     required: true,
     prompt: 'Select from the list',
-    label_html: { class: 'worktype export-source-option hidden' },
-    input_html: { class: 'worktype export-source-option hidden form-control' },
+    label_html: { class: 'worktype export-source-option d-none' },
+    input_html: { class: 'worktype export-source-option d-none form-control' },
     collection: Bulkrax.curation_concerns.map { |cc| [cc.to_s, cc.to_s] } %>
 
   <%= form.input :limit,
@@ -80,7 +80,7 @@
                  as: :boolean,
                  label: t('bulkrax.exporter.labels.filter_by_date') %>
 
-  <div id="date_filter_picker" class="hidden">
+  <div id="date_filter_picker" class="d-none">
     <%= form.input :start_date,
                    as: :date,
                    label: t('bulkrax.exporter.labels.start_date'),
@@ -136,13 +136,13 @@
             // get the date filter option and show the corresponding date selectors
             $('.exporter_date_filter').change(function () {
                 if ($('.exporter_date_filter').find(".boolean").is(":checked"))
-                    $('#date_filter_picker').removeClass('hidden');
+                    $('#date_filter_picker').removeClass('d-none');
                 else
-                    $('#date_filter_picker').addClass('hidden');
+                    $('#date_filter_picker').addClass('d-none');
             });
 
             if ($('.exporter_date_filter').find(".boolean").is(":checked"))
-                $('#date_filter_picker').removeClass('hidden');
+                $('#date_filter_picker').removeClass('d-none');
         });
     });
 </script>

data/app/views/bulkrax/exporters/show.html.erb

@@ -96,9 +96,9 @@
     <div class="bulkrax-nav-tab-bottom-margin">
       <!-- Nav tabs -->
       <ul class="bulkrax-nav-tab-top-margin tab-nav nav nav-tabs" role="tablist">
-        <li role="presentation" class='active'><a href="#work-entries" aria-controls="work-entries" role="tab" data-toggle="tab"><%= t('bulkrax.exporter.labels.work_entries') %></a></li>
-        <li role="presentation"><a href="#collection-entries" aria-controls="collection-entries" role="tab" data-toggle="tab"><%= t('bulkrax.exporter.labels.collection_entries') %></a></li>
-        <li role="presentation"><a href="#file-set-entries" aria-controls="file-set-entries" role="tab" data-toggle="tab"><%= t('bulkrax.exporter.labels.file_set_entries') %></a></li>
+        <li role="presentation" class="nav-link active"><a href="#work-entries" aria-controls="work-entries" role="tab" data-toggle="tab"><%= t('bulkrax.exporter.labels.work_entries') %></a></li>
+        <li role="presentation" class="nav-link"><a href="#collection-entries" aria-controls="collection-entries" role="tab" data-toggle="tab"><%= t('bulkrax.exporter.labels.collection_entries') %></a></li>
+        <li role="presentation" class="nav-link"><a href="#file-set-entries" aria-controls="file-set-entries" role="tab" data-toggle="tab"><%= t('bulkrax.exporter.labels.file_set_entries') %></a></li>
       </ul>
       <!-- Tab panes -->
       <div class="tab-content outline">

data/app/views/bulkrax/importers/_oai_fields.html.erb

@@ -11,7 +11,7 @@
       ['Public', 'open'],
       ['Private', 'restricted'],
       ['Institution', 'authenticated']
-    ],x
+    ],
     selected: importer.parser_fields['visibility'] || 'open',
     input_html: { class: 'form-control' }
   %>

data/app/views/bulkrax/importers/show.html.erb

@@ -76,9 +76,9 @@
     <div class="bulkrax-nav-tab-bottom-margin">
       <!-- Nav tabs -->
       <ul class="bulkrax-nav-tab-top-margin tab-nav nav nav-tabs" role="tablist">
-        <li role="presentation" class='active'><a href="#work-entries" aria-controls="work-entries" role="tab" data-toggle="tab"><%= t('bulkrax.importer.labels.work_entries') %></a></li>
-        <li role="presentation"><a href="#collection-entries" aria-controls="collection-entries" role="tab" data-toggle="tab"><%= t('bulkrax.importer.labels.collection_entries') %></a></li>
-        <li role="presentation"><a href="#file-set-entries" aria-controls="file-set-entries" role="tab" data-toggle="tab"><%= t('bulkrax.importer.labels.file_set_entries') %></a></li>
+        <li role="presentation" class="nav-link active"><a href="#work-entries" aria-controls="work-entries" role="tab" data-toggle="tab"><%= t('bulkrax.importer.labels.work_entries') %></a></li>
+        <li role="presentation" class="nav-link"><a href="#collection-entries" aria-controls="collection-entries" role="tab" data-toggle="tab"><%= t('bulkrax.importer.labels.collection_entries') %></a></li>
+        <li role="presentation" class="nav-link"><a href="#file-set-entries" aria-controls="file-set-entries" role="tab" data-toggle="tab"><%= t('bulkrax.importer.labels.file_set_entries') %></a></li>
       </ul>
       <!-- Tab panes -->
       <div class="tab-content outline">

data/app/views/bulkrax/shared/_bulkrax_errors.html.erb

@@ -13,8 +13,8 @@
         <div class="bulkrax-nav-tab-bottom-margin">
           <!-- Toggle buttons -->
           <div class="btn-group pull-right" role="group" aria-label="...">
-            <button type="button" class="btn btn-default active"><a href="#bulkrax-full-toggle-1" aria-controls="bulkrax-full-toggle-1" role="tab" data-toggle="tab">Full</a></button>
-            <button type="button" class="btn btn-default"><a href="#bulkrax-raw-toggle-1" aria-controls="bulkrax-raw-toggle-1" role="tab" data-toggle="tab">Raw</a></button>
+            <button id="full-errors-tab" type="button" class="btn btn-default active"><a href="#bulkrax-full-toggle-1" aria-controls="bulkrax-full-toggle-1" role="tab" data-toggle="tab">Full</a></button>
+            <button id="raw-errors-tab" type="button" class="btn btn-default"><a href="#bulkrax-raw-toggle-1" aria-controls="bulkrax-raw-toggle-1" role="tab" data-toggle="tab">Raw</a></button>
           </div>
           <!-- Tab panes -->
           <div class="tab-content">

data/app/views/hyrax/dashboard/sidebar/_bulkrax_sidebar_additions.html.erb

@@ -1,12 +1,20 @@
 <% if current_ability.can_import_works? %>
-  <%= menu.nav_link(bulkrax.importers_path,
-                    title: t('bulkrax.admin.sidebar.importers')) do %>
+  <%= menu.nav_link(
+    bulkrax.importers_path,
+    title: t('bulkrax.admin.sidebar.importers'),
+    class: "nav-link",
+    onclick: "dontChangeAccordion(event);"
+  ) do %>
     <span class="fa fa-cloud-upload" aria-hidden="true"></span> <span class="sidebar-action-text"><%= t('bulkrax.admin.sidebar.importers') %></span>
   <% end %>
 <% end %>
 <% if current_ability.can_export_works? %>
-  <%= menu.nav_link(bulkrax.exporters_path,
-                    title: t('bulkrax.admin.sidebar.exporters')) do %>
+  <%= menu.nav_link(
+    bulkrax.exporters_path,
+    title: t('bulkrax.admin.sidebar.exporters'),
+    class: "nav-link",
+    onclick: "dontChangeAccordion(event);"
+  ) do %>
     <span class="fa fa-cloud-download" aria-hidden="true"></span> <span class="sidebar-action-text"><%= t('bulkrax.admin.sidebar.exporters') %></span>
   <% end %>
 <% end %>

data/db/migrate/20190731114016_change_importer_and_exporter_to_polymorphic.rb

@@ -6,11 +6,13 @@ end
 
 class ChangeImporterAndExporterToPolymorphic < ActiveRecord::Migration[5.1]
   def change
-    if column_exists?(:bulkrax_entries, :importer_id)
-      remove_foreign_key :bulkrax_entries, column: :importer_id
-      remove_index :bulkrax_entries, :importer_id
-      rename_column :bulkrax_entries, :importer_id, :importerexporter_id
+    begin # deal with odd bug around foreign keys in ci
+      remove_foreign_key :bulkrax_entries, column: :importer_id if foreign_key_exists?(:bulkrax_entries, column: :importer_id)
+    rescue ArgumentError
+      # do nothing
     end
+    remove_index :bulkrax_entries, :importer_id if index_exists?(:bulkrax_entries, :importer_id)
+    rename_column :bulkrax_entries, :importer_id, :importerexporter_id if column_exists?(:bulkrax_entries, :importer_id)
     add_column :bulkrax_entries, :importerexporter_type, :string, after: :id, default: 'Bulkrax::Importer' unless column_exists?(:bulkrax_entries, :importerexporter_type)
   end
 end

data/lib/bulkrax/entry_spec_helper.rb

@@ -10,13 +10,17 @@ module Bulkrax
   #
   # This module came about through a desire to expose a quick means of vetting the accuracy of the
   # different parsers.
+  #
+  # @see .entry_for
   module EntrySpecHelper
     ##
     # @api public
     # @since v5.0.1
     #
-    # The purpose of this method is encapsulate the logic of creating the appropriate Bulkrax::Entry
-    # object based on the given data, identifier, and parser_class_name.
+    # The purpose of this method is encapsulate the logic of creating the appropriate
+    # {Bulkrax::Entry} object based on the given data, identifier, and parser_class_name.  Due to
+    # the different means of instantiation of {Bulkrax::Entry} subclasses, there are several
+    # optional parameters.
     #
     # From that entry, you should be able to test how {Bulkrax::Entry#build_metadata} populates the
     # {Bulkrax::Entry#parsed_metadata} variable.  Other uses may emerge.
@@ -29,9 +33,47 @@ module Bulkrax
     # @param parser_class_name [String] The name of the parser class you're wanting to test.
     # @param type [Sybmol] The type of entry (e.g. :entry, :collection, :file_set) for testing.
     # @param options [Hash<Symbol,Object>] these are to be passed along into the instantiation of
-    #        the various classes.  See implementation details.
+    #        the various classes.
+    # @option options [String] importer_name (Optional) The name of the test importer.  One will be
+    #         auto-assigned if unprovided.
+    # @option options [String] importer_admin_set_id (Optional) The ID of an admin set to deposit
+    #         into.  One will be auto-assigned if unprovided.  And this admin set does not need to
+    #         be persisted nor exist.  It is simply a required parameter for instantiating an
+    #         importer.
+    # @option options [User] user (Optional) The user who is performing the import.  One will be
+    #         auto-assigned if unprovided.  The user does not need to be persisted.  It is simply a
+    #         required parameter for instantiating an importer
+    # @option options [Integer] limit (Optional) You really shouldn't need to set this, but for
+    #         completeness it is provided.
+    # @option options [Hash<String, Object>] importer_field_mappings Each parser class may require
+    #         different field mappings.  See the given examples for more details.
+    #
+    # @return [Bulkrax::Entry] a subclass of {Bulkrax::Entry} based on the application's
+    #         configuration.  It would behoove you to write a spec regarding the returned entry's
+    #         class.
+    #
+    # @example
+    #   entry = Bulkrax::EntrySpecHelper.entry_for(
+    #     data: { source_identifier: "123", title: "Hello World" },
+    #     parser_class_name: "Bulkrax::CsvParser",
+    #     importer_field_mappings: { 'import_file_path' => "path/to/file.csv" }
+    #   )
+    #
+    # @note In the case of the Bulkrax::CsvParser, the :data keyword is a Hash, where the keys are
+    #       the column name of the CSV you're importing.  The 'import_file_path' is a path to a CSV
+    #       file.  That CSV's columns does not need to match the :data's keys, though there may be
+    #       required headers on that CSV based on the parser implementation.
     #
-    # @return [Bulkrax::Entry]
+    # @example
+    #   entry = Bulkrax::EntrySpecHelper.entry_for(
+    #     identifier: identifier,
+    #     data: File.read("/path/to/some/file.xml"),
+    #     parser_class_name: "Bulkrax::OaiDcParser",
+    #     parser_fields: { "base_url" => "http://oai.adventistdigitallibrary.org/OAI-script" }
+    #   )
+    #
+    # @note In the case of an OaiParser, the :data keyword should be a String.  And you'll need to
+    #       provide a :parser_fields with a "base_url".
     def self.entry_for(data:, identifier:, parser_class_name:, type: :entry, **options)
       importer = importer_for(parser_class_name: parser_class_name, **options)
       entry_type_method_name = ENTRY_TYPE_TO_METHOD_NAME_MAP.fetch(type)
@@ -58,6 +100,7 @@ module Bulkrax
            **options)
     end
 
+    ##
     # @api public
     #
     # @param parser_class_name [String]
@@ -121,16 +164,6 @@ module Bulkrax
     end
     private_class_method :importer_for
 
-    ##
-    # @api private
-    #
-    # @param data [Hash<Symbol,String>] we're expecting a hash with keys that are symbols and then
-    #        values that are strings.
-    #
-    # @return [Bulkrax::CsvEntry]
-    #
-    # @note As a foible of this implementation, you'll need to include along a CSV to establish the
-    #       columns that you'll parse (e.g. the first row
     def self.build_csv_entry_for(importer:, data:, identifier:, entry_class:, **_options)
       entry_class.new(
         importerexporter: importer,
@@ -138,13 +171,8 @@ module Bulkrax
         raw_metadata: data
       )
     end
+    private_class_method :build_csv_entry_for
 
-    ##
-    # @api private
-    #
-    # @param data [String] we're expecting a string that is well-formed XML for OAI parsing.
-    #
-    # @return [Bulkrax::OaiEntry]
     def self.build_oai_entry_for(importer:, data:, identifier:, entry_class:, **options)
       # The raw record assumes we take the XML data, parse it and then send that to the
       # OAI::GetRecordResponse object.
@@ -165,13 +193,8 @@ module Bulkrax
         raw_metadata: raw_metadata
       )
     end
+    private_class_method :build_oai_entry_for
 
-    ##
-    # @api private
-    #
-    # @param data [String] we're expecting a string that is well-formed XML.
-    #
-    # @return [Bulkrax::XmlEntry]
     def self.build_xml_entry_for(importer:, data:, identifier:, entry_class:, **options)
       raw_metadata = {
         importer.parser.source_identifier.to_s => identifier,
@@ -186,5 +209,6 @@ module Bulkrax
         raw_metadata: raw_metadata
       )
     end
+    private_class_method :build_xml_entry_for
   end
 end

data/lib/bulkrax/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bulkrax
-  VERSION = '5.4.0'
+  VERSION = '5.5.0'
 end

data/lib/generators/bulkrax/templates/config/initializers/bulkrax.rb

@@ -80,6 +80,7 @@ Bulkrax.setup do |config|
 end
 
 # Sidebar for hyrax 3+ support
+# rubocop:disable Style/IfUnlessModifier
 if Object.const_defined?(:Hyrax) && ::Hyrax::DashboardController&.respond_to?(:sidebar_partials)
   Hyrax::DashboardController.sidebar_partials[:repository_content] << "hyrax/dashboard/sidebar/bulkrax_sidebar_additions"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bulkrax
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 5.5.0
 platform: ruby
 authors:
 - Rob Kaufman
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-02 00:00:00.000000000 Z
+date: 2023-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: dry-monads
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: iso8601
   requirement: !ruby/object:Gem::Requirement